kuzzle 2.27.0 → 2.27.2

package/lib/core/realtime/notifier.js

@@ -70,7 +70,7 @@ class NotifierController {
       "core:realtime:document:dispatch",
       (rooms, notification, opts) => {
         return this._notifyDocument(rooms, notification, opts);
-      }
+      },
     );
 
     /**
@@ -84,7 +84,7 @@ class NotifierController {
       "core:realtime:user:sendMessage",
       (room, notification, opts) => {
         return this._notifyUser(room, notification, opts);
-      }
+      },
     );
 
     /**
@@ -95,7 +95,7 @@ class NotifierController {
      */
     global.kuzzle.onAsk(
       "core:realtime:document:mNotify",
-      (request, action, docs) => this.notifyDocuments(request, action, docs)
+      (request, action, docs) => this.notifyDocuments(request, action, docs),
     );
 
     /**
@@ -106,7 +106,7 @@ class NotifierController {
      */
     global.kuzzle.onAsk(
       "core:realtime:document:notify",
-      (request, action, doc) => this.notifyDocuments(request, action, [doc])
+      (request, action, doc) => this.notifyDocuments(request, action, [doc]),
     );
 
     /**
@@ -114,7 +114,7 @@ class NotifierController {
      * @param {string} connectionId
      */
     global.kuzzle.onAsk("core:realtime:tokenExpired:notify", (connectionId) =>
-      this.notifyTokenExpired(connectionId)
+      this.notifyTokenExpired(connectionId),
     );
 
     /**
@@ -122,7 +122,7 @@ class NotifierController {
      * @param {Request} request
      */
     global.kuzzle.onAsk("core:realtime:publish", (request) =>
-      this.publish(request)
+      this.publish(request),
     );
   }
 
@@ -146,7 +146,7 @@ class NotifierController {
       request,
       scope,
       action,
-      content
+      content,
     );
 
     global.kuzzle.emit("core:notify:document", {
@@ -194,7 +194,7 @@ class NotifierController {
       "notify:server",
       [KUZZLE_NOTIFICATION_CHANNEL], // Sending notification on Kuzzle notification channel
       new ServerNotification("TokenExpired", "Authentication Token Expired"),
-      connectionId
+      connectionId,
     );
 
     await this.module.hotelClerk.removeConnection(connectionId);
@@ -259,7 +259,7 @@ class NotifierController {
         request,
         "out",
         "replace",
-        document
+        document,
       );
     }
 
@@ -321,7 +321,7 @@ class NotifierController {
             "core",
             "fatal",
             "assertion_failed",
-            `unknown notify action "${doc.action}"`
+            `unknown notify action "${doc.action}"`,
           );
       }
     });
@@ -334,7 +334,7 @@ class NotifierController {
           "core:cache:internal:store",
           cacheIds[index],
           JSON.stringify(rooms),
-          { ttl: this.ttl }
+          { ttl: this.ttl },
         );
       }
 
@@ -369,7 +369,7 @@ class NotifierController {
         request,
         "out",
         "update",
-        document
+        document,
       );
     }
 
@@ -419,7 +419,7 @@ class NotifierController {
           channels: channels,
           connectionId: connectionId,
           notification: updated,
-        }
+        },
       );
 
       const action = updatedInfo.connectionId ? "notify" : "broadcast";
@@ -526,7 +526,7 @@ class NotifierController {
       request.input.args.index,
       request.input.args.collection,
       source || request.input.body || {},
-      id || request.input.args._id
+      id || request.input.args._id,
     );
   }
 }

package/lib/core/security/README.md

@@ -0,0 +1,223 @@
+# Kuzzle repositories
+
+The Repository classes allow to fetch and store some Kuzzle internal business object from/to the persistent layer.
+
+An abstract Repository class is available to be overridden if needed depending on the business needs.
+The class handles the persistence both to the Cache module and to the database (elastic search by default).
+
+The **Repository** class exposes the following methods:
+
+## Constructor
+
+The constructor expects to be passed the kuzzle instance and an options array.
+
+### options
+
+- _string_ collection (mandatory)
+
+The underlying collection to store the Business objects to.
+
+- _integer | false_ ttl (optional)
+
+The ttl to use for the cache module. If set to false, the objects get an unlimited lifetime.
+
+- _function_ ObjectConstructor (mandatory)
+
+The constructor function for the business objects. The load\* methods will return some new instances of this function.
+
+- _function_ indexStorage (optional)
+
+The read engine to use to retrieve the business objects to/from the database. Defaults to Kuzzle's internalStorage (elasticsearch).
+
+- _function_ cache (optional)
+
+The cache database to use to store and retrieve the business objects to/from the cache. Defaults to Kuzzle's internal cache.
+
+## loadOneFromDatabase
+
+```javascript
+Repository.prototype.loadOneFromDatabase = function (id) {...}
+```
+
+This method loads one object from the database given its id.
+
+### parameters
+
+- _string_ id
+
+The id of the document to retrieve.
+
+### returns
+
+Returns a promise that resolves to the _ObjectConstructor_ instance if found or null if the id does not exist in the database.
+
+## loadMultiFromDatabase
+
+```javascript
+Repository.prototype.loadMultiFromDatabase = function (ids, hydrate) {...}
+```
+
+This method tries to load the business objects from the database matching the given ids.
+
+### returns
+
+Returns a promise that resolves to an array containing the _ObjectConstructor_ instances or documents that could be retrieved from the database.
+
+If no matching document could be found, an empty array is returned.
+
+## search
+
+```javascript
+Repository.prototype.search = function (filter, from, size) {...}
+```
+
+This method tries to load documents matching the given ids from the indexStorage.
+
+### parameters
+
+- _object_ query
+
+The query sent to the indexStorage in order to retrieve documents.
+
+- _Integer_ from
+
+Starting offset (default: 0).
+
+- _Integer_ size
+
+Number of hits to return (default: 20).
+
+### returns
+
+Returns a promise that resolves to an object that contains a list of documents from indexStorage.
+
+## loadFromCache
+
+```javascript
+Repository.prototype.loadFromCache = function (id, opts) {...}
+```
+
+This method loads one object from the cache given its id.
+
+### parameters
+
+- _string_ id
+
+The object id to load from the cache.
+
+- _Object_ opts
+
+An optional options object.
+
+Currently, the only optional parameter that can be pass to the method is _key_.
+If no key is given to the method, defaults to _collection_ + '/' + id.
+
+### returns
+
+Returns a promise that resolves to the _ObjectConstructor_ instance if a matching document could be found in the cache, or _null_ if no document could be found.
+
+## persistToDB
+
+```javascript
+Repository.prototype.persistToDB = function (object) {...}
+```
+
+This method persists the given _ObjectConstructor_ instance to the database.
+
+### parameters
+
+- _ObjectConstructor_ object
+
+The business object to persist.
+
+### returns
+
+_(Promise)_
+
+## persistToCache
+
+```javascript
+Repository.prototype.persistToCache = function (object, opts) {...}
+```
+
+This method persists the given _ObjectConstructor_ instance to the cache.
+
+### parameters
+
+- _ObjectConstructor_ object
+
+The business object to persist.
+
+- _Object_ opts
+
+An optional options object.
+The supported options are:
+
+> - key: The key used to store the object in the cache engine. Defaults to _collection_ + '/' + object.\_id
+> - ttl: Defaults to the repository ttl. If set to false, the object will never expire.
+
+### returns
+
+_(Promise)_
+
+## refreshCacheTTL
+
+```javascript
+Repository.prototype.refreshCacheTTL = function (object, opts) {...}
+```
+
+This methods updates the object's TTL in the cache engine.
+
+### parameters
+
+- _ObjectConstructor_ object
+
+The business object to update.
+
+- _Object_ opts
+
+An optional options object.  
+The supported options are:
+
+> - key: The key used to store the object in the cache engine. Defaults to _collection_ + '/' + object.\_id
+> - ttl: Defaults to the repository ttl. If set to false, the object will never expire.
+
+### returns
+
+_(Promise)_
+
+## serializeToCache
+
+```javascript
+Repository.prototype.serializeToCache = function (object) {...}
+```
+
+This method transforms the business object before being persisted to the cache. The default implementation just returns the object without any transformation and is meant to be overridden.
+
+### parameters
+
+- _ObjectConstructor_ object
+
+The business object to persist.
+
+### returns
+
+_(Object)_
+
+## serializeToDatabase
+
+```javascript
+Repository.prototype.serializeToDatabase = function (object) {...}
+```
+
+This method transforms the business object before being persisted to the cache. The default implementation just returns the object without any transformation and is meant to be overridden.
+
+### parameters
+
+- _ObjectConstructor_ object
+
+The business object to persist.
+
+### returns
+
+_(Object)_

package/lib/core/security/roleRepository.js

@@ -64,7 +64,7 @@ class RoleRepository extends Repository {
      * @throws If already exists or if the content is invalid
      */
     global.kuzzle.onAsk("core:security:role:create", (id, content, opts) =>
-      this.create(id, content, opts)
+      this.create(id, content, opts),
     );
 
     /**
@@ -77,7 +77,7 @@ class RoleRepository extends Repository {
      */
     global.kuzzle.onAsk(
       "core:security:role:createOrReplace",
-      (id, content, opts) => this.createOrReplace(id, content, opts)
+      (id, content, opts) => this.createOrReplace(id, content, opts),
     );
 
     /**
@@ -88,7 +88,7 @@ class RoleRepository extends Repository {
      *         still in use
      */
     global.kuzzle.onAsk("core:security:role:delete", (id, opts) =>
-      this.deleteById(id, opts)
+      this.deleteById(id, opts),
     );
 
     /**
@@ -106,7 +106,7 @@ class RoleRepository extends Repository {
      * @param  {String} [id] - role identifier
      */
     global.kuzzle.onAsk("core:security:role:invalidate", (id) =>
-      this.invalidate(id)
+      this.invalidate(id),
     );
 
     /**
@@ -116,7 +116,7 @@ class RoleRepository extends Repository {
      * @throws If one or more roles don't exist
      */
     global.kuzzle.onAsk("core:security:role:mGet", (ids) =>
-      this.loadRoles(ids)
+      this.loadRoles(ids),
     );
 
     /**
@@ -127,7 +127,7 @@ class RoleRepository extends Repository {
      * @returns {Object} Search results
      */
     global.kuzzle.onAsk("core:security:role:search", (controllers, opts) =>
-      this.searchRole(controllers, opts)
+      this.searchRole(controllers, opts),
     );
 
     /**
@@ -135,7 +135,7 @@ class RoleRepository extends Repository {
      * @param  {Object} opts (refresh)
      */
     global.kuzzle.onAsk("core:security:role:truncate", (opts) =>
-      this.truncate(opts)
+      this.truncate(opts),
     );
 
     /**
@@ -147,7 +147,7 @@ class RoleRepository extends Repository {
      * @returns {Role} Updated role
      */
     global.kuzzle.onAsk("core:security:role:update", (id, content, opts) =>
-      this.update(id, content, opts)
+      this.update(id, content, opts),
     );
 
     /**
@@ -195,7 +195,7 @@ class RoleRepository extends Repository {
   async _createOrReplace(
     id,
     content,
-    { force = false, method, refresh = "false", userId = null } = {}
+    { force = false, method, refresh = "false", userId = null } = {},
   ) {
     const dto = {
       ...content,
@@ -319,7 +319,7 @@ class RoleRepository extends Repository {
 
     const searchResults = await this.search(
       { query: {}, sort: [{ _id: { order: "asc" } }] },
-      { from: 0, size: 9999 }
+      { from: 0, size: 9999 },
     ); // /!\ NOT the options values
 
     const result = {
@@ -330,8 +330,8 @@ class RoleRepository extends Repository {
     if (body.controllers.length > 0) {
       result.hits = searchResults.hits.filter((role) =>
         Object.keys(role.controllers).some(
-          (key) => key === "*" || body.controllers.includes(key)
-        )
+          (key) => key === "*" || body.controllers.includes(key),
+        ),
       );
 
       result.total = result.hits.length;
@@ -397,7 +397,7 @@ class RoleRepository extends Repository {
               role._id,
               action,
               roleController,
-              didYouMean(action, controller.__actions)
+              didYouMean(action, controller.__actions),
             );
           }
         });
@@ -428,7 +428,7 @@ class RoleRepository extends Repository {
             "unknown_controller",
             role._id,
             roleController,
-            didYouMean(roleController, plugins.getControllerNames())
+            didYouMean(roleController, plugins.getControllerNames()),
           );
         }
 
@@ -439,7 +439,7 @@ class RoleRepository extends Repository {
         // made after plugins controllers loading.
         if (global.kuzzle.state === kuzzleStateEnum.RUNNING || forceWarn) {
           global.kuzzle.log.warn(
-            `The role "${role._id}" gives access to the non-existing controller "${roleController}".`
+            `The role "${role._id}" gives access to the non-existing controller "${roleController}".`,
           );
         }
 
@@ -455,14 +455,14 @@ class RoleRepository extends Repository {
               role._id,
               action,
               roleController,
-              didYouMean(action, plugins.getActions(roleController))
+              didYouMean(action, plugins.getActions(roleController)),
             );
           }
 
           // see the other comment
           if (global.kuzzle.state === kuzzleStateEnum.RUNNING || forceWarn) {
             global.kuzzle.log.warn(
-              `The role "${role._id}" gives access to the non-existing action "${action}" for the controller "${roleController}".`
+              `The role "${role._id}" gives access to the non-existing action "${action}" for the controller "${roleController}".`,
             );
           }
         }
@@ -510,7 +510,7 @@ class RoleRepository extends Repository {
       {
         from: 0,
         size: 1,
-      }
+      },
     );
 
     if (response.total > 0) {

package/lib/core/security/securityLoader.js

@@ -41,7 +41,7 @@ class SecurityLoader {
      * @param {Object} opts - force, onExistingUsers (fail), onExistingUsersWarning (false), user (null)
      */
     global.kuzzle.onAsk("core:security:load", (json, opts) =>
-      this.load(json, opts)
+      this.load(json, opts),
     );
   }
 
@@ -53,7 +53,7 @@ class SecurityLoader {
       onExistingUsersWarning = false,
       refresh = "false",
       user = null,
-    } = {}
+    } = {},
   ) {
     assertIsObject(permissions);
 
@@ -67,7 +67,7 @@ class SecurityLoader {
       "createOrReplaceProfile",
       permissions.profiles,
       "profiles",
-      { refresh, user }
+      { refresh, user },
     );
 
     const usersToLoad = await this._getUsersToLoad(permissions.users, {
@@ -99,7 +99,7 @@ class SecurityLoader {
           force,
           refresh,
         },
-        { user }
+        { user },
       );
 
       promises.push(global.kuzzle.funnel.processRequest(request));
@@ -135,7 +135,7 @@ class SecurityLoader {
     } else if (onExistingUsers === "skip") {
       if (warning) {
         global.kuzzle.log.info(
-          `Users skipped during import: ${existingUserIds}`
+          `Users skipped during import: ${existingUserIds}`,
         );
       }
       return Object.entries(users).reduce((memo, [userId, content]) => {
@@ -148,7 +148,7 @@ class SecurityLoader {
     } else if (onExistingUsers === "overwrite") {
       if (warning) {
         global.kuzzle.log.info(
-          `Users overwritten during import: ${existingUserIds}`
+          `Users overwritten during import: ${existingUserIds}`,
         );
       }
       const mDeleteUsers = new Request({
@@ -167,7 +167,7 @@ class SecurityLoader {
         "assert",
         "unexpected_argument",
         "onExistingUsers",
-        ["skip", "overwrite", "fail"]
+        ["skip", "overwrite", "fail"],
       );
     }
   }

package/lib/core/security/userRepository.js

@@ -58,7 +58,7 @@ class UserRepository extends Repository {
      */
     global.kuzzle.onAsk(
       "core:security:user:anonymous:get",
-      () => this.anonymousUser
+      () => this.anonymousUser,
     );
 
     /**
@@ -73,7 +73,7 @@ class UserRepository extends Repository {
     global.kuzzle.onAsk(
       "core:security:user:create",
       (id, profileIds, content, opts) =>
-        this.create(id, profileIds, content, opts)
+        this.create(id, profileIds, content, opts),
     );
 
     /**
@@ -83,7 +83,7 @@ class UserRepository extends Repository {
      * @throws If the user doesn't exist
      */
     global.kuzzle.onAsk("core:security:user:delete", (id, opts) =>
-      this.deleteById(id, opts)
+      this.deleteById(id, opts),
     );
 
     /**
@@ -101,7 +101,7 @@ class UserRepository extends Repository {
      * @throws If one or more users don't exist
      */
     global.kuzzle.onAsk("core:security:user:mGet", (ids) =>
-      this.loadMultiFromDatabase(ids)
+      this.loadMultiFromDatabase(ids),
     );
 
     /**
@@ -114,7 +114,7 @@ class UserRepository extends Repository {
     global.kuzzle.onAsk(
       "core:security:user:replace",
       (id, profileIds, content, opts) =>
-        this.replace(id, profileIds, content, opts)
+        this.replace(id, profileIds, content, opts),
     );
 
     /**
@@ -124,7 +124,7 @@ class UserRepository extends Repository {
      * @returns {Object} Search results
      */
     global.kuzzle.onAsk("core:security:user:scroll", (id, ttl) =>
-      this.scroll(id, ttl)
+      this.scroll(id, ttl),
     );
 
     /**
@@ -134,7 +134,7 @@ class UserRepository extends Repository {
      * @returns {Object} Search results
      */
     global.kuzzle.onAsk("core:security:user:search", (searchBody, opts) =>
-      this.search(searchBody, opts)
+      this.search(searchBody, opts),
     );
 
     /**
@@ -142,7 +142,7 @@ class UserRepository extends Repository {
      * @param  {Object} opts (refresh)
      */
     global.kuzzle.onAsk("core:security:user:truncate", (opts) =>
-      this.truncate(opts)
+      this.truncate(opts),
     );
 
     /**
@@ -155,7 +155,7 @@ class UserRepository extends Repository {
     global.kuzzle.onAsk(
       "core:security:user:update",
       (id, profileIds, content, opts) =>
-        this.update(id, profileIds, content, opts)
+        this.update(id, profileIds, content, opts),
     );
 
     /**
@@ -164,7 +164,7 @@ class UserRepository extends Repository {
      * @returns {Boolean}
      */
     global.kuzzle.onAsk("core:security:user:admin:exist", () =>
-      this.adminExists()
+      this.adminExists(),
     );
   }
 
@@ -216,7 +216,7 @@ class UserRepository extends Repository {
     id,
     profileIds,
     content,
-    { refresh = "false", retryOnConflict = 10, userId } = {}
+    { refresh = "false", retryOnConflict = 10, userId } = {},
   ) {
     const user = await this.load(id);
     const pojo = this.toDTO(user);
@@ -374,7 +374,7 @@ class UserRepository extends Repository {
     for (const strategy of availableStrategies) {
       const existStrategy = global.kuzzle.pluginsManager.getStrategyMethod(
         strategy,
-        "exists"
+        "exists",
       );
 
       if (await existStrategy(request, user._id, strategy)) {
@@ -387,7 +387,7 @@ class UserRepository extends Repository {
       for (const strategy of userStrategies) {
         const deleteStrategy = global.kuzzle.pluginsManager.getStrategyMethod(
           strategy,
-          "delete"
+          "delete",
         );
 
         // We catch any error produced by delete as we want to make as much
@@ -396,7 +396,7 @@ class UserRepository extends Repository {
           debug(
             "Deleting credentials on strategy %s for user %s",
             strategy,
-            user._id
+            user._id,
           );
           await deleteStrategy(request, user._id, strategy);
         } catch (error) {
@@ -410,7 +410,7 @@ class UserRepository extends Repository {
         "security",
         "credentials",
         "rejected",
-        errors.join("\n\t- ")
+        errors.join("\n\t- "),
       );
     }
   }
@@ -436,7 +436,7 @@ class UserRepository extends Repository {
           term: { profileIds: "admin" },
         },
       },
-      { size: 1 }
+      { size: 1 },
     );
 
     return total >= 1;

package/lib/core/shared/README.md

@@ -0,0 +1,3 @@
+# Description
+
+This directory contains shared objects between core modules.

package/lib/core/shared/abstractManifest.js

@@ -62,7 +62,7 @@ class AbstractManifest {
         "version_mismatch",
         this.path,
         global.kuzzle.config.version,
-        this.kuzzleVersion
+        this.kuzzleVersion,
       );
     }