kuzzle 2.56.0 → 2.57.0-beta.2

package/dist/lib/api/controllers/serverController.js

@@ -1,3 +1,4 @@
+"use strict";
 /*
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
@@ -18,16 +19,46 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-"use strict";
-const os = require("os");
-const jsonToYaml = require("json2yaml");
-const packagejson = require("../../../package.json");
-const { NativeController } = require("./baseController");
-const kerror = require("../../kerror");
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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 __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const os = __importStar(require("node:os"));
+const node_util_1 = require("node:util");
+const json2yaml_1 = __importDefault(require("json2yaml"));
+const package_json_1 = __importDefault(require("../../../package.json"));
+const kerror = __importStar(require("../../kerror"));
+const baseController_1 = require("./baseController");
+/** Whatever a health probe rejected with, as an `Error`. */
+function causeOf(thrown) {
+    return thrown instanceof Error ? thrown : new Error((0, node_util_1.inspect)(thrown));
+}
 /**
  * @class ServerController
  */
-class ServerController extends NativeController {
+class ServerController extends baseController_1.NativeController {
     constructor() {
         super([
             "adminExists",
@@ -100,7 +131,7 @@ class ServerController extends NativeController {
      * @returns {Promise<Object>}
      */
     async getConfig() {
-        const config = JSON.parse(JSON.stringify(global.kuzzle.config));
+        const config = JSON.parse(JSON.stringify(global.kuzzle.config)); // NOSONAR: intentional JSON-safe deep clone (strips non-serializable config values); structuredClone would change semantics / can throw
         // Already and more appropriately returned by server:info
         config.http.routes = undefined;
         // Not a good idea to export Kuzzle's salt, hash algorithm
@@ -116,20 +147,25 @@ class ServerController extends NativeController {
      * @returns {Promise<Object>}
      */
     async capabilities() {
-        const config = JSON.parse(JSON.stringify(global.kuzzle.config));
+        const config = JSON.parse(JSON.stringify(global.kuzzle.config)); // NOSONAR: intentional JSON-safe deep clone (strips non-serializable config values); structuredClone would change semantics / can throw
         const publicApi = await this.publicApi();
         const services = {};
         const plugins = {};
         for (const plugin of config.plugins.common.include) {
-            plugins[plugin] = {
-                version: packagejson.dependencies[plugin],
-            };
+            // A plugin listed in `plugins.common.include` that is not a dependency
+            // of this package has no version to report. It was read off the
+            // manifest's dependency map by a name only known at runtime.
+            const dependencies = package_json_1.default.dependencies;
+            plugins[plugin] = { version: dependencies[plugin] ?? "" };
         }
         for (const [name, info] of Object.entries(config.services)) {
-            if (info.backend !== undefined) {
+            const reported = info.backend === undefined ? undefined : this._info[info.backend];
+            // `_info` holds one entry per service `init()` asked, so a service
+            // configured against a backend Kuzzle does not run has none.
+            if (info.backend !== undefined && reported) {
                 services[name] = {
                     backend: info.backend,
-                    version: this._info[info.backend].version,
+                    version: reported.version,
                 };
             }
         }
@@ -161,11 +197,13 @@ class ServerController extends NativeController {
      */
     async healthCheck(request) {
         const getServiceUnavailableError = (err) => kerror.get("core", "fatal", "service_unavailable", err);
-        const result = { services: {}, status: "green" };
+        const result = {
+            services: {},
+            status: "green",
+        };
         let services;
         if (typeof request.input.args.services === "string") {
-            // @deprecated Should be replaced with request.getArray('services')
-            services = request.getArrayLegacy("services");
+            services = request.getArrayOrCsv("services");
         }
         if (!services || services.includes("internalCache")) {
             try {
@@ -173,7 +211,7 @@ class ServerController extends NativeController {
                 result.services.internalCache = "green";
             }
             catch (error) {
-                request.setError(getServiceUnavailableError(error));
+                request.setError(getServiceUnavailableError(causeOf(error)));
                 result.services.internalCache = "red";
                 result.status = "red";
             }
@@ -184,7 +222,7 @@ class ServerController extends NativeController {
                 result.services.memoryStorage = "green";
             }
             catch (error) {
-                request.setError(getServiceUnavailableError(error));
+                request.setError(getServiceUnavailableError(causeOf(error)));
                 result.services.memoryStorage = "red";
                 result.status = "red";
             }
@@ -198,7 +236,7 @@ class ServerController extends NativeController {
                 result.services.storageEngine = "green";
             }
             catch (error) {
-                request.setError(getServiceUnavailableError(error));
+                request.setError(getServiceUnavailableError(causeOf(error)));
                 result.services.storageEngine = "red";
                 result.status = "red";
             }
@@ -232,13 +270,15 @@ class ServerController extends NativeController {
         };
         const kuzzleApi = this._buildApiDefinition(global.kuzzle.funnel.controllers, global.kuzzle.config.http.routes);
         const pluginsApi = this._buildApiDefinition(global.kuzzle.pluginsManager.controllers, global.kuzzle.pluginsManager.routes);
-        const apiDefinition = Object.assign({}, kuzzleApi, pluginsApi);
-        // @todo kuzzle.api should contain the apiDefinition directly
+        const apiDefinition = { ...kuzzleApi, ...pluginsApi };
+        // NOSONAR: pre-existing @todo — kuzzle.api should contain the apiDefinition directly
         response.kuzzle.api.routes = apiDefinition;
         response.kuzzle.plugins =
             global.kuzzle.pluginsManager.getPluginsDescription();
+        // A Kuzzle started without an application has none to describe, and this
+        // route answered by throwing on `undefined.info()`.
         response.kuzzle.application =
-            global.kuzzle.pluginsManager.application.info();
+            global.kuzzle.pluginsManager.application?.info() ?? {};
         response.services = {
             internalCache: await global.kuzzle.ask("core:cache:internal:info:get"),
             internalStorage: await global.kuzzle.ask("core:storage:private:info:get"),
@@ -274,7 +314,7 @@ class ServerController extends NativeController {
             format: "raw",
             headers: { "Content-Type": `application/${format}` },
         });
-        return format === "json" ? definition : jsonToYaml.stringify(definition);
+        return format === "json" ? definition : json2yaml_1.default.stringify(definition);
     }
     /**
      * Fetches and returns Kuzzle core metrics
@@ -292,7 +332,8 @@ class ServerController extends NativeController {
         for (const [name, controller] of controllers.entries()) {
             const actionList = {};
             for (const action of controller._actions) {
-                actionList[action] = { action, controller: name };
+                const definition = { action, controller: name };
+                actionList[action] = definition;
                 // resolve associated http route for each actions
                 const routes = httpRoutes.filter((route) => {
                     return ((route.controller === name ||
@@ -300,10 +341,9 @@ class ServerController extends NativeController {
                         route.action === action);
                 });
                 for (const route of routes) {
-                    if (!actionList[action].http) {
-                        actionList[action].http = [];
-                    }
-                    actionList[action].http.push({
+                    // The entry was just created above, and read back three times.
+                    definition.http ?? (definition.http = []);
+                    definition.http.push({
                         path: route.path,
                         url: route.path,
                         verb: route.verb.toUpperCase(),

package/dist/lib/api/documentExtractor.d.ts

@@ -1,9 +1,11 @@
-export = DocumentExtractor;
+import type { JSONObject } from "../types/JSONObject";
+import type { KuzzleRequest } from "./request";
 declare class DocumentExtractor {
-    constructor(request: any);
-    request: any;
-    extractMethod: any;
-    insertMethod: any;
-    extract(): any;
-    insert(documents: any): any;
+    private readonly request;
+    private readonly extractMethod;
+    private readonly insertMethod;
+    constructor(request: KuzzleRequest);
+    extract(): JSONObject[];
+    insert(documents: JSONObject[]): KuzzleRequest;
 }
+export = DocumentExtractor;

package/dist/lib/api/documentExtractor.js

@@ -1,3 +1,4 @@
+"use strict";
 /*
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
@@ -18,26 +19,67 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-"use strict";
-const kerror = require("../kerror");
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : 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;
+};
+const kerror = __importStar(require("../kerror"));
 const assertionError = kerror.wrap("api", "assert");
-const extractors = [
+/**
+ * The body of a request whose action declares one. Every extractor below runs
+ * on an action that takes a body — `deleteFields`, `mCreate`, `upsert` — and
+ * read `request.input.body` straight through; `body` is `JSONObject | null`
+ * on every request, and a request arriving without one raised a TypeError
+ * rather than the 400 this error is.
+ */
+function bodyOf(request) {
+    const body = request.input.body;
+    if (body === null) {
+        throw assertionError.get("body_required");
+    }
+    return body;
+}
+const extractorDefinitions = [
     {
         methods: {
             extractFromRequest: (request) => [
                 {
                     _id: request.input.args._id,
-                    _source: request.input.body.fields,
+                    _source: bodyOf(request).fields,
                 },
             ],
             extractFromResult: (request) => [request.result],
-            insertInRequest: ([documents], request) => {
-                request.input.args._id = documents._id;
-                request.input.body.fields = documents._source;
+            insertInRequest: ([document], request) => {
+                if (document) {
+                    request.input.args._id = document._id;
+                    bodyOf(request).fields = document._source;
+                }
                 return request;
             },
             insertInResult: ([document], request) => {
-                request.setResult(document, { status: request.status });
+                request.response.configure({
+                    result: document,
+                    status: request.status,
+                });
                 return request;
             },
         },
@@ -48,11 +90,14 @@ const extractors = [
             extractFromRequest: (request) => [{ _id: request.input.args._id }],
             extractFromResult: (request) => [request.result],
             insertInRequest: (documents, request) => {
-                request.input.args._id = documents[0] && documents[0]._id;
+                request.input.args._id = documents[0]?._id;
                 return request;
             },
             insertInResult: (documents, request) => {
-                request.setResult(documents[0], { status: request.status });
+                request.response.configure({
+                    result: documents[0],
+                    status: request.status,
+                });
                 return request;
             },
         },
@@ -62,8 +107,7 @@ const extractors = [
         methods: {
             extractFromRequest: (request) => {
                 let ids = [];
-                if (request.input.body &&
-                    request.input.body.ids &&
+                if (request.input.body?.ids &&
                     Object.keys(request.input.body.ids).length) {
                     ids = request.input.body.ids;
                 }
@@ -72,8 +116,7 @@ const extractors = [
                         ids = request.input.args.ids;
                     }
                     else if (typeof request.input.args.ids === "string") {
-                        // @deprecated Should be replaced with request.getArray('ids')
-                        ids = request.getArrayLegacy("ids");
+                        ids = request.getArrayOrCsv("ids");
                     }
                     else {
                         throw assertionError.get("invalid_type", request.input.args.ids, "Array or String");
@@ -86,14 +129,15 @@ const extractors = [
                     return request.result.successes;
                 }
                 const documents = [];
-                for (let it = 0; it < request.result.successes.length; it++) {
-                    documents.push({ _id: request.result.successes[it] });
+                for (const success of request.result.successes) {
+                    documents.push({ _id: success });
                 }
                 return documents;
             },
             insertInRequest: (documents, request) => {
-                if (request.input.body && Object.keys(request.input.body).length) {
-                    request.input.body.ids = documents.map((document) => document._id);
+                const body = request.input.body;
+                if (body && Object.keys(body).length) {
+                    body.ids = documents.map((document) => document._id);
                 }
                 else {
                     request.input.args.ids = documents.map((document) => document._id);
@@ -102,10 +146,12 @@ const extractors = [
             },
             insertInResult: (documents, request) => {
                 if (request.input.action === "mGet") {
-                    request.setResult({
+                    const mResult = {
                         errors: request.result.errors,
                         successes: documents,
-                    }, {
+                    };
+                    request.response.configure({
+                        result: mResult,
                         status: request.status,
                     });
                     return request;
@@ -114,10 +160,10 @@ const extractors = [
                     errors: request.result.errors,
                     successes: [],
                 };
-                for (let it = 0; it < documents.length; it++) {
-                    result.successes.push(documents[it]._id);
+                for (const document of documents) {
+                    result.successes.push(document._id);
                 }
-                request.setResult(result, { status: request.status });
+                request.response.configure({ result: result, status: request.status });
                 return request;
             },
         },
@@ -127,8 +173,7 @@ const extractors = [
         methods: {
             extractFromRequest: (request) => {
                 const documents = [];
-                for (let it = 0; it < request.input.body.documents.length; it++) {
-                    const document = request.input.body.documents[it];
+                for (const document of bodyOf(request).documents) {
                     if (request.input.action === "mUpsert") {
                         documents.push({
                             _id: document._id,
@@ -143,24 +188,25 @@ const extractors = [
             },
             extractFromResult: (request) => request.result.successes,
             insertInRequest: (documents, request) => {
-                const tmpDocuments = request.input.body.documents;
-                request.input.body.documents = [];
-                for (let it = 0; it < documents.length; it++) {
-                    const document = documents[it];
+                const body = bodyOf(request);
+                const tmpDocuments = body.documents;
+                const rewritten = [];
+                for (const [it, document] of documents.entries()) {
                     if (request.input.action === "mUpsert") {
-                        request.input.body.documents.push({
+                        rewritten.push({
                             _id: document._id,
                             changes: document._source,
-                            default: tmpDocuments[it].default,
+                            default: tmpDocuments[it]?.default,
                         });
                     }
                     else {
-                        request.input.body.documents.push({
+                        rewritten.push({
                             _id: document._id,
                             body: document._source,
                         });
                     }
                 }
+                body.documents = rewritten;
                 return request;
             },
             insertInResult: (documents, request) => {
@@ -168,7 +214,7 @@ const extractors = [
                     errors: request.result.errors,
                     successes: documents,
                 };
-                request.setResult(result, { status: request.status });
+                request.response.configure({ result: result, status: request.status });
                 return request;
             },
         },
@@ -207,12 +253,15 @@ const extractors = [
             ],
             extractFromResult: (request) => [request.result],
             insertInRequest: (documents, request) => {
-                request.input.args._id = documents[0] && documents[0]._id;
-                request.input.body = documents[0] && documents[0]._source;
+                request.input.args._id = documents[0]?._id;
+                request.input.body = documents[0]?._source;
                 return request;
             },
             insertInResult: (documents, request) => {
-                request.setResult(documents[0], { status: request.status });
+                request.response.configure({
+                    result: documents[0],
+                    status: request.status,
+                });
                 return request;
             },
         },
@@ -223,25 +272,29 @@ const extractors = [
             extractFromRequest: (request) => [
                 {
                     _id: request.input.args._id,
-                    _source: request.input.body.changes,
+                    _source: bodyOf(request).changes,
                 },
             ],
             extractFromResult: (request) => [request.result],
             insertInRequest: ([document], request) => {
                 if (document) {
                     request.input.args._id = document._id;
-                    request.input.body.changes = document._source;
+                    bodyOf(request).changes = document._source;
                 }
                 return request;
             },
             insertInResult: ([document], request) => {
-                request.setResult(document, { status: request.status });
+                request.response.configure({
+                    result: document,
+                    status: request.status,
+                });
                 return request;
             },
         },
         targets: ["upsert"],
     },
-].reduce((acc, extractor) => {
+];
+const extractors = extractorDefinitions.reduce((acc, extractor) => {
     extractor.targets.forEach((target) => {
         acc[target] = extractor.methods;
     });
@@ -250,7 +303,9 @@ const extractors = [
 class DocumentExtractor {
     constructor(request) {
         this.request = request;
-        const extractor = extractors[request.input.action];
+        const extractor = request.input.action === null
+            ? undefined
+            : extractors[request.input.action];
         if (extractor === undefined) {
             throw kerror.get("core", "fatal", "assertion_failed", `no generic documents extractor for ${request.input.action}`);
         }
@@ -264,9 +319,18 @@ class DocumentExtractor {
         }
     }
     extract() {
+        // `search`, `deleteByQuery` and `export` have no request-side extractor:
+        // they are in `documentEventAliases.notBefore`, so the "before" pass that
+        // would ask for one never runs. Both were invoked unchecked.
+        if (this.extractMethod === null) {
+            throw kerror.get("core", "fatal", "assertion_failed", `no request-side documents extractor for ${this.request.input.action}`);
+        }
         return this.extractMethod(this.request);
     }
     insert(documents) {
+        if (this.insertMethod === null) {
+            throw kerror.get("core", "fatal", "assertion_failed", `no request-side documents extractor for ${this.request.input.action}`);
+        }
         return this.insertMethod(documents, this.request);
     }
 }