kuzzle 2.16.8 → 2.17.0

package/lib/service/storage/elasticsearch.js

@@ -95,7 +95,7 @@ class ElasticSearch extends Service {
     return new StorageClient({ defer, ...config });
   }
 
-  constructor(config, scope = scopeEnum.PUBLIC) {
+  constructor (config, scope = scopeEnum.PUBLIC) {
     super('elasticsearch', config);
 
     this._scope = scope;
@@ -172,7 +172,7 @@ class ElasticSearch extends Service {
 
     const { body: { version } } = await this._client.info();
 
-    if (version && !semver.satisfies(semver.coerce(version.number), '>= 7.0.0')) {
+    if (version && ! semver.satisfies(semver.coerce(version.number), '>= 7.0.0')) {
       throw kerror.get('version_mismatch', version.number);
     }
 
@@ -252,7 +252,7 @@ class ElasticSearch extends Service {
         continue;
       }
 
-      if (!indexes[indexName]) {
+      if (! indexes[indexName]) {
         indexes[indexName] = {
           collections: [],
           name: indexName,
@@ -305,7 +305,7 @@ class ElasticSearch extends Service {
 
     let fetched = await global.kuzzle.ask('core:cache:internal:get', cacheKey);
 
-    if (!fetched) {
+    if (! fetched) {
       throw kerror.get('unknown_scroll_id');
     }
 
@@ -333,7 +333,7 @@ class ElasticSearch extends Service {
 
       body.remaining = body.hits.total.value - fetched;
 
-      return this._formatSearchResult(body);
+      return await this._formatSearchResult(body);
     }
     catch (error) {
       throw this._esWrapper.formatESError(error);
@@ -351,15 +351,31 @@ class ElasticSearch extends Service {
    * @returns {Promise.<{ scrollId, hits, aggregations, suggest, total }>}
    */
   async search (
-    index,
-    collection,
-    searchBody,
-    { from, size, scroll } = {})
-  {
+    { index, collection, searchBody, targets } = {},
+    { from, size, scroll } = {}
+  ) {
+    let esIndexes;
+
+    if (targets && targets.length > 0) {
+      const indexes = new Set();
+      for (const target of targets) {
+        for (const targetCollection of target.collections) {
+          const alias = this._getAlias(target.index, targetCollection);
+          
+          indexes.add(alias);
+        }
+      }
+
+      esIndexes = Array.from(indexes).join(',');
+    }
+    else {
+      esIndexes = this._getAlias(index, collection);
+    }
+
     const esRequest = {
       body: this._sanitizeSearchBody(searchBody),
       from,
-      index: this._getAlias(index, collection),
+      index: esIndexes,
       scroll,
       size,
       trackTotalHits: true,
@@ -391,38 +407,47 @@ class ElasticSearch extends Service {
         body.remaining = body.hits.total.value - body.hits.hits.length;
       }
 
-      return this._formatSearchResult(body);
+      return await this._formatSearchResult(body);
     }
     catch (error) {
       throw this._esWrapper.formatESError(error);
     }
   }
 
-  _formatSearchResult (body) {
-    function formatHit (hit) {
+  async _formatSearchResult (body) {
+    
+    const formatHit = async (hit) => {
+      let alias = null;
+      
+      if (hit._index) {
+        alias = await this._getAliasFromIndice(hit._index);
+      }
+
       return {
         _id: hit._id,
         _score: hit._score,
         _source: hit._source,
+        collection: alias ? this._extractCollection(alias) : undefined,
         highlight: hit.highlight,
+        index: alias ? this._extractIndex(alias) : undefined,
       };
-    }
+    };
 
-    function formatInnerHits (innerHits) {
+    async function formatInnerHits (innerHits) {
       if (! innerHits) {
         return undefined;
       }
 
       const formattedInnerHits = {};
       for (const [name, innerHit] of Object.entries(innerHits)) {
-        formattedInnerHits[name] = innerHit.hits.hits.map(formatHit);
+        formattedInnerHits[name] = await Bluebird.map(innerHit.hits.hits, formatHit);
       }
       return formattedInnerHits;
     }
 
-    const hits = body.hits.hits.map(hit => ({
-      inner_hits: formatInnerHits(hit.inner_hits),
-      ...formatHit(hit)
+    const hits = await Bluebird.map(body.hits.hits, async hit => ({
+      inner_hits: await formatInnerHits(hit.inner_hits),
+      ...await formatHit(hit)
     }));
 
     return {
@@ -491,7 +516,7 @@ class ElasticSearch extends Service {
 
     const esRequest = {
       body: {
-        docs: ids.map(_id => ({ _id, _index: this._getAlias(index, collection)}))
+        docs: ids.map(_id => ({ _id, _index: this._getAlias(index, collection) }))
       }
     };
 
@@ -569,8 +594,7 @@ class ElasticSearch extends Service {
     index,
     collection,
     content,
-    { id, refresh, userId=null } = {})
-  {
+    { id, refresh, userId = null } = {}) {
     assertIsObject(content);
 
     const esRequest = {
@@ -624,8 +648,7 @@ class ElasticSearch extends Service {
     collection,
     id,
     content,
-    { refresh, userId=null, injectKuzzleMeta=true } = {})
-  {
+    { refresh, userId = null, injectKuzzleMeta = true } = {}) {
     const esRequest = {
       body: content,
       id,
@@ -679,8 +702,7 @@ class ElasticSearch extends Service {
     collection,
     id,
     content,
-    { refresh, userId=null, retryOnConflict } = {})
-  {
+    { refresh, userId = null, retryOnConflict } = {}) {
     const esRequest = {
       _source: true,
       body: { doc: content },
@@ -731,8 +753,7 @@ class ElasticSearch extends Service {
     collection,
     id,
     content,
-    { defaultValues = {}, refresh, userId=null, retryOnConflict } = {})
-  {
+    { defaultValues = {}, refresh, userId = null, retryOnConflict } = {}) {
     const esRequest = {
       _source: true,
       body: {
@@ -794,8 +815,7 @@ class ElasticSearch extends Service {
     collection,
     id,
     content,
-    { refresh, userId=null } = {})
-  {
+    { refresh, userId = null } = {}) {
     const alias = this._getAlias(index, collection);
     const esRequest = {
       body: content,
@@ -851,8 +871,7 @@ class ElasticSearch extends Service {
     index,
     collection,
     id,
-    { refresh } = {})
-  {
+    { refresh } = {}) {
     const esRequest = {
       id,
       index: this._getAlias(index, collection),
@@ -892,8 +911,7 @@ class ElasticSearch extends Service {
     index,
     collection,
     query,
-    { refresh, size = 1000, fetch=true } = {})
-  {
+    { refresh, size = 1000, fetch = true } = {}) {
     const esRequest = {
       body: this._sanitizeSearchBody({ query }),
       index: this._getAlias(index, collection),
@@ -901,7 +919,7 @@ class ElasticSearch extends Service {
       size
     };
 
-    if (!isPlainObject(query)) {
+    if (! isPlainObject(query)) {
       throw kerror.get('missing_argument', 'body.query');
     }
 
@@ -947,8 +965,7 @@ class ElasticSearch extends Service {
     collection,
     id,
     fields,
-    { refresh, userId=null } = {})
-  {
+    { refresh, userId = null } = {}) {
     const alias = this._getAlias(index, collection);
     const esRequest = {
       id,
@@ -988,7 +1005,8 @@ class ElasticSearch extends Service {
         _source: body._source,
         _version: updated._version
       };
-    } catch (error) {
+    }
+    catch (error) {
       throw this._esWrapper.formatESError(error);
     }
   }
@@ -1009,8 +1027,7 @@ class ElasticSearch extends Service {
     collection,
     query,
     changes,
-    { refresh, size = 1000, userId=null } = {})
-  {
+    { refresh, size = 1000, userId = null } = {}) {
 
     try {
       const esRequest = {
@@ -1063,8 +1080,7 @@ class ElasticSearch extends Service {
     collection,
     query,
     changes,
-    { refresh = 'false' } = {})
-  {
+    { refresh = 'false' } = {}) {
     const script = {
       params: {},
       source: ''
@@ -1072,7 +1088,7 @@ class ElasticSearch extends Service {
 
     const flatChanges = extractFields(changes, { alsoExtractValues: true });
 
-    for (const {key, value} of flatChanges) {
+    for (const { key, value } of flatChanges) {
       script.source += `ctx._source.${key} = params['${key}'];`;
       script.params[key] = value;
     }
@@ -1125,8 +1141,7 @@ class ElasticSearch extends Service {
     collection,
     query,
     callback,
-    { size=10, scrollTTl= '5s' } = {})
-  {
+    { size = 10, scrollTTl = '5s' } = {}) {
     const esRequest = {
       body: this._sanitizeSearchBody({ query }),
       from: 0,
@@ -1149,7 +1164,7 @@ class ElasticSearch extends Service {
       results = await new Bluebird((resolve, reject) => {
         this._client.search(
           esRequest,
-          async function getMoreUntilDone(error, { body: { hits, _scroll_id } }) {
+          async function getMoreUntilDone (error, { body: { hits, _scroll_id } }) {
             if (error) {
               reject(error);
               return;
@@ -1233,7 +1248,7 @@ class ElasticSearch extends Service {
    *
    * @returns {Promise}
    */
-  async createCollection (index, collection, { mappings={}, settings={} } = {}) {
+  async createCollection (index, collection, { mappings = {}, settings = {} } = {}) {
     this._assertValidIndexAndCollection(index, collection);
 
     if (collection === HIDDEN_COLLECTION) {
@@ -1308,7 +1323,7 @@ class ElasticSearch extends Service {
    *
    * @returns {Promise.<{ dynamic, _meta, properties }>}
    */
-  async getMapping (index, collection, { includeKuzzleMeta=false } = {}) {
+  async getMapping (index, collection, { includeKuzzleMeta = false } = {}) {
     const
       indice = await this._getIndice(index, collection),
       esRequest = {
@@ -1344,7 +1359,7 @@ class ElasticSearch extends Service {
    *
    * @returns {Promise}
    */
-  async updateCollection (index, collection, { mappings={}, settings={} } = {}) {
+  async updateCollection (index, collection, { mappings = {}, settings = {} } = {}) {
     const esRequest = {
       index: await this._getIndice(index, collection)
     };
@@ -1362,12 +1377,12 @@ class ElasticSearch extends Service {
       throw this._esWrapper.formatESError(error);
     }
 
-    if (!_.isEmpty(settings)) {
+    if (! _.isEmpty(settings)) {
       await this.updateSettings(index, collection, settings);
     }
 
     try {
-      if (!_.isEmpty(mappings)) {
+      if (! _.isEmpty(mappings)) {
         const previousMappings = await this.getMapping(index, collection);
 
         await this.updateMapping(index, collection, mappings);
@@ -1385,7 +1400,7 @@ class ElasticSearch extends Service {
       };
 
       // Rollback to previous settings
-      if (!_.isEmpty(settings)) {
+      if (! _.isEmpty(settings)) {
         await this.updateSettings(index, collection, allowedSettings);
       }
 
@@ -1551,8 +1566,7 @@ class ElasticSearch extends Service {
     index,
     collection,
     documents,
-    { refresh, timeout, userId=null } = {})
-  {
+    { refresh, timeout, userId = null } = {}) {
     const alias = this._getAlias(index, collection);
     const actionNames = ['index', 'create', 'update', 'delete'];
     const dateNow = Date.now();
@@ -1920,7 +1934,7 @@ class ElasticSearch extends Service {
     };
 
     try {
-      const { body: exists} = await this._client.exists(esRequest);
+      const { body: exists } = await this._client.exists(esRequest);
 
       return exists;
     }
@@ -1929,6 +1943,60 @@ class ElasticSearch extends Service {
     }
   }
 
+  /**
+   * Returns the list of documents existing with the ids given in the body param
+   * NB: Due to internal Kuzzle mechanism, can only be called on a single
+   * index/collection, using the body { ids: [.. } syntax.
+   *
+   * @param {String} index - Index name
+   * @param {String} collection - Collection name
+   * @param {Array.<String>} ids - Document IDs
+   *
+   * @returns {Promise.<{ items: Array<{ _id, _source, _version }>, errors }>}
+   */
+  async mExists (index, collection, ids) {
+    if (ids.length === 0) {
+      return { errors: [], item: [] };
+    }
+
+    const esRequest = {
+      _source: false,
+      body: {
+        docs: ids.map(_id => ({ _id })),
+      },
+      index: this._getAlias(index, collection)
+    };
+
+    debug('mExists: %o', esRequest);
+
+    let body;
+
+    try {
+      ({ body } = await this._client.mget(esRequest)); // NOSONAR
+    }
+    catch (e) {
+      throw this._esWrapper.formatESError(e);
+    }
+
+    const errors = [];
+    const items = [];
+
+    for (let i = 0; i < body.docs.length; i++) {
+      const doc = body.docs[i];
+
+      if (doc.found) {
+        items.push(
+          doc._id,
+        );
+      }
+      else {
+        errors.push(doc._id);
+      }
+    }
+
+    return { errors, items };
+  }
+
   /**
    * Returns true if the index exists
    *
@@ -1985,8 +2053,7 @@ class ElasticSearch extends Service {
     index,
     collection,
     documents,
-    { refresh, timeout, userId=null } = {})
-  {
+    { refresh, timeout, userId = null } = {}) {
     const
       alias = this._getAlias(index, collection),
       kuzzleMeta = {
@@ -2004,9 +2071,9 @@ class ElasticSearch extends Service {
       } = this._extractMDocuments(documents, kuzzleMeta, { prepareMGet: true });
 
     // prepare the mget request, but only for document having a specified id
-    const {body} = documentsToGet.length > 0
-      ? await this._client.mget({body: {docs: documentsToGet}, index: alias})
-      : {body: {docs: []}};
+    const { body } = documentsToGet.length > 0
+      ? await this._client.mget({ body: { docs: documentsToGet }, index: alias })
+      : { body: { docs: [] } };
 
     const
       existingDocuments = body.docs,
@@ -2080,8 +2147,7 @@ class ElasticSearch extends Service {
     index,
     collection,
     documents,
-    { refresh, timeout, userId=null, injectKuzzleMeta=true, limits=true } = {})
-  {
+    { refresh, timeout, userId = null, injectKuzzleMeta = true, limits = true } = {}) {
     let kuzzleMeta = {};
 
     if (injectKuzzleMeta) {
@@ -2144,8 +2210,7 @@ class ElasticSearch extends Service {
     index,
     collection,
     documents,
-    { refresh, retryOnConflict = 0, timeout, userId=null } = {})
-  {
+    { refresh, retryOnConflict = 0, timeout, userId = null } = {}) {
     const
       alias = this._getAlias(index, collection),
       toImport = [],
@@ -2236,8 +2301,7 @@ class ElasticSearch extends Service {
     index,
     collection,
     documents,
-    { refresh, retryOnConflict = 0, timeout, userId=null } = {})
-  {
+    { refresh, retryOnConflict = 0, timeout, userId = null } = {}) {
     const alias = this._getAlias(index, collection);
     const esRequest = {
       body: [],
@@ -2330,8 +2394,7 @@ class ElasticSearch extends Service {
     index,
     collection,
     documents,
-    { refresh, timeout, userId=null } = {})
-  {
+    { refresh, timeout, userId = null } = {}) {
     const
       alias = this._getAlias(index, collection),
       kuzzleMeta = {
@@ -2355,7 +2418,7 @@ class ElasticSearch extends Service {
       return { errors: rejected, items: [] };
     }
 
-    const {body} = await this._client.mget({
+    const { body } = await this._client.mget({
       body: { docs: documentsToGet },
       index: alias
     });
@@ -2421,8 +2484,7 @@ class ElasticSearch extends Service {
     index,
     collection,
     ids,
-    { refresh, timeout } = {})
-  {
+    { refresh, timeout } = {}) {
     const
       query = { ids: { values: [] } },
       validIds = [],
@@ -2450,7 +2512,7 @@ class ElasticSearch extends Service {
     /* end critical code section */
     await this.refreshCollection(index, collection);
 
-    const {items} = await this.mGet(index, collection, validIds);
+    const { items } = await this.mGet(index, collection, validIds);
 
     let idx = 0;
 
@@ -2501,7 +2563,7 @@ class ElasticSearch extends Service {
    *
    * @returns {Promise.<Object[]>} results
    */
-  async _mExecute (esRequest, documents, partialErrors, { limits=true } = {}) {
+  async _mExecute (esRequest, documents, partialErrors, { limits = true } = {}) {
     assertWellFormedRefresh(esRequest);
 
     if ( limits
@@ -2584,7 +2646,7 @@ class ElasticSearch extends Service {
    *
    * @returns {Object} { rejected, extractedDocuments, documentsToGet }
    */
-  _extractMDocuments (documents, metadata, { prepareMGet=false, requireId=false, prepareMUpsert=false } = {}) {
+  _extractMDocuments (documents, metadata, { prepareMGet = false, requireId = false, prepareMUpsert = false } = {}) {
     const
       rejected = [],
       extractedDocuments = [],
@@ -2598,21 +2660,21 @@ class ElasticSearch extends Service {
     for (let i = 0; i < documents.length; i++) {
       const document = documents[i];
 
-      if (!isPlainObject(document.body) && !prepareMUpsert) {
+      if (! isPlainObject(document.body) && ! prepareMUpsert) {
         rejected.push({
           document,
           reason: 'document body must be an object',
           status: 400
         });
       }
-      else if (!isPlainObject(document.changes) && prepareMUpsert) {
+      else if (! isPlainObject(document.changes) && prepareMUpsert) {
         rejected.push({
           document,
           reason: 'document changes must be an object',
           status: 400
         });
       }
-      else if (prepareMUpsert && document.default && !isPlainObject(document.default)) {
+      else if (prepareMUpsert && document.default && ! isPlainObject(document.default)) {
         rejected.push({
           document,
           reason: 'document default must be an object',
@@ -2678,7 +2740,7 @@ class ElasticSearch extends Service {
         : [...ROOT_MAPPING_PROPERTIES, ...CHILD_MAPPING_PROPERTIES];
 
     for (const property of properties) {
-      if (check && !mappingProperties.includes(property)) {
+      if (check && ! mappingProperties.includes(property)) {
         const currentPath = [...path, property].join('.');
 
         throw kerror.get(
@@ -2778,7 +2840,7 @@ class ElasticSearch extends Service {
    * @throws If there is not exactly one alias associated
    */
   async _getAliasFromIndice (indice) {
-    const { body } = await this._client.indices.getAlias({ index: indice});
+    const { body } = await this._client.indices.getAlias({ index: indice });
     const aliases = Object.keys(body[indice].aliases);
 
     if (aliases.length < 1) {
@@ -2808,9 +2870,9 @@ class ElasticSearch extends Service {
         indice[INDEX_PREFIX_POSITION_IN_INDICE] === this._indexPrefix
         && ! aliases.some(alias => alias.indice === indice));
 
-      const esRequest = { body: { actions : [] } };
+      const esRequest = { body: { actions: [] } };
       for (const indice of indicesWithoutAlias) {
-        esRequest.body.actions.push({ add : { alias: `${ALIAS_PREFIX}${indice}`, index: indice } });
+        esRequest.body.actions.push({ add: { alias: `${ALIAS_PREFIX}${indice}`, index: indice } });
       }
 
       if (esRequest.body.actions.length > 0) {
@@ -2829,11 +2891,11 @@ class ElasticSearch extends Service {
    * @param {String} collection
    */
   _assertValidIndexAndCollection (index, collection = null) {
-    if (!this.isIndexNameValid(index)) {
+    if (! this.isIndexNameValid(index)) {
       throw kerror.get('invalid_index_name', index);
     }
 
-    if (collection !== null && !this.isCollectionNameValid(collection)) {
+    if (collection !== null && ! this.isCollectionNameValid(collection)) {
       throw kerror.get('invalid_collection_name', collection);
     }
   }
@@ -2848,7 +2910,7 @@ class ElasticSearch extends Service {
   _extractIndex (alias) {
     return alias.substr(
       INDEX_PREFIX_POSITION_IN_ALIAS + 1,
-      alias.indexOf(NAME_SEPARATOR) - INDEX_PREFIX_POSITION_IN_ALIAS -1 );
+      alias.indexOf(NAME_SEPARATOR) - INDEX_PREFIX_POSITION_IN_ALIAS - 1 );
   }
 
   /**
@@ -2966,7 +3028,7 @@ class ElasticSearch extends Service {
   _sanitizeSearchBody (searchBody) {
     // Only allow a whitelist of top level properties
     for (const key of Object.keys(searchBody)) {
-      if (!this.searchBodyKeys.includes(key)) {
+      if (searchBody[key] !== undefined && ! this.searchBodyKeys.includes(key)) {
         throw kerror.get('invalid_search_query', key);
       }
     }
@@ -3032,7 +3094,7 @@ class ElasticSearch extends Service {
   async clearScroll (id) {
     if (id) {
       debug('clearing scroll: %s', id);
-      await this._client.clearScroll({scrollId: id});
+      await this._client.clearScroll({ scrollId: id });
     }
   }
 
@@ -3177,7 +3239,7 @@ function findDynamic (mappings, path = [], results = {}) {
  * @param {Object} esRequest
  * @throws
  */
-function assertNoRouting(esRequest) {
+function assertNoRouting (esRequest) {
   if (esRequest.body._routing) {
     throw kerror.get('no_routing');
   }
@@ -3189,7 +3251,7 @@ function assertNoRouting(esRequest) {
  * @param {Object} esRequest
  * @throws
  */
-function assertWellFormedRefresh(esRequest) {
+function assertWellFormedRefresh (esRequest) {
   if (! ['wait_for', 'false', false, undefined].includes(esRequest.refresh)) {
     throw kerror.get('invalid_argument', 'refresh', '"wait_for", false');
   }
@@ -3238,7 +3300,7 @@ function _isObjectNameValid (name) {
   let valid = true;
 
   for (let i = 0; valid && i < FORBIDDEN_CHARS.length; i++) {
-    valid = !name.includes(FORBIDDEN_CHARS[i]);
+    valid = ! name.includes(FORBIDDEN_CHARS[i]);
   }
 
   return valid;

package/lib/service/storage/esWrapper.js

@@ -154,7 +154,7 @@ const errorMessagesMapping = [
 ];
 
 class ESWrapper {
-  constructor(client) {
+  constructor (client) {
     this.client = client;
   }
 
@@ -257,8 +257,7 @@ class ESWrapper {
 
       // empty query throws exception with ES 7
       if ( error.meta.body.error.type === 'parsing_exception'
-        && _.get(error, 'meta.body.error.caused_by.type') === 'illegal_argument_exception')
-      {
+        && _.get(error, 'meta.body.error.caused_by.type') === 'illegal_argument_exception') {
         errorMessage = error.meta.body.error.caused_by.reason;
       }
     }

package/lib/types/ControllerDefinition.d.ts

@@ -8,7 +8,7 @@ import { KuzzleRequest } from '../api/request';
  *   actions: {
  *     sayHello: {
  *       handler: async request => `Hello, ${request.input.args.name}`,
- *       http: [{ verb: 'POST', path: '/greeting/hello/:name' }]
+ *       http: [{ verb: 'post', path: '/greeting/hello/:name' }]
  *     }
  *   }
  * }
@@ -22,7 +22,7 @@ export declare type ControllerDefinition = {
      *   sayHello: {
      *     handler: async request => `Hello, ${request.input.args.name}`,
      *     http: [{
-     *       verb: 'POST',
+     *       verb: 'post',
      *       path: '/greeting/hello/:name',
      *       openapi: {
      *         description: "Simply say hello",
@@ -68,7 +68,7 @@ export declare type HttpRoute = {
     /**
      * HTTP verb.
      */
-    verb: 'get' | 'post' | 'put' | 'delete' | 'head';
+    verb: 'get' | 'head' | 'post' | 'put' | 'delete' | 'patch' | 'options';
     /**
      * Route path.
      * A route starting with `/` will be prefixed by `/_` otherwise the route