kuzzle 2.19.2 → 2.19.3

package/lib/util/asyncStore.js

@@ -19,13 +19,13 @@
  * limitations under the License.
  */
 
-'use strict';
+"use strict";
 
-const assert = require('assert');
-const { AsyncLocalStorage } = require('async_hooks');
+const assert = require("assert");
+const { AsyncLocalStorage } = require("async_hooks");
 
 class AsyncStore {
-  constructor () {
+  constructor() {
     this._asyncLocalStorage = new AsyncLocalStorage();
   }
 
@@ -34,7 +34,7 @@ class AsyncStore {
    *
    * @param {Function} callback
    */
-  run (callback) {
+  run(callback) {
     this._asyncLocalStorage.run(new Map(), callback);
   }
 
@@ -42,7 +42,7 @@ class AsyncStore {
    * Returns true if an async store exists
    * for the current asynchronous context
    */
-  exists () {
+  exists() {
     return Boolean(this._asyncLocalStorage.getStore());
   }
 
@@ -52,7 +52,7 @@ class AsyncStore {
    * @param {String} key
    * @param {any} value
    */
-  set (key, value) {
+  set(key, value) {
     return this._getStore().set(key, value);
   }
 
@@ -63,7 +63,7 @@ class AsyncStore {
    *
    * @returns {any} value
    */
-  get (key) {
+  get(key) {
     return this._getStore().get(key);
   }
 
@@ -74,41 +74,39 @@ class AsyncStore {
    *
    * @returns {Boolean}
    */
-  has (key) {
+  has(key) {
     return this._getStore().has(key);
   }
 
-  _getStore () {
+  _getStore() {
     const store = this._asyncLocalStorage.getStore();
 
-    assert(Boolean(store), 'Associated AsyncStore is not set');
+    assert(Boolean(store), "Associated AsyncStore is not set");
 
     return store;
   }
 }
 
-
 class AsyncStoreStub {
-  constructor () {}
+  constructor() {}
 
-  run (callback) {
+  run(callback) {
     callback();
   }
 
-  exists () {
+  exists() {
     return false;
   }
 
-  set () {}
+  set() {}
 
-  get () {}
+  get() {}
 
-  has () {}
+  has() {}
 }
 
-if (process.version >= 'v12.18.1') {
+if (process.version >= "v12.18.1") {
   module.exports = AsyncStore;
-}
-else {
+} else {
   module.exports = AsyncStoreStub;
 }

package/lib/util/bufferedPassThrough.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
-import stream from 'stream';
-declare type Encoding = BufferEncoding | 'buffer';
+import stream from "stream";
+declare type Encoding = BufferEncoding | "buffer";
 declare type ChunkData = Buffer | string;
 declare type Chunk = {
     chunk: ChunkData;

package/lib/util/bufferedPassThrough.js

@@ -50,7 +50,7 @@ class BufferedPassThrough extends stream_1.default.Duplex {
      * @returns How many bytes have been copied / written to the internal buffer.
      */
     writeToBuffer(data, start, end, encoding) {
-        if (encoding === 'buffer') {
+        if (encoding === "buffer") {
             return data.copy(this.buffer, this.offset, start, end);
         }
         if (start === 0 && end === data.length) {
@@ -80,8 +80,8 @@ class BufferedPassThrough extends stream_1.default.Duplex {
                 chunkOffset += this.writeToBuffer(chunk, chunkOffset, chunkOffset + remainingBufferSize, encoding);
                 // Sends the whole buffer to the stream since it is full
                 if (!this.push(this.buffer)) {
-                    await new Promise(res => {
-                        this.once('_drained', res);
+                    await new Promise((res) => {
+                        this.once("_drained", res);
                     });
                 }
                 this.offset = 0; // Reset the offset
@@ -125,7 +125,7 @@ class BufferedPassThrough extends stream_1.default.Duplex {
      */
     _read() {
         // Emits an internal _drained event when the internal buffer is drained.
-        this.emit('_drained');
+        this.emit("_drained");
     }
     /**
      * @override from stream.Duplex

package/lib/util/bytes.js

@@ -1,30 +1,26 @@
-'use strict';
+"use strict";
 
-function bytes (input) {
-  if (typeof input === 'number') {
+function bytes(input) {
+  if (typeof input === "number") {
     return input;
-  }
-  else if (typeof input !== 'string') {
+  } else if (typeof input !== "string") {
     return null;
   }
 
   let unit = 1;
-  if (input.toLowerCase().includes('kb')) {
+  if (input.toLowerCase().includes("kb")) {
     unit = 1024;
-  }
-  else if (input.toLowerCase().includes('mb')) {
+  } else if (input.toLowerCase().includes("mb")) {
     unit = 1024 ** 2;
-  }
-  else if (input.toLowerCase().includes('gb')) {
+  } else if (input.toLowerCase().includes("gb")) {
     unit = 1024 ** 3;
-  }
-  else if (input.toLowerCase().includes('tb')) {
+  } else if (input.toLowerCase().includes("tb")) {
     unit = 1024 ** 4;
   }
 
   const match = input.match(/\d+/);
 
-  if (! match) {
+  if (!match) {
     return null;
   }
 

package/lib/util/crypto.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.sha256 = void 0;
 const crypto_1 = __importDefault(require("crypto"));
 function sha256(string) {
-    return crypto_1.default.createHash('sha256').update(string).digest('hex');
+    return crypto_1.default.createHash("sha256").update(string).digest("hex");
 }
 exports.sha256 = sha256;
 //# sourceMappingURL=crypto.js.map

package/lib/util/debug.js

@@ -19,19 +19,19 @@
  * limitations under the License.
  */
 
-'use strict';
+"use strict";
 
-const debug = require('debug');
-const util = require('util');
+const debug = require("debug");
+const util = require("util");
 
-debug.formatters.a = value => {
+debug.formatters.a = (value) => {
   const inspectOpts = debug.inspectOpts;
 
   if (inspectOpts.expand) {
     return `\n${util.inspect(value, inspectOpts)}`;
   }
 
-  return util.inspect(value, inspectOpts).replace(/\s*\n\s*/g, ' ');
+  return util.inspect(value, inspectOpts).replace(/\s*\n\s*/g, " ");
 };
 
 module.exports = debug;

package/lib/util/deprecate.js

@@ -19,45 +19,48 @@
  * limitations under the License.
  */
 
-'use strict';
+"use strict";
 
 const deprecationWarning = (logger, ...args) => {
-  if (global.NODE_ENV === 'development') {
-    logger.warn('DEPRECATION WARNING');
+  if (global.NODE_ENV === "development") {
+    logger.warn("DEPRECATION WARNING");
     logger.warn(...args);
   }
 };
 
 const warnIfDeprecated = (logger, deprecations, member) => {
-  const
-    deprecatedProperty = Object
-      .keys(deprecations)
-      .find(deprecated => deprecated === member),
+  const deprecatedProperty = Object.keys(deprecations).find(
+      (deprecated) => deprecated === member
+    ),
     alternative = deprecations[deprecatedProperty];
 
-  if (! deprecatedProperty) {
+  if (!deprecatedProperty) {
     return;
   }
 
-  if (alternative && typeof alternative.message === 'string') {
+  if (alternative && typeof alternative.message === "string") {
     deprecationWarning(logger, alternative.message);
-  }
-  else if (typeof alternative === 'string') {
-    deprecationWarning(logger, `Use of '${deprecatedProperty}' property is deprecated. Please, use '${alternative}' instead.`);
-  }
-  else {
-    deprecationWarning(logger, `Use of '${deprecatedProperty}' property is deprecated.`);
+  } else if (typeof alternative === "string") {
+    deprecationWarning(
+      logger,
+      `Use of '${deprecatedProperty}' property is deprecated. Please, use '${alternative}' instead.`
+    );
+  } else {
+    deprecationWarning(
+      logger,
+      `Use of '${deprecatedProperty}' property is deprecated.`
+    );
   }
 };
 
 const deprecateProperties = (logger, target, deprecations = {}) => {
-  if (global.NODE_ENV !== 'development') {
+  if (global.NODE_ENV !== "development") {
     return target;
   }
 
   return new Proxy(target, {
-    get (object, key, ...rest) {
-      if (key === '__isProxy') {
+    get(object, key, ...rest) {
+      if (key === "__isProxy") {
         return true;
       }
 
@@ -66,14 +69,14 @@ const deprecateProperties = (logger, target, deprecations = {}) => {
       return Reflect.get(object, key, ...rest);
     },
 
-    set (object, key, ...rest) {
+    set(object, key, ...rest) {
       warnIfDeprecated(logger, deprecations, key);
 
       return Reflect.set(object, key, ...rest);
-    }
+    },
   });
 };
 
 module.exports = {
-  deprecateProperties
+  deprecateProperties,
 };

package/lib/util/didYouMean.js

@@ -19,19 +19,19 @@
  * limitations under the License.
  */
 
-'use strict';
+"use strict";
 
-const didYouMean = require('didyoumean');
+const didYouMean = require("didyoumean");
 
-function printDidYouMean (...args) {
-  if (global.NODE_ENV !== 'development') {
-    return '';
+function printDidYouMean(...args) {
+  if (global.NODE_ENV !== "development") {
+    return "";
   }
 
   const result = didYouMean(...args);
 
-  if (! result) {
-    return '';
+  if (!result) {
+    return "";
   }
 
   return ` Did you mean "${result}"?`;

package/lib/util/dump-collection.d.ts

@@ -1,5 +1,5 @@
-import { JSONObject } from '../../index';
-import { HttpStream } from '../types';
+import { JSONObject } from "../../index";
+import { HttpStream } from "../types";
 /**
  * Flatten an object transform:
  * {

package/lib/util/dump-collection.js

@@ -62,8 +62,8 @@ function flattenStep(output, object, prev = null) {
     for (let i = 0; i < keys.length; i++) {
         const key = keys[i];
         const value = object[key];
-        const newKey = prev ? prev + '.' + key : key;
-        if (Object.prototype.toString.call(value) === '[object Object]') {
+        const newKey = prev ? prev + "." + key : key;
+        if (Object.prototype.toString.call(value) === "[object Object]") {
             flattenStep(output, value, newKey);
             continue;
         }
@@ -101,7 +101,7 @@ exports.extractMappingFields = extractMappingFields;
  * @see https://lodash.com/docs/4.17.15#values
  */
 function pickValues(object, fields) {
-    return fields.map(f => formatValueForCSV((0, get_1.default)(object, f)));
+    return fields.map((f) => formatValueForCSV((0, get_1.default)(object, f)));
 }
 exports.pickValues = pickValues;
 /**
@@ -113,15 +113,15 @@ exports.pickValues = pickValues;
  */
 function formatValueForCSV(value) {
     if ((0, isObject_1.default)(value)) {
-        return '[OBJECT]';
+        return "[OBJECT]";
     }
     return value;
 }
 class AbstractDumper {
     constructor(index, collection, query = {}, writeStream, options = {
         fieldsName: {},
-        scroll: '5s',
-        separator: ',',
+        scroll: "5s",
+        separator: ",",
         size: 10,
     }) {
         this.index = index;
@@ -130,7 +130,7 @@ class AbstractDumper {
         this.writeStream = writeStream;
         this.options = options;
         if (!writeStream) {
-            throw kerror.get('api', 'assert', 'missing_argument', 'writeStream');
+            throw kerror.get("api", "assert", "missing_argument", "writeStream");
         }
     }
     /**
@@ -154,7 +154,7 @@ class AbstractDumper {
             return null;
         }
         try {
-            return await global.kuzzle.ask('core:storage:public:document:scroll', scrollId, { scrollTTL: this.options.scroll });
+            return await global.kuzzle.ask("core:storage:public:document:scroll", scrollId, { scrollTTL: this.options.scroll });
         }
         catch {
             return null;
@@ -167,13 +167,13 @@ class AbstractDumper {
      * @returns a promise resolving when the dump is finished.
      */
     async dump() {
-        const waitWrite = new Promise((resolve, reject) => this.writeStream ? this.writeStream.on('finish', resolve) : reject());
-        this.writeStream.on('error', error => {
+        const waitWrite = new Promise((resolve, reject) => this.writeStream ? this.writeStream.on("finish", resolve) : reject());
+        this.writeStream.on("error", (error) => {
             throw error;
         });
         await this.setup();
         await this.writeHeader();
-        let results = await global.kuzzle.ask('core:storage:public:document:search', this.index, this.collection, this.query, {
+        let results = await global.kuzzle.ask("core:storage:public:document:search", this.index, this.collection, this.query, {
             lang: this.options.lang,
             scroll: this.options.scroll,
             size: this.options.size,
@@ -182,7 +182,7 @@ class AbstractDumper {
             for (const hit of results.hits) {
                 await this.onResult({
                     _id: hit._id,
-                    _source: hit._source
+                    _source: hit._source,
                 });
             }
         } while ((results = await this.scroll(results.scrollId)));
@@ -197,7 +197,7 @@ class JSONLDumper extends AbstractDumper {
         this.ndjsonStream = ndjson_1.default.stringify();
     }
     async setup() {
-        this.ndjsonStream.on('data', (line) => {
+        this.ndjsonStream.on("data", (line) => {
             this.writeStream.write(line);
         });
     }
@@ -205,16 +205,16 @@ class JSONLDumper extends AbstractDumper {
         await this.writeLine({
             collection: this.collection,
             index: this.index,
-            type: 'collection',
+            type: "collection",
         });
     }
     writeLine(content) {
-        return new Promise(resolve => {
+        return new Promise((resolve) => {
             if (this.ndjsonStream.write(content)) {
                 resolve();
             }
             else {
-                this.ndjsonStream.once('drain', resolve);
+                this.ndjsonStream.once("drain", resolve);
             }
         });
     }
@@ -225,7 +225,7 @@ class JSONLDumper extends AbstractDumper {
         });
     }
     get fileExtension() {
-        return 'jsonl';
+        return "jsonl";
     }
 }
 class CSVDumper extends AbstractDumper {
@@ -234,36 +234,36 @@ class CSVDumper extends AbstractDumper {
         this.fields = fields;
     }
     get fileExtension() {
-        return 'csv';
+        return "csv";
     }
     async setup() {
         if (!this.fields.length) {
             // If no field has been selected, then all fields are selected.
-            const mappings = await global.kuzzle.ask('core:storage:public:mappings:get', this.index, this.collection);
+            const mappings = await global.kuzzle.ask("core:storage:public:mappings:get", this.index, this.collection);
             if (!mappings.properties) {
                 return;
             }
             this.fields = Object.keys(flattenObject(extractMappingFields(mappings.properties)));
         }
-        else if (this.fields.includes('_id')) {
+        else if (this.fields.includes("_id")) {
             // Delete '_id' from the selected fields, since IDs are
             // _always_ exported.
-            this.fields.splice(this.fields.indexOf('_id'), 1);
+            this.fields.splice(this.fields.indexOf("_id"), 1);
         }
     }
     writeHeader() {
-        const mappedFieldsName = ['_id', ...this.fields].map(field => {
+        const mappedFieldsName = ["_id", ...this.fields].map((field) => {
             return this.options.fieldsName[field] || field;
         });
         return this.writeLine(mappedFieldsName.join(this.options.separator));
     }
     writeLine(content) {
-        return new Promise(resolve => {
+        return new Promise((resolve) => {
             if (this.writeStream.write(`${content}\n`)) {
                 resolve();
             }
             else {
-                this.writeStream.once('drain', resolve);
+                this.writeStream.once("drain", resolve);
             }
         });
     }
@@ -272,11 +272,11 @@ class CSVDumper extends AbstractDumper {
         return this.writeLine(values.join(this.options.separator));
     }
 }
-function dumpCollectionDocuments(index, collection, query = {}, format = 'jsonl', fields = [], options = {}) {
+function dumpCollectionDocuments(index, collection, query = {}, format = "jsonl", fields = [], options = {}) {
     let dumper;
     const writableStream = new bufferedPassThrough_1.BufferedPassThrough({ highWaterMark: 16384 });
     switch (format.toLowerCase()) {
-        case 'csv':
+        case "csv":
             dumper = new CSVDumper(index, collection, query, writableStream, options, fields);
             dumper.dump();
             break;

package/lib/util/esRequest.d.ts

@@ -0,0 +1 @@
+export declare function getESIndexDynamicSettings(requestSettings: object): object;

package/lib/util/esRequest.js

@@ -0,0 +1,62 @@
+"use strict";
+/*
+ * Kuzzle, a backend software, self-hostable and ready to use
+ * to power modern apps
+ *
+ * Copyright 2015-2020 Kuzzle
+ * mailto: support AT kuzzle.io
+ * website: http://kuzzle.io
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getESIndexDynamicSettings = void 0;
+const lodash_1 = __importDefault(require("lodash"));
+// Dynamic index settings specified in the elasticsearch documentation :
+// https://www.elastic.co/guide/en/elasticsearch/reference/7.5/index-modules.html#index-modules-settings
+const dynamicESSettings = [
+    "number_of_replicas",
+    "search",
+    "search.idle.after",
+    "refresh_interval",
+    "max_result_window",
+    "max_inner_result_window",
+    "max_rescore_window",
+    "max_docvalue_fields_search",
+    "max_script_fields",
+    "max_ngram_diff",
+    "max_shingle_diff",
+    "blocks",
+    "blocks.read_only",
+    "blocks.read_only_allow_delete",
+    "blocks.read",
+    "blocks.write",
+    "blocks.metadata",
+    "max_refresh_listeners",
+    "highlight.max_analyzed_offset",
+    "max_terms_count",
+    "max_regex_length",
+    "routing.allocation.enable",
+    "routing.rebalance.enable",
+    "gc_deletes",
+    "default_pipeline",
+    "final_pipeline",
+];
+function getESIndexDynamicSettings(requestSettings) {
+    return lodash_1.default.pick(requestSettings, dynamicESSettings);
+}
+exports.getESIndexDynamicSettings = getESIndexDynamicSettings;
+//# sourceMappingURL=esRequest.js.map

package/lib/util/extractFields.js

@@ -19,29 +19,28 @@
  * limitations under the License.
  */
 
-'use strict';
+"use strict";
 
-const { isPlainObject } = require('./safeObject');
+const { isPlainObject } = require("./safeObject");
 
 /**
-* Extract nested fields of an object in a flat array.
-* Example: { field : { 1: "nested", 2: "nested" } } => [ 'field.1', 'field.2' ]
-*
-* @param {Object} document - Document to extract fields from
-* @param {Object} options - alsoExtractValues (false), fieldsToIgnore ( [ ] )
-*
-* @returns { Array<String> | Array<{ key: String, value: any }> }
-*/
-function extractFields (document, {
-  fieldsToIgnore = [],
-  alsoExtractValues = false,
-} = {}, {
-  path = null,
-  extractedFields = []
-} = {}) {
+ * Extract nested fields of an object in a flat array.
+ * Example: { field : { 1: "nested", 2: "nested" } } => [ 'field.1', 'field.2' ]
+ *
+ * @param {Object} document - Document to extract fields from
+ * @param {Object} options - alsoExtractValues (false), fieldsToIgnore ( [ ] )
+ *
+ * @returns { Array<String> | Array<{ key: String, value: any }> }
+ */
+function extractFields(
+  document,
+  { fieldsToIgnore = [], alsoExtractValues = false } = {},
+  { path = null, extractedFields = [] } = {}
+) {
   for (const [key, value] of Object.entries(document)) {
-    if ( fieldsToIgnore.length
-      && fieldsToIgnore.find(keyToIgnore => keyToIgnore === key )
+    if (
+      fieldsToIgnore.length &&
+      fieldsToIgnore.find((keyToIgnore) => keyToIgnore === key)
     ) {
       continue;
     }
@@ -49,14 +48,14 @@ function extractFields (document, {
     const currentPath = path ? `${path}.${key}` : key;
 
     if (isPlainObject(value)) {
-      extractFields(value,
+      extractFields(
+        value,
         { alsoExtractValues, fieldsToIgnore },
-        { extractedFields, path: currentPath });
-    }
-    else if (alsoExtractValues) {
+        { extractedFields, path: currentPath }
+      );
+    } else if (alsoExtractValues) {
       extractedFields.push({ key: currentPath, value });
-    }
-    else {
+    } else {
       extractedFields.push(currentPath);
     }
   }