feat(sequelize): initial adapter #73

EXIT-ALAMERY · 2021-04-28T14:58:28Z

Added the adapter for Sequelize ORM.

balazsorban44

Thank you so much for submitting this! I had some comments, but all in all it looks great so far!

PS.: If you are into TypeScript (totally fine if you are not interested), we now have an Adapter interface, that could help you type the whole adapter, by applying the interface on the Adapter function.

https://github.com/nextauthjs/next-auth/blob/0cf1823e70ce48024362670d19db09fc0bbb9727/types/adapters.d.ts#L74-L125

packages/sequelize/package.json

balazsorban44 · 2021-04-28T18:58:11Z

packages/sequelize/src/adapter/lib/errors.js

+"use strict";
+
+class UnknownError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = 'UnknownError';
+    this.message = message;
+  }
+
+  toJSON() {
+    return {
+      error: {
+        name: this.name,
+        message: this.message
+      }
+    };
+  }
+
+}
+
+class CreateUserError extends UnknownError {
+  constructor(message) {
+    super(message);
+    this.name = 'CreateUserError';
+    this.message = message;
+  }
+
+}
+
+class AccountNotLinkedError extends UnknownError {
+  constructor(message) {
+    super(message);
+    this.name = 'AccountNotLinkedError';
+    this.message = message;
+  }
+
+}
+
+module.exports = {
+  UnknownError,
+  CreateUserError,
+  AccountNotLinkedError
+};


That file can be deleted. You can import all these (and more!) from next-auth/errors now! 🎉
See https://github.com/nextauthjs/next-auth/blob/main/src/lib/errors.js

(Note. We are also trying to make error handling automatic, so in the future, you may not even need these, but for now, it's fine if you use them wherever possible and fit. You could see that Prisma adapter for reference how and where it uses these Errors: https://github.com/nextauthjs/adapters/blob/canary/packages/prisma/src/index.ts. This will help the users catch their errors much more easily)

balazsorban44 · 2021-04-28T18:59:32Z

packages/sequelize/src/adapter/lib/logger.js

+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var logger = {
+  error: function error(errorCode) {
+    for (var _len = arguments.length, text = new Array(_len > 1 ? _len - 1 : 0), _key = 1; _key < _len; _key++) {
+      text[_key - 1] = arguments[_key];
+    }
+
+    if (!console) {
+      return;
+    }
+
+    if (text && text.length <= 1) {
+      text = text[0] || '';
+    }
+
+    console.error("[next-auth][error][".concat(errorCode.toLowerCase(), "]"), text, "\nhttps://next-auth.js.org/errors#".concat(errorCode.toLowerCase()));
+  },
+  warn: function warn(warnCode) {
+    for (var _len2 = arguments.length, text = new Array(_len2 > 1 ? _len2 - 1 : 0), _key2 = 1; _key2 < _len2; _key2++) {
+      text[_key2 - 1] = arguments[_key2];
+    }
+
+    if (!console) {
+      return;
+    }
+
+    if (text && text.length <= 1) {
+      text = text[0] || '';
+    }
+
+    console.warn("[next-auth][warn][".concat(warnCode.toLowerCase(), "]"), text, "\nhttps://next-auth.js.org/warning#".concat(warnCode.toLowerCase()));
+  },
+  debug: function debug(debugCode) {
+    for (var _len3 = arguments.length, text = new Array(_len3 > 1 ? _len3 - 1 : 0), _key3 = 1; _key3 < _len3; _key3++) {
+      text[_key3 - 1] = arguments[_key3];
+    }
+
+    if (!console) {
+      return;
+    }
+
+    if (text && text.length <= 1) {
+      text = text[0] || '';
+    }
+
+    if (process && process.env && process.env._NEXTAUTH_DEBUG) {
+      console.log("[next-auth][debug][".concat(debugCode.toLowerCase(), "]"), text);
+    }
+  }
+};
+var _default = logger;
+exports.default = _default;


The logger instance is available on appOptions.logger. You get appOptions from getAdapter.

Again, you can have a look at the Prisma adapter:

adapters/packages/prisma/src/index.ts

Lines 87 to 88 in edff780

async getAdapter(appOptions: AppOptions) {

const logger = appOptions.logger ?? console

Co-authored-by: Balázs Orbán <info@balazsorban.com>

balazsorban44 · 2021-04-29T16:21:32Z

packages/sequelize/src/adapter/index.js

+import "regenerator-runtime/runtime";
+import { createHash, randomBytes } from "crypto";
+
+import { CreateUserError } from "./lib/errors";


Suggested change

import { CreateUserError } from "./lib/errors";

import { CreateUserError } from "next-auth/errors";

These are included in the base library now. check out the content of the errors module, there are more type of errors as well. You can delete the ./lib/errors file now

balazsorban44 · 2021-04-29T16:22:50Z

packages/sequelize/src/adapter/index.js

+import { createHash, randomBytes } from "crypto";
+
+import { CreateUserError } from "./lib/errors";
+import logger from "./lib/logger";


Suggested change

import logger from "./lib/logger";

You will find this in appOptions in getAdapter. You can remove ./lib/logger

packages/sequelize/src/adapter/index.js

Co-authored-by: Balázs Orbán <info@balazsorban.com>

luke-j

Nice work, would be great to get this in.

luke-j · 2021-05-13T04:39:08Z

packages/sequelize/LICENSE

+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.


This license isn't necessary given there's already one for the repo.

packages/sequelize/README.MD

packages/sequelize/example/db/models/index.js

packages/sequelize/example/db/models/user_extended.js

packages/sequelize/example/pages/api/auth/[...nextauth].js

luke-j · 2021-05-13T05:04:26Z

packages/sequelize/package.json

+    "@babel/core": "^7.12.10",
+    "@babel/preset-env": "^7.12.11"
+  }
+}


This should have a peer dependency on sequelize, right?

ndom91 · 2021-05-24T15:09:03Z

@EXIT-ALAMERY we now have official TS types for the adapters as well as a test suite all adapters should pass. Maybe these can help you finalize this adapter.

If you're still interested in getting this sequelize adapter in, I'd suggest checking out the suggestions made above and then maybe checking out the new basic-tests.ts file and get your seqeulize adapter passing 👍

Looking forward to this!

balazsorban44 · 2021-05-24T15:16:09Z

@ndom91 I have talked to @EXIT-ALAMERY and unfortunately he doesn't have the opportunity to finish this up, so I am going to take this PR once I have the time, and credit them as a contributor.

Co-authored-by: Luke Jones <luke-j@users.noreply.github.com>

ndom91 · 2021-06-07T14:54:13Z

Hey guys this is looking awesome! If you can add the basic tests to this package i'd be comfortable merging and releasing a canary version!

See:

Basic Test: https://github.com/nextauthjs/adapters/blob/canary/basic-tests.ts
Prisma Example: https://github.com/nextauthjs/adapters/blob/canary/packages/prisma/tests/index.test.ts
TypeORM Example (may be more appropriate / helpful here): https://github.com/nextauthjs/adapters/tree/canary/packages/typeorm-legacy/tests

For an ORM like this where users can put a few types of different DBs underneath, ideally we'd like to have atleast 2+ (for example mysql + postgres) tested. But if we get one in and working I think that'd be a good enough starting point to release a canary version.

EXIT-ALAMERY · 2021-06-09T07:56:07Z

The tests for PostgreSQL passed successfully. I'll probably write tests for MySQL or MSSQL tomorrow.

ndom91 · 2021-06-09T09:03:48Z

Awesome thanks a lot!

ndom91 · 2021-06-11T20:05:05Z

Tests for MySQL and Postgresql are in. Thanks guys! Is this alright to merge from your perspective?

Btw you still need to add sequelize to the adapter matrix in .github/workflows/canary.yml:

adapters/.github/workflows/canary.yml

Lines 33 to 40 in 468bd5e

    
                     filters: | 
        
                       prisma: packages/prisma/** 
        
                       fauna: packages/fauna/** 
        
                       dynamodb: packages/dynamodb/** 
        
                       typeorm-legacy: packages/typeorm-legacy/** 
        
                       prisma-legacy: packages/prisma-legacy/** 
        
                       firebase: packages/firebase/** 
        
                       pouchdb: packages/pouchdb/**

Thanks!

…dapters into sequelize-adapter

ndom91 · 2021-06-20T14:05:38Z

Hey guys I was taking a look at the tests, they don't seem to pass in CI and I couldn't get them to run locally either, but that makes sense since yuo don't have any script or any way to setup the db in a CI environment. The yarn test script just executes jest. I assume in your local environment you manully created the docker container with the mysql db, seeded it, ran migrations, etc. right?

We need to come up with a shell script to automate that whole process in CI for both mysql and postgres. I'll try to push something here shortly 👍

Otherwise looks good so far!

ndom91 · 2021-06-20T14:44:12Z

So I cleaned up some of the default usernames / etc to make them match to what we usually use. Next, I added some npm scripts for each mysql and postgres to execute a bash script to setup the respective containers and execute jest tests on them once they're up.

Also none of the db drivers were listed as peerDeps or anything like that, so I added them as optional peerDeps for mysql and postgres.

Both test (mysql + postgres) pass now locally for me, starting from 0, building the containers, running migrations, running tests, etc. However on both tests I still have a ton of console.log output from what looks like the sequelize adapter itself, but I couldn't find any console.log's anywhere. Do you have any idea where they're coming from? Haha

What do you think?

EDIT: Okay so while it works locally, github actions still seems to not like something. I'd bet its somethign to do with missing types. Have you guys seen sequelize-typescript?

EXIT-ALAMERY · 2021-06-22T16:50:01Z

The SQL queries you see in the console get generated by the sequelize library itself so, you can disable them by setting logging: false in the config file.

Also, I've seen the sequelize-typescript module but, the sequelize team doesn't officially maintain it. So, I decided not to implement it but, if you believe that proceeding with it would suffice the needs of this project, then I'll take a thorough look.

Thanks!

ndom91 · 2021-06-22T20:52:00Z

The SQL queries you see in the console get generated by the sequelize library itself so, you can disable them by setting logging: false in the config file.

Also, I've seen the sequelize-typescript module but, the sequelize team doesn't officially maintain it. So, I decided not to implement it but, if you believe that proceeding with it would suffice the needs of this project, then I'll take a thorough look.

Thanks!

I only mention it because the tests seem to be failing due to missing types. I did some testing with manually declare a dummy sequelize module, but that didn't seem to help..

@lluia any idea whats missing here? Checkout the latest failing test.

EXIT-ALAMERY · 2021-06-30T13:46:11Z

We can try adding sequelize as a dependency and see if it works because I created full-fledged sequelize models specifically for the tests, so they're trying to import sequelize from the node modules, which doesn't exist.

ndom91 · 2021-08-26T23:30:09Z

Hey @EXIT-ALAMERY, we've done a major rewrite of the adapter API to simplify things significantly. Are you still interested in getting sequelize over the finish line?

You can checkout the changes here: nextauthjs/next-auth#2361. As well as the migration @balazsorban44 did of our prisma adapter here: #171 and of fauna here: #182.

Also we would really appreciate it if you could make the PR against next instead of canary. Maybe it makes more sense to just make a new PR all things considered? Up to you 👍

We're also debating whether to replace type-orm as our primary adapter for SQL / Mongo related databases, do you think sequelize could act as a good replacement for type-orm?

EXIT-ALAMERY · 2021-09-18T17:09:12Z

Hey @EXIT-ALAMERY, we've done a major rewrite of the adapter API to simplify things significantly. Are you still interested in getting sequelize over the finish line?

That sounds great and, I wish all the best to nextauthjs, but, unfortunately, I am no longer interested in the sequelize adapter. Thank you for your patience and support.

balazsorban44 · 2021-09-18T17:57:10Z

no problem! we might reuse your code when we get some time to add a sequelize adapter! thank you!

Add sequelize adapter

cf837b6

balazsorban44 suggested changes Apr 28, 2021

View reviewed changes

balazsorban44 changed the title ~~Add sequelize adapter~~ feat(sequelize): initial sequelize adapter Apr 28, 2021

balazsorban44 changed the title ~~feat(sequelize): initial sequelize adapter~~ feat(sequelize): initial adapter Apr 28, 2021

EXIT-ALAMERY and others added 6 commits April 29, 2021 20:48

rename the package

2e55af4

Co-authored-by: Balázs Orbán <info@balazsorban.com>

fix the build script

fbb5d53

Co-authored-by: Balázs Orbán <info@balazsorban.com>

set appropriate github urls

5599b05

Co-authored-by: Balázs Orbán <info@balazsorban.com>

remove unwanted properties

e2a3f2e

Co-authored-by: Balázs Orbán <info@balazsorban.com>

set appropriate url for homepage property

bb1b303

Co-authored-by: Balázs Orbán <info@balazsorban.com>

remove excess dependencies

a9260d8

Co-authored-by: Balázs Orbán <info@balazsorban.com>

balazsorban44 suggested changes Apr 29, 2021

View reviewed changes

Rafay Khan and others added 2 commits April 29, 2021 22:05

correctly import logger and CreateUserError

112076c

Update packages/sequelize/src/adapter/index.js

f090e96

Co-authored-by: Balázs Orbán <info@balazsorban.com>

luke-j reviewed May 13, 2021

View reviewed changes

ndom91 added enhancement New feature or request help wanted Extra attention is needed labels May 24, 2021

EXIT-ALAMERY and others added 11 commits June 7, 2021 14:35

remove legacy info

cabbc43

Co-authored-by: Luke Jones <luke-j@users.noreply.github.com>

Update packages/sequelize/README.MD

be97a30

Co-authored-by: Luke Jones <luke-j@users.noreply.github.com>

Update packages/sequelize/README.MD

fe6d06b

Co-authored-by: Luke Jones <luke-j@users.noreply.github.com>

Update packages/sequelize/README.MD

9634228

Co-authored-by: Luke Jones <luke-j@users.noreply.github.com>

Update packages/sequelize/example/db/models/index.js

496a8ce

Co-authored-by: Luke Jones <luke-j@users.noreply.github.com>

Update packages/sequelize/example/db/models/index.js

28b8020

Co-authored-by: Luke Jones <luke-j@users.noreply.github.com>

Update packages/sequelize/example/db/models/user_extended.js

1f9dc8b

Co-authored-by: Luke Jones <luke-j@users.noreply.github.com>

Update packages/sequelize/example/pages/api/auth/[...nextauth].js

3e9768e

Co-authored-by: Luke Jones <luke-j@users.noreply.github.com>

add ts typings + fix naming issues

aaad0b6

Merge branch 'canary' into sequelize-adapter

6ab1e87

chore(sequelize): update gh-action package matrix

d57fd13

ndom91 and others added 2 commits June 7, 2021 16:59

Merge branch 'canary' into sequelize-adapter

12782ef

add tests for postgres

e26a525

Rafay Khan and others added 2 commits June 9, 2021 21:58

add tests for mysql

9777230

Merge branch 'canary' into sequelize-adapter

468bd5e

Rafay Khan and others added 4 commits June 19, 2021 21:26

add sequelize to the adapter matrix

72040e3

Merge branch 'canary' into sequelize-adapter

1a910b8

Merge branch 'sequelize-adapter' of https://github.com/EXIT-ALAMERY/a…

bf0fd07

…dapters into sequelize-adapter

fix name error

255e4e5

test: create test scripts

83103cd

ndom91 added 2 commits June 20, 2021 16:45

chore: cleanup

f4106ef

fix: tsconfig.json

1138a6b

ndom91 added 3 commits June 22, 2021 22:38

test: dummy declare module

92ca55f

test: dummy declare

5929407

test: fix pkg name

369ec2d

rm: test sequelize module declaration

5b8dc34

EXIT-ALAMERY closed this Sep 18, 2021

luke-j mentioned this pull request Sep 19, 2021

feat(sequelize): Add Sequelize adapter #237

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(sequelize): initial adapter #73

feat(sequelize): initial adapter #73

EXIT-ALAMERY commented Apr 28, 2021

balazsorban44 left a comment

balazsorban44 Apr 28, 2021

balazsorban44 Apr 28, 2021

balazsorban44 Apr 29, 2021

balazsorban44 Apr 29, 2021

luke-j left a comment

luke-j May 13, 2021

luke-j May 13, 2021

ndom91 commented May 24, 2021

balazsorban44 commented May 24, 2021 •

edited

Loading

ndom91 commented Jun 7, 2021 •

edited

Loading

EXIT-ALAMERY commented Jun 9, 2021

ndom91 commented Jun 9, 2021

ndom91 commented Jun 11, 2021 •

edited

Loading

ndom91 commented Jun 20, 2021 •

edited

Loading

ndom91 commented Jun 20, 2021 •

edited

Loading

EXIT-ALAMERY commented Jun 22, 2021

ndom91 commented Jun 22, 2021

EXIT-ALAMERY commented Jun 30, 2021

ndom91 commented Aug 26, 2021

EXIT-ALAMERY commented Sep 18, 2021

balazsorban44 commented Sep 18, 2021

	async getAdapter(appOptions: AppOptions) {
	const logger = appOptions.logger ?? console

	import { CreateUserError } from "./lib/errors";
	import { CreateUserError } from "next-auth/errors";

feat(sequelize): initial adapter #73

feat(sequelize): initial adapter #73

Conversation

EXIT-ALAMERY commented Apr 28, 2021

balazsorban44 left a comment

Choose a reason for hiding this comment

balazsorban44 Apr 28, 2021

Choose a reason for hiding this comment

balazsorban44 Apr 28, 2021

Choose a reason for hiding this comment

balazsorban44 Apr 29, 2021

Choose a reason for hiding this comment

balazsorban44 Apr 29, 2021

Choose a reason for hiding this comment

luke-j left a comment

Choose a reason for hiding this comment

luke-j May 13, 2021

Choose a reason for hiding this comment

luke-j May 13, 2021

Choose a reason for hiding this comment

ndom91 commented May 24, 2021

balazsorban44 commented May 24, 2021 • edited Loading

ndom91 commented Jun 7, 2021 • edited Loading

EXIT-ALAMERY commented Jun 9, 2021

ndom91 commented Jun 9, 2021

ndom91 commented Jun 11, 2021 • edited Loading

ndom91 commented Jun 20, 2021 • edited Loading

ndom91 commented Jun 20, 2021 • edited Loading

EXIT-ALAMERY commented Jun 22, 2021

ndom91 commented Jun 22, 2021

EXIT-ALAMERY commented Jun 30, 2021

ndom91 commented Aug 26, 2021

EXIT-ALAMERY commented Sep 18, 2021

balazsorban44 commented Sep 18, 2021

balazsorban44 commented May 24, 2021 •

edited

Loading

ndom91 commented Jun 7, 2021 •

edited

Loading

ndom91 commented Jun 11, 2021 •

edited

Loading

ndom91 commented Jun 20, 2021 •

edited

Loading

ndom91 commented Jun 20, 2021 •

edited

Loading