kuzzle 2.23.0 → 2.25.0

package/README.md

@@ -111,12 +111,8 @@ Learn how to [Write an Application](https://docs.kuzzle.io/core/2/guides/getting
 
 Train yourself and your teams to use Kuzzle to maximize its potential and accelerate the development of your projects.
 Our teams will be able to meet your needs in terms of expertise and multi-technology support for IoT, mobile/web, backend/frontend, devops.
-:point_right: [Get a quote](https://hubs.ly/H0jkfJ_0)
+:point_right: [Get a quote](https://kuzzle.io/pricing/)
 
-## Public Roadmap
-
-You can consult the public roadmap on Trello. Come and vote for the features you need!
-:point_right: [Kuzzle Public Roadmap](https://trello.com/b/za9vOgRh/kuzzle-public-roadmap)
 
 ## Contributing to Kuzzle
 
@@ -132,7 +128,6 @@ Check our [contributing documentation](./CONTRIBUTING.md) to know about our codi
 * Visit our [blog](https://blog.kuzzle.io/) to be informed about what we are doing
 * Come chat with us on [Discord](http://join.discord.kuzzle.io)
 * Ask technical questions on [stack overflow](https://stackoverflow.com/search?q=kuzzle)
-* Check out our [public roadmap](https://trello.com/b/za9vOgRh/kuzzle-public-roadmap) and vote for the upcoming features
 
 ## License
 

package/lib/api/controllers/documentController.js

@@ -131,6 +131,14 @@ class DocumentController extends NativeController {
         { from, scroll: scrollTTL, size }
       );
     } else {
+      if (!index) {
+        throw kerror.get("api", "assert", "missing_argument", "index");
+      }
+
+      if (!collection) {
+        throw kerror.get("api", "assert", "missing_argument", "collection");
+      }
+
       result = await this.ask(
         "core:storage:public:document:search",
         index,

package/lib/cluster/idCardHandler.js

@@ -146,7 +146,12 @@ class ClusterIdCardHandler {
         const childProcess = (0, child_process_1.fork)(path);
         const exitHandler = () => {
             if (!childProcess.killed || childProcess.connected) {
-                childProcess.kill();
+                try {
+                    childProcess.disconnect();
+                }
+                catch (e) {
+                    // It could happens that the worker has been killed before the dispose causing disconnect to fail
+                }
             }
             process.exit();
         };

package/lib/cluster/workers/IDCardRenewer.js

@@ -136,7 +136,8 @@ process.on("message", async (message) => {
 });
 
 // When the IPC is closed on the main process side
-process.on("disconnect", () => {
+process.on("disconnect", async () => {
+  await idCardRenewer.dispose();
   process.exit();
 });
 

package/lib/config/default.config.js

@@ -210,6 +210,7 @@ const defaultConfig = {
         port: 7512,
         protocols: {
             http: {
+                additionalContentTypes: [],
                 allowCompression: true,
                 enabled: true,
                 maxEncodingLayers: 3,

package/lib/config/index.js

@@ -236,10 +236,16 @@ function checkHttpOptions(config) {
     `[http] "maxFormFileSize" parameter: cannot parse "${cfg.maxFormFileSize}"`
   );
   cfg.maxFormFileSize = maxFormFileSize;
+
   assert(
     typeof config.http.cookieAuthentication === "boolean",
     `[http] "cookieAuthentication" parameter: invalid value "${config.http.cookieAuthentication}" (boolean expected)`
   );
+  assert(
+    Array.isArray(cfg.additionalContentTypes) &&
+      cfg.additionalContentTypes.every((ct) => typeof ct === "string"),
+    `[http] "additionalContentTypes" parameter: invalid value "${cfg.additionalContentTypes}" (array of strings expected)`
+  );
 }
 
 function checkClusterOptions(config) {

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

@@ -502,7 +502,7 @@ class HttpWsProtocol extends Protocol {
 
     if (
       contentType &&
-      !HTTP_ALLOWED_CONTENT_TYPES.some((allowed) =>
+      !this.httpConfig.opts.allowedContentTypes.some((allowed) =>
         contentType.includes(allowed)
       )
     ) {
@@ -1194,6 +1194,10 @@ class HttpWsProtocol extends Protocol {
       headers,
       opts: {
         allowCompression: cfg.allowCompression,
+        allowedContentTypes: [
+          ...HTTP_ALLOWED_CONTENT_TYPES,
+          ...cfg.additionalContentTypes,
+        ],
         maxEncodingLayers: cfg.maxEncodingLayers,
         maxFormFileSize: cfg.maxFormFileSize,
       },

package/lib/core/network/router.js

@@ -136,6 +136,18 @@ class Router {
       this._executeFromHttp("post", apiRequest, cb);
     });
 
+    this.http.get("_healthcheck", (request, cb) => {
+      request.response.configure({
+        status: 200,
+      });
+
+      /**
+       * By avoiding using the funnel, we avoid the request to be logged
+       * This is useful for ochestrators healthchecks
+       */
+      cb(request);
+    });
+
     for (const route of routes) {
       const verb = route.verb.toLowerCase();
 

package/lib/kerror/codes/1-services.json

@@ -335,6 +335,17 @@
           "class": "InternalError"
         }
       }
+    },
+    "koncorde": {
+      "code": 5,
+      "errors": {
+        "elastic_translation_error": {
+          "description": "An error occured while translating a Koncorde filter to an Elasticsearch query",
+          "code": 1,
+          "message": "An error occured while translating a Koncorde filter to an Elasticsearch query: %s",
+          "class": "BadRequestError"
+        }
+      }
     }
   }
 }

package/lib/service/storage/queryTranslator.js

@@ -21,6 +21,8 @@
 
 "use strict";
 
+const kerror = require("../../kerror");
+
 class KeywordError extends Error {
   constructor(type, name) {
     super(
@@ -33,17 +35,78 @@ class KeywordError extends Error {
 
 const KONCORDE_OPERATORS = ["and", "or", "not", "bool"];
 
+/**
+ * Parse the Koncorde path to extract the path and the value
+ * path have the form "path.to.field[json_value]"
+ *
+ * @param {string} path
+ * @returns
+ */
+function parseKoncordePath(path) {
+  const firstBracket = path.indexOf("[");
+
+  if (firstBracket < 0) {
+    return {
+      path,
+    };
+  }
+
+  const lastBracket = path.lastIndexOf("]");
+
+  if (lastBracket < 0) {
+    throw kerror.get(
+      "services",
+      "koncorde",
+      "elastic_translation_error",
+      `Invalid exists path "${path}": missing closing bracket`
+    );
+  }
+
+  return {
+    path: path.slice(0, firstBracket),
+    value: JSON.parse(path.slice(firstBracket + 1, lastBracket)),
+  };
+}
+
 const KONCORDE_CLAUSES_TO_ES = {
   equals: (content) => ({
     term: {
       ...content,
     },
   }),
-  exists: (field) => ({
-    exists: {
-      field,
-    },
-  }),
+  exists: (field) => {
+    // Support old syntax { exists: { field: "path" } } and { exists: "path" }
+    const parsedInfo = parseKoncordePath(field.field || field);
+
+    // If we have a value, we need to use a range query to be sure that the value is the same
+    if (parsedInfo.value) {
+      return {
+        bool: {
+          filter: [
+            {
+              exists: {
+                field: parsedInfo.path,
+              },
+            },
+            {
+              range: {
+                [parsedInfo.path]: {
+                  gte: parsedInfo.value,
+                  lte: parsedInfo.value,
+                },
+              },
+            },
+          ],
+        },
+      };
+    }
+
+    return {
+      exists: {
+        field: parsedInfo.path,
+      },
+    };
+  },
   geoBoundingBox: (content) => ({
     geo_bounding_box: {
       ...content,

package/lib/types/config/ServerConfiguration.d.ts

@@ -68,6 +68,18 @@ export type ServerConfiguration = {
      */
     protocols: {
         http: {
+            /**
+             * Enables Kuzzle to accept additional Content-Types.
+             * Note: This relies on the implementation of a
+             * "protocol:http:beforeParsingPayload" pipe that implements
+             * the formatting of the additional content types to JSON.
+             * The default content types are:
+             *   * application/json
+             *   * application/x-www-form-urlencoded
+             *   * multipart/form-data
+             * @default []
+             */
+            additionalContentTypes: string[];
             /**
              * Enable support for compressed requests, using the Content-Encoding header
              * Currently supported compression algorithms:  gzip, deflate, identity

package/package.json

@@ -1,44 +1,44 @@
 {
   "name": "kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
-  "version": "2.23.0",
+  "version": "2.25.0",
   "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": {
+    "build-ts": "tsc",
+    "build": "npm run build-ts",
+    "clean": "touch index.ts && npm run build | grep TSFILE | cut -d' ' -f 2 | xargs rm",
+    "codecov": "codecov",
+    "cucumber": "cucumber.js --fail-fast",
+    "dev:test": "npm run dev -- docker/scripts/start-kuzzle-test.ts --enable-plugins functional-test-plugin",
+    "dev": "npx ergol docker/scripts/start-kuzzle-dev.ts -c ./config/ergol.config.json",
+    "doc-error-codes": "node -r ts-node/register doc/build-error-codes",
+    "docker:install": "docker-compose run kuzzle_node_1 npm install",
+    "docker:npm": "docker-compose run kuzzle_node_1 npm run --",
+    "docker:test:unit": "docker-compose run kuzzle_node_1 npm run test:unit",
     "docker": "docker-compose run kuzzle_node_1 ",
     "file": "npx ergol docker/scripts/start-kuzzle-dev.ts -c ./config/ergol.config.json",
-    "start:dev": "npx ergol docker/scripts/start-kuzzle-dev.ts -c ./config/ergol.config.json --script-args=--enable-plugins functional-test-plugin",
     "prepublishOnly": "npm run build",
-    "build": "npm run build-ts",
-    "clean": "touch index.ts && npm run build | grep TSFILE | cut -d' ' -f 2 | xargs rm",
-    "build-ts": "tsc",
+    "prettier": "npx prettier ./lib ./test ./bin ./features ./plugins/available/functional-test-plugin --write",
     "services": "npx kourou app:start-services",
-    "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 && npm run test:jest",
+    "start:dev": "npx ergol docker/scripts/start-kuzzle-dev.ts -c ./config/ergol.config.json --script-args=--enable-plugins functional-test-plugin",
     "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:jest": "npm run test:jest",
     "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",
-    "test:lint": "npm run test:lint:js && npm run test:lint:ts",
-    "test:lint:ts": "eslint --max-warnings=0 ./lib --ext .ts --config .eslintc-ts.json",
-    "test:lint:ts:fix": "eslint --max-warnings=0 --fix ./lib --ext .ts --config .eslintc-ts.json",
-    "test:lint:js": "eslint --max-warnings=0 ./lib ./test ./bin ./features ./plugins/available/functional-test-plugin",
+    "test:functional:legacy:websocket": "npx cucumber-js --format progress-bar --profile websocket ./features-legacy",
+    "test:functional:legacy": "npm run test:functional:legacy:http && npm run test:functional:legacy:websocket && npm run test:functional:legacy:mqtt",
+    "test:functional:websocket": "KUZZLE_PROTOCOL=websocket npx cucumber-js --profile websocket",
+    "test:functional": "npm run test:functional:http && npm run test:functional:websocket && npm run test:jest",
+    "test:jest": "jest",
     "test:lint:js:fix": "eslint --max-warnings=0 --fix ./lib ./test ./bin ./features",
-    "doc-error-codes": "node -r ts-node/register doc/build-error-codes",
-    "docker:install": "docker-compose run kuzzle_node_1 npm install",
-    "docker:test:unit": "docker-compose run kuzzle_node_1 npm run test:unit",
-    "docker:npm": "docker-compose run kuzzle_node_1 npm run --"
+    "test:lint:js": "eslint --max-warnings=0 ./lib ./test ./bin ./features ./plugins/available/functional-test-plugin",
+    "test:lint:ts:fix": "eslint --max-warnings=0 --fix ./lib --ext .ts --config .eslintc-ts.json",
+    "test:lint:ts": "eslint --max-warnings=0 ./lib --ext .ts --config .eslintc-ts.json",
+    "test:lint": "npm run test:lint:js && npm run test:lint:ts",
+    "test:unit:coverage": "DEBUG= nyc --reporter=text-summary --reporter=lcov mocha --exit",
+    "test:unit": "DEBUG= npx --node-arg=--trace-warnings mocha --exit",
+    "test": "npm run clean && npm run --silent test:lint && npm run build && npm run test:unit:coverage && npm run test:functional"
   },
   "directories": {
     "lib": "lib"
@@ -79,7 +79,7 @@
     "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",
+    "uWebSockets.js": "https://github.com/uNetworking/uWebSockets.js/archive/refs/tags/v20.7.0.tar.gz",
     "validator": "^13.9.0",
     "winston": "^3.8.2",
     "winston-elasticsearch": "0.17.1",