Fix issues with database; make it easier to test

These changes fix compatibility issues with common SQL databases including MySQL, MariaDB and Postgres.

* Fixes nextauthjs#147 - datetime now ANSI SQL timestamp
* Fixes nextauthjs#160 - AccessToken and RefreshToken type change from varchar to text
* Adds Docker Compose files to make it easier to test database integration.

TODO:

* Update documentation with configuration examples and latest compatibility info
* Create DB URI parser (currently only object config works)
* Database table/collection name prefix (will default to `next-auth_`)
* MongoDB support

MongoDB has some issues which mean it will require additional work and refactoring to support (while preserving SQL DB support, which is important).

It's going to take some thinking about to get right; MongoDB support might have to be dropped from 2.0 (and follow in a subsequent release) but I'm going to review options and consider the impact before making a call.

Author: iaincollins

client.js

@@ -1 +1 @@
-module.exports = require('./dist/client').default
+module.exports = require('./dist/client').default

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "next-auth",
-  "version": "2.0.0-beta.44",
+  "version": "2.0.0-beta.45",
   "description": "An authentication library for Next.js",
   "repository": "https://github.com/iaincollins/next-auth.git",
   "author": "Iain Collins <[email protected]>",
@@ -17,7 +17,9 @@
     "publish:beta": "npm publish --tag beta",
     "publish:canary": "npm publish --tag canary",
     "lint": "standard",
-    "lint:fix": "standard --fix"
+    "lint:fix": "standard --fix",
+    "test:db:start": "docker-compose -f tests/docker/docker-compose.yml up",
+    "test:db:stop": "docker-compose -f tests/docker/docker-compose.yml down"
   },
   "files": [
     "dist",

package.json

@@ -19,6 +19,31 @@ const Adapter = (config, options = {}) => {
   const EmailVerification = options.EmailVerification ? options.EmailVerification.model : Models.EmailVerification.model
   const EmailVerificationSchema = options.EmailVerification ? options.EmailVerification.schema : Models.EmailVerification.schema
 
+  // Models default to being suitable for ANSI SQL database
+  // Some flexiblity is required to support non-SQL databases
+  const idKey = 'id'
+  const getById = (id) => id
+
+  /* @TODO This is a work in progress
+  // Some custom logic is required to make schemas compatible with MongoDB
+  if (config.type === 'mongodb') {
+    if (!options.mongodb) throw new Error('Experimental feature')
+
+    idKey = 'id'
+    AccountSchema.columns.id.objectId = true
+    AccountSchema.columns.userId.objectId = true
+    UserSchema.columns.id.objectId = true
+    SessionSchema.columns.id.objectId = true
+    SessionSchema.columns.userId.objectId = true
+    EmailVerificationSchema.columns.id.objectId = true
+
+    getById = (id) => {
+      console.log('fancy getById', id)
+      return config.mongodb.ObjectId(id)
+    }
+  }
+  */
+
   // Parse config (uses options)
   const defaultConfig = {
     name: 'default',
@@ -71,12 +96,12 @@ const Adapter = (config, options = {}) => {
     // Display debug output if debug option enabled
     function _debug (...args) {
       if (appOptions.debug) {
-        console.log('[DEBUG]', ...args)
+        console.log('[NextAuth.js][DEBUG]', ...args)
       }
     }
 
     async function createUser (profile) {
-      _debug('Create user', profile)
+      _debug('createUser', profile)
       try {
         // Create user account
         const user = new User(profile.name, profile.email, profile.image)
@@ -88,17 +113,17 @@ const Adapter = (config, options = {}) => {
     }
 
     async function getUser (id) {
-      _debug('Get user', id)
+      _debug('getUser', id)
       try {
-        return connection.getRepository(User).findOne({ id })
+        return connection.getRepository(User).findOne({ [idKey]: getById(id) })
       } catch (error) {
         console.error('GET_USER_BY_ID_ERROR', error)
         return Promise.reject(new Error('GET_USER_BY_ID_ERROR', error))
       }
     }
 
     async function getUserByEmail (email) {
-      _debug('Get user by email address', email)
+      _debug('getUserByEmail', email)
       try {
         return connection.getRepository(User).findOne({ email })
       } catch (error) {
@@ -108,37 +133,37 @@ const Adapter = (config, options = {}) => {
     }
 
     async function getUserByProviderAccountId (providerId, providerAccountId) {
-      _debug('Get user by provider account ID', providerId, providerAccountId)
+      _debug('getUserByProviderAccountId', providerId, providerAccountId)
       try {
         const account = await connection.getRepository(Account).findOne({ providerId, providerAccountId })
         if (!account) { return null }
-        return connection.getRepository(User).findOne({ id: account.userId })
+        return connection.getRepository(User).findOne({ [idKey]: getById(account.userId) })
       } catch (error) {
         console.error('GET_USER_BY_PROVIDER_ACCOUNT_ID_ERROR', error)
         return Promise.reject(new Error('GET_USER_BY_PROVIDER_ACCOUNT_ID_ERROR', error))
       }
     }
 
     async function getUserByCredentials (credentials) {
-      _debug('Get user by credentials', credentials)
+      _debug('getUserByCredentials', credentials)
       // @TODO Get user from DB
       return false
     }
 
     async function updateUser (user) {
-      _debug('Update user', user)
+      _debug('updateUser', user)
       // @TODO Save changes to user object in DB
       return false
     }
 
     async function deleteUser (userId) {
-      _debug('Delete user', userId)
+      _debug('deleteUser', userId)
       // @TODO Delete user from DB
       return false
     }
 
     async function linkAccount (userId, providerId, providerType, providerAccountId, refreshToken, accessToken, accessTokenExpires) {
-      _debug('Link provider account', userId, providerId, providerType, providerAccountId, refreshToken, accessToken, accessTokenExpires)
+      _debug('linkAccount', userId, providerId, providerType, providerAccountId, refreshToken, accessToken, accessTokenExpires)
       try {
         // Create provider account linked to user
         const account = new Account(userId, providerId, providerType, providerAccountId, refreshToken, accessToken, accessTokenExpires)
@@ -150,15 +175,15 @@ const Adapter = (config, options = {}) => {
     }
 
     async function unlinkAccount (userId, providerId, providerAccountId) {
-      _debug('Unlink provider account', userId, providerId, providerAccountId)
+      _debug('unlinkAccount', userId, providerId, providerAccountId)
       // @TODO Get current user from DB
       // @TODO Delete [provider] object from user object
       // @TODO Save changes to user object in DB
       return false
     }
 
     async function createSession (user) {
-      _debug('Create session', user)
+      _debug('createSession', user)
       try {
         const { sessionMaxAge } = appOptions
         let expires = null
@@ -178,7 +203,7 @@ const Adapter = (config, options = {}) => {
     }
 
     async function getSession (sessionToken) {
-      _debug('Get session', sessionToken)
+      _debug('getSession', sessionToken)
       try {
         const session = await connection.getRepository(Session).findOne({ sessionToken })
 
@@ -196,7 +221,7 @@ const Adapter = (config, options = {}) => {
     }
 
     async function updateSession (session, force) {
-      _debug('Update session', session)
+      _debug('updateSession', session)
       try {
         const { sessionMaxAge, sessionUpdateAge } = appOptions
 
@@ -216,7 +241,7 @@ const Adapter = (config, options = {}) => {
           if (new Date() > dateSessionIsDueToBeUpdated) {
             const newExpiryDate = new Date()
             newExpiryDate.setTime(newExpiryDate.getTime() + sessionMaxAge)
-            session.sessionExpires = newExpiryDate.toISOString()
+            session.sessionExpires = newExpiryDate
           } else if (!force) {
             return null
           }
@@ -234,7 +259,7 @@ const Adapter = (config, options = {}) => {
     }
 
     async function deleteSession (sessionToken) {
-      _debug('Delete session', sessionToken)
+      _debug('deleteSession', sessionToken)
       try {
         return await connection.getRepository(Session).delete({ sessionToken })
       } catch (error) {
@@ -244,7 +269,7 @@ const Adapter = (config, options = {}) => {
     }
 
     async function createEmailVerification (email, url, token, secret, provider) {
-      _debug('Create verification request', email)
+      _debug('createEmailVerification', email)
       try {
         const { site, verificationMaxAge } = appOptions
         const { verificationCallback } = provider
@@ -277,7 +302,7 @@ const Adapter = (config, options = {}) => {
     }
 
     async function getEmailVerification (email, token, secret, provider) {
-      _debug('Get verification request', email, token)
+      _debug('getEmailVerification', email, token)
       try {
         // Hash token provided with secret before trying to match it with datbase
         // @TODO Use bcrypt function here instead of simple salted hash
@@ -298,7 +323,7 @@ const Adapter = (config, options = {}) => {
     }
 
     async function deleteEmailVerification (email, token, secret, provider) {
-      _debug('Delete verification request', email, token)
+      _debug('deleteEmailVerification', email, token)
       try {
         // Delete email verification so it cannot be used again
         const hashedToken = createHash('sha256').update(`${token}${secret}`).digest('hex')

src/adapters/typeorm/index.js

@@ -35,7 +35,7 @@ export const AccountSchema = {
       unique: true
     },
     userId: {
-      type: 'varchar'
+      type: 'int'
     },
     providerId: {
       type: 'varchar'
@@ -47,14 +47,15 @@ export const AccountSchema = {
       type: 'varchar'
     },
     refreshToken: {
-      type: 'varchar',
+      type: 'text',
       nullable: true
     },
     accessToken: {
-      type: 'varchar'
+      type: 'text'
     },
+    // @TODO AccessToken expiry is not yet tracked (varies across providers)
     accessTokenExpires: {
-      type: 'varchar',
+      type: 'timestamp',
       nullable: true
     }
   }

src/adapters/typeorm/models/account.js

@@ -23,7 +23,7 @@ export const EmailVerificationSchema = {
       unique: true
     },
     expires: {
-      type: 'date'
+      type: 'timestamp'
     }
   }
 }

src/adapters/typeorm/models/email-verification.js

@@ -26,7 +26,7 @@ export const SessionSchema = {
       unique: true
     },
     sessionExpires: {
-      type: 'date'
+      type: 'timestamp'
     },
     accessToken: {
       type: 'varchar',

src/adapters/typeorm/models/session.js

@@ -48,7 +48,7 @@ export default async (req, res, options, done) => {
           // If is missing email address (NB: the only field on a profile currently required)
           res.status(302).setHeader('Location', `${baseUrl}/error?error=EmailRequired`)
         } else {
-          console.error('OAUTH_CALLBACK_ERROR', error)
+          console.error('OAUTH_CALLBACK_HANDLER_ERROR', error)
           res.status(302).setHeader('Location', `${baseUrl}/error?error=Callback`)
         }
         res.end()

src/server/routes/callback.js

@@ -0,0 +1,21 @@
+# Start Mongo, MySQL and Postgres databases
+# Though other databases will be supported, these are the initial targets.
+# Uses Docker Compose v2 as v3 doesn't support extends
+version: '2'
+
+services:
+
+  mongo:
+    extends:
+      file: mongo.yml
+      service: mongo
+
+  mysql:
+    extends:
+      file: mysql.yml
+      service: mysql
+
+  postgres:
+    extends:
+      file: postgres.yml
+      service: postgres

tests/docker/docker-compose.yml

@@ -0,0 +1,13 @@
+version: '2'
+
+services:
+
+  mongo:
+    image: bitnami/mongodb
+    restart: always
+    environment:
+      MONGODB_USERNAME: nextauth
+      MONGODB_PASSWORD: password
+      MONGODB_DATABASE: nextauth
+    ports:
+      - "27017:27017"

tests/docker/mongo.yml

@@ -0,0 +1,15 @@
+version: '2'
+
+services:
+
+  mysql:
+    image: mysql
+    command: --default-authentication-plugin=mysql_native_password
+    restart: always
+    environment:
+      MYSQL_USER: nextauth
+      MYSQL_PASSWORD: password
+      MYSQL_DATABASE: nextauth
+      MYSQL_RANDOM_ROOT_PASSWORD: 'yes'
+    ports:
+      - "3306:3306"

tests/docker/mysql.yml

@@ -0,0 +1,13 @@
+version: '2'
+
+services:
+
+  postgres:
+    image: postgres
+    restart: always
+    environment:
+      POSTGRES_USER: nextauth
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: nextauth
+    ports:
+      - "5432:5432"

tests/docker/postgres.yml

@@ -6,7 +6,7 @@ module.exports = {
       'providers',
       'adapters',
       'client',
-      'rest-api',
+      'rest-api'
     ],
     v1: [
       'v1/getting-started-v1',