kuzzle 2.17.7 → 2.18.1

package/lib/core/network/protocols/mqttProtocol.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
  *
@@ -22,12 +22,13 @@
 'use strict';
 
 const net = require('net');
+
 const aedes = require('aedes');
 
 const ClientConnection = require('../clientConnection');
 const Protocol = require('./protocol');
 const { Request } = require('../../../api/request');
-const removeErrorStack = require('../removeErrorStack');
+const { removeStacktrace } = require('../../../util/stackTrace');
 const kerror = require('../../../kerror').wrap('network', 'mqtt');
 const debug = require('../../../util/debug')('kuzzle:network:protocols:mqtt');
 
@@ -238,7 +239,7 @@ class MqttProtocol extends Protocol {
       connection,
       error: kerror.getFrom(error, 'unexpected_error', error.message)
     });
-    this._respond(client, removeErrorStack(errReq.response.toJSON()));
+    this._respond(client, removeStacktrace(errReq.response.toJSON()));
   }
 
   _authorizePublish (client, packet, callback) {

package/lib/core/network/protocols/protocol.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/network/router.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
  *
@@ -24,6 +24,7 @@
 const { Request } = require('../../api/request');
 const kerror = require('../../kerror');
 const HttpRouter = require('./httpRouter');
+const { removeStacktrace } = require('../../util/stackTrace');
 
 /**
  * @class Router
@@ -189,7 +190,15 @@ class Router {
         cb(request);
       }
       else {
-        global.kuzzle.funnel.execute(mutatedRequest, (err, result) => cb(result));
+        global.kuzzle.funnel.execute(mutatedRequest, (err, result) => {
+          const _res = result || request;
+
+          if (err && ! _res.error) {
+            _res.setError(err);
+          }
+
+          cb(removeStacktrace(_res));
+        });
       }
     });
   }

package/lib/core/plugin/plugin.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
  *
@@ -300,6 +300,13 @@ class Plugin {
         'Controller definition must be an object');
     }
 
+    if (! isPlainObject(definition.actions)) {
+      throw assertionError.get(
+        'invalid_controller_definition',
+        name,
+        'Controller definition "actions" property must be an object');
+    }
+
     for (const [action, actionDefinition] of Object.entries(definition.actions)) {
       const actionProperties = Object.keys(actionDefinition);
 

package/lib/core/plugin/pluginContext.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/plugin/pluginManifest.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/plugin/pluginRepository.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/plugin/pluginsManager.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/plugin/privilegedContext.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/actionEnum.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/channel.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/connectionRooms.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/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.d.ts

@@ -1,5 +1,5 @@
-import { RealtimeController, Notification, JSONObject, ScopeOption, UserOption, Kuzzle } from 'kuzzle-sdk';
-import { RequestPayload, ResponsePayload } from '../../../types';
+import { RealtimeController, Notification, JSONObject, ScopeOption, UserOption, Kuzzle, RequestPayload } from 'kuzzle-sdk';
+import { ResponsePayload } from '../../../types';
 interface EmbeddedRealtime extends RealtimeController {
     /**
      * Subscribes by providing a set of filters: messages, document changes

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,13 @@
+import { KuzzleEventEmitter, RequestPayload } from 'kuzzle-sdk';
+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;
+    }>;
+}