kuzzle 2.49.1 → 2.50.0-beta.3

package/dist/lib/core/realtime/notifier.js

@@ -0,0 +1,405 @@
+/*
+ * Kuzzle, a backend software, self-hostable and ready to use
+ * to power modern apps
+ *
+ * Copyright 2015-2022 Kuzzle
+ * mailto: support AT kuzzle.io
+ * website: http://kuzzle.io
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+"use strict";
+const { difference } = require("lodash");
+const Bluebird = require("bluebird");
+const kerror = require("../../kerror");
+const actionEnum = require("./actionEnum");
+const { koncordeTest } = require("../../util/koncordeCompat");
+const { DocumentNotification, ServerNotification, UserNotification, } = 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";
+/**
+ * @typedef {Object} DocumentChanges
+ * @property {string}  _id              of the document
+ * @property {Object}  [_source]        of the document
+ * @property {Object}  [_updatedFields] applied to the document (for updates)
+ * @property {boolean} [created]        -- tells if this is a CREATE or REPLACE
+ *                                      (for actionEnum.WRITE)
+ */
+/**
+ * @class NotifierController
+ */
+class NotifierController {
+    constructor(realtimeModule) {
+        this.module = realtimeModule;
+        this.ttl = global.kuzzle.config.limits.subscriptionDocumentTTL;
+        this.logger = global.kuzzle.log.child("core:realtime:notifier");
+    }
+    async init() {
+        /**
+         * Low-level document notification method, allocating a new Notification
+         * message and dispatching it to a precomputed list of rooms.
+         * @param {Array.<string>} rooms - list of koncorde rooms to notify
+         * @param {DocumentNotification} notification
+         * @param {Object} [opts]
+         */
+        global.kuzzle.onAsk("core:realtime:document:dispatch", (rooms, notification, opts) => {
+            return this._notifyDocument(rooms, notification, opts);
+        });
+        /**
+         * Low-level user notification method, allocating a new Notification
+         * message and dispatching it to the provided room
+         * @param {string} room
+         * @param {UserNotification}
+         * @param {Object} [opts]
+         */
+        global.kuzzle.onAsk("core:realtime:user:sendMessage", (room, notification, opts) => {
+            return this._notifyUser(room, notification, opts);
+        });
+        /**
+         * Notify about document creations, updates, replacements or deletions
+         * @param {Request} request
+         * @param {notifyActionEnum} action applied to documents
+         * @param {Array.<DocumentChanges>} docs
+         */
+        global.kuzzle.onAsk("core:realtime:document:mNotify", (request, action, docs) => this.notifyDocuments(request, action, docs));
+        /**
+         * Notify about document creations, updates, replacements or deletions
+         * @param {Request} request
+         * @param {notifyActionEnum} action applied to documents
+         * @param {DocumentChanges} doc
+         */
+        global.kuzzle.onAsk("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));
+        /**
+         * Publish the provided request content to listening subscribers
+         * @param {Request} request
+         */
+        global.kuzzle.onAsk("core:realtime:publish", (request) => this.publish(request));
+    }
+    /**
+     * Broadcasts a notification about a document change or a
+     * real-time message
+     *
+     * @param {Array} rooms - Subscribed rooms to notify
+     * @param {Request} request - Request at the origin of the notification
+     * @param {string} scope - 'in' or 'out'
+     * @param {object} content - Document or message
+     *
+     * @returns {Promise}
+     */
+    async notifyDocument(rooms, request, scope, action, content) {
+        if (rooms.length === 0) {
+            return;
+        }
+        const notification = DocumentNotification.fromRequest(request, scope, action, content);
+        global.kuzzle.emit("core:notify:document", {
+            notification,
+            rooms,
+        });
+        await this._notifyDocument(rooms, notification, {
+            fromCluster: false,
+        });
+    }
+    /**
+     * Broadcast a notification about a user entering or leaving
+     * the provided room
+     *
+     * @param {string} room - Room entered or left
+     * @param {Request} request - User (un)subscription request
+     * @param {string} scope - 'in' or 'out'
+     * @param {object} content - Notification additional informations
+     *
+     * @returns {Promise}
+     */
+    notifyUser(room, request, scope, content) {
+        const notification = UserNotification.fromRequest(request, scope, content);
+        global.kuzzle.emit("core:notify:user", {
+            notification,
+            room,
+        });
+        return this._notifyUser(room, notification, {
+            fromCluster: false,
+        });
+    }
+    /**
+     * Send a "token expired" notification to the target user
+     *
+     * @param {string} connectionId - User's connection identifier
+     * @returns {Promise}
+     */
+    async notifyTokenExpired(connectionId) {
+        await this._dispatch("notify:server", [KUZZLE_NOTIFICATION_CHANNEL], // Sending notification on Kuzzle notification channel
+        new ServerNotification("TokenExpired", "Authentication Token Expired"), connectionId);
+        await this.module.hotelClerk.removeConnection(connectionId);
+    }
+    /**
+     * Publish the content of the provided request to listening subscribers
+     *
+     * @param {Request} request
+     * @returns {Promise.<Object>}
+     */
+    publish(request) {
+        const rooms = this._test(request);
+        if (rooms.length === 0) {
+            return Bluebird.resolve(null);
+        }
+        return this.notifyDocument(rooms, request, "in", "publish", {
+            _id: request.input.args._id,
+            _source: request.input.body,
+        });
+    }
+    /**
+     * Notify about a created document
+     *
+     * @param {Request} request
+     * @param {DocumentChanges} document created
+     * @returns {Promise.<Array.<string>>} list of matched rooms
+     */
+    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);
+        }
+        return rooms;
+    }
+    /**
+     * Notify about a replaced document
+     *
+     * @param {Request} request
+     * @param {DocumentChanges} document
+     * @param {string} cache notification content for that document
+     * @returns {Promise.<Array.<string>} list of matched rooms
+     */
+    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);
+        }
+        if (cache !== null) {
+            const stopListening = difference(JSON.parse(cache), rooms);
+            await this.notifyDocument(stopListening, request, "out", "replace", document);
+        }
+        return rooms;
+    }
+    /**
+     * Computes document notifications and sends them to subscribed users.
+     * @param  {Request} request
+     * @param  {notifyActionEnum} action
+     * @param  {Array.<DocumentChanges>} documents
+     * @return {Promise}
+     */
+    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) {
+                cached = doc.created !== true; // force a bool value if undefined
+            }
+            return prefix + doc._id;
+        });
+        const cache = cached
+            ? await global.kuzzle.ask("core:cache:internal:mget", cacheIds)
+            : [];
+        const result = await Bluebird.map(documents, (doc, index) => {
+            switch (action) {
+                case actionEnum.CREATE:
+                    return this.notifyDocumentCreate(request, doc);
+                case actionEnum.DELETE:
+                    return this.notifyDocumentDelete(request, doc);
+                case actionEnum.REPLACE:
+                    return this.notifyDocumentReplace(request, doc, cache[index]);
+                case actionEnum.UPDATE:
+                    return this.notifyDocumentUpdate(request, doc, cache[index]);
+                case actionEnum.UPSERT:
+                    return doc.created
+                        ? this.notifyDocumentCreate(request, doc)
+                        : this.notifyDocumentUpdate(request, doc, cache[index]);
+                case actionEnum.WRITE:
+                    return doc.created
+                        ? this.notifyDocumentCreate(request, doc)
+                        : this.notifyDocumentReplace(request, doc, cache[index]);
+                default:
+                    throw kerror.get("core", "fatal", "assertion_failed", `unknown notify action "${doc.action}"`);
+            }
+        });
+        const toDelete = [];
+        await Bluebird.map(result, (rooms, index) => {
+            if (rooms.length > 0) {
+                return global.kuzzle.ask("core:cache:internal:store", cacheIds[index], JSON.stringify(rooms), { ttl: this.ttl });
+            }
+            toDelete.push(cacheIds[index]);
+            return null;
+        });
+        if (toDelete.length > 0) {
+            await global.kuzzle.ask("core:cache:internal:del", toDelete);
+        }
+    }
+    /**
+     * Notify rooms on a document update
+     * @param {Request} request
+     * @param {DocumentChanges} document
+     * @param {string} cache notification content for that document
+     * @returns {Promise.<Array.<string>} list of matched rooms
+     */
+    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);
+        }
+        if (cache !== null) {
+            const stopListening = difference(JSON.parse(cache), rooms);
+            await this.notifyDocument(stopListening, request, "out", "update", document);
+        }
+        return rooms;
+    }
+    /**
+     * Notify about a document deletion
+     *
+     * @param {Request} request
+     * @param {DocumentChanges} document
+     * @returns {Promise.<Array>} returns an empty array ("no room match anymore")
+     */
+    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);
+        }
+        return [];
+    }
+    /**
+     * Trigger a notify global event and, if accepted by plugins,
+     * dispatch the payload to subscribers
+     *
+     * @param {Array} channels - Subscribers channels to notify
+     * @param {Notification.User|Notification.Document|Notification.Server} notification
+     * @param {string} [connectionId] - Notify this connection, or broadcast
+     *                                   if not provided
+     * @param {boolean} [trigger] - If set to true, triggers Kuzzle plugins
+     *
+     * @returns {Promise}
+     */
+    async _dispatch(event, channels, notification, connectionId) {
+        try {
+            let updated = await global.kuzzle.pipe(event, notification);
+            /**
+             * @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 = updatedInfo.connectionId ? "notify" : "broadcast";
+            global.kuzzle.entryPoint.dispatch(action, {
+                channels: updatedInfo.channels,
+                connectionId: updatedInfo.connectionId,
+                payload: updatedInfo.notification,
+            });
+        }
+        catch (error) {
+            this.logger.error(error);
+        }
+    }
+    /**
+     * Broadcasts a notification about a document change or a
+     * real-time message.
+     *
+     * When this method is called from the node who received
+     * the request triggering notification, then every channel is notified
+     * regardless of the "cluster" option.
+     *
+     * When this method is called from the cluster synchronization,
+     * then only the channels having the "cluster: true" option are notified
+     *
+     * @param {Array} rooms - Subscribed rooms to notify
+     * @param {DocumentNotification} notification
+     * @param {object} [options] - fromCluster (true)
+     *
+     * @returns {Promise}
+     */
+    _notifyDocument(rooms, notification, { fromCluster = true } = {}) {
+        const channels = [];
+        for (const room of rooms) {
+            const hotelClerkRoom = this.module.hotelClerk.rooms.get(room);
+            if (hotelClerkRoom === undefined) {
+                continue;
+            }
+            for (const [channelId, channel] of hotelClerkRoom.channels.entries()) {
+                const executeOnNode = fromCluster ? channel.cluster : true;
+                const matchScope = channel.scope === "all" || channel.scope === notification.scope;
+                if (matchScope && executeOnNode) {
+                    channels.push(channelId);
+                }
+            }
+        }
+        if (channels.length === 0) {
+            return Bluebird.resolve();
+        }
+        return this._dispatch("notify:document", channels, notification);
+    }
+    /**
+     * Broadcast a notification about a user entering or leaving
+     * the provided room
+     *
+     * @param {string} room - Room entered or left
+     * @param {UserNotification} notification
+     * @param {object} content - Notification additional informations
+     *
+     * @returns {Promise}
+     */
+    _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 executeOnNode = fromCluster ? channel.cluster : true;
+                if (executeOnNode && match) {
+                    channels.push(id);
+                }
+            }
+        }
+        if (channels.length === 0) {
+            return Bluebird.resolve();
+        }
+        return this._dispatch("notify:user", channels, notification);
+    }
+    /**
+     * DRYification for calls to Koncorde's test method from a Request object
+     * @param {Request} request
+     * @param {Object} source - document's source
+     * @param {String} id
+     *
+     * @returns {Array.<string>}
+     */
+    _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);
+    }
+}
+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}}/`;
+}
+module.exports = NotifierController;
+//# sourceMappingURL=notifier.js.map

package/dist/lib/core/security/index.d.ts

@@ -0,0 +1,14 @@
+export = SecurityModule;
+declare class SecurityModule {
+    role: RoleRepository;
+    profile: ProfileRepository;
+    token: TokenRepository;
+    user: UserRepository;
+    loader: SecurityLoader;
+    init(): Promise<void>;
+}
+import RoleRepository = require("./roleRepository");
+import { ProfileRepository } from "./profileRepository";
+import { TokenRepository } from "./tokenRepository";
+import UserRepository = require("./userRepository");
+import SecurityLoader = require("./securityLoader");

package/{lib → dist/lib}/core/security/index.js

@@ -18,31 +18,27 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 "use strict";
-
 const RoleRepository = require("./roleRepository");
 const { ProfileRepository } = require("./profileRepository");
 const { TokenRepository } = require("./tokenRepository");
 const UserRepository = require("./userRepository");
 const SecurityLoader = require("./securityLoader");
-
 class SecurityModule {
-  constructor() {
-    this.role = new RoleRepository(this);
-    this.profile = new ProfileRepository(this);
-    this.token = new TokenRepository();
-    this.user = new UserRepository(this);
-    this.loader = new SecurityLoader();
-  }
-
-  async init() {
-    await this.role.init();
-    await this.profile.init();
-    await this.token.init();
-    await this.user.init();
-    await this.loader.init();
-  }
+    constructor() {
+        this.role = new RoleRepository(this);
+        this.profile = new ProfileRepository(this);
+        this.token = new TokenRepository();
+        this.user = new UserRepository(this);
+        this.loader = new SecurityLoader();
+    }
+    async init() {
+        await this.role.init();
+        await this.profile.init();
+        await this.token.init();
+        await this.user.init();
+        await this.loader.init();
+    }
 }
-
 module.exports = SecurityModule;
+//# sourceMappingURL=index.js.map

package/dist/lib/core/security/roleRepository.d.ts

@@ -0,0 +1,143 @@
+export = RoleRepository;
+/**
+ * @class RoleRepository
+ * @extends ObjectRepository
+ */
+declare class RoleRepository extends ObjectRepository<any> {
+    /**
+     * @constructor
+     * @param {SecurityModule} securityModule
+     */
+    constructor(securityModule: SecurityModule);
+    module: SecurityModule;
+    ObjectConstructor: typeof Role;
+    roles: Map<any, any>;
+    logger: import("../../kuzzle/Logger").Logger;
+    init(): void;
+    /**
+     * From a list of role ids, retrieves the matching Role objects.
+     *
+     * @param {Array} ids The role ids to load
+     * @param {Object} options - resetCache (false)
+     * @returns {Promise.<Array.<Role>>}
+     */
+    loadRoles(ids: any[]): Promise<Array<Role>>;
+    /**
+     * Creates a new role, or create/replace a role
+     *
+     * @param {String} id
+     * @param {Object} content
+     * @param {Object} [opts]
+     * @returns {Role}
+     */
+    _createOrReplace(id: string, content: any, { force, method, refresh, userId }?: any): Role;
+    /**
+     * Creates a new role
+     *
+     * @param {String} id
+     * @param {Object} content
+     * @param {Object} [opts]
+     * @returns {Role}
+     */
+    create(id: string, content: any, opts?: any): Role;
+    /**
+     * Creates or replaces a role
+     *
+     * @param {String} id
+     * @param {Object} content
+     * @param {Object} [opts]
+     * @returns {Role}
+     */
+    createOrReplace(id: string, content: any, opts?: any): Role;
+    /**
+     * Updates a role (replaces the entire content)
+     *
+     * @todo  (breaking change) make this function able to handle partial updates
+     *        instead of replacing the entire role content (hint: _.merge)
+     *
+     * @param  {String} id
+     * @param  {Object} content
+     * @param  {Object} [opts]
+     * @returns {Promise}
+     */
+    update(id: string, content: any, { force, refresh, retryOnConflict, userId }?: any): Promise<any>;
+    /**
+     * Get from database the document that represent the role given in parameter
+     *
+     * @param {string} id
+     * @returns {Promise.<Role>} role
+     * @throws {NotFoundError} If the corresponding role doesn't exist
+     */
+    load(id: string): Promise<Role>;
+    /**
+     * @override
+     */
+    override loadOneFromDatabase(id: any): Promise<any>;
+    /**
+     * @param {Object} body Search body containing either "query" or "controllers"
+     * @param {Object} options
+     */
+    searchRole(body: any, { from, size }?: any): Promise<{
+        hits: any[];
+        total: any;
+    }>;
+    /**
+     * Given a Role object, validates its definition and if OK, persist it to the database.
+     *
+     * @param {Role} role
+     * @param {object} [options] The persistence options
+     * @returns Promise
+     */
+    validateAndSaveRole(role: Role, options?: object): Promise<any>;
+    /**
+     * Given a Role object, checks if its controllers and actions exist.
+     *
+     * @param {Role} role
+     */
+    checkRoleNativeRights(role: Role): void;
+    /**
+     * Given a Role object, checks if its controllers and actions exist in plugins.
+     *
+     * @param {Role} role
+     * @param {Force} force
+     */
+    checkRolePluginsRights(role: Role, { force, forceWarn }?: Force): void;
+    /**
+     * Fetching roles and check for each of them for invalid plugin rights.
+     * If there are some, Kuzzle will log a warning.
+     */
+    sanityCheck(): Promise<void>;
+    /**
+     * Deletes a role
+     *
+     * @param {String} id
+     * @param {object} [options]
+     * @returns Promise
+     */
+    deleteById(id: string, options?: object): Promise<void>;
+    /**
+     * @override
+     */
+    override delete(role: any, { refresh }?: {
+        refresh?: string;
+    }): Promise<void>;
+    /**
+     * From a Role object, returns an object ready to be persisted
+     *
+     * @param {Role} role
+     * @returns {object}
+     */
+    serializeToDatabase(role: Role): object;
+    /**
+     * @override
+     */
+    override truncate(opts: any): Promise<void>;
+    /**
+     * Invalidate the cache entries for the given role. If none is provided,
+     * the entire cache is emptied.
+     * @param {string} [roleId]
+     */
+    invalidate(roleId?: string): void;
+}
+import { ObjectRepository } from "../shared/ObjectRepository";
+import { Role } from "../../model/security/role";