kuzzle 2.59.0 → 2.60.0-beta.2

package/dist/lib/api/request/requestResponse.js

@@ -35,13 +35,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RequestResponse = exports.Headers = void 0;
 const assert = __importStar(require("../../util/assertType"));
@@ -72,11 +82,11 @@ class Headers {
         if (typeof name === "symbol") {
             return this.headers[name];
         }
-        assert.assertString("header name", name);
-        if (!name) {
+        const header = assert.assertString("header name", name);
+        if (!header) {
             return;
         }
-        const storedName = this.namesMap.get(name.toLowerCase());
+        const storedName = this.namesMap.get(header.toLowerCase());
         return storedName === undefined ? undefined : this.headers[storedName];
     }
     removeHeader(name) {
@@ -239,6 +249,7 @@ class RequestResponse {
     /**
      * Request result
      */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any -- kept for v2 compatibility, see docs/v3-breaking-changes.md
     get result() {
         return this[_request].result;
     }

package/dist/lib/cluster/command.d.ts

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import Long from "long";
 import type { SerializedState } from "./state";
 import type { Activity, Decoded, FullStateResponse, HandshakeResponse } from "./protobuf/commandMessages";

package/dist/lib/cluster/command.js

@@ -35,13 +35,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };

package/dist/lib/cluster/idCardHandler.d.ts

@@ -1,4 +1,5 @@
 import "../types";
+import type ClusterNode from "./node";
 export type SerializedIdCard = {
     id: string;
     ip: string;
@@ -41,7 +42,7 @@ export declare class ClusterIdCardHandler {
     /**
      * Node instance. Represents the local node.
      */
-    private node;
+    private readonly node;
     /**
      * Local node ID Card
      */
@@ -85,7 +86,7 @@ export declare class ClusterIdCardHandler {
      */
     private disposed;
     private readonly logger;
-    constructor(node: any);
+    constructor(node: ClusterNode);
     /**
      * Generates and reserves a unique ID for this node instance.
      * Makes sure that the ID is not already taken by another node instance.

package/dist/lib/cluster/idCardHandler.js

@@ -207,7 +207,7 @@ class ClusterIdCardHandler {
         // this method runs on the line after it is filled.
         refreshWorker.on("message", ({ initialized }) => {
             if (initialized) {
-                clearInterval(this.refreshTimer);
+                clearInterval(this.refreshTimer ?? undefined);
                 this.refreshTimer = null;
             }
         });

package/dist/lib/cluster/node.js

@@ -40,10 +40,7 @@ const long_1 = __importDefault(require("long"));
 const kuzzleStateEnum_1 = __importDefault(require("../kuzzle/kuzzleStateEnum"));
 const debug_1 = __importDefault(require("../util/debug"));
 const koncordeCompat_1 = require("../util/koncordeCompat");
-// NOSONAR: `Mutex` is deprecated in favour of `withLock`, but the two use
-// incompatible acquisition/TTL formats and must not contend on the same key —
-// every node takes "clusterHandshake" with `Mutex`. Deferred to #2894.
-const mutex_1 = require("../util/mutex"); // NOSONAR
+const distributedLock_1 = require("../util/distributedLock");
 const command_1 = __importDefault(require("./command"));
 const idCardHandler_1 = require("./idCardHandler");
 const publisher_1 = __importDefault(require("./publisher"));
@@ -563,72 +560,80 @@ class ClusterNode {
             this.logger.error(`[CLUSTER] Failed to join the cluster: timed out (joinTimeout: ${this.config.joinTimeout}ms)`);
             global.kuzzle.shutdown();
         }, this.config.joinTimeout);
-        // NOSONAR (S1874): same deferral as the import above — every node takes
-        // "clusterHandshake" with `Mutex`, so converting one site to `withLock`
-        // would remove the exclusion it exists for. #2894.
-        const lockOptions = { timeout: this.config.joinTimeout };
-        const mutex = new mutex_1.Mutex("clusterHandshake", lockOptions); // NOSONAR
+        // No retry limit: the handshakes are taken one at a time, and the
+        // `joinTimeout` above is what gives up on a cluster that never lets this
+        // node in.
         try {
-            await mutex.lock();
-            // Create the ID Key AFTER the handshake mutex is actually locked,
-            // to prevent race conditions (other nodes attempting to connect to this
-            // node while it's still initializing)
-            await this.idCardHandler.createIdCard();
-            debug("[CLUSTER] ID Card created");
-            const nodeId = this.idCardHandler.nodeId;
-            (0, assert_1.default)(nodeId !== null, "[CLUSTER] createIdCard() returned without reserving a node id");
-            this.nodeId = nodeId;
-            await this.startHeartbeat(); // NOSONAR: TD-26
-            debug("[CLUSTER] Start heartbeat");
-            let retried = false;
-            let fullState = null;
-            let nodes;
-            debug("[CLUSTER] Start retrieving full state..");
-            do {
-                nodes = await this.idCardHandler.getRemoteIdCards();
-                debug("[CLUSTER] %s remote nodes discovered", nodes.length);
-                // No other nodes detected = no handshake required
-                if (nodes.length === 0) {
-                    this.trackActivity(this.nodeId, this.ip, nodeActivityEnum.ADDED);
-                    return;
-                }
-                // Verify that no other node share the same IP address as this one
-                const duplicate = nodes.filter((node) => node.ip === this.ip);
-                if (duplicate.length > 0) {
-                    this.logger.error(`[CLUSTER] Another node share the same IP address as this one (${this.ip}): ${duplicate[0]?.id}. Shutting down.`);
-                    global.kuzzle.shutdown();
-                    return;
-                }
-                await this.subscribeToNodes(nodes);
-                debug("[CLUSTER] Successfully subscribed to nodes");
-                fullState = await this.command.getFullState(nodes);
-                if (fullState === null) {
-                    if (!(await this.retryFullState(retried))) {
+            await (0, distributedLock_1.withLock)("clusterHandshake", async () => {
+                // Create the ID Key AFTER the handshake lock is actually taken,
+                // to prevent race conditions (other nodes attempting to connect to this
+                // node while it's still initializing)
+                await this.idCardHandler.createIdCard();
+                debug("[CLUSTER] ID Card created");
+                const nodeId = this.idCardHandler.nodeId;
+                (0, assert_1.default)(nodeId !== null, "[CLUSTER] createIdCard() returned without reserving a node id");
+                this.nodeId = nodeId;
+                await this.startHeartbeat(); // NOSONAR: TD-26
+                debug("[CLUSTER] Start heartbeat");
+                let retried = false;
+                let fullState;
+                let nodes;
+                debug("[CLUSTER] Start retrieving full state..");
+                do {
+                    nodes = await this.idCardHandler.getRemoteIdCards();
+                    debug("[CLUSTER] %s remote nodes discovered", nodes.length);
+                    // No other nodes detected = no handshake required
+                    if (nodes.length === 0) {
+                        this.trackActivity(this.nodeId, this.ip, nodeActivityEnum.ADDED);
                         return;
                     }
-                    retried = true;
-                }
-            } while (fullState === null);
-            debug("[CLUSTER] Fullstate retrieved, loading into node..");
-            await this.fullState.loadFullState(fullState); // NOSONAR: TD-26
-            this.activity = fullState.activity ? fullState.activity : this.activity;
-            debug("[CLUSTER] Fullstate loaded.");
-            const handshakeResponses = await this.command.broadcastHandshake(nodes);
-            debug("[CLUSTER] Successful handshakes with other nodes.");
-            await this.syncWithPeers(handshakeResponses, fullState);
-            // `createIdCard()` adopts `global.nodeId`, so these are normally the same
-            // string and the line reads as one name (TD-59, #2764). They still differ
-            // in the two cases the adoption cannot cover — a stale IdCard holding the
-            // key, and a Kuzzle running without a Backend — and those are exactly the
-            // cases where a reader needs to be told, so the line says both.
-            this.logger.info(global.nodeId && global.nodeId !== this.nodeId
-                ? `[CLUSTER] Successfully joined the cluster as "${this.nodeId}" (process node id: ${global.nodeId}).`
-                : `[CLUSTER] Successfully joined the cluster as "${this.nodeId}".`);
-            this.trackActivity(this.nodeId, this.ip, nodeActivityEnum.ADDED);
+                    // Verify that no other node share the same IP address as this one
+                    const duplicate = nodes.filter((node) => node.ip === this.ip);
+                    if (duplicate.length > 0) {
+                        this.logger.error(`[CLUSTER] Another node share the same IP address as this one (${this.ip}): ${duplicate[0]?.id}. Shutting down.`);
+                        global.kuzzle.shutdown();
+                        return;
+                    }
+                    await this.subscribeToNodes(nodes);
+                    debug("[CLUSTER] Successfully subscribed to nodes");
+                    fullState = await this.command.getFullState(nodes);
+                    if (fullState === null) {
+                        if (!(await this.retryFullState(retried))) {
+                            return;
+                        }
+                        retried = true;
+                    }
+                } while (fullState === null);
+                debug("[CLUSTER] Fullstate retrieved, loading into node..");
+                await this.fullState.loadFullState(fullState); // NOSONAR: TD-26
+                this.activity = fullState.activity ?? this.activity;
+                debug("[CLUSTER] Fullstate loaded.");
+                const handshakeResponses = await this.command.broadcastHandshake(nodes);
+                debug("[CLUSTER] Successful handshakes with other nodes.");
+                await this.syncWithPeers(handshakeResponses, fullState);
+                // `createIdCard()` adopts `global.nodeId`, so these are normally the same
+                // string and the line reads as one name (TD-59, #2764). They still differ
+                // in the two cases the adoption cannot cover — a stale IdCard holding the
+                // key, and a Kuzzle running without a Backend — and those are exactly the
+                // cases where a reader needs to be told, so the line says both.
+                this.logger.info(global.nodeId && global.nodeId !== this.nodeId
+                    ? `[CLUSTER] Successfully joined the cluster as "${this.nodeId}" (process node id: ${global.nodeId}).`
+                    : `[CLUSTER] Successfully joined the cluster as "${this.nodeId}".`);
+                this.trackActivity(this.nodeId, this.ip, nodeActivityEnum.ADDED);
+            }, { retryAttempts: Number.POSITIVE_INFINITY });
+        }
+        catch (error) {
+            // The handshake cannot be stopped where it is: it may still introduce
+            // this node to the others. Leave the cluster rather than stay in it
+            // half-joined, whatever the application does with the failed startup.
+            if (error instanceof distributedLock_1.MutexLockLostError) {
+                this.logger.error("[CLUSTER] Lost the handshake lock while joining the cluster. Shutting down.");
+                void global.kuzzle.shutdown();
+            }
+            throw error;
         }
         finally {
             clearTimeout(handshakeTimeout);
-            await mutex.unlock();
         }
     }
     /**

package/dist/lib/cluster/protobuf/command.proto

@@ -1,5 +1,6 @@
 // messages definition for issuing node commands and receiving the
 // corresponding responses
+// /!\ Every singular scalar field is "optional": see sync.proto's header.
 package command;
 
 syntax="proto3";
@@ -10,36 +11,36 @@ import "sync.proto";
 message FullStateResponse {
   // Describes the nodes that have subscribed to a given realtime room
   message NodeSubscribers {
-    string nodeId = 1;
-    uint32 subscribers = 2;
-    uint64 messageId = 3;
+    optional string nodeId = 1;
+    optional uint32 subscribers = 2;
+    optional uint64 messageId = 3;
   }
 
   // Describes a realtime room
   message RealtimeRoom {
-    string roomId = 1;
-    string index = 2;
-    string collection = 3;
+    optional string roomId = 1;
+    optional string index = 2;
+    optional string collection = 3;
 
     // array of polymorphic objects, needs to be stringified beforehand until
     // this PR is merged: https://github.com/protobufjs/protobuf.js/pull/1495
-    string filters = 4;
+    optional string filters = 4;
 
     repeated NodeSubscribers nodes = 5;
   }
 
   // Describes a cluster activity event
   message Activity {
-    string id = 1;
-    string date = 2;
-    string address = 3;
-    uint32 event = 4;
+    optional string id = 1;
+    optional string date = 2;
+    optional string address = 3;
+    optional uint32 event = 4;
     optional string reason = 5;
   }
 
   message NodeState {
-    string id = 1;
-    uint64 lastMessageId = 2;
+    optional string id = 1;
+    optional uint64 lastMessageId = 2;
   }
 
   repeated RealtimeRoom rooms = 1;
@@ -50,30 +51,30 @@ message FullStateResponse {
 
 // Handshake Request
 message HandshakeRequest {
-  string nodeId = 1;
-  uint64 lastMessageId = 2;
-  string ip = 3;
+  optional string nodeId = 1;
+  optional uint64 lastMessageId = 2;
+  optional string ip = 3;
 }
 
 // Handshake response
 message HandshakeResponse {
-  bool added = 1;
-  uint64 lastMessageId = 2;
+  optional bool added = 1;
+  optional uint64 lastMessageId = 2;
 }
 
 // Retransmit request: the messages a subscriber missed from this node's sync
 // stream, by message id, both ends included (#2785)
 message RetransmitRequest {
-  uint64 from = 1;
-  uint64 to = 2;
+  optional uint64 from = 1;
+  optional uint64 to = 2;
 }
 
 // Retransmit response: the missed messages, in order, exactly as they were
 // published (topic + encoded sync message)
 message RetransmitResponse {
   message Frame {
-    string topic = 1;
-    bytes data = 2;
+    optional string topic = 1;
+    optional bytes data = 2;
   }
 
   repeated Frame frames = 1;

package/dist/lib/cluster/protobuf/sync.proto

@@ -1,107 +1,113 @@
 // sync messages definitions
 // /!\ ALL messages must have a "messageId" property
+// /!\ Every singular scalar field is "optional": protobufjs 8 otherwise drops a
+//     field holding its default value ("", 0, false) on encode and in
+//     toObject(), where protobufjs 7 kept it. "optional" keeps the bytes and
+//     the decoded objects identical between both versions, which a cluster
+//     mixing them during a rolling upgrade relies on. Declare new fields the
+//     same way (tests/cluster/protobufWireCompat.test.ts checks the result).
 package sync;
 
 syntax="proto3";
 
 message Heartbeat {
-  uint64 messageId = 1;
-  string address = 2;
+  optional uint64 messageId = 1;
+  optional string address = 2;
 }
 
 message NodeEvicted {
-  uint64 messageId = 1;
-  string nodeId = 2;
-  string reason = 3;
-  string evictor = 4;
+  optional uint64 messageId = 1;
+  optional string nodeId = 2;
+  optional string reason = 3;
+  optional string evictor = 4;
 }
 
 message NodeShutdown {
-  uint64 messageId = 1;
-  string nodeId = 2;
+  optional uint64 messageId = 1;
+  optional string nodeId = 2;
 }
 
 message NodePreventEviction {
-  uint64 messageId = 1;
-  bool evictionPrevented = 2;
+  optional uint64 messageId = 1;
+  optional bool evictionPrevented = 2;
 }
 
 message NewRealtimeRoom {
-  uint64 messageId = 1;
-  string index = 2;
-  string id = 3;
+  optional uint64 messageId = 1;
+  optional string index = 2;
+  optional string id = 3;
 
   // serialized JSON
-  string filter = 4;
+  optional string filter = 4;
 }
 
 message RemoveRealtimeRoom {
-  uint64 messageId = 1;
-  string roomId = 2;
+  optional uint64 messageId = 1;
+  optional string roomId = 2;
 }
 
 message Subscription {
-  uint64 messageId = 1;
-  string roomId = 2;
+  optional uint64 messageId = 1;
+  optional string roomId = 2;
 }
 
 message Unsubscription {
-  uint64 messageId = 1;
-  string roomId = 2;
+  optional uint64 messageId = 1;
+  optional string roomId = 2;
 }
 
 message DocumentNotification {
-  uint64 messageId = 1;
+  optional uint64 messageId = 1;
   repeated string rooms = 2;
-  uint32 status = 3;
-  string requestId = 4;
-  uint64 timestamp = 5;
-  string index = 6;
-  string collection = 7;
-  string controller = 8;
-  string action = 9;
-  string protocol = 10;
-  string scope = 11;
+  optional uint32 status = 3;
+  optional string requestId = 4;
+  optional uint64 timestamp = 5;
+  optional string index = 6;
+  optional string collection = 7;
+  optional string controller = 8;
+  optional string action = 9;
+  optional string protocol = 10;
+  optional string scope = 11;
 
   // serialized JSON
-  string volatile = 12;
-  string result = 13;
+  optional string volatile = 12;
+  optional string result = 13;
 }
 
 message UserNotification {
-  uint64 messageId = 1;
-  string room = 2;
-  uint32 status = 3;
-  uint64 timestamp = 4;
-  string index = 5;
-  string collection = 6;
-  string controller = 7;
-  string action = 8;
-  string protocol = 9;
-  string user = 10;
+  optional uint64 messageId = 1;
+  optional string room = 2;
+  optional uint32 status = 3;
+  optional uint64 timestamp = 4;
+  optional string index = 5;
+  optional string collection = 6;
+  optional string controller = 7;
+  optional string action = 8;
+  optional string protocol = 9;
+  optional string user = 10;
 
   // serialized JSON
-  string volatile = 11;
-  string result = 12;
+  optional string volatile = 11;
+  optional string result = 12;
 }
 
 message NewAuthStrategy {
   message AuthStrategyConfig {
-    string authenticator = 1;
+    optional string authenticator = 1;
     repeated string fields = 2;
 
     // serialized JSON
-    string authenticateOptions = 3;
-    string strategyOptions = 4;
+    optional string authenticateOptions = 3;
+    optional string strategyOptions = 4;
   }
 
   message AuthStrategyMethods {
-    string create = 1;
-    string delete = 2;
-    string exists = 3;
-    string update = 4;
-    string validate = 5;
-    string verify = 6;
+    optional string create = 1;
+    optional string delete = 2;
+    optional string exists = 3;
+    optional string update = 4;
+    optional string validate = 5;
+    optional string verify = 6;
     optional string getById = 7;
     optional string getInfo = 8;
     optional string afterRegister = 9;
@@ -112,77 +118,77 @@ message NewAuthStrategy {
     AuthStrategyConfig config = 2;
   }
 
-  uint64 messageId = 1;
-  string strategyName = 2;
-  string pluginName = 3;
+  optional uint64 messageId = 1;
+  optional string strategyName = 2;
+  optional string pluginName = 3;
   AuthStrategy strategy = 4;
 }
 
 message RemoveAuthStrategy {
-  uint64 messageId = 1;
-  string strategyName = 2;
-  string pluginName = 3;
+  optional uint64 messageId = 1;
+  optional string strategyName = 2;
+  optional string pluginName = 3;
 }
 
 message DumpRequest {
-  uint64 messageId = 1;
-  string suffix = 2;
+  optional uint64 messageId = 1;
+  optional string suffix = 2;
 }
 
 message ResetSecurity {
-  uint64 messageId = 1;
+  optional uint64 messageId = 1;
 }
 
 message Shutdown {
-  uint64 messageId = 1;
+  optional uint64 messageId = 1;
 }
 
 message RefreshValidators {
-  uint64 messageId = 1;
+  optional uint64 messageId = 1;
 }
 
 message InvalidateProfile {
-  uint64 messageId = 1;
-  string profileId = 2;
+  optional uint64 messageId = 1;
+  optional string profileId = 2;
 }
 
 message InvalidateRole {
-  uint64 messageId = 1;
-  string roleId = 2;
+  optional uint64 messageId = 1;
+  optional string roleId = 2;
 }
 
 message AddIndex {
-  uint64 messageId = 1;
-  string scope = 2;
-  string index = 3;
+  optional uint64 messageId = 1;
+  optional string scope = 2;
+  optional string index = 3;
 }
 
 message AddCollection {
-  uint64 messageId = 1;
-  string scope = 2;
-  string index = 3;
-  string collection = 4;
+  optional uint64 messageId = 1;
+  optional string scope = 2;
+  optional string index = 3;
+  optional string collection = 4;
 }
 
 message RemoveIndexes {
-  uint64 messageId = 1;
-  string scope = 2;
+  optional uint64 messageId = 1;
+  optional string scope = 2;
   repeated string indexes = 3;
 }
 
 message RemoveCollection {
-  uint64 messageId = 1;
-  string scope = 2;
-  string index = 3;
-  string collection = 4;
+  optional uint64 messageId = 1;
+  optional string scope = 2;
+  optional string index = 3;
+  optional string collection = 4;
 }
 
 message ClusterWideEvent {
-  uint64 messageId = 1;
-  string event = 2;
-  string payload = 3;
+  optional uint64 messageId = 1;
+  optional string event = 2;
+  optional string payload = 3;
 }
 
 message RefreshIndexCache {
-  uint64 messageId = 1;
+  optional uint64 messageId = 1;
 }