kuzzle 2.20.0 → 2.20.2

package/lib/api/controllers/documentController.js

@@ -232,17 +232,15 @@ class DocumentController extends NativeController {
 
   async export(request) {
     const { index, collection } = request.getIndexAndCollection();
-    const { size, scrollTTL, searchBody } = request.getSearchParams();
-    const format = request.getString("format", "jsonl");
-    const fields = request.getBodyArray("fields", []);
+    const { size, scrollTTL } = request.getSearchParams();
     const lang = request.getLangParam();
+    const format = request.getString("format", "jsonl");
     const separator = request.getString("separator", ",");
-    const fieldsName = request.getBodyObject("fieldsName", {});
+    const query = request.getObjectFromBodyOrArgs("query", {});
+    const fields = request.getArrayFromBodyOrArgs("fields", []);
+    const fieldsName = request.getObjectFromBodyOrArgs("fieldsName", {});
 
-    // Remove "fields" and "fieldsName" from searchBody to avoid ES throwing an error
-    // since those properties are not allowed in the searchBody
-    searchBody.fields = undefined;
-    searchBody.fieldsName = undefined;
+    const searchBody = { query };
 
     if (request.context.connection.protocol !== "http") {
       throw kerror.get(

package/lib/api/funnel.js

@@ -50,6 +50,7 @@ const kerror = require("../kerror");
 const debug = require("../util/debug")("kuzzle:funnel");
 const processError = kerror.wrap("api", "process");
 const { has } = require("../util/safeObject");
+const { HttpStream } = require("../types");
 
 // Actions of the auth controller that does not necessite to verify the token
 // when cookie auth is active
@@ -662,7 +663,9 @@ class Funnel {
       ) {
         // check if the plugin response can be serialized
         try {
-          JSON.stringify(responseData);
+          if (!(responseData instanceof HttpStream)) {
+            JSON.stringify(responseData);
+          }
         } catch (e) {
           _request.setResult(null);
           throw kerror.get("plugin", "controller", "unserializable_response");

package/lib/api/request/kuzzleRequest.d.ts

@@ -373,6 +373,8 @@ export declare class KuzzleRequest {
      * Returns the search body query according to the http method
      */
     getSearchBody(): JSONObject;
+    getObjectFromBodyOrArgs(name: string, def?: JSONObject): JSONObject;
+    getArrayFromBodyOrArgs(name: string, def?: any): JSONObject;
     /**
      * Returns the search params.
      */

package/lib/api/request/kuzzleRequest.js

@@ -726,6 +726,38 @@ class KuzzleRequest {
         }
         return this.getObject("searchBody", {});
     }
+    getObjectFromBodyOrArgs(name, def) {
+        if (this.context.connection.protocol !== "http" ||
+            this.context.connection.misc.verb !== "GET") {
+            return this.getBodyObject(name, def);
+        }
+        const rawObject = this.getString(name, JSON.stringify(def));
+        try {
+            return JSON.parse(rawObject);
+        }
+        catch (error) {
+            if (error instanceof SyntaxError) {
+                throw assertionError.get("invalid_type", name, "JSON string");
+            }
+            throw error;
+        }
+    }
+    getArrayFromBodyOrArgs(name, def) {
+        if (this.context.connection.protocol !== "http" ||
+            this.context.connection.misc.verb !== "GET") {
+            return this.getBodyArray(name, def);
+        }
+        const rawObject = this.getString(name, JSON.stringify(def));
+        try {
+            return JSON.parse(rawObject);
+        }
+        catch (error) {
+            if (error instanceof SyntaxError) {
+                throw assertionError.get("invalid_type", name, "JSON string");
+            }
+            throw error;
+        }
+    }
     /**
      * Returns the search params.
      */

package/lib/core/network/protocols/httpwsProtocol.js

@@ -83,14 +83,11 @@ const HTTP_ALLOWED_CONTENT_TYPES = [
 ];
 const HTTP_SKIPPED_HEADERS = ["content-length", "set-cookie"];
 const HTTP_HEADER_CONNECTION = Buffer.from("Connection");
-const HTTP_HEADER_CONTENT_LENGTH = Buffer.from("Content-Length");
 const HTTP_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN = Buffer.from(
   "Access-Control-Allow-Origin"
 );
 const HTTP_HEADER_SET_COOKIE = Buffer.from("Set-Cookie");
 const HTTP_HEADER_VARY = Buffer.from("Vary");
-const HTTP_HEADER_TRANSFER_ENCODING = Buffer.from("Transfer-Encoding");
-const CHUNKED = Buffer.from("chunked");
 const WILDCARD = Buffer.from("*");
 const ORIGIN = Buffer.from("Origin");
 const X_KUZZLE_REQUEST_ID = Buffer.from("X-Kuzzle-Request-Id");
@@ -782,15 +779,6 @@ class HttpWsProtocol extends Protocol {
     // Send Headers in one go
     response.cork(() => {
       this.httpWriteRequestHeaders(request, response, message);
-
-      if (streamSizeFixed) {
-        response.writeHeader(
-          HTTP_HEADER_CONTENT_LENGTH,
-          Buffer.from(httpStream.totalBytes.toString())
-        );
-      } else {
-        response.writeHeader(HTTP_HEADER_TRANSFER_ENCODING, CHUNKED);
-      }
     });
 
     httpStream.stream.on("data", (chunk) => {

package/lib/core/plugin/plugin.js

@@ -116,16 +116,21 @@ class Plugin {
     }
 
     const description = {
+      version: this.version,
       controllers: [],
       hooks: [],
       manifest: this.manifest,
       pipes: [],
       routes: [],
       strategies: [],
-      version: this.version,
+      imports: {},
     };
     /* eslint-enable sort-keys */
 
+    if (has(this.instance, "imports")) {
+      description.imports = Object.keys(this.instance.imports);
+    }
+
     if (has(this.instance, "hooks")) {
       description.hooks = Object.keys(this.instance.hooks);
     }

package/lib/core/plugin/pluginsManager.js

@@ -207,7 +207,7 @@ class PluginsManager {
    *
    * @throws PluginImplementationError - Throws when an error occurs when registering a plugin
    */
-  init(plugins = {}) {
+  async init(plugins = {}) {
     this._plugins = new Map([...this.loadPlugins(plugins), ...this._plugins]);
 
     global.kuzzle.on("plugin:hook:loop-error", ({ error, pluginName }) => {
@@ -224,6 +224,7 @@ class PluginsManager {
 
     // register regular plugins features
     const loadPlugins = [];
+    const defaultImports = {};
 
     for (const plugin of this._plugins.values()) {
       if (
@@ -301,13 +302,19 @@ class PluginsManager {
             this.loadedPlugins.push(plugin.name);
           }
 
+          if (!_.isEmpty(plugin.instance.imports)) {
+            _.merge(defaultImports, plugin.instance.imports);
+          }
+
           return null;
         });
 
       loadPlugins.push(promise);
     }
 
-    return Promise.all(loadPlugins);
+    await Promise.all(loadPlugins);
+
+    return defaultImports;
   }
 
   /**

package/lib/kuzzle/kuzzle.js

@@ -165,11 +165,12 @@ class Kuzzle extends kuzzleEventEmitter_1.default {
             // before opening connections to external users
             await this.entryPoint.init();
             this.pluginsManager.application = application;
-            await this.pluginsManager.init(options.plugins);
+            const pluginImports = await this.pluginsManager.init(options.plugins);
             this.log.info(`[✔] Successfully loaded ${this.pluginsManager.loadedPlugins.length} plugins: ${this.pluginsManager.loadedPlugins.join(", ")}`);
+            const imports = lodash_1.default.merge({}, pluginImports, options.import);
             // Authentification plugins must be loaded before users import to avoid
             // credentials related error which would prevent Kuzzle from starting
-            await this.loadInitialState(options.import, options.support);
+            await this.loadInitialState(imports, options.support);
             await this.ask("core:security:verify");
             this.router.init();
             this.log.info("[✔] Core components loaded");

package/lib/types/Plugin.d.ts

@@ -4,6 +4,7 @@ import { PluginManifest } from "./PluginManifest";
 import { StrategyDefinition } from "./StrategyDefinition";
 import { PipeEventHandler, HookEventHandler } from "./EventHandler";
 import { JSONObject } from "../../index";
+import { ImportConfig } from "./Kuzzle";
 /**
  * Allows to define plugins controllers and actions
  */
@@ -102,6 +103,10 @@ export declare abstract class Plugin {
      * @see https://docs.kuzzle.io/core/2/plugins/guides/strategies/overview
      */
     strategies?: StrategyDefinition;
+    /**
+     * Define default imports
+     */
+    imports?: ImportConfig;
     /**
      * Plugin initialization method.
      *

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
-  "version": "2.20.0",
+  "version": "2.20.2",
   "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": {
@@ -16,15 +16,17 @@
     "dev": "npx ergol docker/scripts/start-kuzzle-dev.ts -c ./config/ergol.config.json",
     "dev:test": "npm run dev -- docker/scripts/start-kuzzle-dev.ts --enable-plugins functional-test-plugin",
     "test": "npm run clean && npm run --silent test:lint && npm run build && npm run test:unit:coverage && npm run test:functional",
+    "test:jest": "jest",
     "test:unit": "DEBUG= npx --node-arg=--trace-warnings mocha --exit",
     "test:unit:coverage": "DEBUG= nyc --reporter=text-summary --reporter=lcov mocha --exit",
-    "test:functional": "npm run test:functional:http && npm run test:functional:websocket",
+    "test:functional": "npm run test:functional:http && npm run test:functional:websocket && npm run test:jest",
     "test:functional:http": "KUZZLE_PROTOCOL=http npx cucumber-js --profile http",
     "test:functional:websocket": "KUZZLE_PROTOCOL=websocket npx cucumber-js --profile websocket",
     "test:functional:legacy": "npm run test:functional:legacy:http && npm run test:functional:legacy:websocket && npm run test:functional:legacy:mqtt",
     "test:functional:legacy:http": "npx cucumber-js --format progress-bar --profile http ./features-legacy",
     "test:functional:legacy:websocket": "npx cucumber-js --format progress-bar --profile websocket ./features-legacy",
     "test:functional:legacy:mqtt": "npx cucumber-js --format progress-bar --profile mqtt ./features-legacy",
+    "test:functional:jest": "npm run test:jest",
     "cucumber": "cucumber.js --fail-fast",
     "codecov": "codecov",
     "prettier": "npx prettier ./lib ./test ./bin ./features ./plugins/available/functional-test-plugin --write",
@@ -54,7 +56,7 @@
     "eslint-plugin-kuzzle": "^0.0.6",
     "eventemitter3": "^4.0.7",
     "inquirer": "^9.1.4",
-    "ioredis": "^5.2.4",
+    "ioredis": "^5.3.0",
     "js-yaml": "^4.1.0",
     "json-stable-stringify": "^1.0.2",
     "json2yaml": "^1.1.0",
@@ -62,7 +64,7 @@
     "koncorde": "^4.0.3",
     "kuzzle-plugin-auth-passport-local": "^6.3.6",
     "kuzzle-plugin-logger": "^3.0.3",
-    "kuzzle-sdk": "^7.10.3",
+    "kuzzle-sdk": "^7.10.5",
     "kuzzle-vault": "^2.0.4",
     "lodash": "4.17.21",
     "long": "^5.2.1",
@@ -72,13 +74,13 @@
     "ndjson": "^2.0.0",
     "node-segfault-handler": "^1.4.2",
     "passport": "^0.6.0",
-    "protobufjs": "~7.1.2",
+    "protobufjs": "~7.2.1",
     "rc": "1.2.8",
     "semver": "^7.3.8",
     "sorted-array": "^2.0.4",
     "uuid": "^9.0.0",
     "uWebSockets.js": "https://github.com/uNetworking/uWebSockets.js/archive/refs/tags/v20.0.0.tar.gz",
-    "validator": "^13.7.0",
+    "validator": "^13.9.0",
     "winston": "^3.8.2",
     "winston-elasticsearch": "0.17.1",
     "winston-syslog": "^2.7.0",
@@ -91,14 +93,17 @@
     "url": "git://github.com/kuzzleio/kuzzle.git"
   },
   "devDependencies": {
+    "@jest/globals": "^29.4.1",
+    "@types/jest": "^29.4.0",
     "@types/js-yaml": "^4.0.5",
-    "@types/lodash": "^4.14.190",
+    "@types/lodash": "^4.14.191",
     "async": "^3.2.4",
     "chokidar": "^3.5.3",
     "codecov": "^3.8.3",
     "cucumber": "^6.0.5",
     "ergol": "^1.0.2",
-    "mocha": "^10.1.0",
+    "jest": "^29.4.1",
+    "mocha": "^10.2.0",
     "mock-require": "^3.0.3",
     "mqtt": "^4.3.7",
     "nyc": "^15.1.0",
@@ -109,9 +114,10 @@
     "should-sinon": "0.0.6",
     "sinon": "^14.0.2",
     "strip-json-comments": "https://github.com/sindresorhus/strip-json-comments/archive/refs/tags/v3.1.1.tar.gz",
+    "ts-jest": "^29.0.5",
     "ts-node": "^10.9.1",
-    "typescript": "^4.9.3",
-    "yaml": "^2.1.3"
+    "typescript": "^4.9.5",
+    "yaml": "^2.2.1"
   },
   "engines": {
     "node": ">= 12.13.0"