kuzzle 2.19.2 → 2.19.3

package/lib/core/plugin/pluginContext.js

@@ -61,7 +61,7 @@ const storeScopeEnum_1 = __importDefault(require("../storage/storeScopeEnum"));
 const errors_1 = require("../../kerror/errors");
 const index_1 = require("../../../index");
 const backend_1 = require("../backend");
-const contextError = kerror.wrap('plugin', 'context');
+const contextError = kerror.wrap("plugin", "context");
 class PluginContext {
     constructor(pluginName) {
         this.config = JSON.parse(JSON.stringify(global.kuzzle.config));
@@ -83,7 +83,7 @@ class PluginContext {
             TooManyRequestsError: errors_1.TooManyRequestsError,
             UnauthorizedError: errors_1.UnauthorizedError,
         };
-        this.kerror = kerror.wrap('plugin', pluginName);
+        this.kerror = kerror.wrap("plugin", pluginName);
         // @deprecated - backward compatibility only
         this.errorsManager = this.kerror;
         /* context.secrets ====================================================== */
@@ -96,7 +96,7 @@ class PluginContext {
         // eslint-disable-next-line no-inner-declarations
         function PluginContextRepository(collection, ObjectConstructor = null) {
             if (!collection) {
-                throw contextError.get('missing_collection');
+                throw contextError.get("missing_collection");
             }
             const pluginRepository = new pluginRepository_1.default(pluginStore, collection);
             pluginRepository.init({ ObjectConstructor });
@@ -108,16 +108,15 @@ class PluginContext {
                 mGet: (...args) => pluginRepository.loadMultiFromDatabase(...args),
                 replace: (...args) => pluginRepository.replace(...args),
                 search: (...args) => pluginRepository.search(...args),
-                update: (...args) => pluginRepository.update(...args)
+                update: (...args) => pluginRepository.update(...args),
             };
         }
         // eslint-disable-next-line no-inner-declarations
         function PluginContextESClient() {
-            return elasticsearch_1.default
-                .buildClient(global.kuzzle.config.services.storageEngine.client);
+            return elasticsearch_1.default.buildClient(global.kuzzle.config.services.storageEngine.client);
         }
         this.constructors = {
-            BaseValidationType: require('../validation/baseType'),
+            BaseValidationType: require("../validation/baseType"),
             ESClient: PluginContextESClient,
             Koncorde: KoncordeWrapper_1.Koncorde,
             Mutex: mutex_1.Mutex,
@@ -129,12 +128,12 @@ class PluginContext {
         Object.freeze(this.constructors);
         /* context.log ======================================================== */
         this.log = {
-            debug: msg => global.kuzzle.log.debug(`[${pluginName}] ${msg}`),
-            error: msg => global.kuzzle.log.error(`[${pluginName}] ${msg}`),
-            info: msg => global.kuzzle.log.info(`[${pluginName}] ${msg}`),
-            silly: msg => global.kuzzle.log.silly(`[${pluginName}] ${msg}`),
-            verbose: msg => global.kuzzle.log.verbose(`[${pluginName}] ${msg}`),
-            warn: msg => global.kuzzle.log.warn(`[${pluginName}] ${msg}`)
+            debug: (msg) => global.kuzzle.log.debug(`[${pluginName}] ${msg}`),
+            error: (msg) => global.kuzzle.log.error(`[${pluginName}] ${msg}`),
+            info: (msg) => global.kuzzle.log.info(`[${pluginName}] ${msg}`),
+            silly: (msg) => global.kuzzle.log.silly(`[${pluginName}] ${msg}`),
+            verbose: (msg) => global.kuzzle.log.verbose(`[${pluginName}] ${msg}`),
+            warn: (msg) => global.kuzzle.log.warn(`[${pluginName}] ${msg}`),
         };
         Object.freeze(this.log);
         /* context.accessors ================================================== */
@@ -144,32 +143,32 @@ class PluginContext {
             nodeId: global.kuzzle.id,
             sdk: new embeddedSdk_1.EmbeddedSDK(),
             storage: {
-                bootstrap: collections => pluginStore.init(collections),
-                createCollection: (collection, mappings) => (pluginStore.createCollection(collection, { mappings }))
+                bootstrap: (collections) => pluginStore.init(collections),
+                createCollection: (collection, mappings) => pluginStore.createCollection(collection, { mappings }),
             },
             strategies: {
                 add: curryAddStrategy(pluginName),
-                remove: curryRemoveStrategy(pluginName)
+                remove: curryRemoveStrategy(pluginName),
             },
             subscription: {
                 register: (connectionId, index, collection, filters) => {
                     const request = new index_1.KuzzleRequest({
-                        action: 'subscribe',
+                        action: "subscribe",
                         body: filters,
                         collection,
-                        controller: 'realtime',
+                        controller: "realtime",
                         index,
                     }, {
                         connectionId: connectionId,
                     });
-                    return global.kuzzle.ask('core:realtime:subscribe', request);
+                    return global.kuzzle.ask("core:realtime:subscribe", request);
                 },
-                unregister: (connectionId, roomId, notify) => global.kuzzle.ask('core:realtime:unsubscribe', connectionId, roomId, notify)
+                unregister: (connectionId, roomId, notify) => global.kuzzle.ask("core:realtime:unsubscribe", connectionId, roomId, notify),
             },
-            trigger: (eventName, payload) => (global.kuzzle.pipe(`plugin-${pluginName}:${eventName}`, payload)),
+            trigger: (eventName, payload) => global.kuzzle.pipe(`plugin-${pluginName}:${eventName}`, payload),
             validation: {
                 addType: global.kuzzle.validation.addType.bind(global.kuzzle.validation),
-                validate: global.kuzzle.validation.validate.bind(global.kuzzle.validation)
+                validate: global.kuzzle.validation.validate.bind(global.kuzzle.validation),
             },
         };
         // @todo freeze the "accessors" object once we don't have
@@ -178,33 +177,35 @@ class PluginContext {
 }
 exports.PluginContext = PluginContext;
 /**
-  * @param {KuzzleRequest} request
+ * @param {KuzzleRequest} request
  * @param {Function} [callback]
  */
 function execute(request, callback) {
-    if (callback && typeof callback !== 'function') {
-        const error = contextError.get('invalid_callback', typeof callback);
+    if (callback && typeof callback !== "function") {
+        const error = contextError.get("invalid_callback", typeof callback);
         global.kuzzle.log.error(error);
         return bluebird_1.default.reject(error);
     }
     const promback = new promback_1.default(callback);
-    if (!request || (!(request instanceof index_1.KuzzleRequest) && !(request instanceof index_1.Request))) {
-        return promback.reject(contextError.get('missing_request'));
+    if (!request ||
+        (!(request instanceof index_1.KuzzleRequest) && !(request instanceof index_1.Request))) {
+        return promback.reject(contextError.get("missing_request"));
     }
-    if (request.input.controller === 'realtime'
-        && ['subscribe', 'unsubscribe'].includes(request.input.action)) {
-        return promback.reject(contextError.get('unavailable_realtime', request.input.action));
+    if (request.input.controller === "realtime" &&
+        ["subscribe", "unsubscribe"].includes(request.input.action)) {
+        return promback.reject(contextError.get("unavailable_realtime", request.input.action));
     }
     request.clearError();
     request.status = 102;
-    global.kuzzle.funnel.executePluginRequest(request)
-        .then(result => {
+    global.kuzzle.funnel
+        .executePluginRequest(request)
+        .then((result) => {
         request.setResult(result, {
-            status: request.status === 102 ? 200 : request.status
+            status: request.status === 102 ? 200 : request.status,
         });
         promback.resolve(request);
     })
-        .catch(err => {
+        .catch((err) => {
         promback.reject(err);
     });
     return promback.deferred;
@@ -222,7 +223,7 @@ function execute(request, callback) {
 function instantiateRequest(request, data, options = {}) {
     let _request = request, _data = data, _options = options;
     if (!_request) {
-        throw contextError.get('missing_request_data');
+        throw contextError.get("missing_request_data");
     }
     if (!(_request instanceof index_1.KuzzleRequest)) {
         if (_data) {
@@ -237,7 +238,7 @@ function instantiateRequest(request, data, options = {}) {
     const target = new index_1.KuzzleRequest(_data, _options);
     // forward informations if a request object was supplied
     if (_request) {
-        for (const resource of ['_id', 'index', 'collection']) {
+        for (const resource of ["_id", "index", "collection"]) {
             if (!target.input.resource[resource]) {
                 target.input.resource[resource] = _request.input.resource[resource];
             }
@@ -274,17 +275,17 @@ function curryAddStrategy(pluginName) {
         // be serialized and propagated to other cluster nodes
         // so if a strategy is not defined using an authenticator, we have
         // to reject the call
-        if (!(0, safeObject_1.isPlainObject)(strategy)
-            || !(0, safeObject_1.isPlainObject)(strategy.config)
-            || typeof strategy.config.authenticator !== 'string') {
-            throw contextError.get('missing_authenticator', pluginName, name);
+        if (!(0, safeObject_1.isPlainObject)(strategy) ||
+            !(0, safeObject_1.isPlainObject)(strategy.config) ||
+            typeof strategy.config.authenticator !== "string") {
+            throw contextError.get("missing_authenticator", pluginName, name);
         }
-        const mutex = new mutex_1.Mutex('auth:strategies:add', { ttl: 30000 });
+        const mutex = new mutex_1.Mutex("auth:strategies:add", { ttl: 30000 });
         await mutex.lock();
         try {
             // @todo use Plugin.checkName to ensure format
             global.kuzzle.pluginsManager.registerStrategy(pluginName, name, strategy);
-            return await global.kuzzle.pipe('core:auth:strategyAdded', {
+            return await global.kuzzle.pipe("core:auth:strategyAdded", {
                 name,
                 pluginName,
                 strategy,
@@ -307,11 +308,14 @@ function curryRemoveStrategy(pluginName) {
     // either async or catch unregisterStrategy exceptions + return a rejected
     // promise
     return async function removeStrategy(name) {
-        const mutex = new mutex_1.Mutex('auth:strategies:remove', { ttl: 30000 });
+        const mutex = new mutex_1.Mutex("auth:strategies:remove", { ttl: 30000 });
         await mutex.lock();
         try {
             global.kuzzle.pluginsManager.unregisterStrategy(pluginName, name);
-            return await global.kuzzle.pipe('core:auth:strategyRemoved', { name, pluginName });
+            return await global.kuzzle.pipe("core:auth:strategyRemoved", {
+                name,
+                pluginName,
+            });
         }
         finally {
             await mutex.unlock();

package/lib/core/plugin/pluginManifest.js

@@ -19,33 +19,34 @@
  * limitations under the License.
  */
 
-'use strict';
+"use strict";
 
-const _ = require('lodash');
+const _ = require("lodash");
 
-const kerror = require('../../kerror').wrap('plugin', 'manifest');
-const AbstractManifest = require('../shared/abstractManifest');
+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;
   }
 
-  load () {
+  load() {
     super.load();
 
     // Ensure ES will accept the plugin name as index
-    if (! /^[\w-]+$/.test(this.name)) {
-      throw kerror.get('invalid_name', this.path);
+    if (!/^[\w-]+$/.test(this.name)) {
+      throw kerror.get("invalid_name", this.path);
     }
 
-    if (! _.isNil(this.raw) && ! _.isNil(this.raw.privileged)) {
-      if (typeof this.raw.privileged !== 'boolean') {
+    if (!_.isNil(this.raw) && !_.isNil(this.raw.privileged)) {
+      if (typeof this.raw.privileged !== "boolean") {
         throw kerror.get(
-          'invalid_privileged',
+          "invalid_privileged",
           this.path,
-          typeof this.raw.privileged);
+          typeof this.raw.privileged
+        );
       }
       this.privileged = this.raw.privileged;
     }

package/lib/core/plugin/pluginRepository.js

@@ -19,24 +19,24 @@
  * limitations under the License.
  */
 
-'use strict';
+"use strict";
 
-const { merge } = require('lodash');
+const { merge } = require("lodash");
 
-const { NotFoundError } = require('../../kerror/errors');
-const Repository = require('../shared/repository');
-const cacheDbEnum = require('../cache/cacheDbEnum');
+const { NotFoundError } = require("../../kerror/errors");
+const Repository = require("../shared/repository");
+const cacheDbEnum = require("../cache/cacheDbEnum");
 
 class PluginRepository extends Repository {
-  constructor (store, collection) {
+  constructor(store, collection) {
     super({ cache: cacheDbEnum.NONE, store });
 
     this.collection = collection;
     this.ObjectConstructor = Object;
   }
 
-  init (options) {
-    if (options && typeof options === 'object' && ! Array.isArray(options)) {
+  init(options) {
+    if (options && typeof options === "object" && !Array.isArray(options)) {
       if (options.ObjectConstructor) {
         this.ObjectConstructor = options.ObjectConstructor;
       }
@@ -49,7 +49,7 @@ class PluginRepository extends Repository {
    * @param {object} data - The object to serialize
    * @returns {object}
    */
-  serializeToDatabase (data) {
+  serializeToDatabase(data) {
     // avoid the data var mutation
     const result = merge({}, data);
 
@@ -63,8 +63,8 @@ class PluginRepository extends Repository {
    * @param {object} [options]
    * @returns {Promise}
    */
-  create (object, options = {}) {
-    const opts = Object.assign({ method: 'create' }, options);
+  create(object, options = {}) {
+    const opts = Object.assign({ method: "create" }, options);
 
     return this.persistToDatabase(object, opts);
   }
@@ -74,8 +74,8 @@ class PluginRepository extends Repository {
    * @param {object} [options]
    * @returns {Promise}
    */
-  createOrReplace (object, options = {}) {
-    const opts = Object.assign({ method: 'createOrReplace' }, options);
+  createOrReplace(object, options = {}) {
+    const opts = Object.assign({ method: "createOrReplace" }, options);
 
     return this.persistToDatabase(object, opts);
   }
@@ -85,8 +85,8 @@ class PluginRepository extends Repository {
    * @param {object} [options]
    * @returns {Promise}
    */
-  replace (object, options = {}) {
-    const opts = Object.assign({ method: 'replace' }, options);
+  replace(object, options = {}) {
+    const opts = Object.assign({ method: "replace" }, options);
 
     return this.persistToDatabase(object, opts);
   }
@@ -96,8 +96,8 @@ class PluginRepository extends Repository {
    * @param {object} [options]
    * @returns {Promise}
    */
-  update (object, options = {}) {
-    const opts = Object.assign({ method: 'update' }, options);
+  update(object, options = {}) {
+    const opts = Object.assign({ method: "update" }, options);
 
     return this.persistToDatabase(object, opts);
   }
@@ -109,15 +109,14 @@ class PluginRepository extends Repository {
    * @param {string} documentId
    * @returns {Promise}
    */
-  load (documentId) {
-    return super.load(documentId)
-      .catch(error => {
-        if (this.collection === 'users' && (error instanceof NotFoundError)) {
-          return Promise.resolve(null);
-        }
-
-        throw error;
-      });
+  load(documentId) {
+    return super.load(documentId).catch((error) => {
+      if (this.collection === "users" && error instanceof NotFoundError) {
+        return Promise.resolve(null);
+      }
+
+      throw error;
+    });
   }
 
   /**
@@ -125,7 +124,7 @@ class PluginRepository extends Repository {
    * @param {object} [options]
    * @returns {Promise}
    */
-  delete (documentId, options = {}) {
+  delete(documentId, options = {}) {
     return super.delete({ _id: documentId }, options);
   }
 }