kuzzle 2.16.8 → 2.17.0

package/lib/cluster/node.js

@@ -110,10 +110,10 @@ function getIP ({ family = 'IPv4', interface: netInterface, ip } = {}) {
   debug('Found interfaces %o', interfaces);
 
   interfaces = interfaces.filter(n => {
-    return !n.internal
-      && !isInternalIP(n.address)
+    return ! n.internal
+      && ! isInternalIP(n.address)
       && n.family === family
-      && (!ip || mustBePrivate === isPrivateIP(n.address));
+      && (! ip || mustBePrivate === isPrivateIP(n.address));
   });
 
   debug('Filtered interfaces %o', interfaces);
@@ -123,7 +123,7 @@ function getIP ({ family = 'IPv4', interface: netInterface, ip } = {}) {
   }
 
   // take the first IP from the list if no interface has been defined
-  if (!netInterface) {
+  if (! netInterface) {
     return interfaces[0].address;
   }
 
@@ -298,7 +298,7 @@ class ClusterNode {
   async evictNode (nodeId, { broadcast = false, reason = '' }) {
     const subscriber = this.remoteNodes.get(nodeId);
 
-    if (!subscriber) {
+    if (! subscriber) {
       return;
     }
 
@@ -358,7 +358,7 @@ class ClusterNode {
             return split.every((id, index) => id === topology[index]);
           });
 
-          if (!found) {
+          if (! found) {
             splits.push(topology);
           }
         }
@@ -415,13 +415,13 @@ class ClusterNode {
 
         for (let i = 0; i < isolatedNodes.length; i++) {
           const idCard = idCards.find(card => card.id === isolatedNodes[i]);
-          if (!youngestNode || idCard.birthdate > youngestNode.birthdate) {
+          if (! youngestNode || idCard.birthdate > youngestNode.birthdate) {
             youngestNode = idCard;
           }
         }
 
         if (isIsolated) {
-          for (let i = 0; !candidates && i < eligibleSplits.length; i++) {
+          for (let i = 0; ! candidates && i < eligibleSplits.length; i++) {
             if (eligibleSplits[i].includes(youngestNode.id)) {
               candidates = _.intersection(eligibleSplits[i], isolatedNodes);
             }
@@ -621,7 +621,7 @@ class ClusterNode {
   async getStatus () {
     const status = {
       activeNodes: 0,
-      activity: this.activity.map(({address, date, event, id, reason}) => ({
+      activity: this.activity.map(({ address, date, event, id, reason }) => ({
         address,
         date,
         event: event === nodeActivityEnum.ADDED ? 'joined' : 'evicted',

package/lib/cluster/publisher.js

@@ -337,7 +337,7 @@ class ClusterPublisher {
    * @return {void}
    */
   async bufferSend (topic, data) {
-    this.buffer.push({data, topic});
+    this.buffer.push({ data, topic });
 
     if (this.state === STATE.SENDING) {
       return;

package/lib/cluster/subscriber.js

@@ -667,7 +667,7 @@ class ClusterSubscriber {
    * @return {boolean} false: the message must be discarded, true otherwise
    */
   async validateMessage (message) {
-    if (!has(message, 'messageId')) {
+    if (! has(message, 'messageId')) {
       global.kuzzle.log.warn(`Invalid message received from node ${this.remoteNodeId}. Evicting it.`);
 
       await this.evictNode({

package/lib/cluster/workers/IDCardRenewer.js

@@ -44,7 +44,7 @@ class IDCardRenewer {
      * which could be enough to make the ID Card expire.
      */
     await this.renewIDCard();
-    if (!this.disposed) {
+    if (! this.disposed) {
       this.refreshTimer = setInterval(
         this.renewIDCard.bind(this),
         this.refreshDelay);
@@ -55,8 +55,9 @@ class IDCardRenewer {
   }
 
   async initRedis (config, name) {
-    this.redis = new Redis(config, name);
-    await this.redis.init();
+    const redis = new Redis(config, name);
+    await redis.init();
+    this.redis = redis;
   }
 
   async renewIDCard () {
@@ -89,8 +90,16 @@ class IDCardRenewer {
     }
 
     this.disposed = true;
+
     clearInterval(this.refreshTimer);
     this.refreshTimer = null;
+
+    // If the worker is disposed before it had time to starts, redis service
+    // may not have been initialized
+    if (! this.redis) {
+      return;
+    }
+
     try {
       await this.redis.commands.del(this.nodeIdKey);
     }
@@ -101,7 +110,7 @@ class IDCardRenewer {
   }
 }
 
-if (!isMainThread) {
+if (! isMainThread) {
   const idCardRenewer = new IDCardRenewer();
 
   parentPort.on('message', async message => {

package/lib/config/default.config.js

@@ -380,6 +380,7 @@ const defaultConfig = {
         statsInterval: 10
     },
     cluster: {
+        enabled: true,
         activityDepth: 50,
         heartbeat: 2000,
         interface: null,

package/lib/config/index.js

@@ -80,7 +80,7 @@ function loadConfig () {
  */
 function unstringify (cfg) {
   Object.keys(cfg)
-    .filter(k => !/version$/i.test(k) && (typeof cfg[k] === 'string' || cfg[k] instanceof Object))
+    .filter(k => ! /version$/i.test(k) && (typeof cfg[k] === 'string' || cfg[k] instanceof Object))
     .forEach(k => {
       if (typeof cfg[k] === 'string') {
         if (cfg[k] === 'true') {
@@ -138,7 +138,7 @@ function checkLimitsConfig (cfg) {
     'subscriptionDocumentTTL'
   ];
 
-  if (!isPlainObject(cfg.limits)) {
+  if (! isPlainObject(cfg.limits)) {
     throw kerror.get('invalid_type', 'limits', 'object');
   }
 
@@ -148,7 +148,7 @@ function checkLimitsConfig (cfg) {
     }
 
     if ( cfg.limits[opt] < 0
-      || cfg.limits[opt] === 0 && !canBeZero.includes(opt)
+      || cfg.limits[opt] === 0 && ! canBeZero.includes(opt)
     ) {
       const allowed = `>= ${canBeZero.includes(opt) ? '0' : '1'}`;
       throw kerror.get('out_of_range', `limits.${opt}`, allowed);
@@ -221,9 +221,9 @@ function checkClusterOptions (config) {
   if (`${cfg.ip}`.length === 0 || cfg.ip === 'null') {
     cfg.ip = null;
   }
-  assert(!cfg.ip || ['private', 'public'].includes(cfg.ip), '[CONFIG] kuzzlerc.cluster.ip: invalid value (accepted values: public, private)');
+  assert(! cfg.ip || ['private', 'public'].includes(cfg.ip), '[CONFIG] kuzzlerc.cluster.ip: invalid value (accepted values: public, private)');
 
-  assert(!cfg.interface || typeof cfg.interface === 'string', '[CONFIG] kuzzlerc.cluster.interface: value must be either null, or a string');
+  assert(! cfg.interface || typeof cfg.interface === 'string', '[CONFIG] kuzzlerc.cluster.interface: value must be either null, or a string');
 }
 
 function preprocessHttpOptions (config) {
@@ -251,7 +251,7 @@ function preprocessHttpOptions (config) {
   }
 }
 
-function preprocessProtocolsOptions(config) {
+function preprocessProtocolsOptions (config) {
   const protocols = config.server.protocols;
 
   config.internal.notifiableProtocols = [];

package/lib/core/auth/passportResponse.js

@@ -31,30 +31,30 @@ HTTP Response Mockup to emulate response objects for Passport Authentication
  * @class PassportResponse
  */
 class PassportResponse {
-  constructor() {
+  constructor () {
     this.headers = {};
     this.statusCode = 200;
     this.onEndListener = null;
   }
 
-  setHeader(field, value) {
+  setHeader (field, value) {
     this.headers[field] = value;
   }
 
-  end(statusCode) {
+  end (statusCode) {
     if (statusCode) {
       this.statusCode = statusCode;
     }
-    if(typeof this.onEndListener === 'function') {
+    if (typeof this.onEndListener === 'function') {
       this.onEndListener();
     }
   }
 
-  getHeader(key) {
+  getHeader (key) {
     return this.headers[key];
   }
 
-  addEndListener(listener) {
+  addEndListener (listener) {
     this.onEndListener = listener;
   }
 }

package/lib/core/auth/passportWrapper.js

@@ -32,7 +32,7 @@ const PassportResponse = require('./passportResponse');
  * @class PassportWrapper
  */
 class PassportWrapper {
-  constructor() {
+  constructor () {
     this.options = {};
   }
 
@@ -41,7 +41,7 @@ class PassportWrapper {
    * @param strategyName
    * @returns {Promise.<*>}
    */
-  authenticate(request, strategyName) {
+  authenticate (request, strategyName) {
     const response = new PassportResponse();
 
     return new Bluebird((resolve, reject) => {
@@ -67,7 +67,7 @@ class PassportWrapper {
                 err.message));
           }
         }
-        else if (!user) {
+        else if (! user) {
           reject(
             kerror.get('plugin', 'strategy', 'missing_user', info.message));
         }
@@ -103,7 +103,7 @@ class PassportWrapper {
    * @param {object} strategy - instantiated strategy object
    * @param {object} opts - options to provide to authenticate with the strategy
    */
-  use(name, strategy, opts = {}) {
+  use (name, strategy, opts = {}) {
     passport.use(name, strategy);
     this.options[name] = opts;
   }
@@ -113,7 +113,7 @@ class PassportWrapper {
    *
    * @param  {string} name - name of the strategy to unregister
    */
-  unuse(name) {
+  unuse (name) {
     passport.unuse(name);
     delete this.options[name];
   }

package/lib/core/backend/backend.d.ts

@@ -1,6 +1,6 @@
 import { EmbeddedSDK } from '../shared/sdk/embeddedSdk';
 import { JSONObject } from '../../../index';
-import { BackendCluster, BackendConfig, BackendController, BackendHook, BackendImport, BackendPipe, BackendPlugin, BackendStorage, BackendVault, InternalLogger } from './index';
+import { BackendCluster, BackendConfig, BackendController, BackendHook, BackendImport, BackendPipe, BackendPlugin, BackendStorage, BackendVault, BackendOpenApi, InternalLogger } from './index';
 export declare class Backend {
     private _kuzzle;
     private _name;
@@ -113,6 +113,10 @@ export declare class Backend {
      * @method userMappings - Import user mappings
      */
     import: BackendImport;
+    /**
+     * OpenApi manager
+     */
+    openApi: BackendOpenApi;
     /**
      * @deprecated
      *

package/lib/core/backend/backend.js

@@ -127,6 +127,13 @@ class Backend {
                 this.started = true;
             },
         ];
+        try {
+            const info = JSON.parse(fs_1.default.readFileSync('./package.json', 'utf8'));
+            this.version = info.version;
+        }
+        catch (error) {
+            // Silent if no version can be found
+        }
         global.app = this;
         this.pipe = new index_1.BackendPipe(this);
         this.hook = new index_1.BackendHook(this);
@@ -138,14 +145,8 @@ class Backend {
         this.import = new index_1.BackendImport(this);
         this.log = new index_1.InternalLogger(this);
         this.cluster = new index_1.BackendCluster();
+        this.openApi = new index_1.BackendOpenApi(this);
         this.kerror = kerror_1.default;
-        try {
-            const info = JSON.parse(fs_1.default.readFileSync('./package.json', 'utf8'));
-            this.version = info.version;
-        }
-        catch (error) {
-            // Silent if no version can be found
-        }
         try {
             this.commit = this._readCommit();
         }
@@ -171,6 +172,7 @@ class Backend {
         const application = new this.PluginObject(this._instanceProxy, { application: true, name: this.name });
         application.version = this.version;
         application.commit = this.commit;
+        application.openApi = this.openApi.definition;
         const options = {
             import: this._import,
             installations: this._installationsWaitingList,
@@ -224,7 +226,9 @@ class Backend {
     /**
      * Application Name
      */
-    get name() { return this._name; }
+    get name() {
+        return this._name;
+    }
     /**
      * EmbeddedSDK instance
      */

package/lib/core/backend/backendConfig.d.ts

@@ -2,13 +2,15 @@ import { ApplicationManager, Backend } from './index';
 import { KuzzleConfiguration } from '../../types/config/KuzzleConfiguration';
 export declare class BackendConfig extends ApplicationManager {
     /**
-     * Configuration content
+     * Configuration content.
      */
     content: KuzzleConfiguration;
     constructor(application: Backend);
     /**
      * Sets a configuration value
      *
+     * @deprecated use app.config.content instead
+     *
      * @param path - Path to the configuration key (lodash style)
      * @param value - Value for the configuration key
      */
@@ -16,6 +18,8 @@ export declare class BackendConfig extends ApplicationManager {
     /**
      * Merges a configuration object into the current configuration
      *
+     * @deprecated use app.config.content instead
+     *
      * @param config - Configuration object to merge
      */
     merge(config: KuzzleConfiguration): void;

package/lib/core/backend/backendConfig.js

@@ -37,6 +37,8 @@ class BackendConfig extends index_1.ApplicationManager {
     /**
      * Sets a configuration value
      *
+     * @deprecated use app.config.content instead
+     *
      * @param path - Path to the configuration key (lodash style)
      * @param value - Value for the configuration key
      */
@@ -49,6 +51,8 @@ class BackendConfig extends index_1.ApplicationManager {
     /**
      * Merges a configuration object into the current configuration
      *
+     * @deprecated use app.config.content instead
+     *
      * @param config - Configuration object to merge
      */
     merge(config) {

package/lib/core/backend/backendOpenApi.d.ts

@@ -0,0 +1,9 @@
+import { ApplicationManager, Backend } from './index';
+import { OpenApiDefinition } from '../../types';
+export declare class BackendOpenApi extends ApplicationManager {
+    /**
+     * Application Open API definition
+     */
+    definition: Partial<OpenApiDefinition>;
+    constructor(application: Backend);
+}

package/lib/core/backend/backendOpenApi.js

@@ -0,0 +1,69 @@
+"use strict";
+/*
+ * Kuzzle, a backend software, self-hostable and ready to use
+ * to power modern apps
+ *
+ * Copyright 2015-2020 Kuzzle
+ * mailto: support AT kuzzle.io
+ * website: http://kuzzle.io
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BackendOpenApi = void 0;
+const index_1 = require("./index");
+class BackendOpenApi extends index_1.ApplicationManager {
+    constructor(application) {
+        super(application);
+        /* eslint-disable sort-keys */
+        this.definition = {
+            swagger: '2.0',
+            info: {
+                title: `${application.name} API`,
+                description: `${application.name} HTTP API definition`,
+                contact: {
+                    name: 'Kuzzle team',
+                    url: 'https://kuzzle.io',
+                    email: 'support@kuzzle.io',
+                    discord: 'http://join.discord.kuzzle.io'
+                },
+                license: {
+                    name: 'Apache 2',
+                    url: 'http://opensource.org/licenses/apache2.0'
+                },
+                version: application.version
+            },
+            externalDocs: {
+                description: 'Kuzzle API Documentation',
+                url: 'https://docs.kuzzle.io/core/2/api/'
+            },
+            servers: [
+                {
+                    url: 'https://{baseUrl}:{port}',
+                    description: `${application.name} Base Url`,
+                    variables: {
+                        baseUrl: { default: 'localhost' },
+                        port: { default: 7512 },
+                    }
+                }
+            ],
+            tags: [],
+            schemes: ['https', 'http'],
+            paths: {},
+            components: {}
+        };
+        /* eslint-enable sort-keys */
+    }
+}
+exports.BackendOpenApi = BackendOpenApi;
+//# sourceMappingURL=backendOpenApi.js.map

package/lib/core/backend/index.d.ts

@@ -9,4 +9,5 @@ export * from './backendPipe';
 export * from './backendPlugin';
 export * from './backendStorage';
 export * from './backendVault';
+export * from './backendOpenApi';
 export * from './internalLogger';

package/lib/core/backend/index.js

@@ -21,5 +21,6 @@ __exportStar(require("./backendPipe"), exports);
 __exportStar(require("./backendPlugin"), exports);
 __exportStar(require("./backendStorage"), exports);
 __exportStar(require("./backendVault"), exports);
+__exportStar(require("./backendOpenApi"), exports);
 __exportStar(require("./internalLogger"), exports);
 //# sourceMappingURL=index.js.map

package/lib/core/network/accessLogger.js

@@ -54,15 +54,15 @@ class AccessLogger {
     const config = global.kuzzle.config.server;
 
     for (const out of config.logs.transports) {
-      if (out.transport && !ALLOWED_TRANSPORTS.includes(out.transport)) {
+      if (out.transport && ! ALLOWED_TRANSPORTS.includes(out.transport)) {
         global.kuzzle.log.error(`Failed to initialize logger transport "${out.transport}": unsupported transport. Skipped.`);
       }
       else {
-        this.isActive = this.isActive || !out.silent;
+        this.isActive = this.isActive || ! out.silent;
       }
     }
 
-    if (!this.isActive) {
+    if (! this.isActive) {
       return;
     }
 
@@ -78,7 +78,7 @@ class AccessLogger {
   }
 
   log (connection, request, extra) {
-    if (!this.isActive) {
+    if (! this.isActive) {
       return;
     }
 
@@ -212,7 +212,7 @@ class AccessLoggerWorker {
       }
     }
 
-    this.logger = winston.createLogger({transports});
+    this.logger = winston.createLogger({ transports });
   }
 
   /**
@@ -325,7 +325,7 @@ class AccessLoggerWorker {
   }
 }
 
-if (!isMainThread) {
+if (! isMainThread) {
   // Needed for instantiating a serialized KuzzleRequest object
   global.kuzzle = { id: workerData.kuzzleId };
 

package/lib/core/network/clientConnection.js

@@ -36,7 +36,7 @@ class ClientConnection {
     this.protocol = protocol;
     this.headers = {};
 
-    if (!Array.isArray(ips)) {
+    if (! Array.isArray(ips)) {
       throw new TypeError(`Expected ips to be an Array, got ${typeof ips}`);
     }
     this.ips = ips;

package/lib/core/network/entryPoint.js

@@ -99,7 +99,7 @@ class EntryPoint {
   async startListening () {
     // We need to verify the port ourselves, to make sure Node.js won't open
     // a named pipe if the provided port number is a string
-    if (!Number.isInteger(this.config.port)) {
+    if (! Number.isInteger(this.config.port)) {
       throw networkError.get('invalid_port', this.config.port);
     }
 
@@ -140,7 +140,7 @@ class EntryPoint {
 
     const client = this._clients.get(connectionId);
 
-    if (!client || !client.protocol) {
+    if (! client || ! client.protocol) {
       return;
     }
 
@@ -160,7 +160,7 @@ class EntryPoint {
 
     const client = this._clients.get(connectionId);
 
-    if (!client || !client.protocol) {
+    if (! client || ! client.protocol) {
       return;
     }
 
@@ -248,7 +248,7 @@ class EntryPoint {
     global.kuzzle.funnel.execute(request, (error, result) => {
       const _res = result || request;
 
-      if (error && !_res.error) {
+      if (error && ! _res.error) {
         _res.setError(error);
       }
 
@@ -327,7 +327,7 @@ class EntryPoint {
 
     const client = this._clients.get(data.connectionId);
 
-    if (!client || !client.protocol) {
+    if (! client || ! client.protocol) {
       return;
     }
 

package/lib/core/network/httpRouter/index.js

@@ -142,7 +142,7 @@ class Router {
   route (message, cb) {
     debug('Routing HTTP message: %a', message);
 
-    if (!has(this.routes, message.method)) {
+    if (! has(this.routes, message.method)) {
       this.routeUnhandledHttpMethod(message, cb);
       return;
     }
@@ -165,8 +165,8 @@ class Router {
     }
     catch (err) {
       let request;
-      if (!routeHandler || !routeHandler._request) {
-        request = new Request({requestId: message.requestId}, {});
+      if (! routeHandler || ! routeHandler._request) {
+        request = new Request({ requestId: message.requestId }, {});
         // Set Headers if not present
         request.response.setHeaders(this.defaultHeaders, true);
 
@@ -190,7 +190,7 @@ class Router {
    * @param  {HttpMessage} message
    * @param {function} cb
    */
-  routeUnhandledHttpMethod(message, cb) {
+  routeUnhandledHttpMethod (message, cb) {
     const
       requestContext = global.kuzzle.router.connections.get(message.connection.id),
       request = new Request(
@@ -253,7 +253,7 @@ function applyACAOHeader (message, request) {
 function attach (path, handler, target) {
   const sanitized = path[path.length - 1] === '/' ? path.slice(0, -1) : path;
 
-  if (!attachParts(sanitized.split('/'), handler, target)) {
+  if (! attachParts(sanitized.split('/'), handler, target)) {
     throw kerror.get('duplicate_url', sanitized);
   }
 }

package/lib/core/network/httpRouter/routeHandler.js

@@ -38,7 +38,7 @@ const kerror = require('../../../kerror').wrap('network', 'http');
  *                           in JSON format
  */
 class RouteHandler {
-  constructor(url, query, message) {
+  constructor (url, query, message) {
     this.handler = null;
     this._request = null;
     this.url = url;
@@ -92,7 +92,7 @@ class RouteHandler {
    * @param {string} name
    * @param {string} value
    */
-  addArgument(name, value) {
+  addArgument (name, value) {
     this.data[name] = value;
   }
 
@@ -101,7 +101,7 @@ class RouteHandler {
    *
    * @param {Function} callback
    */
-  invokeHandler(callback) {
+  invokeHandler (callback) {
     this.handler(this.request, callback);
   }
 }