kuzzle 2.60.0-beta.1 → 2.60.0-beta.3

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

package/dist/lib/cluster/publisher.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/state.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 });
 const koncorde_1 = require("koncorde");
 const kerror = __importStar(require("../kerror"));

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

@@ -1,5 +1,3 @@
-/// <reference types="node" />
-/// <reference types="node" />
 import Long from "long";
 import type { IKuzzleConfiguration } from "../types/config/KuzzleConfiguration";
 import type State from "./state";

package/dist/lib/cluster/subscriber.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/workers/IDCardRenewer.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import Redis from "../../service/cache/redis";
 /**
  * `redis.ts` uses `export =`, so it cannot also export this type. Deriving it
@@ -39,6 +38,12 @@ declare class IDCardRenewer {
     init(config: IDCardRenewerConfig): Promise<void>;
     initRedis(config?: RedisServiceConfig, name?: string): Promise<void>;
     renewIDCard(): Promise<void>;
+    /**
+     * Disposes the worker and tells the parent why, once: the renewals queued
+     * behind a stalled redis all fail together, and each report evicts the node
+     * again (#3017)
+     */
+    private reportFailure;
     dispose(): Promise<void>;
 }
 export { IDCardRenewer };

package/dist/lib/cluster/workers/IDCardRenewer.js

@@ -104,18 +104,24 @@ class IDCardRenewer {
             // Unable to refresh the key in time before it expires
             // => this node is too slow, we need to remove it from the cluster
             if (refreshed === 0) {
-                await this.dispose();
-                process.send?.({
-                    error: "Node too slow: ID card expired",
-                });
+                await this.reportFailure("Node too slow: ID card expired");
             }
         }
         catch (error) {
-            await this.dispose();
-            process.send?.({
-                error: `Failed to refresh ID Card: ${messageOf(error)}`,
-            });
+            await this.reportFailure(`Failed to refresh ID Card: ${messageOf(error)}`);
+        }
+    }
+    /**
+     * Disposes the worker and tells the parent why, once: the renewals queued
+     * behind a stalled redis all fail together, and each report evicts the node
+     * again (#3017)
+     */
+    async reportFailure(error) {
+        if (this.disposed) {
+            return;
         }
+        await this.dispose();
+        process.send?.({ error });
     }
     async dispose() {
         if (this.disposed) {

package/dist/lib/config/index.js

@@ -23,7 +23,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadConfig = void 0;
+exports.loadConfig = loadConfig;
 const assert_1 = __importDefault(require("assert"));
 const node_util_1 = require("node:util");
 const rc_1 = __importDefault(require("rc"));
@@ -34,32 +34,38 @@ const safeObject_1 = require("../util/safeObject");
 const bytes_1 = __importDefault(require("../util/bytes"));
 const wrapped = (0, kerror_1.wrap)("core", "configuration");
 function loadConfig() {
-    let config;
+    let loaded;
     try {
-        config = (0, rc_1.default)("kuzzle", default_config_1.default);
+        loaded = (0, rc_1.default)("kuzzle", default_config_1.default);
     }
     catch (e) {
         throw wrapped.get("cannot_parse", e instanceof Error ? e.message : (0, node_util_1.inspect)(e));
     }
-    config = unstringify(config);
-    checkLimitsConfig(config);
-    checkHttpOptions(config);
-    checkWebSocketOptions(config);
-    checkClusterOptions(config);
-    config.internal = {
-        hash: {
-            seed: Buffer.from("^m&mOISKBvb1xpl1mRsrylaQXpjb&IJX"),
+    // In place: what `unstringify` answers is the object it was given.
+    unstringify(loaded);
+    checkLimitsConfig(loaded);
+    checkHttpOptions(loaded);
+    checkWebSocketOptions(loaded);
+    checkClusterOptions(loaded);
+    // The two sections the defaults do not carry. `notifiableProtocols` is
+    // filled in by `preprocessProtocolsOptions` below; `version` injects the
+    // current Kuzzle version.
+    const config = {
+        ...loaded,
+        internal: {
+            hash: {
+                seed: Buffer.from("^m&mOISKBvb1xpl1mRsrylaQXpjb&IJX"),
+            },
+            notifiableProtocols: [],
         },
+        version: package_json_1.default.version,
     };
     preprocessHttpOptions(config);
     preprocessProtocolsOptions(config);
     preprocessRedisOptions(config.services.internalCache);
     preprocessRedisOptions(config.services.memoryStorage);
-    // Injects the current Kuzzle version
-    config.version = package_json_1.default.version;
     return config;
 }
-exports.loadConfig = loadConfig;
 /**
  * RC params can be overriden using environment variables,
  * in which case all values are passed as strings.

package/dist/lib/core/auth/formatProcessing.d.ts

@@ -1,7 +1,7 @@
 import type { Profile } from "../../model/security/profile";
 import type { Role } from "../../model/security/role";
 import type { User } from "../../model/security/user";
-import type { Serialized } from "../../types/core/auth/formatProcessing.type";
+import type { Serialized } from "../../types/core/auth/Serialized";
 declare const _default: {
     /**
      * Serializes profile and transforms it into a POJO

package/dist/lib/core/auth/formatProcessing.js

@@ -29,7 +29,7 @@ exports.default = {
      */
     serializeProfile(profile) {
         const { _id, ..._source } = profile;
-        return { _id, _source: _source };
+        return { _id, _source };
     },
     /**
      * Serializes role and transforms it into a POJO
@@ -39,7 +39,7 @@ exports.default = {
      */
     serializeRole(role) {
         const { _id, ..._source } = role;
-        return { _id, _source: _source };
+        return { _id, _source };
     },
     /**
      * Serializes user and transforms it into a POJO
@@ -49,7 +49,7 @@ exports.default = {
      */
     serializeUser(user) {
         const { _id, ..._source } = user;
-        return { _id, _source: _source };
+        return { _id, _source };
     },
 };
 //# sourceMappingURL=formatProcessing.js.map

package/dist/lib/core/auth/passportResponse.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import type { OutgoingHttpHeaders } from "http";
 /**
  * @class PassportResponse

package/dist/lib/core/auth/passportWrapper.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 };
 };
@@ -63,6 +73,7 @@ class PassportWrapper {
      * @param strategyName
      * @returns {Promise.<*>}
      */
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any -- kept for v2 compatibility, see docs/v3-breaking-changes.md
     authenticate(request, strategyName) {
         const response = new passportResponse_1.default();
         return new bluebird_1.default((resolve, reject) => {
@@ -88,7 +99,12 @@ class PassportWrapper {
                     fail(err);
                 }
                 else if (!user) {
-                    reject(kerror.get("plugin", "strategy", "missing_user", info.message));
+                    const message = 
+                    // `typeof null` is "object" too: a strategy may fail with no info
+                    typeof info === "object" && info !== null && "message" in info
+                        ? info.message
+                        : undefined;
+                    reject(kerror.get("plugin", "strategy", "missing_user", message));
                 }
                 else {
                     resolve(user);

package/dist/lib/core/backend/backend.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/core/backend/backendConfig.d.ts

@@ -26,7 +26,7 @@ export declare class BackendConfig extends ApplicationManager {
      * @param path - Path to the configuration key (lodash style)
      * @param value - Value for the configuration key
      */
-    set(path: string, value: any): void;
+    set(path: string, value: unknown): void;
     /**
      * Merges a configuration object into the current configuration
      *

package/dist/lib/core/backend/backendConfig.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 };
 };