kuzzle 2.17.5 → 2.17.8

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
  *
@@ -361,7 +361,7 @@ class ElasticSearch extends Service {
       for (const target of targets) {
         for (const targetCollection of target.collections) {
           const alias = this._getAlias(target.index, targetCollection);
-          
+
           indexes.add(alias);
         }
       }
@@ -415,10 +415,10 @@ class ElasticSearch extends Service {
   }
 
   async _formatSearchResult (body) {
-    
+
     const formatHit = async (hit) => {
       let alias = null;
-      
+
       if (hit._index) {
         alias = await this._getAliasFromIndice(hit._index);
       }
@@ -1566,7 +1566,8 @@ 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();
@@ -2147,7 +2148,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) {
@@ -2191,7 +2192,7 @@ class ElasticSearch extends Service {
     }
     /* end critical code section */
 
-    return this._mExecute(esRequest, extractedDocuments, rejected, { limits });
+    return this._mExecute(esRequest, extractedDocuments, rejected, { limits, source });
   }
 
   /**
@@ -2563,7 +2564,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
@@ -2617,7 +2618,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,

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
  *

package/lib/types/ResponsePayload.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/StrategyDefinition.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/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/types/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
  *

package/lib/types/index.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/util/array.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/util/assertType.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/util/asyncStore.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/util/debug.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/util/deprecate.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/util/didYouMean.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/util/extractFields.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/util/inflector.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/util/koncordeCompat.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/util/memoize.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/util/mutex.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/util/name-generator.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/util/promback.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/util/requestAssertions.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/util/safeObject.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/util/stackTrace.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
  *
@@ -21,33 +21,72 @@
 
 'use strict';
 
+const util = require('util');
+
+const MARKER = '>';
+const PADDING = '  ';
+
 /**
-  * Hilight user code
-  *
-  * e.g.
-  *     at BackendController._add (/home/kuzzle/lib/core/application/backend.ts:261:28)
-  *     at BackendController.register (/home/kuzzle/lib/core/application/backend.ts:187:10)
-  * >  at registerFoo (/home/aschen/projets/app/test.ts:12:18)
-  * >  at init (/home/aschen/projets/app/test.ts:8:3)
-  *     at Module._compile (internal/modules/cjs/loader.js:1133:30)
-  */
+ * Hilight user code
+ *
+ * e.g.
+ *       at BackendController._add (/home/kuzzle/lib/core/application/backend.ts:261:28)
+ *       at BackendController.register (/home/kuzzle/lib/core/application/backend.ts:187:10)
+ * >>>>  at registerFoo (/home/aschen/projets/app/test.ts:12:18)
+ * >>>>  at init (/home/aschen/projets/app/test.ts:8:3)
+ *       at Module._compile (internal/modules/cjs/loader.js:1133:30)
+ */
 function hilightUserCode (line) {
   // ignore first line (error message) or already enhanced
-  if (! line.includes(' at ') || line.startsWith('>')) {
+  if (! line.includes(' at ') || line.startsWith(MARKER)) {
     return line;
   }
 
-  if ( line.includes('kuzzle/lib/') // ignore kuzzle code
-    || (line.indexOf('at /') === -1 && line.charAt(line.indexOf('(') + 1) !== '/') // ignore node internal
-    || line.includes('node_modules') // ignore dependencies
-  ) {
-    return '   ' + line;
+  const isKuzzleCode = line.includes('kuzzle/lib/');
+  const isNodeCode = ! line.includes('at /')
+                  && ! line.includes('at async /')
+                  && line.charAt(line.indexOf('(') + 1) !== '/';
+  const isModuleCode = line.includes('node_modules');
+  if (isKuzzleCode || isNodeCode || isModuleCode) {
+    return PADDING + line;
   }
 
   // hilight user code
-  return '>' + line;
+  return MARKER + line;
+}
+
+/**
+ * utility method: must be invoked by all protocols to remove stack traces
+ * from payloads before sending them
+ * @param  {Error|Object} data - expected: plain error object or serialized
+ *                               request response
+ * @returns {*} return the data minus the stack trace
+ */
+function removeStacktrace (data) {
+  if (util.types.isNativeError(data)) {
+    if (global.NODE_ENV !== 'development') {
+      data.stack = undefined;
+    }
+    else {
+      data.stack = data.stack.split('\n').map(hilightUserCode).join('\n');
+    }
+  }
+  else if (data && data.content && data.content.error) {
+    // @todo v3: stack should be removed only for "production" env
+    if (global.NODE_ENV !== 'development') {
+      data.content.error.stack = undefined;
+    }
+    else {
+      data.content.error.stack = data.content.error.stack
+        ? data.content.error.stack.split('\n').map(hilightUserCode).join('\n')
+        : undefined;
+    }
+  }
+
+  return data;
 }
 
 module.exports = {
   hilightUserCode,
+  removeStacktrace,
 };

package/lib/util/wildcard.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
  *