kuzzle 2.27.1 → 2.27.3

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

@@ -66,10 +66,10 @@ const JSON_ENDER = '"}';
 // Pre-computed messages & errors
 const WS_FORCED_TERMINATION_CODE = 1011;
 const WS_BACKPRESSURE_MESSAGE = Buffer.from(
-  "too much backpressure: client is too slow"
+  "too much backpressure: client is too slow",
 );
 const WS_GENERIC_CLOSE_MESSAGE = Buffer.from(
-  "Connection closed by remote host"
+  "Connection closed by remote host",
 );
 const WS_RATE_LIMIT_EXCEEDED_ERROR = kerrorWS.get("ratelimit_exceeded");
 const HTTP_REQUEST_TOO_LARGE_ERROR = kerrorHTTP.get("request_too_large");
@@ -84,7 +84,7 @@ const HTTP_ALLOWED_CONTENT_TYPES = [
 const HTTP_SKIPPED_HEADERS = ["content-length", "set-cookie"];
 const HTTP_HEADER_CONNECTION = Buffer.from("Connection");
 const HTTP_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN = Buffer.from(
-  "Access-Control-Allow-Origin"
+  "Access-Control-Allow-Origin",
 );
 const HTTP_HEADER_SET_COOKIE = Buffer.from("Set-Cookie");
 const HTTP_HEADER_VARY = Buffer.from("Vary");
@@ -148,7 +148,7 @@ class HttpWsProtocol extends Protocol {
     this.server.listen(entrypoint.config.port, (socket) => {
       if (!socket) {
         throw new Error(
-          `[http/websocket] fatal: unable to listen to port ${entrypoint.config.port}`
+          `[http/websocket] fatal: unable to listen to port ${entrypoint.config.port}`,
         );
       }
     });
@@ -204,7 +204,7 @@ class HttpWsProtocol extends Protocol {
       debugWS(
         'Publishing to channel "realtime/%s": %s',
         channel,
-        payloadSafeCopy
+        payloadSafeCopy,
       );
       this.server.publish(`realtime/${channel}`, payloadSafeCopy, false);
     }
@@ -236,7 +236,7 @@ class HttpWsProtocol extends Protocol {
     debugWS(
       'Subscribing connection ID "%s" to channel "realtime/%s"',
       connectionId,
-      channel
+      channel,
     );
     socket.subscribe(`realtime/${channel}`);
   }
@@ -251,7 +251,7 @@ class HttpWsProtocol extends Protocol {
     debugWS(
       'Removing connection ID "%s" from channel "realtime/%s"',
       connectionId,
-      channel
+      channel,
     );
 
     socket.unsubscribe(`realtime/${channel}`);
@@ -268,7 +268,7 @@ class HttpWsProtocol extends Protocol {
 
     socket.end(
       WS_FORCED_TERMINATION_CODE,
-      message ? Buffer.from(message) : WS_GENERIC_CLOSE_MESSAGE
+      message ? Buffer.from(message) : WS_GENERIC_CLOSE_MESSAGE,
     );
   }
 
@@ -287,7 +287,7 @@ class HttpWsProtocol extends Protocol {
       req.getHeader("sec-websocket-key"),
       req.getHeader("sec-websocket-protocol"),
       req.getHeader("sec-websocket-extensions"),
-      context
+      context,
     );
   }
 
@@ -297,7 +297,7 @@ class HttpWsProtocol extends Protocol {
       this.name,
       [ip],
       socket.headers,
-      socket.internal
+      socket.internal,
     );
 
     this.entryPoint.newConnection(connection);
@@ -318,7 +318,7 @@ class HttpWsProtocol extends Protocol {
         "[%s] received a `close` event (CODE: %d, REASON: %s)",
         connection.id,
         code,
-        Buffer.from(message || "").toString()
+        Buffer.from(message || "").toString(),
       );
     }
     this.entryPoint.removeConnection(connection.id);
@@ -356,13 +356,13 @@ class HttpWsProtocol extends Protocol {
 
     ({ payload: message } = await global.kuzzle.pipe(
       "protocol:websocket:beforeParsingPayload",
-      { connection, payload: message }
+      { connection, payload: message },
     ));
 
     try {
       ({ payload: parsed } = await global.kuzzle.pipe(
         "protocol:websocket:afterParsingPayload",
-        { connection, payload: JSON.parse(message) }
+        { connection, payload: JSON.parse(message) },
       ));
     } catch (e) {
       /*
@@ -375,7 +375,7 @@ class HttpWsProtocol extends Protocol {
       this.wsSendError(
         socket,
         connection,
-        kerrorWS.getFrom(e, "unexpected_error", e.message)
+        kerrorWS.getFrom(e, "unexpected_error", e.message),
       );
       return;
     }
@@ -487,7 +487,7 @@ class HttpWsProtocol extends Protocol {
     const connection = new ClientConnection(
       "HTTP/1.1",
       getHttpIps(response, request),
-      request.headers
+      request.headers,
     );
     const message = new HttpMessage(connection, request);
 
@@ -509,13 +509,13 @@ class HttpWsProtocol extends Protocol {
 
       if (
         !this.httpConfig.opts.allowedContentTypes.some(
-          (allowed) => contentType === allowed
+          (allowed) => contentType === allowed,
         )
       ) {
         this.httpSendError(
           message,
           response,
-          kerrorHTTP.get("unsupported_content", contentType)
+          kerrorHTTP.get("unsupported_content", contentType),
         );
         return;
       }
@@ -527,7 +527,7 @@ class HttpWsProtocol extends Protocol {
       this.httpSendError(
         message,
         response,
-        kerrorHTTP.get("unsupported_charset", encoding[1].toLowerCase())
+        kerrorHTTP.get("unsupported_charset", encoding[1].toLowerCase()),
       );
       return;
     }
@@ -591,7 +591,7 @@ class HttpWsProtocol extends Protocol {
 
         const { payload: newPayload } = await global.kuzzle.pipe(
           "protocol:http:beforeParsingPayload",
-          { message, payload: inflated }
+          { message, payload: inflated },
         );
         await this.httpParseContent(message, newPayload, cb);
         resolve();
@@ -641,12 +641,12 @@ class HttpWsProtocol extends Protocol {
       try {
         const { payload } = await global.kuzzle.pipe(
           "protocol:http:afterParsingPayload",
-          { message, payload: JSON.parse(content.toString()) }
+          { message, payload: JSON.parse(content.toString()) },
         );
         message.content = payload;
       } catch (e) {
         cb(
-          kerrorHTTP.get("body_parse_failed", content.toString().slice(0, 50))
+          kerrorHTTP.get("body_parse_failed", content.toString().slice(0, 50)),
         );
         return;
       }
@@ -693,7 +693,7 @@ class HttpWsProtocol extends Protocol {
 
           const [success] = response.tryEnd(
             result.compressed,
-            result.compressed.length
+            result.compressed.length,
           );
 
           if (!success) {
@@ -701,7 +701,7 @@ class HttpWsProtocol extends Protocol {
               const retryData = result.compressed.subarray(offset);
               const [retrySuccess] = response.tryEnd(
                 retryData,
-                retryData.length
+                retryData.length,
               );
 
               return retrySuccess;
@@ -739,7 +739,7 @@ class HttpWsProtocol extends Protocol {
     ) {
       response.writeHeader(
         HTTP_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN,
-        Buffer.from(message.headers.origin)
+        Buffer.from(message.headers.origin),
       );
 
       response.writeHeader(HTTP_HEADER_VARY, ORIGIN);
@@ -780,8 +780,8 @@ class HttpWsProtocol extends Protocol {
           "network",
           "http",
           "stream_errored",
-          httpStream.error.message
-        )
+          httpStream.error.message,
+        ),
       );
       return;
     }
@@ -790,7 +790,7 @@ class HttpWsProtocol extends Protocol {
       this.httpSendError(
         message,
         response,
-        kerror.get("network", "http", "stream_closed")
+        kerror.get("network", "http", "stream_closed"),
       );
       return;
     }
@@ -807,7 +807,7 @@ class HttpWsProtocol extends Protocol {
       // Make a copy of the array buffer
       const arrayBuffer = chunk.buffer.slice(
         chunk.byteOffset,
-        chunk.byteOffset + chunk.byteLength
+        chunk.byteOffset + chunk.byteLength,
       );
 
       const arrayBufferOffset = response.getWriteOffset();
@@ -822,7 +822,7 @@ class HttpWsProtocol extends Protocol {
       if (streamSizeFixed) {
         const [success, done] = response.tryEnd(
           arrayBuffer,
-          httpStream.totalBytes
+          httpStream.totalBytes,
         );
         backpressure = !success;
 
@@ -854,13 +854,13 @@ class HttpWsProtocol extends Protocol {
 
           let retryBackpressure = false;
           const remainingChunkData = response.arrayBuffer.slice(
-            offset - response.arrayBufferOffset
+            offset - response.arrayBufferOffset,
           );
 
           if (streamSizeFixed) {
             const [success] = response.tryEnd(
               remainingChunkData,
-              httpStream.totalBytes
+              httpStream.totalBytes,
             );
 
             retryBackpressure = !success;
@@ -899,7 +899,7 @@ class HttpWsProtocol extends Protocol {
       debugHTTP(
         "[%s] httpSendStream: %s",
         httpStream.connection.id,
-        err.message
+        err.message,
       );
     });
 
@@ -931,7 +931,7 @@ class HttpWsProtocol extends Protocol {
         connectionId: message.connection.id,
         error: kerr,
       }),
-      message
+      message,
     );
     this.entryPoint.removeConnection(message.connection.id);
 
@@ -951,12 +951,12 @@ class HttpWsProtocol extends Protocol {
         if (global.kuzzle.config.internal.allowAllOrigins) {
           response.writeHeader(
             HTTP_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN,
-            WILDCARD
+            WILDCARD,
           );
         } else {
           response.writeHeader(
             HTTP_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN,
-            Buffer.from(message.headers.origin)
+            Buffer.from(message.headers.origin),
           );
           response.writeHeader(HTTP_HEADER_VARY, ORIGIN);
         }
@@ -1064,7 +1064,7 @@ class HttpWsProtocol extends Protocol {
           callback({
             compressed: !err ? compressed : data,
             encoding: !err ? "gzip" : "identity",
-          })
+          }),
         );
         return;
       } else if (algorithm === "deflate") {
@@ -1072,7 +1072,7 @@ class HttpWsProtocol extends Protocol {
           callback({
             compressed: !err ? compressed : data,
             encoding: !err ? "deflate" : "identity",
-          })
+          }),
         );
         return;
       }
@@ -1137,7 +1137,7 @@ class HttpWsProtocol extends Protocol {
 
     if (cfg === undefined) {
       global.kuzzle.log.warn(
-        "[websocket] no configuration found for websocket: disabling it"
+        "[websocket] no configuration found for websocket: disabling it",
       );
       return { enabled: false };
     }
@@ -1148,7 +1148,7 @@ class HttpWsProtocol extends Protocol {
     if (idleTimeout === 0 || idleTimeout < 1000) {
       idleTimeout = DEFAULT_IDLE_TIMEOUT;
       global.kuzzle.log.warn(
-        `[websocket] The "idleTimeout" parameter can neither be deactivated or be set with a value lower than 1000. Defaulted to ${DEFAULT_IDLE_TIMEOUT}.`
+        `[websocket] The "idleTimeout" parameter can neither be deactivated or be set with a value lower than 1000. Defaulted to ${DEFAULT_IDLE_TIMEOUT}.`,
       );
     }
 
@@ -1159,7 +1159,7 @@ class HttpWsProtocol extends Protocol {
      */
     if (cfg.heartbeat) {
       global.kuzzle.log.warn(
-        '[websocket] The "heartbeat" parameter has been deprecated and is now ignored. The "idleTimeout" parameter should now be configured instead.'
+        '[websocket] The "heartbeat" parameter has been deprecated and is now ignored. The "idleTimeout" parameter should now be configured instead.',
       );
     }
 
@@ -1181,7 +1181,7 @@ class HttpWsProtocol extends Protocol {
 
     if (cfg === undefined) {
       global.kuzzle.log.warn(
-        "[http] no configuration found for http: disabling it"
+        "[http] no configuration found for http: disabling it",
       );
       return { enabled: false };
     }

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

@@ -25,7 +25,7 @@ const Protocol = require("./protocol");
 const ClientConnection = require("../clientConnection");
 
 const debug = require("../../../util/debug")(
-  "kuzzle:network:protocols:internal"
+  "kuzzle:network:protocols:internal",
 );
 
 /**
@@ -63,7 +63,7 @@ class InternalProtocol extends Protocol {
      */
     global.kuzzle.onAsk(
       "core:network:internal:connectionId:get",
-      () => this.connection.id
+      () => this.connection.id,
     );
   }
 

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

@@ -73,7 +73,7 @@ class MqttProtocol extends Protocol {
           port: 1883,
         },
       },
-      this.config
+      this.config,
     );
 
     /*
@@ -93,7 +93,7 @@ class MqttProtocol extends Protocol {
     this.aedes.on("publish", this.onMessage.bind(this));
 
     await new Promise((res) =>
-      this.server.listen(this.config.server.port, res)
+      this.server.listen(this.config.server.port, res),
     );
 
     return true;
@@ -152,7 +152,7 @@ class MqttProtocol extends Protocol {
     const connection = new ClientConnection(
       this.name,
       [client.conn.remoteAddress],
-      {}
+      {},
     );
     this.entryPoint.newConnection(connection);
 
@@ -198,10 +198,10 @@ class MqttProtocol extends Protocol {
       debug(
         "no connection id for client id %s - packet: %o",
         client.id,
-        packet
+        packet,
       );
       global.kuzzle.log.error(
-        `[MQTT] Received a packet from an unregistered client: ${client.id}`
+        `[MQTT] Received a packet from an unregistered client: ${client.id}`,
       );
       return;
     }
@@ -214,7 +214,7 @@ class MqttProtocol extends Protocol {
       const request = new Request(payload, { connection });
 
       this.entryPoint.execute(connection, request, (response) =>
-        this._respond(client, response)
+        this._respond(client, response),
       );
     } catch (error) {
       this._respondError(client, error);
@@ -238,7 +238,7 @@ class MqttProtocol extends Protocol {
         payload: Buffer.from(JSON.stringify(response.content)),
         topic: this.config.responseTopic,
       },
-      this.publishCallback
+      this.publishCallback,
     );
   }
 
@@ -250,7 +250,7 @@ class MqttProtocol extends Protocol {
       {
         connection,
         error: kerror.getFrom(error, "unexpected_error", error.message),
-      }
+      },
     );
     this._respond(client, removeStacktrace(errReq.response.toJSON()));
   }
@@ -270,7 +270,7 @@ class MqttProtocol extends Protocol {
       callback(
         topic === this.config.requestTopic
           ? null
-          : new Error("Cannot publish on this topic: unauthorized")
+          : new Error("Cannot publish on this topic: unauthorized"),
       );
     }
   }

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

@@ -52,7 +52,7 @@ class Protocol {
     // name should be passed in the constructor
     assert(
       this.name && !name,
-      "A name has been given in the constructor and init method. Passing the name in the init method is deprecated."
+      "A name has been given in the constructor and init method. Passing the name in the init method is deprecated.",
     );
 
     if (!this.name) {
@@ -63,7 +63,7 @@ class Protocol {
 
     assert(
       typeof this.name === "string" && this.name.length > 0,
-      'Invalid "name" parameter value: expected a non empty string value'
+      'Invalid "name" parameter value: expected a non empty string value',
     );
 
     if (entryPoint.config.protocols && entryPoint.config.protocols[this.name]) {
@@ -72,7 +72,7 @@ class Protocol {
 
     assert(
       Number.isInteger(this.maxRequestSize),
-      'Invalid "maxRequestSize" parameter value: expected a numeric value'
+      'Invalid "maxRequestSize" parameter value: expected a numeric value',
     );
 
     this.initCalled = true;

package/lib/core/network/router.js

@@ -49,8 +49,8 @@ class Router {
           "protocol",
           "runtime",
           "invalid_connection",
-          JSON.stringify(requestContext)
-        )
+          JSON.stringify(requestContext),
+        ),
       );
     } else {
       this.connections.set(requestContext.connection.id, requestContext);
@@ -72,8 +72,8 @@ class Router {
           "protocol",
           "runtime",
           "invalid_connection",
-          JSON.stringify(requestContext.context)
-        )
+          JSON.stringify(requestContext.context),
+        ),
       );
       return;
     }
@@ -84,8 +84,8 @@ class Router {
           "protocol",
           "runtime",
           "unknown_connection",
-          JSON.stringify(connId)
-        )
+          JSON.stringify(connId),
+        ),
       );
       return;
     }
@@ -130,7 +130,7 @@ class Router {
 
       const apiRequest = new Request(
         requestPayload,
-        request.serialize().options
+        request.serialize().options,
       );
 
       this._executeFromHttp("post", apiRequest, cb);

package/lib/core/plugin/plugin.js

@@ -41,7 +41,7 @@ const HTTP_VERBS = ["get", "head", "post", "put", "delete", "patch", "options"];
 class Plugin {
   constructor(
     instance,
-    { name, application = false, deprecationWarning = true } = {}
+    { name, application = false, deprecationWarning = true } = {},
   ) {
     this._instance = instance;
 
@@ -65,7 +65,7 @@ class Plugin {
 
     if (global.kuzzle.config.plugins[this.name]) {
       this.config = JSON.parse(
-        JSON.stringify(global.kuzzle.config.plugins[this.name])
+        JSON.stringify(global.kuzzle.config.plugins[this.name]),
       );
     }
 
@@ -83,7 +83,7 @@ class Plugin {
       if (
         !semver.satisfies(
           global.kuzzle.config.version,
-          this.manifest.kuzzleVersion
+          this.manifest.kuzzleVersion,
         )
       ) {
         throw kerror.get(
@@ -92,7 +92,7 @@ class Plugin {
           "version_mismatch",
           this.name,
           global.kuzzle.config.version,
-          this.manifest.kuzzleVersion
+          this.manifest.kuzzleVersion,
         );
       }
     }
@@ -141,7 +141,7 @@ class Plugin {
 
     if (has(this.instance, "controllers")) {
       description.controllers = Object.keys(this.instance.controllers).map(
-        (controller) => `${this.name}/${controller}`
+        (controller) => `${this.name}/${controller}`,
       );
     }
 
@@ -207,7 +207,7 @@ class Plugin {
   set name(name) {
     if (!this.constructor.checkName(name)) {
       this.printDeprecation(
-        "Plugin names should be in kebab-case. This behavior will be enforced in futur versions of Kuzzle."
+        "Plugin names should be in kebab-case. This behavior will be enforced in futur versions of Kuzzle.",
       );
     }
 
@@ -268,7 +268,7 @@ class Plugin {
         errorCodes.loadPluginsErrors(plugin.manifest.raw, pluginCode);
 
         global.kuzzle.log.info(
-          `${plugin.logPrefix} Custom errors successfully loaded.`
+          `${plugin.logPrefix} Custom errors successfully loaded.`,
         );
       } catch (err) {
         if (
@@ -281,7 +281,7 @@ class Plugin {
             "manifest",
             "invalid_errors",
             plugin.manifest.name,
-            err.message
+            err.message,
           );
         }
 
@@ -304,12 +304,12 @@ class Plugin {
   static checkControllerDefinition(
     name,
     definition,
-    { application = false } = {}
+    { application = false } = {},
   ) {
     if (typeof name !== "string") {
       throw assertionError.get(
         "invalid_controller_definition",
-        "Controller name must be a string"
+        "Controller name must be a string",
       );
     }
 
@@ -317,7 +317,7 @@ class Plugin {
       throw assertionError.get(
         "invalid_controller_definition",
         name,
-        "Controller definition must be an object"
+        "Controller definition must be an object",
       );
     }
 
@@ -325,12 +325,12 @@ class Plugin {
       throw assertionError.get(
         "invalid_controller_definition",
         name,
-        'Controller definition "actions" property must be an object'
+        'Controller definition "actions" property must be an object',
       );
     }
 
     for (const [action, actionDefinition] of Object.entries(
-      definition.actions
+      definition.actions,
     )) {
       const actionProperties = Object.keys(actionDefinition);
 
@@ -342,8 +342,8 @@ class Plugin {
           "invalid_controller_definition",
           name,
           `action "${action}" has invalid properties: ${actionProperties.join(
-            ", "
-          )}`
+            ", ",
+          )}`,
         );
       }
 
@@ -351,7 +351,7 @@ class Plugin {
         throw assertionError.get(
           "invalid_controller_definition",
           name,
-          "action names must be strings"
+          "action names must be strings",
         );
       }
 
@@ -359,7 +359,7 @@ class Plugin {
         throw assertionError.get(
           "invalid_controller_definition",
           name,
-          `action "${action}" handler must be a function`
+          `action "${action}" handler must be a function`,
         );
       }
 
@@ -368,7 +368,7 @@ class Plugin {
           throw assertionError.get(
             "invalid_controller_definition",
             name,
-            `action "${action}" http definition must be an array`
+            `action "${action}" http definition must be an array`,
           );
         }
 
@@ -377,7 +377,7 @@ class Plugin {
             throw assertionError.get(
               "invalid_controller_definition",
               name,
-              `action "${action}" http "verb" property must be a non-empty string`
+              `action "${action}" http "verb" property must be a non-empty string`,
             );
           }
 
@@ -385,7 +385,7 @@ class Plugin {
             throw assertionError.get(
               "invalid_controller_definition",
               name,
-              `action "${action}" http verb "${route.verb}" is not a valid http verb`
+              `action "${action}" http verb "${route.verb}" is not a valid http verb`,
             );
           }
 
@@ -402,8 +402,8 @@ class Plugin {
               "invalid_controller_definition",
               name,
               `action "${action}" has invalid http properties: ${routeProperties.join(
-                ", "
-              )}`
+                ", ",
+              )}`,
             );
           }
         }
@@ -421,7 +421,7 @@ function checkHttpRouteProperties(route, action, name, application) {
     throw assertionError.get(
       "invalid_controller_definition",
       name,
-      `action "${action}" http "path" property must be a non-empty string`
+      `action "${action}" http "path" property must be a non-empty string`,
     );
   }
 }

package/lib/core/plugin/pluginManifest.js

@@ -45,7 +45,7 @@ class PluginManifest extends AbstractManifest {
         throw kerror.get(
           "invalid_privileged",
           this.path,
-          typeof this.raw.privileged
+          typeof this.raw.privileged,
         );
       }
       this.privileged = this.raw.privileged;