kuzzle 2.17.5 → 2.17.8

package/lib/core/realtime/hotelClerk.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *
@@ -218,20 +218,37 @@ class HotelClerk {
             throw kerror.get('api', 'assert', 'koncorde_dsl_error', e.message);
         }
         this.createRoom(normalized);
-        const { channel, subscribed } = await this.subscribeToRoom(normalized.id, request);
-        if (subscribed) {
-            global.kuzzle.emit('core:realtime:subscribe:after', normalized.id);
-            // @deprecated -- to be removed in next major version
-            // we have to recreate the old "diff" object
-            await global.kuzzle.pipe('core:hotelClerk:addSubscription', {
-                changed: subscribed,
-                collection,
-                connectionId: request.context.connection.id,
-                filters: normalized.filter,
-                index,
-                roomId: normalized.id,
-            });
-        }
+        /**
+         * You might wonder why in the world is there a callback here.
+         * The fact is that to prevent the event loop from switching to another function
+         * we need to keep descending the execution stack without returning in a function that has been awaited
+         * otherwise once we return to the await keyword the event loop will switch to another function.
+         *
+         * Everything needs to be atomic (multiple operation done without interruption) otherwise we might
+         * run into some issues where the room is created but another request has deleted it before we can
+         * subscribe to it.
+         * All because the subscription was not atomic.
+         *
+         * So to keep the context of execution we use a lambda that we give to the subscribeToRoom function
+         * and we execute it right after the subscription this way we keep descending the execution stack without returning and
+         * without switching context.
+         */
+        const afterSubscribeCallback = async (subscribed) => {
+            if (subscribed) {
+                global.kuzzle.call('core:realtime:subscribe:after', normalized.id);
+                // @deprecated -- to be removed in next major version
+                // we have to recreate the old "diff" object
+                await global.kuzzle.pipe('core:hotelClerk:addSubscription', {
+                    changed: subscribed,
+                    collection,
+                    connectionId: request.context.connection.id,
+                    filters: normalized.filter,
+                    index,
+                    roomId: normalized.id,
+                });
+            }
+        };
+        const { channel } = await this.subscribeToRoom(normalized.id, request, afterSubscribeCallback);
         const subscription = new subscription_1.Subscription(index, collection, request.input.body, normalized.id, request.context.connection.id, request.context.user);
         global.kuzzle.emit('core:realtime:user:subscribe:after', subscription);
         return {
@@ -260,10 +277,27 @@ class HotelClerk {
             }
             this.createRoom(normalized);
         }
-        const { channel, cluster, subscribed } = await this.subscribeToRoom(roomId, request);
-        if (cluster && subscribed) {
-            global.kuzzle.emit('core:realtime:subscribe:after', roomId);
-        }
+        /**
+         * You might wonder why in the world is there a callback here.
+         * The fact is that to prevent the event loop from switching to another function
+         * we need to keep descending the execution stack without returning in a function that has been awaited
+         * otherwise once we return to the await keyword the event loop will switch to another function.
+         *
+         * Everything needs to be atomic (multiple operation done without interruption) otherwise we might
+         * run into some issues where the room is created but another request has deleted it before we can
+         * subscribe to it.
+         * All because the subscription was not atomic.
+         *
+         * So to keep the context of execution we use a lambda that we give to the subscribeToRoom function
+         * and we execute it right after the subscription this way we keep descending the execution stack without returning and
+         * without switching context.
+         */
+        const afterSubscribeCallback = async (subscribed, cluster) => {
+            if (cluster && subscribed) {
+                global.kuzzle.call('core:realtime:subscribe:after', roomId);
+            }
+        };
+        const { channel } = await this.subscribeToRoom(roomId, request, afterSubscribeCallback);
         return {
             channel,
             roomId,
@@ -347,7 +381,7 @@ class HotelClerk {
             throw realtimeError.get('too_many_rooms');
         }
         this.koncorde.store(normalized);
-        global.kuzzle.emit('core:realtime:room:create:after', normalized);
+        global.kuzzle.call('core:realtime:room:create:after', normalized);
         // @deprecated -- to be removed in the next major version of kuzzle
         global.kuzzle.emit('room:new', { collection, index, roomId });
         /*
@@ -395,8 +429,14 @@ class HotelClerk {
             global.kuzzle.entryPoint.leaveChannel(channel, connectionId);
         }
         room.removeConnection(connectionId);
+        // Used to know whether the room has been deleted or not during the unsubscription
+        // We need to store this information for later since we cannot checks if the room exists or has more than 0 subscriber
+        // later because the room might have been recreated by the time we need to send the notification
+        // all because of the `await this.removeRoom(roomId)`.
+        let roomDeleted = false;
         if (room.size === 0) {
             await this.removeRoom(roomId);
+            roomDeleted = true;
         }
         // even if the room is deleted for this node, another one may need the
         // notification
@@ -407,13 +447,13 @@ class HotelClerk {
             index: room.index,
             volatile,
         }, requestContext);
-        await this.module.notifier.notifyUser(roomId, request, 'out', { count: room.size });
         // Do not send an unsubscription notification if the room has been destroyed
         // because the other nodes already had destroyed it in the full state
         if (notify
             && this.rooms.has(roomId)
-            && room.channels.size > 0) {
-            await global.kuzzle.pipe('core:realtime:unsubscribe:after', roomId);
+            && room.channels.size > 0
+            && !roomDeleted) {
+            global.kuzzle.call('core:realtime:unsubscribe:after', roomId);
             // @deprecated -- to be removed in next major version
             await global.kuzzle.pipe('core:hotelClerk:removeRoomForCustomer', {
                 requestContext,
@@ -424,6 +464,7 @@ class HotelClerk {
                 },
             });
         }
+        await this.module.notifier.notifyUser(roomId, request, 'out', { count: room.size });
         const kuid = global.kuzzle.tokenManager.getKuidFromConnection(connectionId);
         const subscription = new subscription_1.Subscription(room.index, room.collection, undefined, roomId, connectionId, { _id: kuid });
         global.kuzzle.emit('core:realtime:user:unsubscribe:after', {
@@ -474,7 +515,7 @@ class HotelClerk {
      * on the room if it does not already exists.
      *
      */
-    async subscribeToRoom(roomId, request) {
+    async subscribeToRoom(roomId, request, afterSubscribeCallback) {
         let subscribed = false;
         let notifyPromise;
         const { scope, users, propagate } = request.input.args;
@@ -492,6 +533,7 @@ class HotelClerk {
         }
         global.kuzzle.entryPoint.joinChannel(channel.name, connectionId);
         room.createChannel(channel);
+        await afterSubscribeCallback(subscribed, channel.cluster);
         await notifyPromise;
         return {
             channel: channel.name,

package/lib/core/realtime/index.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/realtime/notification/document.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/realtime/notification/index.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/realtime/notification/server.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/realtime/notification/user.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/realtime/notifier.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/realtime/room.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/realtime/subscription.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/security/index.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/security/profileRepository.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/security/roleRepository.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/security/securityLoader.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/security/tokenRepository.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/security/userRepository.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/shared/KoncordeWrapper.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/shared/abstractManifest.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/shared/repository.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/shared/sdk/embeddedSdk.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *
@@ -48,7 +48,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.EmbeddedSDK = void 0;
 const kuzzle_sdk_1 = require("kuzzle-sdk");
-const funnelProtocol_1 = __importDefault(require("./funnelProtocol"));
+const funnelProtocol_1 = require("./funnelProtocol");
 const safeObject_1 = require("../../../util/safeObject");
 const kerror = __importStar(require("../../../kerror"));
 const impersonatedSdk_1 = __importDefault(require("./impersonatedSdk"));
@@ -58,7 +58,8 @@ const contextError = kerror.wrap('plugin', 'context');
  */
 class EmbeddedSDK extends kuzzle_sdk_1.Kuzzle {
     constructor() {
-        super(new funnelProtocol_1.default(), { autoResubscribe: false });
+        // FunnelProtocol is not technically a valid SDK protocol
+        super(new funnelProtocol_1.FunnelProtocol(), { autoResubscribe: false });
     }
     /**
      * Returns a new SDK impersonated with the provided user.

package/lib/core/shared/sdk/funnelProtocol.d.ts

@@ -0,0 +1,14 @@
+import { KuzzleEventEmitter } from 'kuzzle-sdk';
+import { RequestPayload } from '../../../types';
+export declare class FunnelProtocol extends KuzzleEventEmitter {
+    private id;
+    private connectionId;
+    constructor();
+    isReady(): boolean;
+    /**
+     *  Hydrate the user and execute SDK query
+     */
+    query(request: RequestPayload): Promise<{
+        result: any;
+    }>;
+}

package/lib/core/shared/sdk/funnelProtocol.js

@@ -1,8 +1,9 @@
+"use strict";
 /*
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *
@@ -18,88 +19,82 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-'use strict';
-
-const { KuzzleEventEmitter } = require('kuzzle-sdk');
-
-const { Request } = require('../../../api/request');
-const kerror = require('../../../kerror');
-const { hilightUserCode } = require('../../../util/stackTrace');
-
-class FunnelProtocol extends KuzzleEventEmitter {
-  constructor () {
-    super();
-
-    this.id = 'funnel';
-    this.connectionId = null;
-
-    /**
-     * Realtime notifications are sent by the InternalProtocol
-     * through the internal event system.
-     */
-    global.kuzzle.on('core:network:internal:message', message => {
-      // Send the notifications to the SDK for the internal Room mechanism
-      this.emit(message.room, message);
-    });
-  }
-
-  isReady () {
-    return true;
-  }
-
-  /**
-   *  Hydrate the user and execute SDK query
-   */
-  async query (request) {
-    if (! this.connectionId) {
-      this.connectionId = await global.kuzzle.ask('core:network:internal:connectionId:get');
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
     }
-
-    const requestOptions = {
-      connection: {
-        id: this.connectionId,
-        protocol: this.id
-      },
-      user: null,
-    };
-
-    // Validate and use the provided request.kuid
-    if (request.__kuid__) {
-      if (typeof request.__kuid__ !== 'string') {
-        throw kerror.get('plugin', 'context', 'invalid_user');
-      }
-      // Get the user and store it in this context to prevent any possible race conditions
-      requestOptions.user = await global.kuzzle.ask('core:security:user:get', request.__kuid__);
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FunnelProtocol = void 0;
+const kuzzle_sdk_1 = require("kuzzle-sdk");
+const request_1 = require("../../../api/request");
+const kerror = __importStar(require("../../../kerror"));
+class FunnelProtocol extends kuzzle_sdk_1.KuzzleEventEmitter {
+    constructor() {
+        super();
+        this.id = 'funnel';
+        this.connectionId = null;
+        /**
+         * Realtime notifications are sent by the InternalProtocol
+         * through the internal event system.
+         */
+        global.kuzzle.on('core:network:internal:message', message => {
+            // Send the notifications to the SDK for the internal Room mechanism
+            this.emit(message.room, message);
+        });
     }
-
-    const kuzzleRequest = new Request(request, requestOptions);
-
-    try {
-      if (requestOptions.user && request.__checkRights__
-        && ! await requestOptions.user.isActionAllowed(kuzzleRequest)
-      ) {
-        throw kerror.get(
-          'security',
-          'rights',
-          'forbidden',
-          kuzzleRequest.input.controller,
-          kuzzleRequest.input.action,
-          requestOptions.user._id);
-      }
-
-      const result = await global.kuzzle.funnel.executePluginRequest(kuzzleRequest);
-
-      return { result };
+    isReady() {
+        return true;
     }
-    catch (error) {
-      if (error.stack) {
-        error.stack = error.stack.split('\n').map(hilightUserCode).join('\n');
-      }
-
-      throw error;
+    /**
+     *  Hydrate the user and execute SDK query
+     */
+    async query(request) {
+        if (!this.connectionId) {
+            this.connectionId = await global.kuzzle.ask('core:network:internal:connectionId:get');
+        }
+        const requestOptions = {
+            connection: {
+                id: this.connectionId,
+                protocol: this.id
+            },
+            user: null,
+        };
+        // Validate and use the provided request.kuid
+        if (request.__kuid__) {
+            if (typeof request.__kuid__ !== 'string') {
+                throw kerror.get('plugin', 'context', 'invalid_user');
+            }
+            // Get the user and store it in this context to prevent any possible race conditions
+            requestOptions.user = await global.kuzzle.ask('core:security:user:get', request.__kuid__);
+        }
+        const kuzzleRequest = new request_1.Request(request, requestOptions);
+        if (requestOptions.user
+            && request.__checkRights__
+            && !await requestOptions.user.isActionAllowed(kuzzleRequest)) {
+            throw kerror.get('security', 'rights', 'forbidden', kuzzleRequest.input.controller, kuzzleRequest.input.action, requestOptions.user._id);
+        }
+        const result = await global.kuzzle.funnel.executePluginRequest(kuzzleRequest);
+        return { result };
     }
-  }
 }
-
-module.exports = FunnelProtocol;
+exports.FunnelProtocol = FunnelProtocol;
+//# sourceMappingURL=funnelProtocol.js.map

package/lib/core/shared/sdk/impersonatedSdk.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/shared/store.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/statistics/index.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/statistics/statistics.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/storage/clientAdapter.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *
@@ -499,7 +499,7 @@ class ClientAdapter {
      */
     global.kuzzle.onAsk(
       `core:storage:${this.scope}:document:import`,
-      fixtures => this.loadFixtures(fixtures));
+      (fixtures, options) => this.loadFixtures(fixtures, options));
 
     /**
      * Create multiple documents
@@ -690,7 +690,7 @@ class ClientAdapter {
             this.cache.assertCollectionExists(target.index, collection);
           }
         }
-        
+
         return this.client.search({ searchBody, targets }, opts);
       });
 
@@ -861,7 +861,7 @@ class ClientAdapter {
    * @param {String} fixturesId
    * @returns {Promise}
    */
-  async loadFixtures (fixtures = {}) {
+  async loadFixtures (fixtures = {}, { refresh = 'wait_for' } = { }) {
     if (! isPlainObject(fixtures)) {
       throw kerror.get('api', 'assert', 'invalid_argument', fixtures, 'object');
     }
@@ -878,7 +878,7 @@ class ClientAdapter {
           index,
           collection,
           payload,
-          { refresh: 'wait_for' });
+          { refresh });
 
         if (errors.length > 0) {
           throw servicesError.get('import_failed', errors);

package/lib/core/storage/indexCache.js

@@ -3,7 +3,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *

package/lib/core/storage/storageEngine.js

@@ -2,7 +2,7 @@
  * Kuzzle, a backend software, self-hostable and ready to use
  * to power modern apps
  *
- * Copyright 2015-2020 Kuzzle
+ * Copyright 2015-2022 Kuzzle
  * mailto: support AT kuzzle.io
  * website: http://kuzzle.io
  *