kuzzle 2.27.0 → 2.27.2

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;

package/lib/core/plugin/pluginsManager.js

@@ -67,10 +67,10 @@ class PluginsManager {
     this.routes = [];
 
     this.pluginsEnabledDir = path.resolve(
-      path.join(global.kuzzle.rootPath, "plugins", "enabled")
+      path.join(global.kuzzle.rootPath, "plugins", "enabled"),
     );
     this.pluginsAvailableDir = path.resolve(
-      path.join(global.kuzzle.rootPath, "plugins", "available")
+      path.join(global.kuzzle.rootPath, "plugins", "available"),
     );
 
     /**
@@ -96,7 +96,7 @@ class PluginsManager {
     // @deprecated - Warn about the pipeTimeout configuration being obsolete
     if (this.config.common.pipeTimeout) {
       global.kuzzle.log.warn(
-        'The configuration "plugins.common.pipeTimeout" has been deprecated and is now unused. It can be safely removed from configuration files'
+        'The configuration "plugins.common.pipeTimeout" has been deprecated and is now unused. It can be safely removed from configuration files',
       );
     }
 
@@ -106,11 +106,11 @@ class PluginsManager {
   set application(plugin) {
     assert(
       this._plugins.size === 0,
-      "The application plugin can only be set before every other plugins are loaded"
+      "The application plugin can only be set before every other plugins are loaded",
     );
     assert(
       plugin.application,
-      'The application plugin must have the "application" property equals to true'
+      'The application plugin must have the "application" property equals to true',
     );
 
     this._plugins.set(plugin.name, plugin);
@@ -118,13 +118,13 @@ class PluginsManager {
 
   get plugins() {
     return Array.from(this._plugins.values()).filter(
-      (plugin) => !plugin.application
+      (plugin) => !plugin.application,
     );
   }
 
   get application() {
     return Array.from(this._plugins.values()).find(
-      (plugin) => plugin.application
+      (plugin) => plugin.application,
     );
   }
 
@@ -193,7 +193,7 @@ class PluginsManager {
       debug(
         "[%s] reading plugin configuration: %a",
         plugin,
-        pluginsDescription[plugin.name]
+        pluginsDescription[plugin.name],
       );
     }
 
@@ -212,13 +212,13 @@ class PluginsManager {
 
     global.kuzzle.on("plugin:hook:loop-error", ({ error, pluginName }) => {
       global.kuzzle.log.error(
-        `[${pluginName}] Infinite loop detected on event "hook:onError": ${error}`
+        `[${pluginName}] Infinite loop detected on event "hook:onError": ${error}`,
       );
     });
 
     global.kuzzle.on("hook:onError", ({ error, event, pluginName }) => {
       global.kuzzle.log.error(
-        `[${pluginName}] Error executing hook on "${event}": ${error}${error.stack}`
+        `[${pluginName}] Error executing hook on "${event}": ${error}${error.stack}`,
       );
     });
 
@@ -232,7 +232,7 @@ class PluginsManager {
         !CORE_PLUGINS.includes(plugin.name)
       ) {
         global.kuzzle.log.info(
-          `Failsafe mode activated, skipping plugin "${plugin.name}"`
+          `Failsafe mode activated, skipping plugin "${plugin.name}"`,
         );
         continue;
       }
@@ -246,7 +246,7 @@ class PluginsManager {
       debug(
         '[%s] starting plugin in "%s" mode',
         plugin.name,
-        plugin.config.privileged ? "privileged" : "standard"
+        plugin.config.privileged ? "privileged" : "standard",
       );
 
       const promise = Bluebird.resolve(
@@ -256,11 +256,11 @@ class PluginsManager {
           } catch (error) {
             throw runtimeError.get("failed_init", plugin.name, error);
           }
-        })()
+        })(),
       )
         .timeout(
           initTimeout,
-          `${plugin.logPrefix} Initialization timed out after ${initTimeout}ms. Try to increase the configuration "plugins.common.initTimeout".`
+          `${plugin.logPrefix} Initialization timed out after ${initTimeout}ms. Try to increase the configuration "plugins.common.initTimeout".`,
         )
         .then(async () => {
           plugin.initCalled = true;
@@ -381,7 +381,7 @@ class PluginsManager {
             "invalid_method_type",
             errorPrefix,
             methodName,
-            strategy.methods[methodName]
+            strategy.methods[methodName],
           );
         }
 
@@ -389,10 +389,10 @@ class PluginsManager {
           throw strategyError.get(
             "missing_method_function",
             errorPrefix,
-            strategy.methods[methodName]
+            strategy.methods[methodName],
           );
         }
-      }
+      },
     );
 
     // optional methods check
@@ -405,7 +405,7 @@ class PluginsManager {
             "invalid_method_type",
             errorPrefix,
             name,
-            optionalMethodName
+            optionalMethodName,
           );
         }
 
@@ -413,7 +413,7 @@ class PluginsManager {
           throw strategyError.get(
             "missing_method_function",
             errorPrefix,
-            optionalMethodName
+            optionalMethodName,
           );
         }
       }
@@ -427,7 +427,7 @@ class PluginsManager {
       throw strategyError.get(
         "invalid_authenticator",
         errorPrefix,
-        strategy.config.authenticator
+        strategy.config.authenticator,
       );
     } else if (
       !this.authenticators[pluginName] ||
@@ -436,7 +436,7 @@ class PluginsManager {
       throw strategyError.get(
         "unknown_authenticator",
         errorPrefix,
-        strategy.config.authenticator
+        strategy.config.authenticator,
       );
     }
 
@@ -448,7 +448,7 @@ class PluginsManager {
           "invalid_option",
           errorPrefix,
           optionName,
-          options
+          options,
         );
       }
     }
@@ -460,7 +460,7 @@ class PluginsManager {
       throw strategyError.get(
         "invalid_fields",
         errorPrefix,
-        strategy.config.fields
+        strategy.config.fields,
       );
     }
   }
@@ -493,7 +493,7 @@ class PluginsManager {
 
           if (elapsed > warnDelay) {
             global.kuzzle.log.warn(
-              `${plugin.logPrefix} pipe for event '${event}' is slow (${elapsed}ms)`
+              `${plugin.logPrefix} pipe for event '${event}' is slow (${elapsed}ms)`,
             );
           }
         }
@@ -522,7 +522,7 @@ class PluginsManager {
         cb(
           error instanceof KuzzleError
             ? error
-            : runtimeError.getFrom(error, "unexpected_error", error.message)
+            : runtimeError.getFrom(error, "unexpected_error", error.message),
         );
       }
     };
@@ -570,7 +570,7 @@ class PluginsManager {
     // convert uncaught exception into PluginImplementationError
     // promise rejections
     for (const methodName of Object.keys(strategy.methods).filter(
-      (name) => name !== "verify"
+      (name) => name !== "verify",
     )) {
       methods[methodName] = async (...args) => {
         try {
@@ -597,7 +597,7 @@ class PluginsManager {
     const verifyAdapter = this.wrapStrategyVerify(
       plugin.logPrefix,
       strategyName,
-      plugin.instance[strategy.methods.verify].bind(plugin.instance)
+      plugin.instance[strategy.methods.verify].bind(plugin.instance),
     );
 
     try {
@@ -609,7 +609,7 @@ class PluginsManager {
       global.kuzzle.passport.use(
         strategyName,
         instance,
-        strategy.config.authenticateOptions
+        strategy.config.authenticateOptions,
       );
 
       if (methods.afterRegister) {
@@ -620,7 +620,7 @@ class PluginsManager {
         e,
         "failed_registration",
         strategyName,
-        e.message
+        e.message,
       );
     }
   }
@@ -673,7 +673,7 @@ class PluginsManager {
         if (typeof target === "string") {
           // @deprecated - warn about using a string representing an instance method
           plugin.printDeprecation(
-            "Defining pipe handler using a string is deprecated. Pass a function instead."
+            "Defining pipe handler using a string is deprecated. Pass a function instead.",
           );
 
           handler = plugin.instance[target].bind(plugin.instance);
@@ -717,7 +717,7 @@ class PluginsManager {
         // @deprecated - warn about using a string representing an instance method
         if (typeof target === "string") {
           plugin.printDeprecation(
-            "Defining hook handler using a string is deprecated. Pass a function instead."
+            "Defining hook handler using a string is deprecated. Pass a function instead.",
           );
 
           handler = plugin.instance[target].bind(plugin.instance);
@@ -736,31 +736,31 @@ class PluginsManager {
 
   async _initApi(plugin) {
     for (const [controller, definition] of Object.entries(
-      plugin.instance.api
+      plugin.instance.api,
     )) {
       debug(
         "[%s][%s] starting api controller registration",
         plugin.name,
-        controller
+        controller,
       );
 
       if (
         await global.kuzzle.ask(
           "kuzzle:api:funnel:controller:isNative",
-          controller
+          controller,
         )
       ) {
         throw assertionError.get(
           "invalid_controller_definition",
           controller,
-          "Native controllers cannot be overriden"
+          "Native controllers cannot be overriden",
         );
       }
 
       Plugin.checkControllerDefinition(controller, definition);
 
       for (const [action, actionDefinition] of Object.entries(
-        definition.actions
+        definition.actions,
       )) {
         let apiController = this.controllers.get(controller);
 
@@ -788,7 +788,7 @@ class PluginsManager {
         if (httpRoutes.length === 0) {
           httpRoutes.push({
             path: `${Inflector.kebabCase(controller)}/${Inflector.kebabCase(
-              action
+              action,
             )}`,
             verb: "get",
           });
@@ -799,7 +799,7 @@ class PluginsManager {
             '[%s] binding HTTP route "%s" to controller "%s"',
             plugin.name,
             httpRoute.path,
-            controller
+            controller,
           );
 
           const routePath =
@@ -829,7 +829,7 @@ class PluginsManager {
     // @deprecated - warn about using the obsolete "controllers" object
     if (!_.isEmpty(plugin.instance.controllers)) {
       plugin.printDeprecation(
-        'Defining controllers using the "controllers" object is deprecated. You should use the "api" object instead.'
+        'Defining controllers using the "controllers" object is deprecated. You should use the "api" object instead.',
       );
     }
 
@@ -837,7 +837,7 @@ class PluginsManager {
       debug(
         "[%s][%s] starting controller registration",
         plugin.name,
-        controller
+        controller,
       );
 
       const methodsList = getMethods(plugin.instance);
@@ -850,7 +850,7 @@ class PluginsManager {
         throw controllerError.get(
           "invalid_description",
           errorControllerPrefix,
-          typeof definition
+          typeof definition,
         );
       }
 
@@ -859,7 +859,7 @@ class PluginsManager {
           "[%s][%s][%s] starting action controller registration",
           plugin.name,
           controller,
-          action
+          action,
         );
 
         if (
@@ -876,7 +876,7 @@ class PluginsManager {
             errorControllerPrefix,
             controller,
             action,
-            suggestion
+            suggestion,
           );
         }
 
@@ -892,7 +892,7 @@ class PluginsManager {
         } else {
           apiController._addAction(
             action,
-            plugin.instance[definition[action]].bind(plugin.instance)
+            plugin.instance[definition[action]].bind(plugin.instance),
           );
         }
       }
@@ -913,14 +913,14 @@ class PluginsManager {
     // @deprecated - warn about using the obsolete "routes" object
     if (!_.isEmpty(plugin.instance.routes)) {
       plugin.printDeprecation(
-        'Defining routes using the "routes" object is deprecated. You should use the "api" object instead.'
+        'Defining routes using the "routes" object is deprecated. You should use the "api" object instead.',
       );
     }
 
     for (const route of plugin.instance.routes || []) {
       const controller = `${plugin.name}/${route.controller}`;
       const errorRoutePrefix = `Unable to inject API route "${JSON.stringify(
-        route
+        route,
       )}" from plugin "${plugin.name}":`;
 
       for (const key of Object.keys(route)) {
@@ -929,7 +929,7 @@ class PluginsManager {
             "unexpected_route_property",
             errorRoutePrefix,
             key,
-            didYouMean(key, routeProperties)
+            didYouMean(key, routeProperties),
           );
         }
 
@@ -940,7 +940,7 @@ class PluginsManager {
           throw controllerError.get(
             "invalid_route_property",
             errorRoutePrefix,
-            key
+            key,
           );
         }
       }
@@ -952,7 +952,7 @@ class PluginsManager {
           "undefined_controller",
           errorRoutePrefix,
           route.controller,
-          didYouMean(route.controller, controllerNames)
+          didYouMean(route.controller, controllerNames),
         );
       }
 
@@ -962,7 +962,7 @@ class PluginsManager {
           "undefined_action",
           errorRoutePrefix,
           route.action,
-          didYouMean(route.action, actionNames)
+          didYouMean(route.action, actionNames),
         );
       }
 
@@ -971,14 +971,14 @@ class PluginsManager {
           "unsupported_verb",
           errorRoutePrefix,
           httpVerbs.join(", "),
-          didYouMean(route.verb, httpVerbs)
+          didYouMean(route.verb, httpVerbs),
         );
       }
 
       // @deprecated route.url is deprecated
       if (route.url) {
         plugin.printDeprecation(
-          'Usage of "url" property for routes is deprecated. Use "path" instead.'
+          'Usage of "url" property for routes is deprecated. Use "path" instead.',
         );
       }
       route.path = route.path || route.url;
@@ -987,7 +987,7 @@ class PluginsManager {
         '[%s] binding HTTP route "%s" to controller "%s"',
         plugin.name,
         route.path,
-        route.controller
+        route.controller,
       );
 
       // @deprecated "/_plugin" prefix is deprecated for plugin routes
@@ -1028,7 +1028,7 @@ class PluginsManager {
       this.registerStrategy(
         plugin.name,
         name,
-        plugin.instance.strategies[name]
+        plugin.instance.strategies[name],
       );
     }
   }
@@ -1043,7 +1043,7 @@ class PluginsManager {
         "plugin",
         "authenticators",
         "not_an_object",
-        plugin.logPrefix
+        plugin.logPrefix,
       );
     }
 
@@ -1054,14 +1054,14 @@ class PluginsManager {
           "authenticators",
           "invalid_authenticator",
           plugin.logPrefix,
-          authenticator
+          authenticator,
         );
       }
     }
 
     this.authenticators[plugin.name] = Object.assign(
       {},
-      plugin.instance.authenticators
+      plugin.instance.authenticators,
     );
   }
 
@@ -1075,7 +1075,7 @@ class PluginsManager {
 
     // first load plugins from Backend.plugin.use
     for (const [name, { plugin: instance, options }] of Object.entries(
-      plugins
+      plugins,
     )) {
       const plugin = new Plugin(instance, { name, ...options });
 
@@ -1108,7 +1108,7 @@ class PluginsManager {
       throw assertionError.get(
         "invalid_plugins_dir",
         this.pluginsEnabledDir,
-        e.message
+        e.message,
       );
     }
 
@@ -1175,7 +1175,7 @@ class PluginsManager {
           try {
             const user = await global.kuzzle.ask(
               "core:security:user:get",
-              result.kuid
+              result.kuid,
             );
 
             callback(null, user);
@@ -1226,11 +1226,11 @@ function getMethods(object) {
   const prototype = Object.getPrototypeOf(object);
 
   const instanceMethods = Object.getOwnPropertyNames(prototype).filter(
-    (method) => ["init", "constructor"].indexOf(method) === -1
+    (method) => ["init", "constructor"].indexOf(method) === -1,
   );
 
   const objectMethods = Object.getOwnPropertyNames(object).filter(
-    (key) => typeof object[key] === "function"
+    (key) => typeof object[key] === "function",
   );
 
   return [...instanceMethods, ...objectMethods];