kuzzle 2.26.2 → 2.27.0

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

@@ -1162,6 +1162,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",

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.2",
+  "version": "2.27.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": {
@@ -78,7 +78,7 @@
     "semver": "^7.3.8",
     "sorted-array": "^2.0.4",
     "uuid": "9.0.1",
-    "uWebSockets.js": "https://github.com/uNetworking/uWebSockets.js/archive/refs/tags/v20.31.0.tar.gz",
+    "uWebSockets.js": "https://github.com/uNetworking/uWebSockets.js/archive/refs/tags/v20.32.0.tar.gz",
     "validator": "13.11.0",
     "winston": "3.10.0",
     "winston-elasticsearch": "0.17.4",