kuzzle 2.16.8 → 2.17.0

package/lib/core/plugin/plugin.js

@@ -24,7 +24,6 @@
 const path = require('path');
 const fs = require('fs');
 const semver = require('semver');
-const enforcer = require('openapi-enforcer');
 
 const { PluginContext } = require('./pluginContext');
 const PrivilegedPluginContext = require('./privilegedContext');
@@ -34,7 +33,6 @@ const Manifest = require('./pluginManifest');
 const { has, isPlainObject } = require('../../util/safeObject');
 
 const assertionError = kerror.wrap('plugin', 'assert');
-const controllerError = kerror.wrap('plugin', 'controller');
 const runtimeError = kerror.wrap('plugin', 'runtime');
 
 const PLUGIN_NAME_REGEX = /^[a-z-\d]+$/;
@@ -43,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;
 
@@ -154,24 +152,46 @@ class Plugin {
 
   // getters/setters ===========================================================
 
-  get instance () { return this._instance; }
+  get instance () {
+    return this._instance;
+  }
 
-  get context () { return this._context; }
+  get context () {
+    return this._context;
+  }
 
-  get application () { return this._application; }
+  get application () {
+    return this._application;
+  }
 
-  get logPrefix () { return `[${this.name}]`; }
+  get logPrefix () {
+    return `[${this.name}]`;
+  }
 
-  get config () { return this._config; }
-  set config (config) { this._config = config; }
+  get config () {
+    return this._config;
+  }
+  set config (config) {
+    this._config = config;
+  }
 
-  get version () { return this._version; }
-  set version (version) { this._version = version; }
+  get version () {
+    return this._version;
+  }
+  set version (version) {
+    this._version = version;
+  }
 
-  get deprecationWarning () { return this._deprecationWarning; }
-  set deprecationWarning (value) { this._deprecationWarning = value; }
+  get deprecationWarning () {
+    return this._deprecationWarning;
+  }
+  set deprecationWarning (value) {
+    this._deprecationWarning = value;
+  }
 
-  get name () { return this._name; }
+  get name () {
+    return this._name;
+  }
   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.');
@@ -180,7 +200,9 @@ class Plugin {
     this._name = name;
   }
 
-  get manifest () { return this._manifest; }
+  get manifest () {
+    return this._manifest;
+  }
   set manifest (manifest) {
     this._manifest = manifest;
   }
@@ -264,7 +286,7 @@ class Plugin {
     return PLUGIN_NAME_REGEX.test(name);
   }
 
-  static async checkControllerDefinition (name, definition, { application=false } = {}) {
+  static checkControllerDefinition (name, definition, { application = false } = {}) {
     if (typeof name !== 'string') {
       throw assertionError.get(
         'invalid_controller_definition',
@@ -342,10 +364,6 @@ class Plugin {
               name,
               `action "${action}" has invalid http properties: ${routeProperties.join(', ')}`);
           }
-
-          if (route.openapi) {
-            await checkOpenAPISpecification(name, action, route);
-          }
         }
       }
     }
@@ -365,48 +383,4 @@ function checkHttpRouteProperties (route, action, name, application) {
   }
 }
 
-async function checkOpenAPISpecification (controller, action, route) {
-  if (! isPlainObject(route.openapi)) {
-    throw assertionError.get(
-      'invalid_controller_definition',
-      controller,
-      'The "openapi" property of the route definition must be an object');
-  }
-
-  const routePath = route.path.charAt(0) === '/'
-    ? route.path
-    : `/_/${route.path}`;
-
-  // Set :param notation to {param}
-  const formattedPath = routePath.replace(/\/:([^/]*)/g,'/{$1}');
-
-  const { error, warning } = await enforcer({
-    /* eslint-disable sort-keys */
-    openapi: '3.0.0',
-    info: {
-      title: 'Kuzzle API',
-      version: require('../../../package').version
-    },
-    paths: {
-      [formattedPath]: {
-        [route.verb]: route.openapi
-      }
-    },
-    /* eslint-enable sort-keys */
-  });
-
-  if (warning) {
-    global.kuzzle.log.warn(`Warning for OpenAPI specification in "${controller}:${action}", ${route.openapi} : ${warning}`);
-  }
-
-  if (error) {
-    throw controllerError.get(
-      'invalid_openapi_schema',
-      controller,
-      action,
-      route.openapi,
-      error);
-  }
-}
-
 module.exports = Plugin;

package/lib/core/plugin/pluginContext.d.ts

@@ -2,6 +2,7 @@ import { Koncorde } from '../shared/KoncordeWrapper';
 import { Client } from '@elastic/elasticsearch';
 import { JSONObject } from 'kuzzle-sdk';
 import { EmbeddedSDK } from '../shared/sdk/embeddedSdk';
+import { Mutex } from '../../util/mutex';
 import { RequestContext, RequestInput, KuzzleRequest } from '../../../index';
 import { BackendCluster } from '../backend';
 export interface Repository {
@@ -83,6 +84,10 @@ export declare class PluginContext {
          * @type {BackendCluster}
          */
         cluster: BackendCluster;
+        /**
+         * Current Kuzzle node unique identifier
+         */
+        nodeId: string;
     };
     config: JSONObject;
     constructors: {
@@ -94,6 +99,10 @@ export declare class PluginContext {
          * @deprecated import directly: `import { Koncorde } from 'kuzzle'`
          */
         Koncorde: Koncorde;
+        /**
+         * Mutex class
+         */
+        Mutex: typeof Mutex;
         /**
          * Plugin private storage space
          */
@@ -113,7 +122,7 @@ export declare class PluginContext {
         /**
          * Constructor for Elasticsearch SDK Client
          */
-        ESClient: new () => Client;
+        ESClient: typeof Client;
     };
     /**
      * @deprecated import directly: `import { BadRequestError, ... } from 'kuzzle'`

package/lib/core/plugin/pluginContext.js

@@ -97,6 +97,7 @@ class PluginContext {
             BaseValidationType: require('../validation/baseType'),
             ESClient: PluginContextESClient,
             Koncorde: KoncordeWrapper_1.Koncorde,
+            Mutex: mutex_1.Mutex,
             Repository: PluginContextRepository,
             Request: instantiateRequest,
             RequestContext: index_1.RequestContext,
@@ -117,6 +118,7 @@ class PluginContext {
         this.accessors = {
             cluster: new backend_1.BackendCluster(),
             execute: (request, callback) => execute(request, callback),
+            nodeId: global.kuzzle.id,
             sdk: new embeddedSdk_1.EmbeddedSDK(),
             storage: {
                 bootstrap: collections => pluginStore.init(collections),

package/lib/core/plugin/pluginManifest.js

@@ -27,7 +27,7 @@ const kerror = require('../../kerror').wrap('plugin', 'manifest');
 const AbstractManifest = require('../shared/abstractManifest');
 
 class PluginManifest extends AbstractManifest {
-  constructor(pluginPath) {
+  constructor (pluginPath) {
     super(pluginPath);
     this.privileged = false;
   }
@@ -36,11 +36,11 @@ class PluginManifest extends AbstractManifest {
     super.load();
 
     // Ensure ES will accept the plugin name as index
-    if (!/^[\w-]+$/.test(this.name)) {
+    if (! /^[\w-]+$/.test(this.name)) {
       throw kerror.get('invalid_name', this.path);
     }
 
-    if (!_.isNil(this.raw) && !_.isNil(this.raw.privileged)) {
+    if (! _.isNil(this.raw) && ! _.isNil(this.raw.privileged)) {
       if (typeof this.raw.privileged !== 'boolean') {
         throw kerror.get(
           'invalid_privileged',

package/lib/core/plugin/pluginRepository.js

@@ -36,7 +36,7 @@ class PluginRepository extends Repository {
   }
 
   init (options) {
-    if (options && typeof options === 'object' && !Array.isArray(options)) {
+    if (options && typeof options === 'object' && ! Array.isArray(options)) {
       if (options.ObjectConstructor) {
         this.ObjectConstructor = options.ObjectConstructor;
       }
@@ -64,7 +64,7 @@ class PluginRepository extends Repository {
    * @returns {Promise}
    */
   create (object, options = {}) {
-    const opts = Object.assign({method: 'create'}, options);
+    const opts = Object.assign({ method: 'create' }, options);
 
     return this.persistToDatabase(object, opts);
   }
@@ -75,7 +75,7 @@ class PluginRepository extends Repository {
    * @returns {Promise}
    */
   createOrReplace (object, options = {}) {
-    const opts = Object.assign({method: 'createOrReplace'}, options);
+    const opts = Object.assign({ method: 'createOrReplace' }, options);
 
     return this.persistToDatabase(object, opts);
   }
@@ -86,7 +86,7 @@ class PluginRepository extends Repository {
    * @returns {Promise}
    */
   replace (object, options = {}) {
-    const opts = Object.assign({method: 'replace'}, options);
+    const opts = Object.assign({ method: 'replace' }, options);
 
     return this.persistToDatabase(object, opts);
   }
@@ -97,7 +97,7 @@ class PluginRepository extends Repository {
    * @returns {Promise}
    */
   update (object, options = {}) {
-    const opts = Object.assign({method: 'update'}, options);
+    const opts = Object.assign({ method: 'update' }, options);
 
     return this.persistToDatabase(object, opts);
   }

package/lib/core/plugin/pluginsManager.js

@@ -50,7 +50,7 @@ const CORE_PLUGINS = ['kuzzle-plugin-logger', 'kuzzle-plugin-auth-passport-local
  * @param {Kuzzle} kuzzle
  */
 class PluginsManager {
-  constructor() {
+  constructor () {
     Reflect.defineProperty(this, 'kuzzle', {
       value: global.kuzzle,
     });
@@ -234,8 +234,7 @@ class PluginsManager {
           plugin.initCalled = true;
 
           if ( ! _.isEmpty(plugin.instance.controllers)
-            && ! _.isEmpty(plugin.instance.api))
-          {
+            && ! _.isEmpty(plugin.instance.api)) {
             throw assertionError.get('duplicated_api_definition');
           }
 
@@ -265,7 +264,9 @@ class PluginsManager {
 
           debug('[%s] plugin started', plugin.name);
 
-          this.loadedPlugins.push(plugin.name);
+          if (! plugin.application) {
+            this.loadedPlugins.push(plugin.name);
+          }
 
           return null;
         });
@@ -322,11 +323,11 @@ class PluginsManager {
   validateStrategy (pluginName, strategyName, strategy) {
     const errorPrefix = `[${pluginName}] Strategy ${strategyName}:`;
 
-    if (!isPlainObject(strategy)) {
+    if (! isPlainObject(strategy)) {
       throw strategyError.get('invalid_description', errorPrefix, strategy);
     }
 
-    if (!isPlainObject(strategy.methods)) {
+    if (! isPlainObject(strategy.methods)) {
       throw strategyError.get('invalid_methods', errorPrefix, strategy.methods);
     }
 
@@ -334,7 +335,7 @@ class PluginsManager {
 
     // required methods check
     ['exists', 'create', 'update', 'delete', 'validate', 'verify'].forEach(methodName => {
-      if (!_.isString(strategy.methods[methodName])) {
+      if (! _.isString(strategy.methods[methodName])) {
         throw strategyError.get(
           'invalid_method_type',
           errorPrefix,
@@ -342,7 +343,7 @@ class PluginsManager {
           strategy.methods[methodName]);
       }
 
-      if (!_.isFunction(plugin.instance[strategy.methods[methodName]])) {
+      if (! _.isFunction(plugin.instance[strategy.methods[methodName]])) {
         throw strategyError.get(
           'missing_method_function',
           errorPrefix,
@@ -354,8 +355,8 @@ class PluginsManager {
     ['getInfo', 'getById', 'afterRegister'].forEach(name => {
       const optionalMethodName = strategy.methods[name];
 
-      if (!_.isNil(optionalMethodName)) {
-        if (!_.isString(optionalMethodName)) {
+      if (! _.isNil(optionalMethodName)) {
+        if (! _.isString(optionalMethodName)) {
           throw strategyError.get(
             'invalid_method_type',
             errorPrefix,
@@ -363,7 +364,7 @@ class PluginsManager {
             optionalMethodName);
         }
 
-        if (!_.isFunction(plugin.instance[optionalMethodName])) {
+        if (! _.isFunction(plugin.instance[optionalMethodName])) {
           throw strategyError.get(
             'missing_method_function',
             errorPrefix,
@@ -372,7 +373,7 @@ class PluginsManager {
       }
     });
 
-    if (!isPlainObject(strategy.config)) {
+    if (! isPlainObject(strategy.config)) {
       throw strategyError.get('invalid_config', errorPrefix, strategy.config);
     }
 
@@ -382,8 +383,8 @@ class PluginsManager {
         errorPrefix,
         strategy.config.authenticator);
     }
-    else if (!this.authenticators[pluginName]
-      || !this.authenticators[pluginName][strategy.config.authenticator]
+    else if (! this.authenticators[pluginName]
+      || ! this.authenticators[pluginName][strategy.config.authenticator]
     ) {
       throw strategyError.get(
         'unknown_authenticator',
@@ -394,12 +395,12 @@ class PluginsManager {
     for (const optionName of ['strategyOptions', 'authenticateOptions']) {
       const options = strategy.config[optionName];
 
-      if (!_.isNil(options) && !isPlainObject(options)) {
+      if (! _.isNil(options) && ! isPlainObject(options)) {
         throw strategyError.get('invalid_option', errorPrefix, optionName, options);
       }
     }
 
-    if (!_.isNil(strategy.config.fields) && !Array.isArray(strategy.config.fields)) {
+    if (! _.isNil(strategy.config.fields) && ! Array.isArray(strategy.config.fields)) {
       throw strategyError.get('invalid_fields', errorPrefix, strategy.config.fields);
     }
   }
@@ -678,7 +679,7 @@ class PluginsManager {
           'Native controllers cannot be overriden');
       }
 
-      await Plugin.checkControllerDefinition(controller, definition);
+      Plugin.checkControllerDefinition(controller, definition);
 
       for (const [action, actionDefinition ] of Object.entries(definition.actions)) {
         let apiController = this.controllers.get(controller);
@@ -741,7 +742,7 @@ class PluginsManager {
    */
   _initControllers (plugin) {
     // @deprecated - warn about using the obsolete "controllers" object
-    if (!_.isEmpty(plugin.instance.controllers)) {
+    if (! _.isEmpty(plugin.instance.controllers)) {
       plugin.printDeprecation('Defining controllers using the "controllers" object is deprecated. You should use the "api" object instead.');
     }
 
@@ -756,7 +757,7 @@ class PluginsManager {
       const definition = plugin.instance.controllers[controller];
       const errorControllerPrefix = `Unable to inject controller "${controller}" from plugin "${plugin.name}":`;
 
-      if (!isPlainObject(definition)) {
+      if (! isPlainObject(definition)) {
         // @todo deprecate all those errors and use plugin.assert.invalid_controller_definition
         throw controllerError.get(
           'invalid_description',
@@ -809,7 +810,7 @@ class PluginsManager {
     const controllerNames = Object.keys(plugin.instance.controllers);
 
     // @deprecated - warn about using the obsolete "routes" object
-    if (!_.isEmpty(plugin.instance.routes)) {
+    if (! _.isEmpty(plugin.instance.routes)) {
       plugin.printDeprecation('Defining routes using the "routes" object is deprecated. You should use the "api" object instead.');
     }
 
@@ -835,7 +836,7 @@ class PluginsManager {
 
       const apiController = this.controllers.get(controller);
 
-      if (!apiController) {
+      if (! apiController) {
         throw controllerError.get(
           'undefined_controller',
           errorRoutePrefix,
@@ -843,7 +844,7 @@ class PluginsManager {
           didYouMean(route.controller, controllerNames));
       }
 
-      if (!apiController._isAction(route.action)) {
+      if (! apiController._isAction(route.action)) {
         const actionNames = Array.from(apiController._actions);
         throw controllerError.get(
           'undefined_action',
@@ -898,7 +899,7 @@ class PluginsManager {
    * @throws {PluginImplementationError} If strategies registration fails
    */
   _initStrategies (plugin) {
-    if ( !isPlainObject(plugin.instance.strategies)
+    if ( ! isPlainObject(plugin.instance.strategies)
       || _.isEmpty(plugin.instance.strategies)
     ) {
       throw strategyError.get('invalid_definition', plugin.logPrefix);
@@ -917,12 +918,12 @@ class PluginsManager {
    * @throws {PluginImplementationError} If strategies registration fails
    */
   _initAuthenticators (plugin) {
-    if (!isPlainObject(plugin.instance.authenticators)) {
+    if (! isPlainObject(plugin.instance.authenticators)) {
       throw kerror.get('plugin', 'authenticators', 'not_an_object', plugin.logPrefix);
     }
 
     for (const authenticator of Object.keys(plugin.instance.authenticators)) {
-      if (!isConstructor(plugin.instance.authenticators[authenticator])) {
+      if (! isConstructor(plugin.instance.authenticators[authenticator])) {
         throw kerror.get(
           'plugin',
           'authenticators',
@@ -1015,7 +1016,7 @@ class PluginsManager {
 
       // catching plugins returning non-thenable content
       // @todo - with async/await we might consider allowing non-promise results
-      if (!ret || !_.isFunction(ret.then)) {
+      if (! ret || ! _.isFunction(ret.then)) {
         callback(strategyError.get('invalid_verify_return', prefix, ret));
         return;
       }
@@ -1031,11 +1032,11 @@ class PluginsManager {
       }
 
       if (result === false) {
-        callback(null, result, {message: null});
+        callback(null, result, { message: null });
         return;
       }
 
-      if (!isPlainObject(result)) {
+      if (! isPlainObject(result)) {
         callback(strategyError.get('invalid_verify_resolve', prefix));
         return;
       }

package/lib/core/realtime/notification/server.js

@@ -30,7 +30,7 @@
  * @param {string} message - Notification message
  */
 class ServerNotification {
-  constructor(type, message) {
+  constructor (type, message) {
     this.status = 200;
     this.info = 'This is an automated server notification';
     this.message = message;

package/lib/core/realtime/notification/user.js

@@ -27,7 +27,7 @@
  * @class UserNotification
  */
 class UserNotification {
-  constructor(opts) {
+  constructor (opts) {
     this.type = 'user';
 
     this.status = opts.status;

package/lib/core/realtime/notifier.js

@@ -53,7 +53,7 @@ const KUZZLE_NOTIFICATION_CHANNEL = 'kuzzle:notification:server';
  * @class NotifierController
  */
 class NotifierController {
-  constructor(realtimeModule) {
+  constructor (realtimeModule) {
     this.module = realtimeModule;
     this.ttl = global.kuzzle.config.limits.subscriptionDocumentTTL;
   }
@@ -267,7 +267,7 @@ class NotifierController {
     let cached = action === actionEnum.REPLACE || action === actionEnum.UPDATE;
 
     const cacheIds = documents.map(doc => {
-      if ((action === actionEnum.WRITE || action === actionEnum.UPSERT) && !cached) {
+      if ((action === actionEnum.WRITE || action === actionEnum.UPSERT) && ! cached) {
         cached = doc.created !== true; // force a bool value if undefined
       }
 
@@ -414,7 +414,7 @@ class NotifierController {
    *
    * @returns {Promise}
    */
-  _notifyDocument (rooms, notification, { fromCluster=true } = {}) {
+  _notifyDocument (rooms, notification, { fromCluster = true } = {}) {
     const channels = [];
 
     for (const room of rooms) {
@@ -452,7 +452,7 @@ class NotifierController {
    *
    * @returns {Promise}
    */
-  _notifyUser (room, notification, { fromCluster=true } = {}) {
+  _notifyUser (room, notification, { fromCluster = true } = {}) {
     const channels = [];
     const hotelClerkRoom = this.module.hotelClerk.rooms.get(room);
 
@@ -493,7 +493,7 @@ class NotifierController {
   }
 }
 
-function getCachePrefix(request) {
+function getCachePrefix (request) {
   // use redis key hash tag
   // (see https://redis.io/topics/cluster-spec#keys-distribution-model)
   return `{notif/${request.input.args.index}/${request.input.args.collection}}/`;

package/lib/core/security/index.js

@@ -22,7 +22,7 @@
 'use strict';
 
 const RoleRepository = require('./roleRepository');
-const ProfileRepository = require('./profileRepository');
+const { ProfileRepository } = require('./profileRepository');
 const TokenRepository = require('./tokenRepository');
 const UserRepository = require('./userRepository');
 const SecurityLoader = require('./securityLoader');