kuzzle 2.17.6 → 2.18.0

package/lib/kuzzle/event/kuzzleEventEmitter.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *
@@ -67,6 +67,7 @@ class KuzzleEventEmitter extends EventEmitter {
 
     this.corePipes = new Map();
     this.coreAnswerers = new Map();
+    this.coreSyncedAnswerers = new Map();
   }
 
   /**
@@ -101,6 +102,21 @@ class KuzzleEventEmitter extends EventEmitter {
     this.coreAnswerers.set(event, fn);
   }
 
+  
+  /**
+   * Registers a core 'callback' answerer
+   * There can only be 0 or 1 answerer per callback event.
+   *
+   * @param  {String}   event
+   * @param  {Function} fn
+   */
+  onCall (event, fn) {
+    assert(typeof fn === 'function', `Cannot register callback for event "${event}": "${fn}" is not a function`);
+    assert(! this.coreSyncedAnswerers.has(event), `Cannot register callback for event "${event}": a callback has already been registered`);
+
+    this.coreSyncedAnswerers.set(event, fn);
+  }
+
   /**
    * Emits an event and all its wildcarded versions
    *
@@ -199,6 +215,28 @@ class KuzzleEventEmitter extends EventEmitter {
     return response;
   }
 
+  /**
+   * Calls a callback to get information about the provided payload
+   */
+  call (event, ...payload) {
+    debug('Triggering callback "%s" with payload: %o', event, payload);
+
+    const fn = this.coreSyncedAnswerers.get(event);
+
+    if (! fn) {
+      throw kerror.get('core', 'fatal', 'assertion_failed', `the requested callback event '${event}' doesn't have an answerer`);
+    }
+
+    const response = fn(...payload);
+
+    getWildcardEvents(event).forEach(ev => super.emit(ev, {
+      args: payload,
+      response,
+    }));
+
+    return response;
+  }
+
   /**
    * Registers a plugin hook.
    * Catch any error in the handler and emit the hook:onError event.

package/lib/kuzzle/event/pipeRunner.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/kuzzle/event/waterfall.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/kuzzle/index.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/kuzzle/internalIndexHandler.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/kuzzle/kuzzle.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/kuzzle/kuzzleStateEnum.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/kuzzle/log.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/kuzzle/vault.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/model/security/profile.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/model/security/rights.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/model/security/role.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/model/security/token.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/model/security/user.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *
@@ -47,9 +47,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.User = void 0;
-const rights_1 = __importDefault(require("./rights"));
-const bluebird_1 = __importDefault(require("bluebird"));
 const lodash_1 = __importDefault(require("lodash"));
+const rights_1 = __importDefault(require("./rights"));
 const kerror = __importStar(require("../../kerror"));
 /**
  * @class User
@@ -73,7 +72,7 @@ class User {
      */
     async getRights() {
         const profiles = await this.getProfiles();
-        const results = await bluebird_1.default.map(profiles, p => p.getRights());
+        const results = await Promise.all(profiles.map(p => p.getRights()));
         const rights = {};
         results.forEach(right => lodash_1.default.assignWith(rights, right, rights_1.default.merge));
         return rights;
@@ -97,15 +96,15 @@ class User {
             return false;
         }
         // Every target must be allowed by at least one profile
-        return this.areTargetsAllowed(profiles, targets);
+        return this.areTargetsAllowed(request, profiles, targets);
     }
     /**
      * Verifies that every targets are allowed by at least one profile,
      * while skipping the ones that includes a wildcard since they will be expanded
      * later on, based on index and collections authorized for the given user.
      */
-    async areTargetsAllowed(profiles, targets) {
-        const profilesPolicies = await bluebird_1.default.map(profiles, profile => profile.getAllowedPolicies());
+    async areTargetsAllowed(request, profiles, targets) {
+        const profilesPolicies = await Promise.all(profiles.map(profile => profile.getAllowedPolicies(request)));
         // Every target must be allowed by at least one profile
         for (const target of targets) {
             // Skip targets with no Index or Collection

package/lib/model/storage/apiKey.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/model/storage/baseModel.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/service/cache/redis.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/service/service.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/service/storage/elasticsearch.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *
@@ -243,7 +243,8 @@ class ElasticSearch extends Service {
         continue;
       }
 
-      const alias = await this._getAliasFromIndice(indice);
+      const aliases = await this._getAliasFromIndice(indice);
+      const alias = aliases[0];
       const indexName = this._extractIndex(alias);
       const collectionName = this._extractCollection(alias);
 
@@ -303,20 +304,20 @@ class ElasticSearch extends Service {
       }
     }
 
-    let fetched = await global.kuzzle.ask('core:cache:internal:get', cacheKey);
+    const stringifiedScrollInfo = await global.kuzzle.ask('core:cache:internal:get', cacheKey);
 
-    if (! fetched) {
+    if (! stringifiedScrollInfo) {
       throw kerror.get('unknown_scroll_id');
     }
 
-    fetched = Number.parseInt(fetched);
+    const scrollInfo = JSON.parse(stringifiedScrollInfo);
 
     try {
       const { body } = await this._client.scroll(esRequest);
 
-      fetched += body.hits.hits.length;
+      scrollInfo.fetched += body.hits.hits.length;
 
-      if (fetched >= body.hits.total.value) {
+      if (scrollInfo.fetched >= body.hits.total.value) {
         debug('Last scroll page fetched: deleting scroll %s', body._scroll_id);
         await global.kuzzle.ask('core:cache:internal:del', cacheKey);
         await this.clearScroll(body._scroll_id);
@@ -325,15 +326,15 @@ class ElasticSearch extends Service {
         await global.kuzzle.ask(
           'core:cache:internal:store',
           cacheKey,
-          fetched,
+          JSON.stringify(scrollInfo),
           {
             ttl: ms(_scrollTTL) || this.scrollTTL,
           });
       }
 
-      body.remaining = body.hits.total.value - fetched;
+      body.remaining = body.hits.total.value - scrollInfo.fetched;
 
-      return await this._formatSearchResult(body);
+      return await this._formatSearchResult(body, scrollInfo);
     }
     catch (error) {
       throw this._esWrapper.formatESError(error);
@@ -401,35 +402,101 @@ class ElasticSearch extends Service {
         await global.kuzzle.ask(
           'core:cache:internal:store',
           SCROLL_CACHE_PREFIX + global.kuzzle.hash(body._scroll_id),
-          body.hits.hits.length,
+          JSON.stringify({
+            collection,
+            fetched: body.hits.hits.length,
+            index,
+            targets
+          }),
           { ttl });
 
         body.remaining = body.hits.total.value - body.hits.hits.length;
       }
 
-      return await this._formatSearchResult(body);
+      return await this._formatSearchResult(body, {
+        collection,
+        index,
+        targets
+      });
     }
     catch (error) {
       throw this._esWrapper.formatESError(error);
     }
   }
 
-  async _formatSearchResult (body) {
+  /**
+   * Generate a map that associate an alias to a pair of index and collection
+   * 
+   * @param {*} targets 
+   * @returns 
+   */
+  _mapTargetsToAlias (targets) {
+    const aliasToTargets = {};
+
+    for (const target of targets) {
+      for (const targetCollection of target.collections) {
+        const alias = this._getAlias(target.index, targetCollection);
+        if (! aliasToTargets[alias]) {
+          aliasToTargets[alias] = {
+            collection: targetCollection,
+            index: target.index,
+          };
+        }
+      }
+    }
+
+    return aliasToTargets;
+  }
+
+  async _formatSearchResult (body, searchInfo = {}) {
+    let aliasToTargets = {};
+    const aliasCache = new Map();
+
+    if (searchInfo.targets) {
+      /**
+       * We need to map the alias to the target index and collection,
+       * so we can later retrieve informations about an index & collection
+       * based on its alias.
+       */
+      aliasToTargets = this._mapTargetsToAlias(searchInfo.targets);
+    }
 
     const formatHit = async (hit) => {
-      let alias = null;
+      let index = searchInfo.index;
+      let collection = searchInfo.collection;
+
+      /**
+       * If the search has been done on multiple targets, we need to
+       * retrieve the appropriate index and collection based on the alias
+       */
+      if (hit._index && searchInfo.targets) {
+
+        // Caching to reduce call to ES
+        let aliases = aliasCache.get(hit._index);
+        if (! aliases) {
+          // Retrieve all the alias associated to one index
+          aliases = await this._getAliasFromIndice(hit._index);
+          aliasCache.set(hit._index, aliases);
+        }
 
-      if (hit._index) {
-        alias = await this._getAliasFromIndice(hit._index);
+        /**
+         * Since multiple alias can point to the same index in ES, we need to
+         * find the first alias that exists in the map of aliases associated
+         * to the targets.
+         */
+        const alias = aliases.find(_alias => aliasToTargets[_alias]);
+        // Retrieve index and collection information based on the matching alias
+        index = aliasToTargets[alias].index;
+        collection = aliasToTargets[alias].collection;
       }
 
       return {
         _id: hit._id,
         _score: hit._score,
         _source: hit._source,
-        collection: alias ? this._extractCollection(alias) : undefined,
+        collection,
         highlight: hit.highlight,
-        index: alias ? this._extractIndex(alias) : undefined,
+        index,
       };
     };
 
@@ -1819,22 +1886,14 @@ class ElasticSearch extends Service {
       index: await this._getIndice(index, collection)
     };
 
-    const mutex = new Mutex(`hiddenCollection/delete/${index}`);
     try {
       await this._client.indices.delete(esRequest);
 
-      await mutex.lock();
-
-      if (! await this._hasHiddenCollection(index)) {
-        await this._createHiddenCollection(index);
-      }
+      await this._createHiddenCollection(index);
     }
     catch (e) {
       throw this._esWrapper.formatESError(e);
     }
-    finally {
-      await mutex.unlock();
-    }
 
     return null;
   }
@@ -2148,7 +2207,7 @@ class ElasticSearch extends Service {
     index,
     collection,
     documents,
-    { refresh, timeout, userId = null, injectKuzzleMeta = true, limits = true } = {}) {
+    { refresh, timeout, userId = null, injectKuzzleMeta = true, limits = true, source = true } = {}) {
     let kuzzleMeta = {};
 
     if (injectKuzzleMeta) {
@@ -2192,7 +2251,7 @@ class ElasticSearch extends Service {
     }
     /* end critical code section */
 
-    return this._mExecute(esRequest, extractedDocuments, rejected, { limits });
+    return this._mExecute(esRequest, extractedDocuments, rejected, { limits, source });
   }
 
   /**
@@ -2564,7 +2623,7 @@ class ElasticSearch extends Service {
    *
    * @returns {Promise.<Object[]>} results
    */
-  async _mExecute (esRequest, documents, partialErrors, { limits = true } = {}) {
+  async _mExecute (esRequest, documents, partialErrors, { limits = true, source = true } = {}) {
     assertWellFormedRefresh(esRequest);
 
     if ( limits
@@ -2618,7 +2677,7 @@ class ElasticSearch extends Service {
       else {
         successes.push({
           _id: result._id,
-          _source: documents[i]._source,
+          _source: source ? documents[i]._source : undefined,
           _version: result._version,
           created: result.result === 'created',
           get: result.get,
@@ -2792,7 +2851,7 @@ class ElasticSearch extends Service {
       throw kerror.get('unknown_index_collection');
     }
     else if (body.length > 1) {
-      throw kerror.get('multiple_indice_alias', 'alias', 'indices');
+      throw kerror.get('multiple_indice_alias', `"alias" starting with "${ALIAS_PREFIX}"`, '"indices"');
     }
 
     return body[0].index;
@@ -2838,20 +2897,19 @@ class ElasticSearch extends Service {
    * @param {String} indice
    *
    * @returns {String} Alias name (eg: '@&nepali.liia')
-   * @throws If there is not exactly one alias associated
+   * @throws If there is not exactly one alias associated that is prefixed with @
    */
   async _getAliasFromIndice (indice) {
     const { body } = await this._client.indices.getAlias({ index: indice });
-    const aliases = Object.keys(body[indice].aliases);
+    const aliases =
+      Object.keys(body[indice].aliases)
+        .filter(alias => alias.startsWith(ALIAS_PREFIX));
 
     if (aliases.length < 1) {
       throw kerror.get('unknown_index_collection');
     }
-    else if (aliases.length > 1) {
-      throw kerror.get('multiple_indice_alias', 'indice', 'aliases');
-    }
 
-    return aliases[0];
+    return aliases;
   }
 
   /**
@@ -2960,13 +3018,21 @@ class ElasticSearch extends Service {
   }
 
   /**
-   * Creates the hidden collection on the provided index.
+   * Creates the hidden collection on the provided index if it does not already
+   * exists
    *
    * @param {String} index Index name
    */
   async _createHiddenCollection (index) {
+    const mutex = new Mutex(`hiddenCollection/${index}`);
 
     try {
+      await mutex.lock();
+
+      if (await this._hasHiddenCollection(index)) {
+        return;
+      }
+
       await this._client.indices.create({
         body: {
           aliases: {
@@ -2983,6 +3049,9 @@ class ElasticSearch extends Service {
     catch (e) {
       throw this._esWrapper.formatESError(e);
     }
+    finally {
+      await mutex.unlock();
+    }
   }
 
   /**

package/lib/service/storage/esWrapper.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/service/storage/queryTranslator.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/types/Controller.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/types/ControllerDefinition.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/types/Deprecation.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/types/EventHandler.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/types/KuzzleDocument.d.ts

@@ -1,4 +1,7 @@
 import { JSONObject } from 'kuzzle-sdk';
+/**
+ * @deprecated Use KDocument instead (See https://docs.kuzzle.io/sdk/js/7/essentials/strong-typing/)
+ */
 export interface KuzzleDocument {
     _id: string;
     _source: JSONObject;

package/lib/types/Plugin.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/types/PluginManifest.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/types/RequestPayload.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *