WIP: refactor findOrRegisterUserByLdapInfo

config/env.dev.js

@@ -11,13 +11,14 @@ module.exports = {
   // filters for debug
   DEBUG: [
     // 'express:*',
+    // 'crowi:*',
     // 'crowi:crowi',
     'crowi:crowi:dev',
     'crowi:crowi:express-init',
+    'crowi:models:external-account',
     // 'crowi:routes:login',
     'crowi:routes:login-passport',
     'crowi:service:PassportService',
-    // 'crowi:*',
     // 'crowi:routes:page',
     // 'crowi:plugins:*',
     // 'crowi:InterceptorManager',

lib/models/external-account.js

@@ -1,4 +1,4 @@
-const debug = require('debug')('crowi.models.external-account');
+const debug = require('debug')('crowi:models:external-account');
 const mongoose = require('mongoose');
 const uniqueValidator = require('mongoose-unique-validator');
 const ObjectId = mongoose.Schema.Types.ObjectId;
@@ -23,6 +23,51 @@ schema.plugin(uniqueValidator);
  * @class ExternalAccount
  */
 class ExternalAccount {
+
+  /**
+   * get the populated user entity
+   *
+   * @returns Promise<User>
+   * @memberof ExternalAccount
+   */
+  getPopulatedUser() {
+    return this.populate('user').execPopulate()
+      .then((account) => {
+        return account.user;
+      })
+  }
+
+  /**
+   * find an account or register if not found
+   *
+   * @static
+   * @param {string} providerType
+   * @param {string} accountId
+   * @param {object} createUserFunction the function that create a user document and return Promise<User>
+   * @returns {Promise<ExternalAccount>}
+   * @memberof ExternalAccount
+   */
+  static findOrRegister(providerType, accountId, createUserFunction) {
+
+    return this.findOne({ providerType, accountId })
+      .then((account) => {
+        // found
+        if (account != null) {
+          debug(`ExternalAccount '${accountId}' is found `, account);
+          return account;
+        }
+        // not found
+        else {
+          debug(`ExternalAccount '${accountId}' is not found, it is going to be registered.`);
+
+          return createUserFunction().then((user) => {
+              return this.create({ providerType: 'ldap', accountId, user: user._id });
+            });
+        }
+      });
+
+  }
+
 }
 
 module.exports = function(crowi) {

lib/service/passport.js

@@ -145,12 +145,12 @@ class PassportService {
       if (!req.form.isValid) {
         return callback({ message: 'Incorrect credentials.' });
       }
-      const username = loginForm.username;
+      const ldapAccountId = loginForm.username;
       const password = loginForm.password;
 
       // user bind
       if (isUserBind) {
-        bindDN = bindDN.replace(/{{username}}/, username);
+        bindDN = bindDN.replace(/{{username}}/, ldapAccountId);
         bindCredentials = password;
       }
 
@@ -158,7 +158,8 @@ class PassportService {
         const opts = {
           usernameField: PassportService.USERNAME_FIELD,
           passwordField: PassportService.PASSWORD_FIELD,
-          server: { url, bindDN, bindCredentials, searchBase, searchFilter }
+          server: { url, bindDN, bindCredentials, searchBase, searchFilter },
+          passReqToCallback: true,
         };
         debug('ldap configuration: ', opts);
         callback(null, opts);
@@ -166,10 +167,12 @@ class PassportService {
     };
 
     passport.use(new LdapStrategy(getLDAPConfiguration,
-      (ldapUserInfo, done) => {
-        debug("LDAP authentication has successed", ldapUserInfo);
+      (req, ldapAccountInfo, done) => {
+        debug("LDAP authentication has successed", ldapAccountInfo);
 
-        this.findOrRegisterUserByLdapInfo(ldapUserInfo)
+        const ldapAccountId = req.body.loginForm.username;
+
+        this.findOrRegisterUserByLdapInfo(ldapAccountId, ldapAccountInfo)
           .then((user) => {
             done(null, user);
           })
@@ -183,35 +186,25 @@ class PassportService {
     debug('LdapStrategy: setup is done');
   }
 
-  findOrRegisterUserByLdapInfo(ldapUserInfo) {
+  /**
+   * find the ExternalAccount or register if not found
+   *
+   * @param {string} ldapAccountId
+   * @param {object} ldapAccountInfo
+   * @returns
+   * @memberof PassportService
+   */
+  findOrRegisterUserByLdapInfo(ldapAccountId, ldapAccountInfo) {
     const User = this.crowi.model('User');
     const ExternalAccount = this.crowi.model('ExternalAccount');
 
-    const accountId = ldapUserInfo['uid'];
-
-    return ExternalAccount.findOne({ providerType: 'ldap', accountId: accountId })
-      .then((account) => {
-        if (account != null) {
-          debug(`LdapStrategy: accountId '${accountId}' is found `, account);
-          return account;
-        }
-        else {
-          debug(`LdapStrategy: accountId '${accountId}' is not found, it is going to be registered.`);
-
-          // TODO ensure to be able to select the way to determine username
-          const username = ldapUserInfo['uid'];
-
-          return User.createUser('', username, undefined, undefined, undefined)
-            .then((user) => {
-              return ExternalAccount.create({ providerType: 'ldap', accountId, user: user._id });
-            });
-        }
-      })
-      .then((account) => {
-        return account.populate('user').execPopulate();
+    return ExternalAccount.findOrRegister('ldap', ldapAccountId, () => {
+        // TODO ensure to be able to select the way to determine username
+        const username = ldapAccountInfo['uid'];
+        return User.createUser('', username, undefined, undefined, undefined);
       })
       .then((account) => {
-        return account.user;
+        return account.getPopulatedUser();
       });
   }