kuzzle 2.19.2 → 2.19.3

package/lib/core/realtime/notifier.js

@@ -19,26 +19,26 @@
  * limitations under the License.
  */
 
-'use strict';
+"use strict";
 
-const { difference } = require('lodash');
-const Bluebird = require('bluebird');
+const { difference } = require("lodash");
+const Bluebird = require("bluebird");
 
-const kerror = require('../../kerror');
-const actionEnum = require('./actionEnum');
-const { koncordeTest } = require('../../util/koncordeCompat');
+const kerror = require("../../kerror");
+const actionEnum = require("./actionEnum");
+const { koncordeTest } = require("../../util/koncordeCompat");
 const {
   DocumentNotification,
   ServerNotification,
   UserNotification,
-} = require('./notification');
+} = require("./notification");
 
 /**
  * Notification are meant to be dispatched on "channels" created when subscribing.
  * But some notification like TokenExpired don't have a specific channel to be received on,
  * so we need a constant channel name to send Kuzzle notification without having to subscribe.
  */
-const KUZZLE_NOTIFICATION_CHANNEL = 'kuzzle:notification:server';
+const KUZZLE_NOTIFICATION_CHANNEL = "kuzzle:notification:server";
 
 /**
  * @typedef {Object} DocumentChanges
@@ -53,12 +53,12 @@ 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;
   }
 
-  async init () {
+  async init() {
     /**
      * Low-level document notification method, allocating a new Notification
      * message and dispatching it to a precomputed list of rooms.
@@ -67,11 +67,11 @@ class NotifierController {
      * @param {Object} [opts]
      */
     global.kuzzle.onAsk(
-      'core:realtime:document:dispatch',
+      "core:realtime:document:dispatch",
       (rooms, notification, opts) => {
         return this._notifyDocument(rooms, notification, opts);
-      });
-
+      }
+    );
 
     /**
      * Low-level user notification method, allocating a new Notification
@@ -81,10 +81,11 @@ class NotifierController {
      * @param {Object} [opts]
      */
     global.kuzzle.onAsk(
-      'core:realtime:user:sendMessage',
+      "core:realtime:user:sendMessage",
       (room, notification, opts) => {
         return this._notifyUser(room, notification, opts);
-      });
+      }
+    );
 
     /**
      * Notify about document creations, updates, replacements or deletions
@@ -93,8 +94,9 @@ class NotifierController {
      * @param {Array.<DocumentChanges>} docs
      */
     global.kuzzle.onAsk(
-      'core:realtime:document:mNotify',
-      (request, action, docs) => this.notifyDocuments(request, action, docs));
+      "core:realtime:document:mNotify",
+      (request, action, docs) => this.notifyDocuments(request, action, docs)
+    );
 
     /**
      * Notify about document creations, updates, replacements or deletions
@@ -103,23 +105,25 @@ class NotifierController {
      * @param {DocumentChanges} doc
      */
     global.kuzzle.onAsk(
-      'core:realtime:document:notify',
-      (request, action, doc) => this.notifyDocuments(request, action, [doc]));
-
+      "core:realtime:document:notify",
+      (request, action, doc) => this.notifyDocuments(request, action, [doc])
+    );
 
     /**
      * Send a "token expired" notification to the target user
      * @param {string} connectionId
      */
-    global.kuzzle.onAsk(
-      'core:realtime:tokenExpired:notify',
-      connectionId => this.notifyTokenExpired(connectionId));
+    global.kuzzle.onAsk("core:realtime:tokenExpired:notify", (connectionId) =>
+      this.notifyTokenExpired(connectionId)
+    );
 
     /**
      * Publish the provided request content to listening subscribers
      * @param {Request} request
      */
-    global.kuzzle.onAsk('core:realtime:publish', request => this.publish(request));
+    global.kuzzle.onAsk("core:realtime:publish", (request) =>
+      this.publish(request)
+    );
   }
 
   /**
@@ -133,7 +137,7 @@ class NotifierController {
    *
    * @returns {Promise}
    */
-  async notifyDocument (rooms, request, scope, action, content) {
+  async notifyDocument(rooms, request, scope, action, content) {
     if (rooms.length === 0) {
       return;
     }
@@ -142,15 +146,16 @@ class NotifierController {
       request,
       scope,
       action,
-      content);
+      content
+    );
 
-    global.kuzzle.emit('core:notify:document', {
+    global.kuzzle.emit("core:notify:document", {
       notification,
       rooms,
     });
 
     await this._notifyDocument(rooms, notification, {
-      fromCluster: false
+      fromCluster: false,
     });
   }
 
@@ -165,16 +170,16 @@ class NotifierController {
    *
    * @returns {Promise}
    */
-  notifyUser (room, request, scope, content) {
+  notifyUser(room, request, scope, content) {
     const notification = UserNotification.fromRequest(request, scope, content);
 
-    global.kuzzle.emit('core:notify:user', {
+    global.kuzzle.emit("core:notify:user", {
       notification,
       room,
     });
 
     return this._notifyUser(room, notification, {
-      fromCluster: false
+      fromCluster: false,
     });
   }
 
@@ -184,13 +189,13 @@ class NotifierController {
    * @param {string} connectionId - User's connection identifier
    * @returns {Promise}
    */
-  async notifyTokenExpired (connectionId) {
-
+  async notifyTokenExpired(connectionId) {
     await this._dispatch(
-      'notify:server',
+      "notify:server",
       [KUZZLE_NOTIFICATION_CHANNEL], // Sending notification on Kuzzle notification channel
-      new ServerNotification('TokenExpired', 'Authentication Token Expired'),
-      connectionId);
+      new ServerNotification("TokenExpired", "Authentication Token Expired"),
+      connectionId
+    );
 
     await this.module.hotelClerk.removeConnection(connectionId);
   }
@@ -201,14 +206,14 @@ class NotifierController {
    * @param {Request} request
    * @returns {Promise.<Object>}
    */
-  publish (request) {
+  publish(request) {
     const rooms = this._test(request);
 
     if (rooms.length === 0) {
       return Bluebird.resolve(null);
     }
 
-    return this.notifyDocument(rooms, request, 'in', 'publish', {
+    return this.notifyDocument(rooms, request, "in", "publish", {
       _id: request.input.args._id,
       _source: request.input.body,
     });
@@ -221,11 +226,11 @@ class NotifierController {
    * @param {DocumentChanges} document created
    * @returns {Promise.<Array.<string>>} list of matched rooms
    */
-  async notifyDocumentCreate (request, document) {
+  async notifyDocumentCreate(request, document) {
     const rooms = this._test(request, document._source, document._id);
 
     if (rooms.length > 0) {
-      await this.notifyDocument(rooms, request, 'in', 'create', document);
+      await this.notifyDocument(rooms, request, "in", "create", document);
     }
 
     return rooms;
@@ -239,17 +244,23 @@ class NotifierController {
    * @param {string} cache notification content for that document
    * @returns {Promise.<Array.<string>} list of matched rooms
    */
-  async notifyDocumentReplace (request, document, cache = null) {
+  async notifyDocumentReplace(request, document, cache = null) {
     const rooms = this._test(request, document._source, document._id);
 
     if (rooms.length > 0) {
-      await this.notifyDocument(rooms, request, 'in', 'replace', document);
+      await this.notifyDocument(rooms, request, "in", "replace", document);
     }
 
     if (cache !== null) {
       const stopListening = difference(JSON.parse(cache), rooms);
 
-      await this.notifyDocument(stopListening, request, 'out', 'replace', document);
+      await this.notifyDocument(
+        stopListening,
+        request,
+        "out",
+        "replace",
+        document
+      );
     }
 
     return rooms;
@@ -262,12 +273,15 @@ class NotifierController {
    * @param  {Array.<DocumentChanges>} documents
    * @return {Promise}
    */
-  async notifyDocuments (request, action, documents) {
+  async notifyDocuments(request, action, documents) {
     const prefix = getCachePrefix(request);
     let cached = action === actionEnum.REPLACE || action === actionEnum.UPDATE;
 
-    const cacheIds = documents.map(doc => {
-      if ((action === actionEnum.WRITE || action === actionEnum.UPSERT) && ! cached) {
+    const cacheIds = documents.map((doc) => {
+      if (
+        (action === actionEnum.WRITE || action === actionEnum.UPSERT) &&
+        !cached
+      ) {
         cached = doc.created !== true; // force a bool value if undefined
       }
 
@@ -275,7 +289,7 @@ class NotifierController {
     });
 
     const cache = cached
-      ? await global.kuzzle.ask('core:cache:internal:mget', cacheIds)
+      ? await global.kuzzle.ask("core:cache:internal:mget", cacheIds)
       : [];
 
     const result = await Bluebird.map(documents, (doc, index) => {
@@ -303,7 +317,12 @@ class NotifierController {
             : this.notifyDocumentReplace(request, doc, cache[index]);
 
         default:
-          throw kerror.get('core', 'fatal', 'assertion_failed', `unknown notify action "${doc.action}"`);
+          throw kerror.get(
+            "core",
+            "fatal",
+            "assertion_failed",
+            `unknown notify action "${doc.action}"`
+          );
       }
     });
 
@@ -312,10 +331,11 @@ class NotifierController {
     await Bluebird.map(result, (rooms, index) => {
       if (rooms.length > 0) {
         return global.kuzzle.ask(
-          'core:cache:internal:store',
+          "core:cache:internal:store",
           cacheIds[index],
           JSON.stringify(rooms),
-          { ttl: this.ttl });
+          { ttl: this.ttl }
+        );
       }
 
       toDelete.push(cacheIds[index]);
@@ -323,7 +343,7 @@ class NotifierController {
     });
 
     if (toDelete.length > 0) {
-      await global.kuzzle.ask('core:cache:internal:del', toDelete);
+      await global.kuzzle.ask("core:cache:internal:del", toDelete);
     }
   }
 
@@ -334,17 +354,23 @@ class NotifierController {
    * @param {string} cache notification content for that document
    * @returns {Promise.<Array.<string>} list of matched rooms
    */
-  async notifyDocumentUpdate (request, document, cache = null) {
+  async notifyDocumentUpdate(request, document, cache = null) {
     const rooms = this._test(request, document._source, document._id);
 
     if (rooms.length > 0) {
-      await this.notifyDocument(rooms, request, 'in', 'update', document);
+      await this.notifyDocument(rooms, request, "in", "update", document);
     }
 
     if (cache !== null) {
       const stopListening = difference(JSON.parse(cache), rooms);
 
-      await this.notifyDocument(stopListening, request, 'out', 'update', document);
+      await this.notifyDocument(
+        stopListening,
+        request,
+        "out",
+        "update",
+        document
+      );
     }
 
     return rooms;
@@ -357,11 +383,11 @@ class NotifierController {
    * @param {DocumentChanges} document
    * @returns {Promise.<Array>} returns an empty array ("no room match anymore")
    */
-  async notifyDocumentDelete (request, document) {
+  async notifyDocumentDelete(request, document) {
     const rooms = this._test(request, document._source, document._id);
 
     if (rooms.length > 0) {
-      await this.notifyDocument(rooms, request, 'out', 'delete', document);
+      await this.notifyDocument(rooms, request, "out", "delete", document);
     }
 
     return [];
@@ -379,20 +405,31 @@ class NotifierController {
    *
    * @returns {Promise}
    */
-  async _dispatch (event, channels, notification, connectionId) {
+  async _dispatch(event, channels, notification, connectionId) {
     try {
       let updated = await global.kuzzle.pipe(event, notification);
-      updated = await global.kuzzle.pipe('notify:dispatch', updated);
+      /**
+       * @deprecated  Should be replaced by `core:realtime:notification:dispatch`
+       */
+      updated = await global.kuzzle.pipe("notify:dispatch", updated);
+
+      const updatedInfo = await global.kuzzle.pipe(
+        "core:realtime:notification:dispatch:before",
+        {
+          channels: channels,
+          connectionId: connectionId,
+          notification: updated,
+        }
+      );
 
-      const action = connectionId ? 'notify' : 'broadcast';
+      const action = updatedInfo.connectionId ? "notify" : "broadcast";
 
       global.kuzzle.entryPoint.dispatch(action, {
-        channels,
-        connectionId,
-        payload: updated
+        channels: updatedInfo.channels,
+        connectionId: updatedInfo.connectionId,
+        payload: updatedInfo.notification,
       });
-    }
-    catch (error) {
+    } catch (error) {
       global.kuzzle.log.error(error);
     }
   }
@@ -414,7 +451,7 @@ class NotifierController {
    *
    * @returns {Promise}
    */
-  _notifyDocument (rooms, notification, { fromCluster = true } = {}) {
+  _notifyDocument(rooms, notification, { fromCluster = true } = {}) {
     const channels = [];
 
     for (const room of rooms) {
@@ -426,8 +463,8 @@ class NotifierController {
 
       for (const [channelId, channel] of hotelClerkRoom.channels.entries()) {
         const executeOnNode = fromCluster ? channel.cluster : true;
-        const matchScope = channel.scope === 'all'
-          || channel.scope === notification.scope;
+        const matchScope =
+          channel.scope === "all" || channel.scope === notification.scope;
 
         if (matchScope && executeOnNode) {
           channels.push(channelId);
@@ -439,7 +476,7 @@ class NotifierController {
       return Bluebird.resolve();
     }
 
-    return this._dispatch('notify:document', channels, notification);
+    return this._dispatch("notify:document", channels, notification);
   }
 
   /**
@@ -452,14 +489,14 @@ class NotifierController {
    *
    * @returns {Promise}
    */
-  _notifyUser (room, notification, { fromCluster = true } = {}) {
+  _notifyUser(room, notification, { fromCluster = true } = {}) {
     const channels = [];
     const hotelClerkRoom = this.module.hotelClerk.rooms.get(room);
 
     if (hotelClerkRoom !== undefined) {
       for (const [id, channel] of hotelClerkRoom.channels.entries()) {
-        const match = channel.users === 'all'
-          || channel.users === notification.user;
+        const match =
+          channel.users === "all" || channel.users === notification.user;
         const executeOnNode = fromCluster ? channel.cluster : true;
 
         if (executeOnNode && match) {
@@ -472,7 +509,7 @@ class NotifierController {
       return Bluebird.resolve();
     }
 
-    return this._dispatch('notify:user', channels, notification);
+    return this._dispatch("notify:user", channels, notification);
   }
 
   /**
@@ -483,17 +520,18 @@ class NotifierController {
    *
    * @returns {Array.<string>}
    */
-  _test (request, source = null, id = null) {
+  _test(request, source = null, id = null) {
     return koncordeTest(
       global.kuzzle.koncorde,
       request.input.args.index,
       request.input.args.collection,
       source || request.input.body || {},
-      id || request.input.args._id);
+      id || request.input.args._id
+    );
   }
 }
 
-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/realtime/room.d.ts

@@ -1,4 +1,4 @@
-import { Channel } from './channel';
+import { Channel } from "./channel";
 /**
  * A room represents a subscription scope made on a combination of:
  *  - index

package/lib/core/realtime/subscription.d.ts

@@ -1,4 +1,4 @@
-import { JSONObject } from 'kuzzle-sdk';
+import { JSONObject } from "kuzzle-sdk";
 /**
  * Represents a realtime subscription of a connection to a room.
  *

package/lib/core/realtime/subscription.js

@@ -41,7 +41,7 @@ class Subscription {
         this.index = index;
         this.collection = collection;
         this.filters = filters;
-        this.kuid = user && user._id || null;
+        this.kuid = (user && user._id) || null;
     }
 }
 exports.Subscription = Subscription;

package/lib/core/security/index.js

@@ -19,16 +19,16 @@
  * limitations under the License.
  */
 
-'use strict';
+"use strict";
 
-const RoleRepository = require('./roleRepository');
-const { ProfileRepository } = require('./profileRepository');
-const TokenRepository = require('./tokenRepository');
-const UserRepository = require('./userRepository');
-const SecurityLoader = require('./securityLoader');
+const RoleRepository = require("./roleRepository");
+const { ProfileRepository } = require("./profileRepository");
+const TokenRepository = require("./tokenRepository");
+const UserRepository = require("./userRepository");
+const SecurityLoader = require("./securityLoader");
 
 class SecurityModule {
-  constructor () {
+  constructor() {
     this.role = new RoleRepository(this);
     this.profile = new ProfileRepository(this);
     this.token = new TokenRepository();
@@ -36,7 +36,7 @@ class SecurityModule {
     this.loader = new SecurityLoader();
   }
 
-  async init () {
+  async init() {
     await this.role.init();
     await this.profile.init();
     await this.token.init();

package/lib/core/security/profileRepository.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="lodash" />
-import { Profile } from '../../model/security/profile';
-import Repository from '../shared/repository';
-import { JSONObject } from 'kuzzle-sdk';
+import { Profile } from "../../model/security/profile";
+import Repository from "../shared/repository";
+import { JSONObject } from "kuzzle-sdk";
 /** @internal */
 declare type CreateOrReplaceOptions = {
     method?: string;
@@ -70,7 +70,7 @@ export declare class ProfileRepository extends Repository {
      * @param {Object} [opts]
      * @returns {Profile}
      */
-    _createOrReplace(id: string, content: JSONObject, { method, refresh, strict, userId }?: CreateOrReplaceOptions): Promise<Profile>;
+    _createOrReplace(id: string, content: JSONObject, { method, refresh, strict, userId, }?: CreateOrReplaceOptions): Promise<Profile>;
     /**
      * Creates a new profile
      *
@@ -108,7 +108,7 @@ export declare class ProfileRepository extends Repository {
     /**
      * @override
      */
-    delete(profile: Profile, { refresh, onAssignedUsers, userId, }?: {
+    delete(profile: Profile, { refresh, onAssignedUsers, userId }?: {
         refresh?: string;
         onAssignedUsers?: string;
         userId?: string;
@@ -134,7 +134,7 @@ export declare class ProfileRepository extends Repository {
      *                                     applied on existing indexes/collections
      * @returns {Promise<Profile>}
      **/
-    validateAndSaveProfile(profile: Profile, { method, refresh, retryOnConflict, strict }?: ValidateAndSaveProfileOptions): Promise<Profile>;
+    validateAndSaveProfile(profile: Profile, { method, refresh, retryOnConflict, strict, }?: ValidateAndSaveProfileOptions): Promise<Profile>;
     /**
      * @param {object} dto
      * @returns {Promise<Profile>}