kuzzle 2.30.0 → 2.31.0-elasticsearch-8.1

package/lib/api/controllers/authController.d.ts

@@ -1,3 +1,4 @@
+import Bluebird from "bluebird";
 import { KuzzleRequest } from "../request";
 import { NativeController } from "./baseController";
 export declare class AuthController extends NativeController {
@@ -78,7 +79,7 @@ export declare class AuthController extends NativeController {
      * @param {KuzzleRequest} request
      * @returns {Promise<Object>}
      */
-    getCurrentUser(request: any): any;
+    getCurrentUser(request: any): Bluebird<any>;
     /**
      * Returns the rights of the user identified by the given jwt token
      *
@@ -115,7 +116,7 @@ export declare class AuthController extends NativeController {
      *
      * @returns {Promise.<string[]>}
      */
-    getStrategies(): any;
+    getStrategies(): Bluebird<any>;
     /**
      * @param {KuzzleRequest} request
      * @returns {Promise.<Object>}

package/lib/config/default.config.js

@@ -275,6 +275,7 @@ const defaultConfig = {
             bootstrapLockTimeout: 60000,
         },
         storageEngine: {
+            majorVersion: "7",
             aliases: ["storageEngine"],
             backend: "elasticsearch",
             client: {

package/lib/core/backend/backendStorage.d.ts

@@ -1,19 +1,17 @@
-import { Client } from "@elastic/elasticsearch";
-import { ApplicationManager, Backend } from "./index";
+import { ApplicationManager } from "./index";
 export declare class BackendStorage extends ApplicationManager {
     private _client;
     private _Client;
-    constructor(application: Backend);
     /**
      * Storage client constructor.
      * (Currently Elasticsearch)
      *
      * @param clientConfig Overload configuration for the underlaying storage client
      */
-    get StorageClient(): new (clientConfig?: any) => Client;
+    get StorageClient(): new (clientConfig?: any) => any;
     /**
      * Access to the underlaying storage engine client.
      * (Currently Elasticsearch)
      */
-    get storageClient(): Client;
+    get storageClient(): any;
 }

package/lib/core/backend/backendStorage.js

@@ -19,16 +19,13 @@
  * 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.BackendStorage = void 0;
-const elasticsearch_1 = __importDefault(require("../../service/storage/elasticsearch"));
+const Elasticsearch_1 = require("../../service/storage/Elasticsearch");
 const index_1 = require("./index");
 class BackendStorage extends index_1.ApplicationManager {
-    constructor(application) {
-        super(application);
+    constructor() {
+        super(...arguments);
         this._client = null;
         this._Client = null;
     }
@@ -39,13 +36,13 @@ class BackendStorage extends index_1.ApplicationManager {
      * @param clientConfig Overload configuration for the underlaying storage client
      */
     get StorageClient() {
+        const kuzzle = this._kuzzle;
         if (!this._Client) {
-            const kuzzle = this._kuzzle;
             this._Client = function ESClient(clientConfig = {}) {
-                return elasticsearch_1.default.buildClient({
+                return Elasticsearch_1.Elasticsearch.buildClient({
                     ...kuzzle.config.services.storageEngine.client,
                     ...clientConfig,
-                });
+                }, kuzzle.config.services.storageEngine.majorVersion);
             };
         }
         return this._Client;
@@ -55,8 +52,9 @@ class BackendStorage extends index_1.ApplicationManager {
      * (Currently Elasticsearch)
      */
     get storageClient() {
+        const kuzzle = this._kuzzle;
         if (!this._client) {
-            this._client = elasticsearch_1.default.buildClient(this._kuzzle.config.services.storageEngine.client);
+            this._client = Elasticsearch_1.Elasticsearch.buildClient(kuzzle.config.services.storageEngine.client, kuzzle.config.services.storageEngine.majorVersion);
         }
         return this._client;
     }

package/lib/core/plugin/pluginContext.d.ts

@@ -1,6 +1,5 @@
-import { Client } from "@elastic/elasticsearch";
-import { JSONObject } from "kuzzle-sdk";
 import { Koncorde } from "../shared/KoncordeWrapper";
+import { JSONObject } from "kuzzle-sdk";
 import { KuzzleRequest, RequestContext, RequestInput } from "../../../index";
 import { Mutex } from "../../util/mutex";
 import { BackendCluster } from "../backend";
@@ -122,7 +121,7 @@ export declare class PluginContext {
         /**
          * Constructor for Elasticsearch SDK Client
          */
-        ESClient: typeof Client;
+        ESClient: new () => any;
     };
     /**
      * @deprecated import directly: `import { BadRequestError, ... } from 'kuzzle'`

package/lib/core/plugin/pluginContext.js

@@ -52,7 +52,7 @@ const KoncordeWrapper_1 = require("../shared/KoncordeWrapper");
 const index_1 = require("../../../index");
 const kerror = __importStar(require("../../kerror"));
 const errors_1 = require("../../kerror/errors");
-const elasticsearch_1 = __importDefault(require("../../service/storage/elasticsearch"));
+const Elasticsearch_1 = require("../../service/storage/Elasticsearch");
 const mutex_1 = require("../../util/mutex");
 const promback_1 = __importDefault(require("../../util/promback"));
 const safeObject_1 = require("../../util/safeObject");
@@ -111,9 +111,8 @@ class PluginContext {
                 update: (...args) => pluginRepository.update(...args),
             };
         }
-        // eslint-disable-next-line no-inner-declarations
         function PluginContextESClient() {
-            return elasticsearch_1.default.buildClient(global.kuzzle.config.services.storageEngine.client);
+            return Elasticsearch_1.Elasticsearch.buildClient(global.kuzzle.config.services.storageEngine.client);
         }
         this.constructors = {
             BaseValidationType: require("../validation/baseType"),
@@ -252,7 +251,10 @@ function instantiateRequest(request, data, options = {}) {
             target.input.jwt = _request.input.jwt;
         }
         if (_data) {
-            target.input.volatile = Object.assign({}, _request.input.volatile, _data.volatile);
+            target.input.volatile = {
+                ..._request.input.volatile,
+                ..._data.volatile,
+            };
         }
         else {
             target.input.volatile = _request.input.volatile;

package/lib/core/storage/clientAdapter.js

@@ -21,7 +21,7 @@
 
 "use strict";
 
-const Elasticsearch = require("../../service/storage/elasticsearch");
+const { Elasticsearch } = require("../../service/storage/Elasticsearch");
 const { IndexCache } = require("./indexCache");
 const { isPlainObject } = require("../../util/safeObject");
 const kerror = require("../../kerror");
@@ -38,16 +38,17 @@ class ClientAdapter {
    * @param {storeScopeEnum} scope
    */
   constructor(scope) {
-    this.client = new Elasticsearch(
+    this.es = new Elasticsearch(
       global.kuzzle.config.services.storageEngine,
       scope,
     );
+    this.client = this.es.client;
     this.scope = scope;
     this.cache = new IndexCache();
   }
 
   async init() {
-    await this.client.init();
+    await this.es.init();
     await this.populateCache();
 
     this.registerCollectionEvents();
@@ -202,6 +203,7 @@ class ClientAdapter {
      * @return {Promise}
      * @throws
      */
+
     global.kuzzle.onAsk(
       `core:storage:${this.scope}:collection:create`,
       (index, collection, opts, creationOptions) =>
@@ -454,7 +456,7 @@ class ClientAdapter {
      * @param {string} collection
      * @param {Object} query
      * @param {Object} [opts] -- see Elasticsearch "deleteByQuery" options
-     * @returns {Promise.<{ documents, total, deleted, failures: [ _shardId, reason ] }>}
+     * @returns {Promise.<{ documents, total, deleted, failures: [ id, reason ] }>}
      */
     global.kuzzle.onAsk(
       `core:storage:${this.scope}:document:deleteByQuery`,

package/lib/core/storage/storageEngine.js

@@ -21,8 +21,6 @@
 
 "use strict";
 
-const Bluebird = require("bluebird");
-
 const kerror = require("../../kerror").wrap("services", "storage");
 const ClientAdapter = require("./clientAdapter");
 const { storeScopeEnum } = require("./storeScopeEnum");
@@ -42,11 +40,12 @@ class StorageEngine {
    * @returns {Promise}
    */
   async init() {
-    await Bluebird.all([this.public.init(), this.private.init()]);
+    await Promise.all([this.public.init(), this.private.init()]);
 
-    const privateIndexes = await this.private.cache.listIndexes();
+    const privateIndexes = this.private.cache.listIndexes();
+    const publicIndexes = this.public.cache.listIndexes();
 
-    for (const publicIndex of await this.public.cache.listIndexes()) {
+    for (const publicIndex of publicIndexes) {
       if (privateIndexes.includes(publicIndex)) {
         throw kerror.get("index_already_exists", "public", publicIndex);
       }

package/lib/kuzzle/kuzzle.js

@@ -240,7 +240,7 @@ class Kuzzle extends kuzzleEventEmitter_1.default {
      * @returns {Promise<void>}
      */
     async install(installations) {
-        if (!installations || !installations.length) {
+        if (!installations?.length) {
             return;
         }
         const mutex = new mutex_1.Mutex("backend:installations");

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 = __importDefault(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,28 +97,9 @@ 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;
@@ -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 = [
   {