kuzzle 2.19.2 → 2.19.3

package/lib/api/request/requestInput.js

@@ -48,20 +48,20 @@ const internalError_1 = require("../../kerror/errors/internalError");
 const assert = __importStar(require("../../util/assertType"));
 // private properties
 // \u200b is a zero width space, used to masquerade console.log output
-const _jwt = 'jwt\u200b';
-const _volatile = 'volatile\u200b';
-const _body = 'body\u200b';
-const _headers = 'headers\u200b';
-const _controller = 'controller\u200b';
-const _action = 'action\u200b';
+const _jwt = "jwt\u200b";
+const _volatile = "volatile\u200b";
+const _body = "body\u200b";
+const _headers = "headers\u200b";
+const _controller = "controller\u200b";
+const _action = "action\u200b";
 // any property not listed here will be copied into
 // RequestInput.args
 const resourceProperties = new Set([
-    'jwt',
-    'volatile',
-    'body',
-    'controller',
-    'action',
+    "jwt",
+    "volatile",
+    "body",
+    "controller",
+    "action",
 ]);
 /**
  * @deprecated
@@ -118,8 +118,8 @@ class RequestInput {
      * Any undefined option is set to null
      */
     constructor(data) {
-        if (!data || typeof data !== 'object' || Array.isArray(data)) {
-            throw new internalError_1.InternalError('Input request data must be a non-null object');
+        if (!data || typeof data !== "object" || Array.isArray(data)) {
+            throw new internalError_1.InternalError("Input request data must be a non-null object");
         }
         this[_jwt] = null;
         this[_volatile] = null;
@@ -169,7 +169,7 @@ class RequestInput {
         return this[_jwt];
     }
     set jwt(str) {
-        this[_jwt] = assert.assertString('jwt', str);
+        this[_jwt] = assert.assertString("jwt", str);
     }
     /**
      * API controller name.
@@ -194,7 +194,7 @@ class RequestInput {
     set controller(str) {
         // can only be set once
         if (!this[_controller]) {
-            this[_controller] = assert.assertString('controller', str);
+            this[_controller] = assert.assertString("controller", str);
         }
     }
     /**
@@ -220,7 +220,7 @@ class RequestInput {
     set action(str) {
         // can only be set once
         if (!this[_action]) {
-            this[_action] = assert.assertString('action', str);
+            this[_action] = assert.assertString("action", str);
         }
     }
     /**
@@ -245,7 +245,7 @@ class RequestInput {
         return this[_body];
     }
     set body(obj) {
-        this[_body] = assert.assertObject('body', obj);
+        this[_body] = assert.assertObject("body", obj);
     }
     /**
      * Request headers (Http only).
@@ -256,7 +256,7 @@ class RequestInput {
         return this[_headers];
     }
     set headers(obj) {
-        this[_headers] = assert.assertObject('headers', obj);
+        this[_headers] = assert.assertObject("headers", obj);
     }
     /**
      * Volatile object.
@@ -279,7 +279,7 @@ class RequestInput {
         return this[_volatile];
     }
     set volatile(obj) {
-        this[_volatile] = assert.assertObject('volatile', obj);
+        this[_volatile] = assert.assertObject("volatile", obj);
     }
 }
 exports.RequestInput = RequestInput;

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

@@ -1,6 +1,6 @@
-import { JSONObject } from 'kuzzle-sdk';
-import { Deprecation } from '../../types';
-import { KuzzleError } from '../../kerror/errors/kuzzleError';
+import { JSONObject } from "kuzzle-sdk";
+import { Deprecation } from "../../types";
+import { KuzzleError } from "../../kerror/errors/kuzzleError";
 export declare class Headers {
     headers: JSONObject;
     private namesMap;
@@ -94,7 +94,7 @@ export declare class RequestResponse {
     configure(options?: {
         headers?: JSONObject;
         status?: number;
-        format?: 'standard' | 'raw';
+        format?: "standard" | "raw";
     }): void;
     /**
      * Gets a header value (case-insensitive)

package/lib/api/request/requestResponse.js

@@ -47,13 +47,11 @@ exports.RequestResponse = exports.Headers = void 0;
 const assert = __importStar(require("../../util/assertType"));
 // private properties
 // \u200b is a zero width space, used to masquerade console.log output
-const _request = 'request\u200b';
-const _headers = 'headers\u200b';
-const _userHeaders = 'userHeaders\u200b'; // List of headers to be sent in the response
+const _request = "request\u200b";
+const _headers = "headers\u200b";
+const _userHeaders = "userHeaders\u200b"; // List of headers to be sent in the response
 // List of headers that should not be present in the body of the response
-const restrictedHeaders = [
-    'set-cookie',
-];
+const restrictedHeaders = ["set-cookie"];
 class Headers {
     constructor() {
         this.namesMap = new Map();
@@ -63,7 +61,7 @@ class Headers {
             get: (target, name) => this.getHeader(name),
             set: (target, name, value) => this.setHeader(name, value),
         });
-        this.setHeader('X-Kuzzle-Node', global.kuzzle.id);
+        this.setHeader("X-Kuzzle-Node", global.kuzzle.id);
     }
     /**
      * Gets a header value
@@ -71,17 +69,17 @@ class Headers {
      * @param name Header name. Could be a string (case-insensitive) or a symbol
      */
     getHeader(name) {
-        if (typeof name === 'symbol') {
+        if (typeof name === "symbol") {
             return this.headers[name];
         }
-        assert.assertString('header name', name);
+        assert.assertString("header name", name);
         if (!name) {
             return;
         }
         return this.headers[this.namesMap.get(name.toLowerCase())];
     }
     removeHeader(name) {
-        assert.assertString('header name', name);
+        assert.assertString("header name", name);
         if (!name) {
             return true;
         }
@@ -94,7 +92,7 @@ class Headers {
         return true;
     }
     setHeader(name, value) {
-        assert.assertString('header name', name);
+        assert.assertString("header name", name);
         if (!name) {
             return true;
         }
@@ -108,25 +106,25 @@ class Headers {
         // Common HTTP headers are overwritten when set, instead of being
         // concatenated
         switch (lowerCased) {
-            case 'age':
-            case 'authorization':
-            case 'content-length':
-            case 'content-type':
-            case 'etag':
-            case 'expires':
-            case 'from':
-            case 'host':
-            case 'if-modified-since':
-            case 'if-unmodified-since':
-            case 'last-modified, location':
-            case 'max-forwards':
-            case 'proxy-authorization':
-            case 'referer':
-            case 'retry-after':
-            case 'user-agent':
+            case "age":
+            case "authorization":
+            case "content-length":
+            case "content-type":
+            case "etag":
+            case "expires":
+            case "from":
+            case "host":
+            case "if-modified-since":
+            case "if-unmodified-since":
+            case "last-modified, location":
+            case "max-forwards":
+            case "proxy-authorization":
+            case "referer":
+            case "retry-after":
+            case "user-agent":
                 this.headers[_name] = _value;
                 break;
-            case 'set-cookie':
+            case "set-cookie":
                 if (!this.headers[_name]) {
                     this.headers[_name] = [_value];
                 }
@@ -136,7 +134,7 @@ class Headers {
                 break;
             default: {
                 if (this.headers[_name]) {
-                    this.headers[_name] += ', ' + _value;
+                    this.headers[_name] += ", " + _value;
                 }
                 else {
                     this.headers[_name] = _value;
@@ -271,10 +269,10 @@ class RequestResponse {
             this.status = 200;
         }
         switch (options.format) {
-            case 'raw':
+            case "raw":
                 this.raw = true;
                 break;
-            case 'standard':
+            case "standard":
                 this.raw = false;
                 break;
         }
@@ -302,7 +300,7 @@ class RequestResponse {
      * Adds new multiple headers.
      */
     setHeaders(headers, ifNotPresent = false) {
-        assert.assertObject('headers', headers);
+        assert.assertObject("headers", headers);
         if (headers) {
             for (const name of Object.keys(headers)) {
                 // When ifNotPresent is set to true, only set the header if no value has been defined before
@@ -334,7 +332,7 @@ class RequestResponse {
          * For example "set-cookie" headers should only be visible by the browser,
          * otherwise they may leak information about the server's cookies, since the browser will
          * not be able to restrict them to the domain of the request.
-        */
+         */
         for (const header of restrictedHeaders) {
             if (filteredHeaders[header] !== undefined) {
                 filteredHeaders[header] = undefined;

package/lib/cluster/command.js

@@ -19,11 +19,11 @@
  * limitations under the License.
  */
 
-'use strict';
+"use strict";
 
-const { Reply, Request } = require('zeromq');
-const protobuf = require('protobufjs');
-const Bluebird = require('bluebird');
+const { Reply, Request } = require("zeromq");
+const protobuf = require("protobufjs");
+const Bluebird = require("bluebird");
 
 /* eslint-disable sort-keys */
 const stateEnum = Object.freeze({
@@ -33,9 +33,9 @@ const stateEnum = Object.freeze({
 });
 
 const topicEnum = Object.freeze({
-  FULLSTATE: 'fullstate',
-  HANDSHAKE: 'handshake',
-  DISCARDED: 'discarded', // 0 byte message expected
+  FULLSTATE: "fullstate",
+  HANDSHAKE: "handshake",
+  DISCARDED: "discarded", // 0 byte message expected
 });
 /* eslint-enable sort-keys */
 
@@ -45,7 +45,7 @@ class ClusterCommand {
    * @constructor
    * @param {ClusterNode} localNode
    */
-  constructor (localNode) {
+  constructor(localNode) {
     this.node = localNode;
     this.server = null;
     this.protoroot = null;
@@ -53,14 +53,14 @@ class ClusterCommand {
     this.state = stateEnum.INITIALIZING;
   }
 
-  async init () {
+  async init() {
     this.protoroot = await protobuf.load(`${__dirname}/protobuf/command.proto`);
     await this.serve();
 
     this.listen();
   }
 
-  async serve () {
+  async serve() {
     this.server = new Reply();
     await this.server.bind(`tcp://*:${this.node.config.ports.command}`);
   }
@@ -73,7 +73,7 @@ class ClusterCommand {
    *
    * @returns {void}
    */
-  async listen () {
+  async listen() {
     this.state = stateEnum.RUNNING;
 
     while (this.state === stateEnum.RUNNING) {
@@ -92,8 +92,7 @@ class ClusterCommand {
             // to send some kind of response on an invalid request received
             await this.server.send([topicEnum.DISCARDED, null]);
         }
-      }
-      catch (e) {
+      } catch (e) {
         if (this.state !== stateEnum.CLOSED) {
           throw e;
         }
@@ -105,7 +104,7 @@ class ClusterCommand {
    * Closes opened sockets and marks this server as closed.
    * @return {void}
    */
-  dispose () {
+  dispose() {
     this.state = stateEnum.CLOSED;
     this.server.close();
   }
@@ -114,21 +113,21 @@ class ClusterCommand {
    * Sends back the full state to the requesting node
    * @return {void}
    */
-  async sendFullState () {
+  async sendFullState() {
     const fullState = this.node.fullState.serialize();
     fullState.activity = this.node.activity;
     fullState.nodesState = [];
     for (const [id, subscriber] of this.node.remoteNodes.entries()) {
       fullState.nodesState.push({
         id,
-        lastMessageId: subscriber.lastMessageId
+        lastMessageId: subscriber.lastMessageId,
       });
     }
     fullState.nodesState.push({
       id: this.node.nodeId,
-      lastMessageId: this.node.publisher.lastMessageId
+      lastMessageId: this.node.publisher.lastMessageId,
     });
-    const protoEncode = this.protoroot.lookupType('FullStateResponse');
+    const protoEncode = this.protoroot.lookupType("FullStateResponse");
     const buffer = protoEncode.encode(protoEncode.create(fullState)).finish();
 
     await this.server.send([topicEnum.FULLSTATE, buffer]);
@@ -138,13 +137,15 @@ class ClusterCommand {
    * Handles a handshake request from a remote node
    * @return {void}
    */
-  async handleHandshake (data) {
-    const decoder = this.protoroot.lookupType('HandshakeRequest');
-    const { nodeId, ip, lastMessageId } = decoder.toObject(decoder.decode(data));
+  async handleHandshake(data) {
+    const decoder = this.protoroot.lookupType("HandshakeRequest");
+    const { nodeId, ip, lastMessageId } = decoder.toObject(
+      decoder.decode(data)
+    );
 
     const added = await this.node.addNode(nodeId, ip, lastMessageId);
 
-    const encoder = this.protoroot.lookupType('HandshakeResponse');
+    const encoder = this.protoroot.lookupType("HandshakeResponse");
     const response = {
       added,
       lastMessageId: this.node.publisher.lastMessageId,
@@ -163,11 +164,15 @@ class ClusterCommand {
    * @param  {Array.<IdCard>} nodes
    * @return {Object|null} Returns the fetched full state, or null if no node answered
    */
-  async getFullState (nodes) {
+  async getFullState(nodes) {
     let idx = Math.floor(Math.random() * Math.floor(nodes.length));
     let fullState = null;
 
-    for (let retries = 0; fullState === null && retries < nodes.length; retries++) {
+    for (
+      let retries = 0;
+      fullState === null && retries < nodes.length;
+      retries++
+    ) {
       const { id, ip } = nodes[idx];
       const req = new Request();
 
@@ -180,14 +185,14 @@ class ClusterCommand {
 
       try {
         [, fullState] = await req.receive();
-      }
-      catch (e) {
+      } catch (e) {
         // no response from the remote node in a timely fashion... retrying
         // with another one
-        global.kuzzle.log.warn(`Unable to fetch a full state from node ${id} (no response received)`);
+        global.kuzzle.log.warn(
+          `Unable to fetch a full state from node ${id} (no response received)`
+        );
         idx = (idx + 1) % nodes.length;
-      }
-      finally {
+      } finally {
         req.close();
       }
     }
@@ -196,7 +201,7 @@ class ClusterCommand {
       return null;
     }
 
-    const decoder = this.protoroot.lookupType('FullStateResponse');
+    const decoder = this.protoroot.lookupType("FullStateResponse");
 
     return decoder.toObject(decoder.decode(fullState));
   }
@@ -213,28 +218,27 @@ class ClusterCommand {
    * @param  {Array.<IdCard>} nodes
    * @return {Object}
    */
-  async broadcastHandshake (nodes) {
+  async broadcastHandshake(nodes) {
     const payload = {
       ip: this.node.ip,
       lastMessageId: this.node.publisher.lastMessageId,
       nodeId: this.node.nodeId,
     };
 
-    const encoder = this.protoroot.lookupType('HandshakeRequest');
+    const encoder = this.protoroot.lookupType("HandshakeRequest");
     const encoded = encoder.encode(encoder.create(payload)).finish();
 
-    const responses = await Bluebird.map(
-      nodes,
-      ({ id, ip }) => this._sendSingleHandshake(id, ip, encoded));
+    const responses = await Bluebird.map(nodes, ({ id, ip }) =>
+      this._sendSingleHandshake(id, ip, encoded)
+    );
 
-    const decoder = this.protoroot.lookupType('HandshakeResponse');
+    const decoder = this.protoroot.lookupType("HandshakeResponse");
     const result = {};
 
     for (let i = 0; i < nodes.length; i++) {
       if (responses[i] === null) {
         result[nodes[i].id] = null;
-      }
-      else {
+      } else {
         result[nodes[i].id] = decoder.toObject(decoder.decode(responses[i]));
       }
     }
@@ -251,7 +255,7 @@ class ClusterCommand {
    * @return {Object|null}    - handshake encoded response, or null if no
    *                            response was received
    */
-  async _sendSingleHandshake (id, ip, payload) {
+  async _sendSingleHandshake(id, ip, payload) {
     const req = new Request();
 
     req.receiveTimeout = 2000;
@@ -264,11 +268,11 @@ class ClusterCommand {
 
     try {
       [, response] = await req.receive();
-    }
-    catch (e) {
-      global.kuzzle.log.warn(`Couldn't complete handshake with node ${id}: no response received`);
-    }
-    finally {
+    } catch (e) {
+      global.kuzzle.log.warn(
+        `Couldn't complete handshake with node ${id}: no response received`
+      );
+    } finally {
       req.close();
     }
 

package/lib/cluster/idCardHandler.d.ts

@@ -1,4 +1,4 @@
-import '../types';
+import "../types";
 export declare type SerializedIdCard = {
     id: string;
     ip: string;

package/lib/cluster/idCardHandler.js

@@ -28,8 +28,8 @@ const name_generator_1 = require("../util/name-generator");
 const worker_threads_1 = require("worker_threads");
 const bluebird_1 = __importDefault(require("bluebird"));
 require("../types");
-const REDIS_PREFIX = '{cluster/node}/';
-const REDIS_ID_CARDS_INDEX = REDIS_PREFIX + 'id-cards-index';
+const REDIS_PREFIX = "{cluster/node}/";
+const REDIS_ID_CARDS_INDEX = REDIS_PREFIX + "id-cards-index";
 class IdCard {
     constructor({ id, ip, birthdate, topology }) {
         this.id = id;
@@ -98,7 +98,7 @@ class ClusterIdCardHandler {
     async createIdCard() {
         let reserved = false;
         do {
-            this.nodeId = name_generator_1.NameGenerator.generateRandomName({ prefix: 'knode' });
+            this.nodeId = name_generator_1.NameGenerator.generateRandomName({ prefix: "knode" });
             this.nodeIdKey = `${REDIS_PREFIX}${this.nodeId}`;
             this.idCard = new IdCard({
                 birthdate: Date.now(),
@@ -111,14 +111,14 @@ class ClusterIdCardHandler {
         await this.addIdCardToIndex();
         this.refreshWorker = this.constructWorker(`${__dirname}/workers/IDCardRenewer.js`);
         this.refreshWorker.unref();
-        this.refreshWorker.on('message', async (message) => {
+        this.refreshWorker.on("message", async (message) => {
             if (message.error) {
                 await this.node.evictSelf(message.error);
             }
         });
         // Transfer informations to the worker
         this.refreshWorker.postMessage({
-            action: 'start',
+            action: "start",
             kuzzle: {
                 config: global.kuzzle.config,
                 id: global.kuzzle.id,
@@ -127,7 +127,7 @@ class ClusterIdCardHandler {
             // Used to configure a redis the same way as the Cache Engine does
             redis: {
                 config: global.kuzzle.config.services.internalCache,
-                name: 'internal_adapter',
+                name: "internal_adapter",
             },
             refreshDelay: this.refreshDelay,
             refreshMultiplier: this.refreshMultiplier,
@@ -155,7 +155,7 @@ class ClusterIdCardHandler {
                 global.kuzzle.log.error(`An error occurred while refreshing the ID card during WorkerThread startup: ${error}`);
             }
         }, this.refreshDelay * this.refreshMultiplier);
-        this.refreshWorker.on('message', ({ initialized }) => {
+        this.refreshWorker.on("message", ({ initialized }) => {
             if (initialized) {
                 clearInterval(this.refreshTimer);
                 this.refreshTimer = null;
@@ -165,7 +165,7 @@ class ClusterIdCardHandler {
     async dispose() {
         this.disposed = true;
         if (this.refreshWorker) {
-            this.refreshWorker.postMessage({ action: 'dispose' });
+            this.refreshWorker.postMessage({ action: "dispose" });
         }
     }
     /**
@@ -187,12 +187,12 @@ class ClusterIdCardHandler {
      */
     async getRemoteIdCards() {
         const idCards = [];
-        let keys = await global.kuzzle.ask('core:cache:internal:execute', 'smembers', REDIS_ID_CARDS_INDEX);
-        keys = keys.filter(nodeIdKey => nodeIdKey !== this.nodeIdKey);
+        let keys = await global.kuzzle.ask("core:cache:internal:execute", "smembers", REDIS_ID_CARDS_INDEX);
+        keys = keys.filter((nodeIdKey) => nodeIdKey !== this.nodeIdKey);
         if (keys.length === 0) {
             return idCards;
         }
-        const rawIdCards = await global.kuzzle.ask('core:cache:internal:mget', keys);
+        const rawIdCards = await global.kuzzle.ask("core:cache:internal:mget", keys);
         const expiredIdCards = [];
         for (let i = 0; i < keys.length; i++) {
             // filter keys that might have expired between the key search and their
@@ -205,8 +205,8 @@ class ClusterIdCardHandler {
             }
         }
         // Clean expired ID Card's keys in the index
-        await bluebird_1.default.map(expiredIdCards, idCardKey => {
-            return global.kuzzle.ask('core:cache:internal:execute', 'srem', REDIS_ID_CARDS_INDEX, idCardKey);
+        await bluebird_1.default.map(expiredIdCards, (idCardKey) => {
+            return global.kuzzle.ask("core:cache:internal:execute", "srem", REDIS_ID_CARDS_INDEX, idCardKey);
         });
         return idCards;
     }
@@ -234,7 +234,7 @@ class ClusterIdCardHandler {
      * This set is an index to retrieve ID Cards faster.
      */
     async addIdCardToIndex() {
-        await global.kuzzle.ask('core:cache:internal:execute', 'sadd', REDIS_ID_CARDS_INDEX, this.nodeIdKey);
+        await global.kuzzle.ask("core:cache:internal:execute", "sadd", REDIS_ID_CARDS_INDEX, this.nodeIdKey);
     }
     /**
      * Saves the local node IdCard into Redis
@@ -245,7 +245,7 @@ class ClusterIdCardHandler {
         if (!this.idCard) {
             return false;
         }
-        return await global.kuzzle.ask('core:cache:internal:store', this.nodeIdKey, JSON.stringify(this.idCard.serialize()), { onlyIfNew: creation, ttl: this.refreshDelay * this.refreshMultiplier });
+        return await global.kuzzle.ask("core:cache:internal:store", this.nodeIdKey, JSON.stringify(this.idCard.serialize()), { onlyIfNew: creation, ttl: this.refreshDelay * this.refreshMultiplier });
     }
 }
 exports.ClusterIdCardHandler = ClusterIdCardHandler;

package/lib/cluster/index.js

@@ -19,6 +19,6 @@
  * limitations under the License.
  */
 
-'use strict';
+"use strict";
 
-module.exports = require('./node');
+module.exports = require("./node");