weseek__growi/packages/app/src/server/models/external-account.js

// disable no-return-await for model functions
/* eslint-disable no-return-await */
import { NullUsernameToBeRegisteredError } from '~/server/models/errors';

const debug = require('debug')('growi:models:external-account');
const mongoose = require('mongoose');
const mongoosePaginate = require('mongoose-paginate-v2');
const uniqueValidator = require('mongoose-unique-validator');

const ObjectId = mongoose.Schema.Types.ObjectId;

/*
 * define schema
 */
const schema = new mongoose.Schema({
  providerType: { type: String, required: true },
  accountId: { type: String, required: true },
  user: { type: ObjectId, ref: 'User', required: true },
}, {
  timestamps: { createdAt: true, updatedAt: false },
});
// compound index
schema.index({ providerType: 1, accountId: 1 }, { unique: true });
// apply plugins
schema.plugin(mongoosePaginate);
schema.plugin(uniqueValidator);

/**
 * The Exception class thrown when User.username is duplicated when creating user
 *
 * @class DuplicatedUsernameException
 */
class DuplicatedUsernameException {

  constructor(message, user) {
    this.name = this.constructor.name;
    this.message = message;
    this.user = user;
  }

}

/**
 * ExternalAccount Class
 *
 * @class ExternalAccount
 */
class ExternalAccount {

  /**
   * limit items num for pagination
   *
   * @readonly
   * @static
   * @memberof ExternalAccount
   */
  static get DEFAULT_LIMIT() {
    return 50;
  }

  static set crowi(crowi) {
    this._crowi = crowi;
  }

  static get crowi() {
    return this._crowi;
  }

  /**
   * get the populated user entity
   *
   * @returns Promise<User>
   * @memberof ExternalAccount
   */
  getPopulatedUser() {
    return this.populate('user')
      .then((account) => {
        return account.user;
      });
  }

  /**
   * find an account or register if not found
   *
   * @static
   * @param {string} providerType
   * @param {string} accountId
   * @param {object} usernameToBeRegistered the username of User entity that will be created when accountId is not found
   * @param {object} nameToBeRegistered the name of User entity that will be created when accountId is not found
   * @param {object} mailToBeRegistered the mail of User entity that will be created when accountId is not found
   * @param {boolean} isSameUsernameTreatedAsIdenticalUser
   * @param {boolean} isSameEmailTreatedAsIdenticalUser
   * @returns {Promise<ExternalAccount>}
   * @memberof ExternalAccount
   */
  static findOrRegister(providerType, accountId,
      usernameToBeRegistered, nameToBeRegistered, mailToBeRegistered,
      isSameUsernameTreatedAsIdenticalUser, isSameEmailTreatedAsIdenticalUser) {
    //
    return this.findOne({ providerType, accountId })
      .then((account) => {
        // ExternalAccount is found
        if (account != null) {
          debug(`ExternalAccount '${accountId}' is found `, account);
          return account;
        }

        if (usernameToBeRegistered == null) {
          throw new NullUsernameToBeRegisteredError('username_should_not_be_null');
        }

        const User = ExternalAccount.crowi.model('User');

        let promise = User.findOne({ username: usernameToBeRegistered });
        if (isSameUsernameTreatedAsIdenticalUser && isSameEmailTreatedAsIdenticalUser) {
          promise = promise
            .then((user) => {
              if (user == null) { return User.findOne({ email: mailToBeRegistered }) }
              return user;
            });
        }
        else if (isSameEmailTreatedAsIdenticalUser) {
          promise = User.findOne({ email: mailToBeRegistered });
        }

        return promise
          .then((user) => {
            // when the User that have the same `username` exists
            if (user != null) {
              throw new DuplicatedUsernameException(`User '${usernameToBeRegistered}' already exists`, user);
            }
            if (nameToBeRegistered == null) {
              // eslint-disable-next-line no-param-reassign
              nameToBeRegistered = '';
            }

            // create a new User with STATUS_ACTIVE
            debug(`ExternalAccount '${accountId}' is not found, it is going to be registered.`);
            return User.createUser(nameToBeRegistered, usernameToBeRegistered, mailToBeRegistered, undefined, undefined, User.STATUS_ACTIVE);
          })
          .then((newUser) => {
            return this.associate(providerType, accountId, newUser);
          });
      });
  }

  /**
   * Create ExternalAccount document and associate to existing User
   *
   * @param {string} providerType
   * @param {string} accountId
   * @param {object} user
   */
  static associate(providerType, accountId, user) {
    return this.create({ providerType, accountId, user: user._id });
  }

  /**
   * find all entities with pagination
   *
   * @see https://github.com/edwardhotchkiss/mongoose-paginate
   *
   * @static
   * @param {any} opts mongoose-paginate options object
   * @returns {Promise<any>} mongoose-paginate result object
   * @memberof ExternalAccount
   */
  static findAllWithPagination(opts) {
    const query = {};
    const options = Object.assign({ populate: 'user' }, opts);
    if (options.sort == null) {
      options.sort = { accountId: 1, createdAt: 1 };
    }
    if (options.limit == null) {
      options.limit = ExternalAccount.DEFAULT_LIMIT;
    }

    return this.paginate(query, options);
  }

}

module.exports = function(crowi) {
  ExternalAccount.crowi = crowi;
  schema.loadClass(ExternalAccount);
  return mongoose.model('ExternalAccount', schema);
};