kuzzle 2.26.3 → 2.27.1

package/lib/config/default.config.d.ts

@@ -4,7 +4,7 @@ import { KuzzleConfiguration } from "../types/config/KuzzleConfiguration";
  *
  * To customize your Kuzzle installation, create a
  * ".kuzzlerc" file and put your overrides there.
- * Please check the ".kuzzlerc.sample" file to get
+ * Please check the ".kuzzlerc.sample.jsonc" file to get
  * started.
  *
  * @class KuzzleConfiguration

package/lib/config/default.config.js

@@ -10,7 +10,7 @@ const httpRoutes_js_1 = __importDefault(require("../api/httpRoutes.js"));
  *
  * To customize your Kuzzle installation, create a
  * ".kuzzlerc" file and put your overrides there.
- * Please check the ".kuzzlerc.sample" file to get
+ * Please check the ".kuzzlerc.sample.jsonc" file to get
  * started.
  *
  * @class KuzzleConfiguration
@@ -234,6 +234,8 @@ const defaultConfig = {
                 compression: false,
                 rateLimit: 0,
                 realtimeNotifications: true,
+                resetIdleTimeoutOnSend: false,
+                sendPingsAutomatically: false,
             },
         },
         strictSdkVersion: true,

package/lib/config/index.js

@@ -197,7 +197,15 @@ function checkWebSocketOptions(config) {
   );
   assert(
     typeof cfg.compression === "boolean",
-    `[websocket] "compression" parameter: invalid value "${cfg.compression}" (boolean value expected)`
+    `[websocket] "compression" parameter: invalid value "${cfg.compression}" (boolean expected)`
+  );
+  assert(
+    typeof cfg.sendPingsAutomatically === "boolean",
+    `[websocket] "sendPingsAutomatically" parameter: invalid value "${cfg.sendPingsAutomatically}" (boolean expected)`
+  );
+  assert(
+    typeof cfg.resetIdleTimeoutOnSend === "boolean",
+    `[websocket] "resetIdleTimeoutOnSend" parameter: invalid value "${cfg.resetIdleTimeoutOnSend}" (boolean expected)`
   );
 }
 
@@ -334,7 +342,7 @@ function preprocessProtocolsOptions(config) {
 
 function preprocessRedisOptions(redisConfig) {
   // @deprecated Remove those lines for Kuzzle v3 then
-  // remove also 'database' from .kuzzlerc.sample and default.config
+  // remove also 'database' from .kuzzlerc.sample.jsonc and default.config
   if (redisConfig.database) {
     redisConfig.options = { db: redisConfig.database, ...redisConfig.options };
   }

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

@@ -33,10 +33,10 @@ class HttpMessage {
     this.connection = connection;
     this._content = null;
     this.ips = connection.ips;
-    this.query = request.getQuery() || "";
+    this.query = request.getQuery();
     this.path = request.getUrl();
 
-    if (this.query.length > 0) {
+    if (this.query && this.query.length > 0) {
       this.path = `${request.getUrl()}?${this.query}`;
     } else {
       this.path = request.getUrl();

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

@@ -498,23 +498,30 @@ class HttpWsProtocol extends Protocol {
       return;
     }
 
-    const contentType = message.headers["content-type"];
+    const contentTypeHeader = message.headers["content-type"];
 
-    if (
-      contentType &&
-      !this.httpConfig.opts.allowedContentTypes.some((allowed) =>
-        contentType.includes(allowed)
-      )
-    ) {
-      this.httpSendError(
-        message,
-        response,
-        kerrorHTTP.get("unsupported_content", contentType)
-      );
-      return;
+    if (contentTypeHeader) {
+      const contentTypeParamIndex = contentTypeHeader.indexOf(";");
+      const contentType =
+        contentTypeParamIndex !== -1
+          ? contentTypeHeader.slice(0, contentTypeParamIndex).trim()
+          : contentTypeHeader.trim();
+
+      if (
+        !this.httpConfig.opts.allowedContentTypes.some(
+          (allowed) => contentType === allowed
+        )
+      ) {
+        this.httpSendError(
+          message,
+          response,
+          kerrorHTTP.get("unsupported_content", contentType)
+        );
+        return;
+      }
     }
 
-    const encoding = CHARSET_REGEX.exec(contentType);
+    const encoding = CHARSET_REGEX.exec(contentTypeHeader);
 
     if (encoding !== null && encoding[1].toLowerCase() !== "utf-8") {
       this.httpSendError(
@@ -1162,6 +1169,8 @@ class HttpWsProtocol extends Protocol {
         compression,
         idleTimeout: idleTimeoutInSecond,
         maxPayloadLength: this.maxRequestSize,
+        resetIdleTimeoutOnSend: cfg.resetIdleTimeoutOnSend,
+        sendPingsAutomatically: cfg.sendPingsAutomatically,
       },
       rateLimit: cfg.rateLimit,
     };

package/lib/service/storage/elasticsearch.js

@@ -118,6 +118,7 @@ class ElasticSearch extends Service {
       "aggs",
       "collapse",
       "explain",
+      "fields",
       "from",
       "highlight",
       "query",
@@ -2260,8 +2261,6 @@ class ElasticSearch extends Service {
             reason: "document already exists",
             status: 400,
           });
-
-          idx++;
         } else {
           esRequest.body.push({
             index: {
@@ -2273,6 +2272,7 @@ class ElasticSearch extends Service {
 
           toImport.push(document);
         }
+        idx++;
       } else {
         esRequest.body.push({ index: { _index: alias } });
         esRequest.body.push(document._source);

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

@@ -198,6 +198,18 @@ export type ServerConfiguration = {
              * @default true
              */
             realtimeNotifications: boolean;
+            /**
+             * Whether or not we should automatically send pings to uphold a stable connection given whatever idleTimeout.
+             *
+             * @default false
+             */
+            sendPingsAutomatically: boolean;
+            /**
+             * Whether or not we should reset the idle timeout on every message received.
+             *
+             * @default false
+             */
+            resetIdleTimeoutOnSend: boolean;
         };
     };
     /**

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
-  "version": "2.26.3",
+  "version": "2.27.1",
   "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": {