kuzzle 2.16.8 → 2.17.0

package/lib/core/security/roleRepository.js

@@ -24,7 +24,7 @@
 const Bluebird = require('bluebird');
 
 const kuzzleStateEnum = require('../../kuzzle/kuzzleStateEnum');
-const Role = require('../../model/security/role');
+const { Role } = require('../../model/security/role');
 const Repository = require('../shared/repository');
 const kerror = require('../../kerror');
 const didYouMean = require('../../util/didYouMean');
@@ -166,7 +166,7 @@ class RoleRepository extends Repository {
     for (const id of ids) {
       let role = this.roles.get(id);
 
-      if (!role) {
+      if (! role) {
         role = this.loadOneFromDatabase(id)
           .then(r => {
             this.roles.set(id, r);
@@ -209,7 +209,7 @@ class RoleRepository extends Repository {
 
     const role = await this.fromDTO(dto);
 
-    return this.validateAndSaveRole(role, {force, method, refresh});
+    return this.validateAndSaveRole(role, { force, method, refresh });
   }
 
   /**
@@ -253,7 +253,7 @@ class RoleRepository extends Repository {
    * @param  {Object} [opts]
    * @returns {Promise}
    */
-  async update (id, content, {force, refresh, retryOnConflict, userId} = {}) {
+  async update (id, content, { force, refresh, retryOnConflict, userId } = {}) {
     const updated = await this.fromDTO({
       // /!\ order is important
       ...content,
@@ -299,7 +299,7 @@ class RoleRepository extends Repository {
     try {
       return await super.loadOneFromDatabase(id);
     }
-    catch(err) {
+    catch (err) {
       if (err.status === 404) {
         throw kerror.get('security', 'role', 'not_found', id);
       }
@@ -317,7 +317,7 @@ class RoleRepository extends Repository {
     }
 
     const searchResults = await this.search(
-      { query: {}, sort: [{ _id: { order: 'asc' } }]},
+      { query: {}, sort: [{ _id: { order: 'asc' } }] },
       { from: 0, size: 9999 }); // /!\ NOT the options values
 
     const result = {
@@ -349,7 +349,7 @@ class RoleRepository extends Repository {
   async validateAndSaveRole (role, options = {}) {
     await role.validateDefinition();
 
-    if (role._id === 'anonymous' && !role.canLogIn()) {
+    if (role._id === 'anonymous' && ! role.canLogIn()) {
       throw kerror.get('security', 'role', 'login_required');
     }
 
@@ -371,7 +371,7 @@ class RoleRepository extends Repository {
   checkRoleNativeRights (role) {
     Object.keys(role.controllers).forEach(roleController => {
       if ( roleController !== '*'
-        && !global.kuzzle.funnel.isNativeController(roleController)
+        && ! global.kuzzle.funnel.isNativeController(roleController)
       ) {
         return;
       }
@@ -388,7 +388,7 @@ class RoleRepository extends Repository {
         const actions = Object.keys(role.controllers[roleController].actions);
 
         actions.forEach(action => {
-          if (action !== '*' && !controller._isAction(action)) {
+          if (action !== '*' && ! controller._isAction(action)) {
             throw roleRightsError.get(
               'unknown_action',
               role._id,
@@ -407,7 +407,7 @@ class RoleRepository extends Repository {
    * @param {Role} role
    * @param {Force} force
    */
-  checkRolePluginsRights (role, { force=false, forceWarn=false } = {}) {
+  checkRolePluginsRights (role, { force = false, forceWarn = false } = {}) {
     const plugins = global.kuzzle.pluginsManager;
 
     for (const roleController of Object.keys(role.controllers)) {
@@ -417,8 +417,8 @@ class RoleRepository extends Repository {
         return;
       }
 
-      if (!plugins.isController(roleController)) {
-        if (!force) {
+      if (! plugins.isController(roleController)) {
+        if (! force) {
           throw roleRightsError.get(
             'unknown_controller',
             role._id,
@@ -440,8 +440,8 @@ class RoleRepository extends Repository {
 
       const roleActions = Object.keys(role.controllers[roleController].actions);
       for (const action of roleActions) {
-        if (action !== '*' && !plugins.isAction(roleController, action)) {
-          if (!force) {
+        if (action !== '*' && ! plugins.isAction(roleController, action)) {
+          if (! force) {
             throw roleRightsError.get(
               'unknown_action',
               role._id,
@@ -487,7 +487,7 @@ class RoleRepository extends Repository {
   /**
    * @override
    */
-  async delete (role, {refresh = 'false'} = {}) {
+  async delete (role, { refresh = 'false' } = {}) {
     if (['admin', 'default', 'anonymous'].indexOf(role._id) > -1) {
       throw kerror.get('security', 'role', 'cannot_delete');
     }
@@ -544,7 +544,7 @@ class RoleRepository extends Repository {
    * @param {string} [roleId]
    */
   invalidate (roleId) {
-    if (!roleId) {
+    if (! roleId) {
       this.roles.clear();
     }
     else {

package/lib/core/security/securityLoader.js

@@ -46,12 +46,12 @@ class SecurityLoader {
       (json, opts) => this.load(json, opts));
   }
 
-  async load(permissions = {}, {
+  async load (permissions = {}, {
     force,
     onExistingUsers = 'fail',
     onExistingUsersWarning = false,
-    refresh = false,
-    user=null,
+    refresh = 'false',
+    user = null,
   } = {}) {
     assertIsObject(permissions);
 

package/lib/core/security/tokenRepository.js

@@ -57,7 +57,7 @@ class TokenRepository extends Repository {
     this.anonymousToken = new Token({ userId: '-1' });
   }
 
-  async init() {
+  async init () {
     await this._loadApiKeys();
 
     /**
@@ -130,7 +130,7 @@ class TokenRepository extends Repository {
     global.kuzzle.onAsk(
       'core:security:token:verify',
       hash => this.verifyToken(hash));
-    
+
   }
 
   /**
@@ -169,11 +169,11 @@ class TokenRepository extends Repository {
       );
     }
 
-    const refreshed = await this.generateToken(user, {expiresIn});
+    const refreshed = await this.generateToken(user, { expiresIn });
 
     // Mark as "refreshed" only if generating the new token succeeds
     token.refreshed = true;
-    await this.persistToCache(token, {ttl: this.tokenGracePeriod});
+    await this.persistToCache(token, { ttl: this.tokenGracePeriod });
 
     global.kuzzle.tokenManager.refresh(token, refreshed);
 
@@ -195,7 +195,7 @@ class TokenRepository extends Repository {
       type = 'authToken',
     } = {}
   ) {
-    if (!user || user._id === null) {
+    if (! user || user._id === null) {
       throw securityError.get('unknown_user');
     }
 
@@ -213,7 +213,7 @@ class TokenRepository extends Repository {
       throw securityError.get('ttl_exceeded');
     }
 
-    const signOptions = {algorithm};
+    const signOptions = { algorithm };
 
     if (parsedExpiresIn === 0) {
       throw kerror.get('api', 'assert', 'invalid_argument', 'expiresIn', 'a number of milliseconds, or a parsable timespan string');
@@ -255,8 +255,8 @@ class TokenRepository extends Repository {
    * @returns {Promise}
    */
   async persistForUser (encodedToken, userId, ttl) {
-    const redisTTL = ttl !== -1 ? ttl : 0;
-    const expiresAt = ttl !== -1 ? Date.now() + ttl : -1;
+    const redisTTL = ttl === -1 ? 0 : ttl;
+    const expiresAt = ttl === -1 ? -1 : Date.now() + ttl;
     const token = new Token({
       _id: `${userId}#${encodedToken}`,
       expiresAt,
@@ -268,7 +268,7 @@ class TokenRepository extends Repository {
     try {
       return await this.persistToCache(token, { ttl: redisTTL });
     }
-    catch(err) {
+    catch (err) {
       throw kerror.getFrom(
         err,
         'services',
@@ -289,7 +289,7 @@ class TokenRepository extends Repository {
       decoded = jwt.verify(this.removeTokenPrefix(token), global.kuzzle.secret);
 
       // probably forged token => throw without providing any information
-      if (!decoded._id) {
+      if (! decoded._id) {
         throw new jwt.JsonWebTokenError('Invalid token');
       }
     }
@@ -336,13 +336,13 @@ class TokenRepository extends Repository {
   }
 
   async hydrate (userToken, data) {
-    if (!_.isObject(data)) {
+    if (! _.isObject(data)) {
       return userToken;
     }
 
     _.assignIn(userToken, data);
 
-    if (!userToken.userId) {
+    if (! userToken.userId) {
       return this.anonymousToken;
     }
 
@@ -359,7 +359,7 @@ class TokenRepository extends Repository {
    * @param {string} kuid
    * @returns {Promise}
    */
-  async deleteByKuid (kuid, {keepApiKeys = true} = {}) {
+  async deleteByKuid (kuid, { keepApiKeys = true } = {}) {
     const emptyKeyLength = super.getCacheKey('').length;
     const userKey = super.getCacheKey(`${kuid}#*`);
 
@@ -396,7 +396,7 @@ class TokenRepository extends Repository {
         if (keepApiKeys && cacheToken.type === 'apiKey') {
           return;
         }
-        
+
         await this.expire(cacheToken);
       }
     });
@@ -428,13 +428,10 @@ class TokenRepository extends Repository {
       debug('Loading API keys into Redis');
 
       const promises = [];
-      const createToken = async ({ token, userId, ttl }) => {
-        return await this.persistForUser(token, userId, ttl);
-      };
 
-      await ApiKey.batchExecute({ match_all: {} }, apiKeys => {
-        for (const apiKey of apiKeys) {
-          promises.push(createToken(apiKey));
+      await ApiKey.batchExecute({ match_all: {} }, documents => {
+        for (const { _source } of documents) {
+          promises.push(this.persistForUser(_source.token, _source.userId, _source.ttl));
         }
       });
 
@@ -456,7 +453,7 @@ class TokenRepository extends Repository {
    *
    * So we need to override the TTL auto-refresh function to disable it
    */
-  refreshCacheTTL() {
+  refreshCacheTTL () {
     // This comment is here to please Sonarqube. It requires a comment
     // explaining why a function is empty, but there is no sense
     // duplicating what has been just said in the JSDoc.

package/lib/core/security/userRepository.js

@@ -25,7 +25,7 @@ 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 { User } = require('../../model/security/user');
 const ApiKey = require('../../model/storage/apiKey');
 
 /**
@@ -166,7 +166,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.
@@ -242,7 +242,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);
 
@@ -304,7 +304,7 @@ class UserRepository extends Repository {
    * @returns {Promise<User>}
    */
   async fromDTO (dto) {
-    if (dto.profileIds && !Array.isArray(dto.profileIds)) {
+    if (dto.profileIds && ! Array.isArray(dto.profileIds)) {
       dto.profileIds = [dto.profileIds];
     }
 
@@ -347,13 +347,13 @@ class UserRepository extends Repository {
   /**
    * @override
    */
-  async delete (user, {refresh = 'false'} = {}) {
+  async delete (user, { refresh = 'false' } = {}) {
     debug('Delete user: %s', user);
 
     await this._removeUserStrategies(user);
-    await ApiKey.deleteByUser(user, {refresh});
+    await ApiKey.deleteByUser(user, { refresh });
     await this.module.token.deleteByKuid(user._id);
-    await super.delete(user, {refresh});
+    await super.delete(user, { refresh });
   }
 
   async _removeUserStrategies (user) {
@@ -406,7 +406,7 @@ class UserRepository extends Repository {
     try {
       return await super.loadOneFromDatabase(id);
     }
-    catch(err) {
+    catch (err) {
       if (err.status === 404) {
         throw kerror.get('security', 'user', 'not_found', id);
       }

package/lib/core/shared/abstractManifest.js

@@ -35,7 +35,7 @@ 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');
@@ -58,7 +58,7 @@ class AbstractManifest {
 
     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',
         this.path,
@@ -66,7 +66,7 @@ class AbstractManifest {
         this.kuzzleVersion);
     }
 
-    if (!_.isNil(this.raw.name)) {
+    if (! _.isNil(this.raw.name)) {
       if (typeof this.raw.name !== 'string' || this.raw.name.length === 0) {
         throw kerror.get('invalid_name_type', this.manifestPath);
       }
@@ -87,7 +87,7 @@ class AbstractManifest {
    *
    * @returns {Object}
    */
-  toJSON() {
+  toJSON () {
     return {
       kuzzleVersion: this.kuzzleVersion,
       name: this.name,

package/lib/core/shared/repository.js

@@ -41,7 +41,7 @@ class Repository {
    * @param {{cache: cacheDbEnum, store: Store}} [options]
    * @constructor
    */
-  constructor({ cache = cacheDbEnum.INTERNAL, store = null } = {}) {
+  constructor ({ cache = cacheDbEnum.INTERNAL, store = null } = {}) {
     this.ttl = global.kuzzle.config.repositories.common.cacheTTL;
     this.collection = null;
     this.ObjectConstructor = null;
@@ -72,7 +72,7 @@ class Repository {
       const dto = {};
 
       if (response._source) {
-        Object.assign(dto, response._source, {_id: response._id});
+        Object.assign(dto, response._source, { _id: response._id });
       }
       else {
         Object.assign(dto, response);
@@ -90,7 +90,7 @@ class Repository {
    * @returns {Promise<object>}
    */
   async loadMultiFromDatabase (ids) {
-    const {items} = await this.store.mGet(this.collection, ids);
+    const { items } = await this.store.mGet(this.collection, ids);
 
     if (items.length === 0) {
       return [];
@@ -98,7 +98,7 @@ class Repository {
 
     return Bluebird.map(
       items,
-      doc => this.fromDTO(Object.assign({}, doc._source, {_id: doc._id})));
+      doc => this.fromDTO(Object.assign({}, doc._source, { _id: doc._id })));
   }
 
   /**
@@ -398,7 +398,7 @@ class Repository {
    */
   async _truncate (options, part = null) {
     if (part === null) {
-      const objects = await this.search({}, { scroll: '5s', size: 100 });
+      const objects = await this.search({}, { refresh: options.refresh, scroll: '5s', size: 100 });
       const deleted = await this._truncatePart(objects, options);
 
       if (objects.hits.length < objects.total) {
@@ -435,7 +435,7 @@ class Repository {
    * @returns {Promise<integer>} count of deleted objects
    * @private
    */
-  async _truncatePart(objects, options) {
+  async _truncatePart (objects, options) {
     return Bluebird
       .map(objects.hits, async object => {
         // profile and role repositories have protected objects, we can't delete

package/lib/core/shared/sdk/funnelProtocol.js

@@ -28,7 +28,7 @@ const kerror = require('../../../kerror');
 const { hilightUserCode } = require('../../../util/stackTrace');
 
 class FunnelProtocol extends KuzzleEventEmitter {
-  constructor() {
+  constructor () {
     super();
 
     this.id = 'funnel';

package/lib/core/shared/sdk/impersonatedSdk.js

@@ -64,7 +64,7 @@ class ImpersonatedSDK {
                 // Make sure we bring any local methods into our new custom context
                 Object.getOwnPropertyNames(Object.getPrototypeOf(global.app.sdk[controllerName]))
                   .forEach((localMethod) => {
-                    if (!['constructor', 'query'].includes(localMethod)) {
+                    if (! ['constructor', 'query'].includes(localMethod)) {
                       customContext[localMethod] = controllerInstance[localMethod];
                     }
                   });

package/lib/core/shared/store.js

@@ -41,40 +41,47 @@ class Store {
     this.scope = scope;
 
     const methodsMapping = {
-      count:              `core:storage:${scope}:document:count`,
-      create:             `core:storage:${scope}:document:create`,
-      createCollection:   `core:storage:${scope}:collection:create`,
-      createOrReplace:    `core:storage:${scope}:document:createOrReplace`,
-      delete:             `core:storage:${scope}:document:delete`,
-      deleteByQuery:      `core:storage:${scope}:document:deleteByQuery`,
-      deleteCollection:   `core:storage:${scope}:collection:delete`,
-      deleteFields:       `core:storage:${scope}:document:deleteFields`,
-      deleteIndex:        `core:storage:${scope}:index:delete`,
-      exists:             `core:storage:${scope}:document:exist`,
-      get:                `core:storage:${scope}:document:get`,
-      getMapping:         `core:storage:${scope}:mappings:get`,
-      mExecute:           `core:storage:${scope}:document:mExecute`,
-      mGet:               `core:storage:${scope}:document:mGet`,
-      refreshCollection:  `core:storage:${scope}:collection:refresh`,
-      replace:            `core:storage:${scope}:document:replace`,
-      search:             `core:storage:${scope}:document:search`,
+      count: `core:storage:${scope}:document:count`,
+      create: `core:storage:${scope}:document:create`,
+      createCollection: `core:storage:${scope}:collection:create`,
+      createOrReplace: `core:storage:${scope}:document:createOrReplace`,
+      delete: `core:storage:${scope}:document:delete`,
+      deleteByQuery: `core:storage:${scope}:document:deleteByQuery`,
+      deleteCollection: `core:storage:${scope}:collection:delete`,
+      deleteFields: `core:storage:${scope}:document:deleteFields`,
+      deleteIndex: `core:storage:${scope}:index:delete`,
+      exists: `core:storage:${scope}:document:exist`,
+      get: `core:storage:${scope}:document:get`,
+      getMapping: `core:storage:${scope}:mappings:get`,
+      mExecute: `core:storage:${scope}:document:mExecute`,
+      mGet: `core:storage:${scope}:document:mGet`,
+      refreshCollection: `core:storage:${scope}:collection:refresh`,
+      replace: `core:storage:${scope}:document:replace`,
+      search: `core:storage:${scope}:document:search`,
       truncateCollection: `core:storage:${scope}:collection:truncate`,
-      update:             `core:storage:${scope}:document:update`,
-      updateByQuery:      `core:storage:${scope}:document:updateByQuery`,
-      updateCollection:   `core:storage:${scope}:collection:update`,
-      updateMapping:      `core:storage:${scope}:mappings:update`,
+      update: `core:storage:${scope}:document:update`,
+      updateByQuery: `core:storage:${scope}:document:updateByQuery`,
+      updateCollection: `core:storage:${scope}:collection:update`,
+      updateMapping: `core:storage:${scope}:mappings:update`,
     };
 
     for (const [method, event] of Object.entries(methodsMapping)) {
       this[method] = (...args) => global.kuzzle.ask(event, this.index, ...args);
     }
 
-    // the scroll method is special: it doesn't need an index parameter
-    // we keep it for ease of use
+    // the scroll and multiSearch method are special: they doesn't need an index parameter
+    // we keep them for ease of use
     this.scroll = (scrollId, opts) => global.kuzzle.ask(
       `core:storage:${scope}:document:scroll`,
       scrollId,
       opts);
+
+    this.multiSearch = (targets, searchBody, opts) => global.kuzzle.ask(
+      `core:storage:${scope}:document:multiSearch`,
+      targets,
+      searchBody,
+      opts
+    );
   }
 
   /**

package/lib/core/statistics/statistics.js

@@ -61,11 +61,11 @@ class Statistics {
 
     const protocol = request && request.context.connection.protocol;
 
-    if (!protocol) {
+    if (! protocol) {
       return;
     }
 
-    if (!this.currentStats.ongoingRequests.has(protocol)) {
+    if (! this.currentStats.ongoingRequests.has(protocol)) {
       this.currentStats.ongoingRequests.set(protocol, 1);
     }
     else {
@@ -87,7 +87,7 @@ class Statistics {
 
     const protocol = request && request.context.connection.protocol;
 
-    if (!protocol) {
+    if (! protocol) {
       return;
     }
 
@@ -95,7 +95,7 @@ class Statistics {
       protocol,
       this.currentStats.ongoingRequests.get(protocol) - 1);
 
-    if (!this.currentStats.completedRequests.has(protocol)) {
+    if (! this.currentStats.completedRequests.has(protocol)) {
       this.currentStats.completedRequests.set(protocol, 1);
     }
     else {
@@ -117,7 +117,7 @@ class Statistics {
 
     const protocol = request && request.context.connection.protocol;
 
-    if (!protocol) {
+    if (! protocol) {
       return;
     }
 
@@ -125,7 +125,7 @@ class Statistics {
       protocol,
       this.currentStats.ongoingRequests.get(protocol) - 1);
 
-    if (!this.currentStats.failedRequests.has(protocol)) {
+    if (! this.currentStats.failedRequests.has(protocol)) {
       this.currentStats.failedRequests.set(protocol, 1);
     }
     else {
@@ -145,11 +145,11 @@ class Statistics {
       return;
     }
 
-    if (!requestContext.connection.protocol) {
+    if (! requestContext.connection.protocol) {
       return;
     }
 
-    if (!this.currentStats.connections.has(requestContext.connection.protocol)) {
+    if (! this.currentStats.connections.has(requestContext.connection.protocol)) {
       this.currentStats.connections.set(requestContext.connection.protocol, 1);
     }
     else {
@@ -169,7 +169,7 @@ class Statistics {
       return;
     }
 
-    if (!requestContext.connection.protocol) {
+    if (! requestContext.connection.protocol) {
       return;
     }
 
@@ -194,10 +194,10 @@ class Statistics {
     }
 
     const frame = Object.assign(
-      {timestamp: (new Date()).getTime()},
+      { timestamp: (new Date()).getTime() },
       this.currentStats);
 
-    if (!this.lastFrame) {
+    if (! this.lastFrame) {
       return frame;
     }
 
@@ -260,11 +260,11 @@ class Statistics {
       ongoingRequests: Object.fromEntries(this.currentStats.ongoingRequests),
     };
 
-    if (!this.lastFrame) {
-      if (!stopTime || stopTime >= currentDate) {
+    if (! this.lastFrame) {
+      if (! stopTime || stopTime >= currentDate) {
         response.hits.push(
           Object.assign(
-            {timestamp: (new Date(currentDate)).getTime()},
+            { timestamp: (new Date(currentDate)).getTime() },
             stats));
       }
 
@@ -288,13 +288,13 @@ class Statistics {
       const frameDate = new Date(Number(frames[idx].replace(regex, '')));
       const frameDateTime = frameDate.getTime();
 
-      if ( (!startTime || startTime <= frameDateTime)
-        && (!stopTime || stopTime >= frameDateTime)
+      if ( (! startTime || startTime <= frameDateTime)
+        && (! stopTime || stopTime >= frameDateTime)
       ) {
         response.hits.push(
           Object.assign(
             JSON.parse(v),
-            {timestamp: (new Date(frameDateTime)).getTime()}));
+            { timestamp: (new Date(frameDateTime)).getTime() }));
       }
     });