kuzzle 2.45.0 → 2.46.0-beta.1

package/check-node-version.js

@@ -13,5 +13,6 @@ if (!semver.satisfies(nodeVersion, version)) {
     "\x1b[31m%s\x1b[0m",
     `Required node version ${version} not satisfied with current version ${nodeVersion}`,
   );
+
   process.exit(1);
 }

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

@@ -133,6 +133,7 @@ export declare class Backend {
      *
      */
     _support: JSONObject;
+    private readonly nodeId;
     /**
      * Instantiates a new Kuzzle application
      *
@@ -170,10 +171,6 @@ export declare class Backend {
      * EmbeddedSDK instance
      */
     get sdk(): EmbeddedSDK;
-    /**
-     * Cluster node ID
-     */
-    get nodeId(): string;
     private get _instanceProxy();
     get started(): boolean;
     protected set started(started: boolean);

package/lib/core/backend/backend.js

@@ -51,7 +51,9 @@ const fs_1 = __importDefault(require("fs"));
 const kuzzle_1 = __importDefault(require("../../kuzzle"));
 const embeddedSdk_1 = require("../shared/sdk/embeddedSdk");
 const kerror = __importStar(require("../../kerror"));
-const index_1 = require("./index");
+const index_1 = require("../../../index");
+const index_2 = require("./index");
+const Logger_1 = require("../../kuzzle/Logger");
 const assertionError = kerror.wrap("plugin", "assert");
 const runtimeError = kerror.wrap("plugin", "runtime");
 let _app = null;
@@ -115,12 +117,21 @@ class Backend {
             throw assertionError.get("invalid_application_name", name);
         }
         this._name = name;
+        this.nodeId = index_1.NameGenerator.generateRandomName({ prefix: "knode" });
         Reflect.defineProperty(this, "_kuzzle", {
             writable: true,
         });
         Reflect.defineProperty(this, "_sdk", {
             writable: true,
         });
+        Reflect.defineProperty(global, "nodeId", {
+            get: () => {
+                return this.nodeId;
+            },
+            set: () => {
+                throw new Error("nodeId is read-only");
+            },
+        });
         /**
          * Set the "started" property in this event so developers can use runtime
          * features in pipes/hooks attached to this event.
@@ -138,18 +149,19 @@ class Backend {
             // Silent if no version can be found
         }
         global.app = this;
-        this.pipe = new index_1.BackendPipe(this);
-        this.hook = new index_1.BackendHook(this);
-        this.config = new index_1.BackendConfig(this);
-        this.vault = new index_1.BackendVault(this);
-        this.controller = new index_1.BackendController(this);
-        this.plugin = new index_1.BackendPlugin(this);
-        this.storage = new index_1.BackendStorage(this);
-        this.import = new index_1.BackendImport(this);
-        this.cluster = new index_1.BackendCluster();
-        this.openApi = new index_1.BackendOpenApi(this);
-        this.errors = new index_1.BackendErrors(this);
-        this.subscription = new index_1.BackendSubscription(this);
+        this.pipe = new index_2.BackendPipe(this);
+        this.hook = new index_2.BackendHook(this);
+        this.config = new index_2.BackendConfig(this);
+        this.vault = new index_2.BackendVault(this);
+        this.controller = new index_2.BackendController(this);
+        this.plugin = new index_2.BackendPlugin(this);
+        this.storage = new index_2.BackendStorage(this);
+        this.import = new index_2.BackendImport(this);
+        this.cluster = new index_2.BackendCluster();
+        this.openApi = new index_2.BackendOpenApi(this);
+        this.errors = new index_2.BackendErrors(this);
+        this.subscription = new index_2.BackendSubscription(this);
+        this.log = new Logger_1.Logger(this.config.content, "kuzzle:app");
         this.kerror = kerror;
         try {
             this.commit = this._readCommit();
@@ -166,7 +178,6 @@ class Backend {
             throw runtimeError.get("already_started", "start");
         }
         this._kuzzle = new kuzzle_1.default(this.config.content);
-        this.log = this._kuzzle.log.child(`app`);
         for (const plugin of this.config.content.plugins.common.include) {
             const { default: PluginClass } = await Promise.resolve(`${plugin}`).then(s => __importStar(require(s)));
             this.plugin.use(new PluginClass(), {
@@ -246,15 +257,6 @@ class Backend {
         }
         return this._sdk;
     }
-    /**
-     * Cluster node ID
-     */
-    get nodeId() {
-        if (!this.started) {
-            throw runtimeError.get("unavailable_before_start", "nodeId");
-        }
-        return this._kuzzle.id;
-    }
     get _instanceProxy() {
         return {
             api: this._controllers,

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

@@ -4,6 +4,7 @@ import { KuzzleRequest, RequestContext, RequestInput } from "../../../index";
 import { Mutex } from "../../util/mutex";
 import { BackendCluster } from "../backend";
 import { EmbeddedSDK } from "../shared/sdk/embeddedSdk";
+import { KuzzleLogger } from "kuzzle-logger/dist";
 export interface Repository {
     create(document: JSONObject, options: any): Promise<any>;
     createOrReplace(document: JSONObject, options: any): Promise<any>;
@@ -139,6 +140,10 @@ export declare class PluginContext {
      * Decrypted secrets from Kuzzle Vault
      */
     secrets: JSONObject;
+    /**
+     * Logger instance
+     */
+    logger: KuzzleLogger;
     /**
      * Internal Logger
      */

package/lib/core/plugin/pluginContext.js

@@ -125,14 +125,16 @@ class PluginContext {
             RequestInput: index_1.RequestInput,
         };
         Object.freeze(this.constructors);
+        this.logger = globalThis.kuzzle.log.child(`${pluginName}`);
         /* context.log ======================================================== */
+        // @deprecated backward compatibility only
         this.log = {
-            debug: (msg) => global.kuzzle.log.debug(`[${pluginName}] ${msg}`),
-            error: (msg) => global.kuzzle.log.error(`[${pluginName}] ${msg}`),
-            info: (msg) => global.kuzzle.log.info(`[${pluginName}] ${msg}`),
-            silly: (msg) => global.kuzzle.log.silly(`[${pluginName}] ${msg}`),
-            verbose: (msg) => global.kuzzle.log.verbose(`[${pluginName}] ${msg}`),
-            warn: (msg) => global.kuzzle.log.warn(`[${pluginName}] ${msg}`),
+            debug: (msg) => this.logger.debug(`[${pluginName}] ${msg}`),
+            error: (msg) => this.logger.error(`[${pluginName}] ${msg}`),
+            info: (msg) => this.logger.info(`[${pluginName}] ${msg}`),
+            silly: (msg) => this.logger.trace(`[${pluginName}] ${msg}`),
+            verbose: (msg) => this.logger.trace(`[${pluginName}] ${msg}`),
+            warn: (msg) => this.logger.warn(`[${pluginName}] ${msg}`),
         };
         Object.freeze(this.log);
         /* context.accessors ================================================== */

package/lib/kuzzle/Logger.d.ts

@@ -6,7 +6,7 @@ import { KuzzleConfiguration } from "../../";
 export declare class Logger extends KuzzleLogger {
     private warnedForSillyDeprecation;
     private warnedForVerboseDeprecation;
-    constructor(kuzzleConfig: KuzzleConfiguration);
+    constructor(kuzzleConfig: KuzzleConfiguration, namespace?: string);
     /**
      * Logs a message with the "silly" level.
      *

package/lib/kuzzle/Logger.js

@@ -26,15 +26,18 @@ const kuzzle_logger_1 = require("kuzzle-logger");
  * The Logger class provides logging functionality for Kuzzle.
  */
 class Logger extends kuzzle_logger_1.KuzzleLogger {
-    constructor(kuzzleConfig) {
+    constructor(kuzzleConfig, namespace = "kuzzle") {
         const config = kuzzleConfig.server.appLogs;
         const deprecatedConfig = kuzzleConfig.plugins["kuzzle-plugin-logger"];
         const getMergingObject = () => {
             const mergingObject = {};
-            mergingObject.namespace = "kuzzle";
+            mergingObject.namespace = namespace;
             mergingObject.failsafeMode = Boolean(kuzzleConfig.plugins.common.failsafeMode);
-            if (global.kuzzle.id) {
-                mergingObject.nodeId = global.kuzzle.id;
+            if (global.nodeId) {
+                mergingObject.nodeId = global.nodeId;
+            }
+            if (namespace !== "kuzzle") {
+                return mergingObject;
             }
             if (global.kuzzle.asyncStore?.exists() &&
                 global.kuzzle.asyncStore?.has("REQUEST")) {
@@ -74,9 +77,6 @@ class Logger extends kuzzle_logger_1.KuzzleLogger {
         if (deprecatedConfig) {
             this.warn("[DEPRECATED] The plugins.kuzzle-plugin-logger configuration is deprecated, use server.logs instead.");
         }
-        global.kuzzle.onPipe("kuzzle:shutdown", async () => {
-            await this.flush();
-        });
     }
     /**
      * Logs a message with the "silly" level.

package/lib/kuzzle/kuzzle.js

@@ -73,7 +73,6 @@ const kerror = __importStar(require("../kerror"));
 const asyncStore_1 = __importDefault(require("../util/asyncStore"));
 const crypto_1 = require("../util/crypto");
 const mutex_1 = require("../util/mutex");
-const name_generator_1 = require("../util/name-generator");
 const dumpGenerator_1 = __importDefault(require("./dumpGenerator"));
 const KuzzleEventEmitter_1 = __importDefault(require("./event/KuzzleEventEmitter"));
 const internalIndexHandler_1 = __importDefault(require("./internalIndexHandler"));
@@ -152,7 +151,7 @@ class Kuzzle extends KuzzleEventEmitter_1.default {
             await this.internalIndex.init();
             await new security_1.default().init();
             // This will init the cluster module if enabled
-            this.id = await this.initKuzzleNode();
+            await this.initKuzzleNode();
             this.vault = vault_1.default.load(options.vaultKey, options.secretsFile);
             await this.validation.init();
             await this.tokenManager.init();
@@ -180,7 +179,7 @@ class Kuzzle extends KuzzleEventEmitter_1.default {
             await this.pipe("kuzzle:state:live");
             await this.entryPoint.startListening();
             await this.pipe("kuzzle:state:ready");
-            this.log.info(`[✔] Kuzzle ${this.version} is ready (node name: ${this.id})`);
+            this.log.info(`[✔] Kuzzle ${this.version} is ready (node name: ${global.nodeId})`);
             // @deprecated
             this.emit("core:kuzzleStart", "Kuzzle is ready to accept requests");
             this._state = kuzzleStateEnum_1.default.RUNNING;
@@ -196,16 +195,13 @@ class Kuzzle extends KuzzleEventEmitter_1.default {
      * This will init the cluster if it's enabled.
      */
     async initKuzzleNode() {
-        let id;
         if (this.config.cluster.enabled) {
-            id = await new cluster_1.default().init();
+            await new cluster_1.default().init();
             this.log.info("[✔] Cluster initialized");
         }
         else {
-            id = name_generator_1.NameGenerator.generateRandomName({ prefix: "knode" });
             this.log.info("[X] Cluster disabled: single node mode.");
         }
-        return id;
     }
     /**
      * Gracefully exits after processing remaining requests
@@ -225,6 +221,9 @@ class Kuzzle extends KuzzleEventEmitter_1.default {
             await bluebird_1.default.delay(1000);
         }
         this.log.info("Halted.");
+        // flush both application and Kuzzle core loggers before leaving (Could happen even if some core/application components are not initialized)
+        await this?.log?.flush?.();
+        await this?.pluginsManager?.application?.log?.flush?.();
         process.exit(0);
     }
     /**

package/lib/service/storage/7/elasticsearch.js

@@ -2329,6 +2329,9 @@ class ES7 {
     _processExtract(prepareMUpsert, prepareMGet, metadata, document, extractedDocuments, documentsToGet) {
         let extractedDocument;
         if (prepareMUpsert) {
+            if (document.changes !== undefined && document.changes !== null) {
+                delete document.changes._kuzzle_info;
+            }
             extractedDocument = {
                 _source: {
                     // Do not use destructuring, it's 10x slower
@@ -2338,6 +2341,9 @@ class ES7 {
             };
         }
         else {
+            if (document.body !== undefined && document.body !== null) {
+                delete document.body._kuzzle_info;
+            }
             extractedDocument = {
                 // Do not use destructuring, it's 10x slower
                 _source: Object.assign({}, metadata, document.body),

package/lib/service/storage/8/elasticsearch.js

@@ -2322,6 +2322,9 @@ class ES8 {
     _processExtract(prepareMUpsert, prepareMGet, metadata, document, extractedDocuments, documentsToGet) {
         let extractedDocument;
         if (prepareMUpsert) {
+            if (document.changes !== undefined && document.changes !== null) {
+                delete document.changes._kuzzle_info;
+            }
             extractedDocument = {
                 _source: {
                     // Do not use destructuring, it's 10x slower
@@ -2331,6 +2334,9 @@ class ES8 {
             };
         }
         else {
+            if (document.body !== undefined && document.body !== null) {
+                delete document.body._kuzzle_info;
+            }
             extractedDocument = {
                 // Do not use destructuring, it's 10x slower
                 _source: Object.assign({}, metadata, document.body),

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
-  "version": "2.45.0",
+  "version": "2.46.0-beta.1",
   "description": "Kuzzle is an open-source solution that handles all the data management through a secured API, with a large choice of protocols.",
   "bin": "bin/start-kuzzle-server",
   "scripts": {
@@ -33,21 +33,21 @@
     "bluebird": "3.7.2",
     "cli-color": "2.0.4",
     "cookie": "1.0.2",
-    "debug": "4.4.1",
+    "debug": "4.4.3",
     "denque": "2.1.0",
     "didyoumean": "1.2.2",
     "dumpme": "2.0.0",
     "eventemitter3": "5.0.1",
-    "inquirer": "12.8.2",
-    "ioredis": "5.6.1",
+    "inquirer": "12.9.6",
+    "ioredis": "5.8.0",
     "js-yaml": "4.1.0",
     "json-stable-stringify": "1.3.0",
     "json2yaml": "1.1.0",
     "jsonwebtoken": "9.0.2",
     "koncorde": "4.6.0",
-    "kuzzle-logger": "1.3.0",
+    "kuzzle-logger": "1.4.0",
     "kuzzle-plugin-auth-passport-local": "6.4.1",
-    "kuzzle-sdk": ">=7.15.0",
+    "kuzzle-sdk": ">=7.15.1",
     "kuzzle-vault": "2.1.0",
     "lodash": "4.17.21",
     "long": "5.3.2",
@@ -59,9 +59,9 @@
     "pino-caller": "4.0.0",
     "pino-elasticsearch": "8.1.0",
     "pino-loki": "2.6.0",
-    "pino-pretty": "13.0.0",
+    "pino-pretty": "13.1.1",
     "pino-transport-ecs": "1.1.0",
-    "protobufjs": "7.5.3",
+    "protobufjs": "7.5.4",
     "rc": "1.2.8",
     "sdk-es7": "npm:@elastic/elasticsearch@7.13.0",
     "sdk-es8": "npm:@elastic/elasticsearch@8.17.1",
@@ -82,9 +82,9 @@
     "url": "git://github.com/kuzzleio/kuzzle.git"
   },
   "devDependencies": {
-    "@commitlint/cli": "19.8.1",
-    "@commitlint/config-conventional": "19.8.1",
-    "@jest/globals": "30.0.5",
+    "@commitlint/cli": "20.0.0",
+    "@commitlint/config-conventional": "20.0.0",
+    "@jest/globals": "30.1.2",
     "@types/bluebird": "3.5.42",
     "@types/cookie": "1.0.0",
     "@types/jest": "30.0.0",
@@ -96,10 +96,10 @@
     "cucumber": "6.0.7",
     "cz-conventional-changelog": "3.3.0",
     "eslint-plugin-kuzzle": "0.0.14",
-    "jest": "30.0.5",
-    "mocha": "11.7.1",
+    "jest": "30.1.3",
+    "mocha": "11.7.2",
     "mock-require": "3.0.3",
-    "mqtt": "5.13.3",
+    "mqtt": "5.14.1",
     "nyc": "17.1.0",
     "request": "2.88.2",
     "request-promise": "4.2.6",
@@ -109,16 +109,16 @@
     "should-sinon": "0.0.6",
     "sinon": "21.0.0",
     "strip-json-comments": "https://github.com/sindresorhus/strip-json-comments/archive/refs/tags/v3.1.1.tar.gz",
-    "ts-jest": "29.4.0",
+    "ts-jest": "29.4.4",
     "ts-node": "10.9.2",
-    "tsx": "4.20.3",
-    "typescript": "5.3.2",
-    "yaml": "2.8.0"
+    "tsx": "4.20.6",
+    "typescript": "5.4.5",
+    "yaml": "2.8.1"
   },
   "engines": {
     "node": ">=18.0.0 <23.0.0"
   },
-  "packageManager": "npm@11.4.2",
+  "packageManager": "npm@11.6.1",
   "engineStrict": true,
   "license": "Apache-2.0",
   "files": [