kuzzle 2.30.1-beta.1 → 2.31.0-elasticsearch-8.2

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/api/controllers/memoryStorageController.js

@@ -267,15 +267,11 @@ function initMapping() {
           kassert.assertBodyAttributeType(request, "entries", "array");
 
           val.forEach((v) => {
-            if (
-              typeof v !== "object" ||
-              !v.field ||
-              (!v.value && v.value !== 0)
-            ) {
+            if (typeof v !== "object" || !v.field || !v.value) {
               throw kerror.get(
                 "invalid_argument",
                 "entries",
-                "<array of objects>",
+                "<array of object>",
               );
             }
 
@@ -352,11 +348,7 @@ function initMapping() {
           kassert.assertBodyHasAttribute(request, "entries");
           kassert.assertBodyAttributeType(request, "entries", "array");
           val.forEach((entry) => {
-            if (
-              typeof entry !== "object" ||
-              !entry.key ||
-              (!entry.value && entry.value !== 0)
-            ) {
+            if (typeof entry !== "object" || !entry.key || !entry.value) {
               throw kerror.get(
                 "invalid_argument",
                 "entries",

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/security/profileRepository.d.ts

@@ -29,6 +29,7 @@ type UpdateOptions = {
  */
 export declare class ProfileRepository extends ObjectRepository<Profile> {
     private module;
+    private profiles;
     /**
      * @constructor
      */
@@ -41,9 +42,7 @@ export declare class ProfileRepository extends ObjectRepository<Profile> {
      * @returns {Promise.<Promise>}
      * @throws {NotFoundError} If the corresponding profile doesn't exist
      */
-    load(id: string, options?: {
-        key?: string;
-    }): Promise<Profile>;
+    load(id: string): Promise<Profile>;
     /**
      * Loads a Profile object given its id.
      * Stores the promise of the profile being loaded in the memcache
@@ -141,6 +140,16 @@ export declare class ProfileRepository extends ObjectRepository<Profile> {
      * @returns {Promise<Profile>}
      */
     fromDTO(dto: JSONObject): Promise<Profile>;
+    /**
+     * @override
+     */
+    truncate(opts: JSONObject): Promise<void>;
+    /**
+     * Invalidate the cache entries for the given profile. If none is provided,
+     * the entire cache is emptied.
+     * @param {string} [profileId]
+     */
+    invalidate(profileId?: string): void;
     /**
      * Optimize each policy to get a O(1) index access time
      * and a O(log(n)) collection search time.
@@ -159,8 +168,8 @@ export declare class ProfileRepository extends ObjectRepository<Profile> {
      * @param policy
      */
     private optimizePolicy;
-    toDTO(dto: Profile): JSONObject;
-    deleteFromDatabase(id: string, options: JSONObject): any;
+    toDTO(dto: Profile): Promise<JSONObject>;
+    deleteFromDatabase(id: string, options: JSONObject): Promise<any>;
     search(searchBody: JSONObject, options: JSONObject): Promise<{
         aggregations: any;
         hits: any[];

package/lib/core/security/profileRepository.js

@@ -51,6 +51,7 @@ const bluebird_1 = __importDefault(require("bluebird"));
 const lodash_1 = require("lodash");
 const kerror = __importStar(require("../../kerror"));
 const profile_1 = require("../../model/security/profile");
+const cacheDbEnum_1 = require("../cache/cacheDbEnum");
 const ObjectRepository_1 = require("../shared/ObjectRepository");
 /**
  * @class ProfileRepository
@@ -61,8 +62,12 @@ class ProfileRepository extends ObjectRepository_1.ObjectRepository {
      * @constructor
      */
     constructor(securityModule) {
-        super({ store: global.kuzzle.internalIndex });
+        super({
+            cache: cacheDbEnum_1.cacheDbEnum.NONE,
+            store: global.kuzzle.internalIndex,
+        });
         this.module = securityModule;
+        this.profiles = new Map();
         this.collection = "profiles";
         this.ObjectConstructor = profile_1.Profile;
     }
@@ -106,7 +111,7 @@ class ProfileRepository extends ObjectRepository_1.ObjectRepository {
          *
          * @param  {String} [id] - profile identifier
          */
-        global.kuzzle.onAsk("core:security:profile:invalidate", (id) => this.deleteFromCache(id));
+        global.kuzzle.onAsk("core:security:profile:invalidate", (id) => this.invalidate(id));
         /**
          * Gets multiple profiles
          * @param  {Array} ids
@@ -151,18 +156,13 @@ class ProfileRepository extends ObjectRepository_1.ObjectRepository {
      * @returns {Promise.<Promise>}
      * @throws {NotFoundError} If the corresponding profile doesn't exist
      */
-    async load(id, options = {}) {
-        const profile = await this.loadFromCache(id, options);
-        if (profile === null) {
-            const profileFromDatabase = await this.loadOneFromDatabase(id);
-            if (profileFromDatabase !== null) {
-                await this.persistToCache(profileFromDatabase);
-                profileFromDatabase.optimizedPolicies = this.optimizePolicies(profileFromDatabase.policies);
-            }
-            return profileFromDatabase;
+    async load(id) {
+        if (this.profiles.has(id)) {
+            return this.profiles.get(id);
         }
+        const profile = await super.load(id);
         profile.optimizedPolicies = this.optimizePolicies(profile.policies);
-        await this.refreshCacheTTL(profile);
+        this.profiles.set(id, profile);
         return profile;
     }
     /**
@@ -185,7 +185,14 @@ class ProfileRepository extends ObjectRepository_1.ObjectRepository {
             throw kerror.get("api", "assert", "invalid_type", "profileIds", "string[]");
         }
         for (const id of profileIds) {
-            const profile = this.load(id);
+            let profile = this.profiles.get(id);
+            if (!profile) {
+                profile = this.loadOneFromDatabase(id).then((p) => {
+                    p.optimizedPolicies = this.optimizePolicies(p.policies);
+                    this.profiles.set(id, p);
+                    return p;
+                });
+            }
             profiles.push(profile);
         }
         return bluebird_1.default.all(profiles);
@@ -335,7 +342,7 @@ class ProfileRepository extends ObjectRepository_1.ObjectRepository {
             }
         }
         await this.deleteFromDatabase(profile._id, { refresh });
-        await this.deleteFromCache(profile._id);
+        this.profiles.delete(profile._id);
     }
     /**
      * From a Profile object, returns a serialized object ready to be persisted
@@ -377,9 +384,9 @@ class ProfileRepository extends ObjectRepository_1.ObjectRepository {
             retryOnConflict,
         });
         const updatedProfile = await this.loadOneFromDatabase(profile._id);
-        await this.persistToCache(updatedProfile);
         // Recompute optimized policies based on new policies
         updatedProfile.optimizedPolicies = this.optimizePolicies(updatedProfile.policies);
+        this.profiles.set(profile._id, updatedProfile);
         return updatedProfile;
     }
     /**
@@ -403,6 +410,32 @@ class ProfileRepository extends ObjectRepository_1.ObjectRepository {
         }
         return profile;
     }
+    /**
+     * @override
+     */
+    async truncate(opts) {
+        try {
+            await super.truncate(opts);
+        }
+        finally {
+            // always clear the RAM cache: even if truncate fails in the middle of it,
+            // some of the cached profiles might not be valid anymore
+            this.invalidate();
+        }
+    }
+    /**
+     * Invalidate the cache entries for the given profile. If none is provided,
+     * the entire cache is emptied.
+     * @param {string} [profileId]
+     */
+    invalidate(profileId) {
+        if (!profileId) {
+            this.profiles.clear();
+        }
+        else {
+            this.profiles.delete(profileId);
+        }
+    }
     /**
      * Optimize each policy to get a O(1) index access time
      * and a O(log(n)) collection search time.
@@ -463,10 +496,10 @@ class ProfileRepository extends ObjectRepository_1.ObjectRepository {
     // Every method described after are for testing purpose only
     // Otherwise we cannot stub them
     // ============================================
-    toDTO(dto) {
+    async toDTO(dto) {
         return super.toDTO(dto);
     }
-    deleteFromDatabase(id, options) {
+    async deleteFromDatabase(id, options) {
         return super.deleteFromDatabase(id, options);
     }
     async search(searchBody, options) {

package/lib/core/security/roleRepository.js

@@ -43,7 +43,7 @@ class RoleRepository extends ObjectRepository {
    */
   constructor(securityModule) {
     super({
-      cache: cacheDbEnum.INTERNAL,
+      cache: cacheDbEnum.NONE,
       store: global.kuzzle.internalIndex,
     });
 

package/lib/core/shared/ObjectRepository.js

@@ -127,7 +127,7 @@ class ObjectRepository {
         let response;
         try {
             response = await global.kuzzle.ask(`core:cache:${this.cacheDb}:get`, key);
-            if (response === null || response === undefined) {
+            if (response === null) {
                 return null;
             }
             return await this.fromDTO({ ...JSON.parse(response) });

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;
 }