kuzzle 2.14.10 → 2.14.14

package/lib/core/realtime/index.js

@@ -22,7 +22,7 @@
 'use strict';
 
 const Notifier = require('./notifier');
-const HotelClerk = require('./hotelClerk');
+const { HotelClerk } = require('./hotelClerk');
 
 class RealtimeModule {
   constructor () {

package/lib/core/realtime/notifier.js

@@ -185,14 +185,14 @@ class NotifierController {
    * @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.removeUser(connectionId);
+
+    await this.module.hotelClerk.removeConnection(connectionId);
   }
 
   /**
@@ -426,10 +426,10 @@ class NotifierController {
         continue;
       }
 
-      for (const [channelId, channel] of Object.entries(hotelClerkRoom.channels)) {
+      for (const [channelId, channel] of hotelClerkRoom.channels.entries()) {
+        const executeOnNode = fromCluster ? channel.cluster : true;
         const matchScope = channel.scope === 'all'
           || channel.scope === notification.scope;
-        const executeOnNode = fromCluster ? channel.cluster : true;
 
         if (matchScope && executeOnNode) {
           channels.push(channelId);
@@ -459,7 +459,7 @@ class NotifierController {
     const hotelClerkRoom = this.module.hotelClerk.rooms.get(room);
 
     if (hotelClerkRoom !== undefined) {
-      for (const [id, channel] of Object.entries(hotelClerkRoom.channels)) {
+      for (const [id, channel] of hotelClerkRoom.channels.entries()) {
         const match = channel.users === 'all'
           || channel.users === notification.user;
         const executeOnNode = fromCluster ? channel.cluster : true;

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

@@ -0,0 +1,66 @@
+import { Channel } from './channel';
+/**
+ * A room represents a subscription scope made on a combination of:
+ *  - index
+ *  - collection
+ *  - filters
+ *
+ * A room may contain differents channels that describe which notifications should
+ * be sent. (e.g. only document leaving the scope, users joining the room)
+ *
+ * The rooms also contains the list of connections who subscribed to it.
+ *
+ * @property id
+ * @property index
+ * @property collection
+ * @property connections
+ * @property channels
+ */
+export declare class Room {
+    /**
+     * Room unique identifier.
+     *
+     * Koncorde hash for the desired scope (index + collection + filters)
+     */
+    id: string;
+    index: string;
+    collection: string;
+    /**
+     * List of connections subscribing to this room.
+     */
+    private connections;
+    /**
+     * Map of channels configuration for this room.
+     *
+     * Map<channel, Channel>
+     *
+     * @example
+     *
+     * channels: {
+     *   '<channel>': {
+     *
+     *     // request scope filter, default: 'all'
+     *     scope: 'all|in|out|none',
+     *
+     *     // filter users notifications, default: 'none'
+     *     users: 'all|in|out|none',
+     *
+     *     // should propagate notification to the cluster
+     *     // (used for plugin subscriptions)
+     *     cluster: true|false
+     *   }
+     * },
+     */
+    channels: Map<string, Channel>;
+    constructor(id: string, index: string, collection: string, channels?: Map<string, Channel>, connections?: Set<string>);
+    /**
+     * Number of connections subscribing to the room
+     */
+    get size(): number;
+    /**
+     * Creates a new configuration channel on the room if it doesn't already exists
+     */
+    createChannel(channel: Channel): void;
+    addConnection(connectionId: string): void;
+    removeConnection(connectionId: string): void;
+}

package/lib/core/realtime/room.js

@@ -0,0 +1,103 @@
+"use strict";
+/*
+ * Kuzzle, a backend software, self-hostable and ready to use
+ * to power modern apps
+ *
+ * Copyright 2015-2020 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Room = void 0;
+/**
+ * A room represents a subscription scope made on a combination of:
+ *  - index
+ *  - collection
+ *  - filters
+ *
+ * A room may contain differents channels that describe which notifications should
+ * be sent. (e.g. only document leaving the scope, users joining the room)
+ *
+ * The rooms also contains the list of connections who subscribed to it.
+ *
+ * @property id
+ * @property index
+ * @property collection
+ * @property connections
+ * @property channels
+ */
+class Room {
+    constructor(id, index, collection, channels, connections) {
+        /**
+         * List of connections subscribing to this room.
+         */
+        this.connections = new Set();
+        /**
+         * Map of channels configuration for this room.
+         *
+         * Map<channel, Channel>
+         *
+         * @example
+         *
+         * channels: {
+         *   '<channel>': {
+         *
+         *     // request scope filter, default: 'all'
+         *     scope: 'all|in|out|none',
+         *
+         *     // filter users notifications, default: 'none'
+         *     users: 'all|in|out|none',
+         *
+         *     // should propagate notification to the cluster
+         *     // (used for plugin subscriptions)
+         *     cluster: true|false
+         *   }
+         * },
+         */
+        this.channels = new Map();
+        this.id = id;
+        this.index = index;
+        this.collection = collection;
+        if (channels) {
+            this.channels = channels;
+        }
+        if (connections) {
+            this.connections = connections;
+        }
+    }
+    /**
+     * Number of connections subscribing to the room
+     */
+    get size() {
+        return this.connections.size;
+    }
+    /**
+     * Creates a new configuration channel on the room if it doesn't already exists
+     */
+    createChannel(channel) {
+        if (this.channels.has(channel.name)) {
+            return;
+        }
+        this.channels.set(channel.name, channel);
+    }
+    addConnection(connectionId) {
+        this.connections.add(connectionId);
+    }
+    removeConnection(connectionId) {
+        this.connections.delete(connectionId);
+    }
+}
+exports.Room = Room;
+//# sourceMappingURL=room.js.map

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

@@ -0,0 +1,25 @@
+import { JSONObject } from 'kuzzle-sdk';
+/**
+ * Represents a realtime subscription of a connection to a room.
+ *
+ * This object is used in the Internal Event System to give informations about
+ * added/removed subscriptions.
+ *
+ * @property connectionId
+ * @property roomId
+ * @property index
+ * @property collection
+ * @property filters
+ * @property kuid
+ */
+export declare class Subscription {
+    connectionId: string;
+    roomId: string;
+    index: string;
+    collection: string;
+    filters: JSONObject;
+    kuid: string;
+    constructor(index: string, collection: string, filters: JSONObject, roomId: string, connectionId: string, user: {
+        _id: string;
+    });
+}

package/lib/core/realtime/subscription.js

@@ -0,0 +1,48 @@
+"use strict";
+/*
+ * Kuzzle, a backend software, self-hostable and ready to use
+ * to power modern apps
+ *
+ * Copyright 2015-2020 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Subscription = void 0;
+/**
+ * Represents a realtime subscription of a connection to a room.
+ *
+ * This object is used in the Internal Event System to give informations about
+ * added/removed subscriptions.
+ *
+ * @property connectionId
+ * @property roomId
+ * @property index
+ * @property collection
+ * @property filters
+ * @property kuid
+ */
+class Subscription {
+    constructor(index, collection, filters, roomId, connectionId, user) {
+        this.connectionId = connectionId;
+        this.roomId = roomId;
+        this.index = index;
+        this.collection = collection;
+        this.filters = filters;
+        this.kuid = user && user._id || null;
+    }
+}
+exports.Subscription = Subscription;
+//# sourceMappingURL=subscription.js.map

package/lib/core/statistics/statistics.js

@@ -21,19 +21,21 @@
 
 'use strict';
 
-const kerror = require('../../kerror').wrap('api', 'assert');
+const errorApiAssert = require('../../kerror').wrap('api', 'assert');
+const errorStats = require('../../kerror').wrap('services', 'stats');
 
 /**
  * @class Statistics
  * @param {Kuzzle} kuzzle
  */
 class Statistics {
-  constructor() {
+  constructor () {
     // uses '{' and '}' to force all statistics frames to be stored on 1 redis
     // node
     // (see https://redis.io/topics/cluster-spec#keys-distribution-model)
     this.cacheKeyPrefix = '{stats/}';
 
+    this.enabled = global.kuzzle.config.stats.enabled;
     this.ttl = global.kuzzle.config.stats.ttl * 1000;
     this.interval = global.kuzzle.config.stats.statsInterval * 1000;
     this.lastFrame = null;
@@ -53,6 +55,10 @@ class Statistics {
    * @param {Request} request
    */
   startRequest (request) {
+    if (! this.enabled) {
+      return;
+    }
+
     const protocol = request && request.context.connection.protocol;
 
     if (!protocol) {
@@ -75,6 +81,10 @@ class Statistics {
    * @param {Request} request
    */
   completedRequest (request) {
+    if (! this.enabled) {
+      return;
+    }
+
     const protocol = request && request.context.connection.protocol;
 
     if (!protocol) {
@@ -101,6 +111,10 @@ class Statistics {
    * @param {Request} request
    */
   failedRequest (request) {
+    if (! this.enabled) {
+      return;
+    }
+
     const protocol = request && request.context.connection.protocol;
 
     if (!protocol) {
@@ -127,6 +141,10 @@ class Statistics {
    * @param {RequestContext} requestContext
    */
   newConnection (requestContext) {
+    if (! this.enabled) {
+      return;
+    }
+
     if (!requestContext.connection.protocol) {
       return;
     }
@@ -147,6 +165,10 @@ class Statistics {
    * @param {RequestContext} requestContext
    */
   dropConnection (requestContext) {
+    if (! this.enabled) {
+      return;
+    }
+
     if (!requestContext.connection.protocol) {
       return;
     }
@@ -166,7 +188,11 @@ class Statistics {
    *
    * @returns {Promise}
    */
-  async getLastStats() {
+  async getLastStats () {
+    if (! this.enabled) {
+      throw errorStats.get('not_available');
+    }
+
     const frame = Object.assign(
       {timestamp: (new Date()).getTime()},
       this.currentStats);
@@ -189,6 +215,10 @@ class Statistics {
    * @returns {Promise<Object>}
    */
   async getStats (request) {
+    if (! this.enabled) {
+      throw errorStats.get('not_available');
+    }
+
     const response = {
       hits: [],
       total: null
@@ -211,11 +241,11 @@ class Statistics {
     }
 
     if (startTime !== undefined && isNaN(startTime)) {
-      throw kerror.get('invalid_argument', 'startTime', 'number');
+      throw errorApiAssert.get('invalid_argument', 'startTime', 'number');
     }
 
     if (stopTime !== undefined && isNaN(stopTime)) {
-      throw kerror.get('invalid_argument', 'stopTime', 'number');
+      throw errorApiAssert.get('invalid_argument', 'stopTime', 'number');
     }
 
     if (startTime !== undefined && startTime >= currentDate) {
@@ -286,6 +316,10 @@ class Statistics {
    * Init statistics component
    */
   init () {
+    if (! this.enabled) {
+      return;
+    }
+
     this.timer = setInterval(async () => {
       try {
         await this.writeStats();
@@ -301,6 +335,10 @@ class Statistics {
   }
 
   async writeStats () {
+    if (! this.enabled) {
+      return;
+    }
+
     const stats = JSON.stringify(this.currentStats);
 
     this.lastFrame = Date.now();

package/lib/kerror/codes/1-services.json

@@ -306,6 +306,17 @@
           "class": "InternalError"
         }
       }
+    },
+    "statistics": {
+      "code": 4,
+      "errors": {
+        "not_available": {
+          "description": "The statistics module is not enabled. See \"config.stats.enabled\".",
+          "code": 1,
+          "message": "Statistics module is not available.",
+          "class": "InternalError"
+        }
+      }
     }
   }
 }

package/lib/kerror/codes/2-api.json

@@ -124,7 +124,7 @@
           "class": "NotFoundError"
         },
         "incompatible_sdk_version": {
-          "description": "SDK is incompatible with the current Kuzzle version",
+          "description": "SDK is incompatible with the current Kuzzle version. You can set \"config.server.strictSdkVersion\" to false to disable this safety check at your own risk.",
           "code": 6,
           "message": "Incompatible SDK client. Your SDK version (%s) does not match Kuzzle requirement (%s).",
           "class": "BadRequestError"

package/lib/kuzzle/kuzzle.js

@@ -169,11 +169,11 @@ class Kuzzle extends kuzzleEventEmitter_1.default {
     async shutdown() {
         this._state = kuzzleStateEnum_1.default.SHUTTING_DOWN;
         this.log.info('Initiating shutdown...');
+        // Ask the network layer to stop accepting new request
+        this.entryPoint.dispatch('shutdown');
         await this.pipe('kuzzle:shutdown');
         // @deprecated
         this.emit('core:shutdown');
-        // Ask the network layer to stop accepting new request
-        this.entryPoint.dispatch('shutdown');
         while (this.funnel.remainingRequests !== 0) {
             this.log.info(`[shutdown] Waiting: ${this.funnel.remainingRequests} remaining requests`);
             await bluebird_1.default.delay(1000);

package/lib/types/KuzzleDocument.d.ts

@@ -0,0 +1,5 @@
+import { JSONObject } from 'kuzzle-sdk';
+export interface KuzzleDocument {
+    _id: string;
+    _source: JSONObject;
+}

package/lib/types/KuzzleDocument.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=KuzzleDocument.js.map

package/lib/types/index.d.ts

@@ -8,3 +8,7 @@ export * from './EventHandler';
 export * from './User';
 export * from './Token';
 export * from './Global';
+export * from './realtime/RealtimeScope';
+export * from './realtime/RealtimeUsers';
+export * from './realtime/RoomList';
+export * from './KuzzleDocument';

package/lib/types/index.js

@@ -40,4 +40,8 @@ __exportStar(require("./EventHandler"), exports);
 __exportStar(require("./User"), exports);
 __exportStar(require("./Token"), exports);
 __exportStar(require("./Global"), exports);
+__exportStar(require("./realtime/RealtimeScope"), exports);
+__exportStar(require("./realtime/RealtimeUsers"), exports);
+__exportStar(require("./realtime/RoomList"), exports);
+__exportStar(require("./KuzzleDocument"), exports);
 //# sourceMappingURL=index.js.map

package/lib/types/realtime/RealtimeScope.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Subscribe to notification of document entering, leaving the scope or both.
+ */
+export declare type RealtimeScope = 'in' | 'out' | 'all';

package/lib/types/realtime/RealtimeScope.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=RealtimeScope.js.map

package/lib/types/realtime/RealtimeUsers.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Subscribe to users entering or leaving the room
+ */
+export declare type RealtimeUsers = 'in' | 'out' | 'all' | 'none';

package/lib/types/realtime/RealtimeUsers.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=RealtimeUsers.js.map

package/lib/types/realtime/RoomList.d.ts

@@ -0,0 +1,20 @@
+/**
+ * List of realtime rooms and the number of connections subscribing
+ *
+ * @example
+ * {
+ *   <index>: {
+ *     <collection>: {
+ *       <roomId>: <number of connections>
+ *     }
+ *   }
+ * }
+ *
+ */
+export declare type RoomList = {
+    [index: string]: {
+        [collection: string]: {
+            [roomId: string]: number;
+        };
+    };
+};

package/lib/types/realtime/RoomList.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=RoomList.js.map