kuzzle 2.19.2 → 2.19.3

package/lib/core/security/userRepository.js

@@ -19,14 +19,14 @@
  * limitations under the License.
  */
 
-'use strict';
+"use strict";
 
-const { Request } = require('../../api/request');
-const debug = require('../../util/debug')('kuzzle:core:security:users');
-const Repository = require('../shared/repository');
-const kerror = require('../../kerror');
-const { User } = require('../../model/security/user');
-const ApiKey = require('../../model/storage/apiKey');
+const { Request } = require("../../api/request");
+const debug = require("../../util/debug")("kuzzle:core:security:users");
+const Repository = require("../shared/repository");
+const kerror = require("../../kerror");
+const { User } = require("../../model/security/user");
+const ApiKey = require("../../model/storage/apiKey");
 
 /**
  * @class UserRepository
@@ -37,26 +37,29 @@ class UserRepository extends Repository {
    * @param {SecurityModule} securityModule
    * @constructor
    */
-  constructor (securityModule) {
+  constructor(securityModule) {
     super({ store: global.kuzzle.internalIndex });
     this.module = securityModule;
-    this.collection = 'users';
+    this.collection = "users";
     this.ObjectConstructor = User;
     this.anonymousUser = null;
   }
 
-  async init () {
+  async init() {
     this.anonymousUser = await this.fromDTO({
-      _id: '-1',
-      name: 'Anonymous',
-      profileIds: ['anonymous']
+      _id: "-1",
+      name: "Anonymous",
+      profileIds: ["anonymous"],
     });
 
     /**
      * Gets the standard anonymous User object
      * @returns {User}
      */
-    global.kuzzle.onAsk('core:security:user:anonymous:get', () => this.anonymousUser);
+    global.kuzzle.onAsk(
+      "core:security:user:anonymous:get",
+      () => this.anonymousUser
+    );
 
     /**
      * Creates a new user
@@ -68,8 +71,10 @@ class UserRepository extends Repository {
      * @throws If already exists or if at least one profile ID is unknown
      */
     global.kuzzle.onAsk(
-      'core:security:user:create',
-      (id, profileIds, content, opts) => this.create(id, profileIds, content, opts));
+      "core:security:user:create",
+      (id, profileIds, content, opts) =>
+        this.create(id, profileIds, content, opts)
+    );
 
     /**
      * Deletes an existing user
@@ -77,9 +82,9 @@ class UserRepository extends Repository {
      * @param  {Object} opts - refresh
      * @throws If the user doesn't exist
      */
-    global.kuzzle.onAsk(
-      'core:security:user:delete',
-      (id, opts) => this.deleteById(id, opts));
+    global.kuzzle.onAsk("core:security:user:delete", (id, opts) =>
+      this.deleteById(id, opts)
+    );
 
     /**
      * Loads and returns an existing user
@@ -87,7 +92,7 @@ class UserRepository extends Repository {
      * @returns {User}
      * @throws {NotFoundError} If the user doesn't exist
      */
-    global.kuzzle.onAsk('core:security:user:get', id => this.load(id));
+    global.kuzzle.onAsk("core:security:user:get", (id) => this.load(id));
 
     /**
      * Gets multiple users
@@ -95,9 +100,9 @@ class UserRepository extends Repository {
      * @returns {Array.<User>}
      * @throws If one or more users don't exist
      */
-    global.kuzzle.onAsk(
-      'core:security:user:mGet',
-      ids => this.loadMultiFromDatabase(ids));
+    global.kuzzle.onAsk("core:security:user:mGet", (ids) =>
+      this.loadMultiFromDatabase(ids)
+    );
 
     /**
      * Replaces the user's content
@@ -107,8 +112,10 @@ class UserRepository extends Repository {
      * @returns {User} Updated user
      */
     global.kuzzle.onAsk(
-      'core:security:user:replace',
-      (id, profileIds, content, opts) => this.replace(id, profileIds, content, opts));
+      "core:security:user:replace",
+      (id, profileIds, content, opts) =>
+        this.replace(id, profileIds, content, opts)
+    );
 
     /**
      * Fetches the next page of search results
@@ -116,9 +123,9 @@ class UserRepository extends Repository {
      * @param  {String} [ttl] - refresh the scroll results TTL
      * @returns {Object} Search results
      */
-    global.kuzzle.onAsk(
-      'core:security:user:scroll',
-      (id, ttl) => this.scroll(id, ttl));
+    global.kuzzle.onAsk("core:security:user:scroll", (id, ttl) =>
+      this.scroll(id, ttl)
+    );
 
     /**
      * Searches users
@@ -126,17 +133,17 @@ class UserRepository extends Repository {
      * @param  {Object} opts (from, size, scroll)
      * @returns {Object} Search results
      */
-    global.kuzzle.onAsk(
-      'core:security:user:search',
-      (searchBody, opts) => this.search(searchBody, opts));
+    global.kuzzle.onAsk("core:security:user:search", (searchBody, opts) =>
+      this.search(searchBody, opts)
+    );
 
     /**
      * Removes all existing users
      * @param  {Object} opts (refresh)
      */
-    global.kuzzle.onAsk(
-      'core:security:user:truncate',
-      opts => this.truncate(opts));
+    global.kuzzle.onAsk("core:security:user:truncate", (opts) =>
+      this.truncate(opts)
+    );
 
     /**
      * Updates an existing user using a partial content
@@ -146,17 +153,19 @@ class UserRepository extends Repository {
      * @returns {User} Updated user
      */
     global.kuzzle.onAsk(
-      'core:security:user:update',
-      (id, profileIds, content, opts) => this.update(id, profileIds, content, opts));
+      "core:security:user:update",
+      (id, profileIds, content, opts) =>
+        this.update(id, profileIds, content, opts)
+    );
 
     /**
      * Returns true if there is at least one user with the "admin" profile
      *
      * @returns {Boolean}
      */
-    global.kuzzle.onAsk(
-      'core:security:user:admin:exist',
-      () => this.adminExists());
+    global.kuzzle.onAsk("core:security:user:admin:exist", () =>
+      this.adminExists()
+    );
   }
 
   /**
@@ -166,7 +175,7 @@ class UserRepository extends Repository {
    * @param {Object} content
    * @param {Object} [opts]
    */
-  async create (id, profileIds, content, { userId, refresh = 'false' } = {}) {
+  async create(id, profileIds, content, { userId, refresh = "false" } = {}) {
     const user = await this.fromDTO({
       ...content,
       // Profile Ids and content are stored at the same level... for now.
@@ -184,12 +193,11 @@ class UserRepository extends Repository {
 
     try {
       return await this.persist(user, {
-        database: { method: 'create', refresh }
+        database: { method: "create", refresh },
       });
-    }
-    catch (error) {
-      if (error.id === 'services.storage.document_already_exists') {
-        throw kerror.get('security', 'user', 'already_exists', id);
+    } catch (error) {
+      if (error.id === "services.storage.document_already_exists") {
+        throw kerror.get("security", "user", "already_exists", id);
       }
 
       throw error;
@@ -204,11 +212,12 @@ class UserRepository extends Repository {
    * @param  {Object} [opts]
    * @returns {Promise}
    */
-  async update (id, profileIds, content, {
-    refresh = 'false',
-    retryOnConflict = 10,
-    userId,
-  } = {}) {
+  async update(
+    id,
+    profileIds,
+    content,
+    { refresh = "false", retryOnConflict = 10, userId } = {}
+  ) {
     const user = await this.load(id);
     const pojo = this.toDTO(user);
 
@@ -228,10 +237,10 @@ class UserRepository extends Repository {
 
     return this.persist(updated, {
       database: {
-        method: 'update',
+        method: "update",
         refresh,
         retryOnConflict,
-      }
+      },
     });
   }
 
@@ -242,7 +251,7 @@ class UserRepository extends Repository {
    * @param  {Object} [opts]
    * @returns {Promise}
    */
-  async replace (id, profileIds, content, { refresh = 'false', userId } = {}) {
+  async replace(id, profileIds, content, { refresh = "false", userId } = {}) {
     // Assertion: the user must exist
     await this.load(id);
 
@@ -254,16 +263,16 @@ class UserRepository extends Repository {
         author: userId,
         createdAt: Date.now(),
         updatedAt: null,
-        updater: null
+        updater: null,
       },
       profileIds,
     });
 
     return this.persist(user, {
       database: {
-        method: 'replace',
+        method: "replace",
         refresh,
-      }
+      },
     });
   }
 
@@ -274,22 +283,23 @@ class UserRepository extends Repository {
    * @returns {Promise.<User>}
    * @throws {NotFoundError} If the user is not found
    */
-  async load (id) {
-    if (id === 'anonymous' || id === '-1') {
+  async load(id) {
+    if (id === "anonymous" || id === "-1") {
       return this.anonymousUser;
     }
 
     return super.load(id);
   }
 
-  async persist (user, options = {}) {
+  async persist(user, options = {}) {
     const databaseOptions = options.database || {};
     const cacheOptions = options.cache || {};
 
-    if ( user._id === this.anonymousUser._id
-      && user.profileIds.indexOf('anonymous') === -1
+    if (
+      user._id === this.anonymousUser._id &&
+      user.profileIds.indexOf("anonymous") === -1
     ) {
-      throw kerror.get('security', 'user', 'anonymous_profile_required');
+      throw kerror.get("security", "user", "anonymous_profile_required");
     }
 
     await this.persistToDatabase(user, databaseOptions);
@@ -303,8 +313,8 @@ class UserRepository extends Repository {
    * @param dto
    * @returns {Promise<User>}
    */
-  async fromDTO (dto) {
-    if (dto.profileIds && ! Array.isArray(dto.profileIds)) {
+  async fromDTO(dto) {
+    if (dto.profileIds && !Array.isArray(dto.profileIds)) {
       dto.profileIds = [dto.profileIds];
     }
 
@@ -317,14 +327,14 @@ class UserRepository extends Repository {
     // if the user exists (has an _id) but no profile associated: there is a
     // database inconsistency
     if (user.profileIds.length === 0) {
-      throw kerror.get('security', 'user', 'no_profile', user._id);
+      throw kerror.get("security", "user", "no_profile", user._id);
     }
 
     const profiles = await this.module.profile.loadProfiles(user.profileIds);
 
     // Fail if not all profiles are found
-    if (profiles.some(p => p === null)) {
-      throw kerror.get('security', 'user', 'cannot_hydrate', dto._id);
+    if (profiles.some((p) => p === null)) {
+      throw kerror.get("security", "user", "cannot_hydrate", dto._id);
     }
 
     return user;
@@ -338,7 +348,7 @@ class UserRepository extends Repository {
    * @param {Object} [options]
    * @returns {Promise}
    */
-  async deleteById (id, opts) {
+  async deleteById(id, opts) {
     const user = await this.load(id);
 
     return this.delete(user, opts);
@@ -347,8 +357,8 @@ class UserRepository extends Repository {
   /**
    * @override
    */
-  async delete (user, { refresh = 'false' } = {}) {
-    debug('Delete user: %s', user);
+  async delete(user, { refresh = "false" } = {}) {
+    debug("Delete user: %s", user);
 
     await this._removeUserStrategies(user);
     await ApiKey.deleteByUser(user, { refresh });
@@ -356,7 +366,7 @@ class UserRepository extends Repository {
     await super.delete(user, { refresh });
   }
 
-  async _removeUserStrategies (user) {
+  async _removeUserStrategies(user) {
     const availableStrategies = global.kuzzle.pluginsManager.listStrategies();
     const userStrategies = [];
     const request = new Request({ _id: user._id });
@@ -364,7 +374,8 @@ class UserRepository extends Repository {
     for (const strategy of availableStrategies) {
       const existStrategy = global.kuzzle.pluginsManager.getStrategyMethod(
         strategy,
-        'exists');
+        "exists"
+      );
 
       if (await existStrategy(request, user._id, strategy)) {
         userStrategies.push(strategy);
@@ -376,15 +387,19 @@ class UserRepository extends Repository {
       for (const strategy of userStrategies) {
         const deleteStrategy = global.kuzzle.pluginsManager.getStrategyMethod(
           strategy,
-          'delete');
+          "delete"
+        );
 
         // We catch any error produced by delete as we want to make as much
         // cleanup as possible
         try {
-          debug('Deleting credentials on strategy %s for user %s', strategy, user._id);
+          debug(
+            "Deleting credentials on strategy %s for user %s",
+            strategy,
+            user._id
+          );
           await deleteStrategy(request, user._id, strategy);
-        }
-        catch (error) {
+        } catch (error) {
           errors.push(error);
         }
       }
@@ -392,36 +407,37 @@ class UserRepository extends Repository {
 
     if (errors.length > 0) {
       throw kerror.get(
-        'security',
-        'credentials',
-        'rejected',
-        errors.join('\n\t- '));
+        "security",
+        "credentials",
+        "rejected",
+        errors.join("\n\t- ")
+      );
     }
   }
 
   /**
    * @override
    */
-  async loadOneFromDatabase (id) {
+  async loadOneFromDatabase(id) {
     try {
       return await super.loadOneFromDatabase(id);
-    }
-    catch (err) {
+    } catch (err) {
       if (err.status === 404) {
-        throw kerror.get('security', 'user', 'not_found', id);
+        throw kerror.get("security", "user", "not_found", id);
       }
       throw err;
     }
   }
 
-  async adminExists () {
+  async adminExists() {
     const { total } = await this.search(
       {
         query: {
-          term: { profileIds: 'admin' }
-        }
+          term: { profileIds: "admin" },
+        },
       },
-      { size: 1 });
+      { size: 1 }
+    );
 
     return total >= 1;
   }

package/lib/core/shared/KoncordeWrapper.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from 'kuzzle-sdk';
+import { JSONObject } from "kuzzle-sdk";
 /**
  * Emulates the normalized object returned by Koncorde v3
  */

package/lib/core/shared/KoncordeWrapper.js

@@ -82,7 +82,9 @@ class Koncorde {
      * @return {boolean}
      */
     exists(index, collection) {
-        return this.koncorde.getIndexes().includes((0, koncordeCompat_1.toKoncordeIndex)(index, collection));
+        return this.koncorde
+            .getIndexes()
+            .includes((0, koncordeCompat_1.toKoncordeIndex)(index, collection));
     }
     /**
      * Returns the list of collections associated to an index registered in this

package/lib/core/shared/abstractManifest.js

@@ -19,13 +19,13 @@
  * limitations under the License.
  */
 
-'use strict';
+"use strict";
 
-const _ = require('lodash');
-const path = require('path');
-const semver = require('semver');
+const _ = require("lodash");
+const path = require("path");
+const semver = require("semver");
 
-const kerror = require('../../kerror').wrap('plugin', 'manifest');
+const kerror = require("../../kerror").wrap("plugin", "manifest");
 
 /**
  * Abstract class used to load a manifest.json file.
@@ -35,46 +35,45 @@ const kerror = require('../../kerror').wrap('plugin', 'manifest');
  * @param {string} pluginPath   - Absolute path to the plugin directory
  */
 class AbstractManifest {
-  constructor (pluginPath) {
+  constructor(pluginPath) {
     this.path = pluginPath;
 
-    this.manifestPath = path.resolve(this.path, 'manifest.json');
+    this.manifestPath = path.resolve(this.path, "manifest.json");
     this.name = null;
     this.kuzzleVersion = null;
     this.raw = null;
   }
 
-  load () {
+  load() {
     try {
       this.raw = require(this.manifestPath);
-    }
-    catch (e) {
-      throw kerror.get('cannot_load', this.manifestPath, e.message);
+    } catch (e) {
+      throw kerror.get("cannot_load", this.manifestPath, e.message);
     }
 
     if (_.isNil(this.raw.kuzzleVersion)) {
-      throw kerror.get('missing_version', this.manifestPath);
+      throw kerror.get("missing_version", this.manifestPath);
     }
 
     this.kuzzleVersion = this.raw.kuzzleVersion;
 
-    if (! semver.satisfies(global.kuzzle.config.version, this.kuzzleVersion)) {
+    if (!semver.satisfies(global.kuzzle.config.version, this.kuzzleVersion)) {
       throw kerror.get(
-        'version_mismatch',
+        "version_mismatch",
         this.path,
         global.kuzzle.config.version,
-        this.kuzzleVersion);
+        this.kuzzleVersion
+      );
     }
 
-    if (! _.isNil(this.raw.name)) {
-      if (typeof this.raw.name !== 'string' || this.raw.name.length === 0) {
-        throw kerror.get('invalid_name_type', this.manifestPath);
+    if (!_.isNil(this.raw.name)) {
+      if (typeof this.raw.name !== "string" || this.raw.name.length === 0) {
+        throw kerror.get("invalid_name_type", this.manifestPath);
       }
 
       this.name = this.raw.name;
-    }
-    else {
-      throw kerror.get('missing_name', this.manifestPath);
+    } else {
+      throw kerror.get("missing_name", this.manifestPath);
     }
   }
 
@@ -87,11 +86,11 @@ class AbstractManifest {
    *
    * @returns {Object}
    */
-  toJSON () {
+  toJSON() {
     return {
       kuzzleVersion: this.kuzzleVersion,
       name: this.name,
-      path: this.path
+      path: this.path,
     };
   }
 }