kuzzle 2.31.0 → 2.32.0-beta.1

package/lib/service/storage/{elasticsearch.d.ts → 7/elasticsearch.d.ts}

@@ -1,19 +1,18 @@
 import _ from "lodash";
-import { RequestParams, Client as StorageClient } from "@elastic/elasticsearch";
-import { JSONObject, KRequestBody, KRequestParams } from "../../types/storage/Elasticsearch";
-import { TypeMapping } from "@elastic/elasticsearch/api/types";
-import { storeScopeEnum } from "../../core/storage/storeScopeEnum";
-import Service from "../service";
+import { RequestParams, Client } from "sdk-es7";
+import { TypeMapping } from "sdk-es7/api/types";
+import { JSONObject, KRequestBody, KRequestParams } from "../../../types/storage/7/Elasticsearch";
 import ESWrapper from "./esWrapper";
-import QueryTranslator from "./queryTranslator";
+import { QueryTranslator } from "../commons/queryTranslator";
+import { storeScopeEnum } from "../../../core/storage/storeScopeEnum";
 /**
  * @param {Kuzzle} kuzzle kuzzle instance
  * @param {Object} config Service configuration
  * @param {storeScopeEnum} scope
  * @constructor
  */
-export default class ElasticSearch extends Service {
-    _client: StorageClient;
+export declare class ES7 {
+    _client: Client;
     _scope: storeScopeEnum;
     _indexPrefix: string;
     _esWrapper: ESWrapper;
@@ -25,12 +24,6 @@ export default class ElasticSearch extends Service {
     maxScrollDuration: number;
     scrollTTL: number;
     _config: any;
-    /**
-     * Returns a new elasticsearch client instance
-     *
-     * @returns {Object}
-     */
-    static buildClient(config: any): StorageClient;
     constructor(config: any, scope?: storeScopeEnum);
     get scope(): storeScopeEnum;
     /**
@@ -77,7 +70,15 @@ export default class ElasticSearch extends Service {
         scrollTTL?: string;
     }): Promise<{
         aggregations: any;
-        hits: any;
+        hits: {
+            _id: any;
+            _score: any;
+            _source: any;
+            collection: any;
+            highlight: any;
+            index: any;
+            inner_hits: {};
+        }[];
         remaining: any;
         scrollId: any;
         suggest: any;
@@ -104,7 +105,15 @@ export default class ElasticSearch extends Service {
         scroll?: string;
     }): Promise<{
         aggregations: any;
-        hits: any;
+        hits: {
+            _id: any;
+            _score: any;
+            _source: any;
+            collection: any;
+            highlight: any;
+            index: any;
+            inner_hits: {};
+        }[];
         remaining: any;
         scrollId: any;
         suggest: any;
@@ -119,7 +128,15 @@ export default class ElasticSearch extends Service {
     _mapTargetsToAlias(targets: any): {};
     _formatSearchResult(body: any, searchInfo?: any): Promise<{
         aggregations: any;
-        hits: any;
+        hits: {
+            _id: any;
+            _score: any;
+            _source: any;
+            collection: any;
+            highlight: any;
+            index: any;
+            inner_hits: {};
+        }[];
         remaining: any;
         scrollId: any;
         suggest: any;
@@ -187,7 +204,7 @@ export default class ElasticSearch extends Service {
         _version: any;
     }>;
     /**
-     * Creates a new document to ElasticSearch, or replace it if it already exist
+     * Creates a new document to Elasticsearch, or replace it if it already exist
      *
      * @param {String} index - Index name
      * @param {String} collection - Collection name
@@ -253,7 +270,7 @@ export default class ElasticSearch extends Service {
         created: boolean;
     }>;
     /**
-     * Replaces a document to ElasticSearch
+     * Replaces a document to Elasticsearch
      *
      * @param {String} index - Index name
      * @param {String} collection - Collection name
@@ -559,7 +576,7 @@ export default class ElasticSearch extends Service {
      *
      * @returns {Promise.<String[]>}
      */
-    deleteIndexes(indexes?: string[]): Promise<any>;
+    deleteIndexes(indexes?: string[]): Promise<any[]>;
     /**
      * Deletes an index
      *
@@ -830,7 +847,7 @@ export default class ElasticSearch extends Service {
      * @returns {String} Alias name (eg: '@&nepali.liia')
      * @throws If there is not exactly one alias associated that is prefixed with @
      */
-    _getAliasFromIndice(indice: any): Promise<string[]>;
+    _getAliasFromIndice(indice: string): Promise<string[]>;
     /**
      * Check for each indice whether it has an alias or not.
      * When the latter is missing, create one based on the indice name.
@@ -870,7 +887,7 @@ export default class ElasticSearch extends Service {
      *
      * @returns {Object.<String, String[]>} Indexes as key and an array of their collections as value
      */
-    _extractSchema(aliases: any, { includeHidden }?: {
+    _extractSchema(aliases: string[], { includeHidden }?: {
         includeHidden?: boolean;
     }): {};
     /**
@@ -953,4 +970,5 @@ export default class ElasticSearch extends Service {
     _checkDynamicProperty(mappings: any): void;
     _setLastActionToKuzzleMeta(esRequest: JSONObject, alias: string, kuzzleMeta: JSONObject): void;
     _setLastActionToKuzzleMetaUpdate(item: JSONObject, kuzzleMeta: JSONObject): void;
+    _getRandomNumber(number: number): number;
 }

package/lib/service/storage/{elasticsearch.js → 7/elasticsearch.js}

@@ -46,24 +46,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ES7 = void 0;
 const lodash_1 = __importDefault(require("lodash"));
-const elasticsearch_1 = require("@elastic/elasticsearch");
+const sdk_es7_1 = require("sdk-es7");
 const assert_1 = __importDefault(require("assert"));
 const bluebird_1 = __importDefault(require("bluebird"));
 const ms_1 = __importDefault(require("ms"));
 const semver_1 = __importDefault(require("semver"));
-const debug_1 = __importDefault(require("../../util/debug"));
-const storeScopeEnum_1 = require("../../core/storage/storeScopeEnum");
-const kerror = __importStar(require("../../kerror"));
-const didYouMean_1 = __importDefault(require("../../util/didYouMean"));
-const extractFields_1 = __importDefault(require("../../util/extractFields"));
-const mutex_1 = require("../../util/mutex");
-const name_generator_1 = require("../../util/name-generator");
-const requestAssertions_1 = require("../../util/requestAssertions");
-const safeObject_1 = require("../../util/safeObject");
-const service_1 = __importDefault(require("../service"));
+const debug_1 = __importDefault(require("../../../util/debug"));
 const esWrapper_1 = __importDefault(require("./esWrapper"));
-const queryTranslator_1 = __importDefault(require("./queryTranslator"));
+const queryTranslator_1 = require("../commons/queryTranslator");
+const didYouMean_1 = __importDefault(require("../../../util/didYouMean"));
+const kerror = __importStar(require("../../../kerror"));
+const requestAssertions_1 = require("../../../util/requestAssertions");
+const safeObject_1 = require("../../../util/safeObject");
+const extractFields_1 = __importDefault(require("../../../util/extractFields"));
+const mutex_1 = require("../../../util/mutex");
+const name_generator_1 = require("../../../util/name-generator");
+const storeScopeEnum_1 = require("../../../core/storage/storeScopeEnum");
 (0, debug_1.default)("kuzzle:services:elasticsearch");
 const SCROLL_CACHE_PREFIX = "_docscroll_";
 const ROOT_MAPPING_PROPERTIES = [
@@ -97,35 +97,16 @@ let esState = esStateEnum.NONE;
  * @param {storeScopeEnum} scope
  * @constructor
  */
-class ElasticSearch extends service_1.default {
-    /**
-     * Returns a new elasticsearch client instance
-     *
-     * @returns {Object}
-     */
-    static buildClient(config) {
-        // Passed to Elasticsearch's client to make it use
-        // Bluebird instead of ES6 promises
-        const defer = function defer() {
-            let resolve;
-            let reject;
-            const promise = new bluebird_1.default((res, rej) => {
-                resolve = res;
-                reject = rej;
-            });
-            return { promise, reject, resolve };
-        };
-        return new elasticsearch_1.Client({ defer, ...config });
-    }
+class ES7 {
     constructor(config, scope = storeScopeEnum_1.storeScopeEnum.PUBLIC) {
-        super("elasticsearch", config);
+        this._config = config;
         this._scope = scope;
         this._indexPrefix =
             scope === storeScopeEnum_1.storeScopeEnum.PRIVATE ? PRIVATE_PREFIX : PUBLIC_PREFIX;
         this._client = null;
         this._esWrapper = null;
         this._esVersion = null;
-        this._translator = new queryTranslator_1.default();
+        this._translator = new queryTranslator_1.QueryTranslator();
         // Allowed root key of a search query
         this.searchBodyKeys = [
             "aggregations",
@@ -175,7 +156,7 @@ class ElasticSearch extends service_1.default {
                 'See the "services.storageEngine.commonMapping.dynamic" option in the kuzzlerc configuration file to change this value.',
             ].join("\n"));
         }
-        this._client = ElasticSearch.buildClient(this._config.client);
+        this._client = new sdk_es7_1.Client(this._config.client);
         await this.waitForElasticsearch();
         this._esWrapper = new esWrapper_1.default(this._client);
         const { body: { version }, } = await this._client.info();
@@ -619,7 +600,7 @@ class ElasticSearch extends service_1.default {
         }
     }
     /**
-     * Creates a new document to ElasticSearch, or replace it if it already exist
+     * Creates a new document to Elasticsearch, or replace it if it already exist
      *
      * @param {String} index - Index name
      * @param {String} collection - Collection name
@@ -757,7 +738,7 @@ class ElasticSearch extends service_1.default {
         }
     }
     /**
-     * Replaces a document to ElasticSearch
+     * Replaces a document to Elasticsearch
      *
      * @param {String} index - Index name
      * @param {String} collection - Collection name
@@ -2468,7 +2449,7 @@ class ElasticSearch extends service_1.default {
         let notAvailable;
         let suffix;
         do {
-            suffix = `.${(0, name_generator_1.randomNumber)(100000)}`;
+            suffix = `.${this._getRandomNumber(100000)}`;
             const overflow = Buffer.from(indice + suffix).length - 255;
             if (overflow > 0) {
                 const indiceBuffer = Buffer.from(indice);
@@ -2574,7 +2555,7 @@ class ElasticSearch extends service_1.default {
         const schema = {};
         for (const alias of aliases) {
             const [indexName, collectionName] = alias
-                .substr(INDEX_PREFIX_POSITION_IN_ALIAS + 1, alias.length)
+                .slice(INDEX_PREFIX_POSITION_IN_ALIAS + 1)
                 .split(NAME_SEPARATOR);
             if (alias[INDEX_PREFIX_POSITION_IN_ALIAS] === this._indexPrefix &&
                 (collectionName !== HIDDEN_COLLECTION || includeHidden)) {
@@ -2856,8 +2837,11 @@ class ElasticSearch extends service_1.default {
             }
         }
     }
+    _getRandomNumber(number) {
+        return (0, name_generator_1.randomNumber)(number);
+    }
 }
-exports.default = ElasticSearch;
+exports.ES7 = ES7;
 /**
  * Finds paths and values of mappings dynamic properties
  *
@@ -2942,7 +2926,4 @@ function _isObjectNameValid(name) {
     }
     return valid;
 }
-// TODO: Remove this function when we move to Jest
-// This is kept because we use an old ReRequire that use require() instead of import
-module.exports = ElasticSearch;
 //# sourceMappingURL=elasticsearch.js.map

package/lib/service/storage/{esWrapper.js → 7/esWrapper.js}

@@ -25,11 +25,13 @@
 
 const Bluebird = require("bluebird");
 const _ = require("lodash");
-const es = require("@elastic/elasticsearch");
+const es = require("sdk-es7");
 
-const { KuzzleError } = require("../../kerror/errors");
-const debug = require("../../util/debug")("kuzzle:services:storage:ESCommon");
-const kerror = require("../../kerror").wrap("services", "storage");
+const { KuzzleError } = require("../../../kerror/errors");
+const debug = require("../../../util/debug")(
+  "kuzzle:services:storage:ESCommon",
+);
+const kerror = require("../../../kerror").wrap("services", "storage");
 
 const errorMessagesMapping = [
   {