kuzzle 2.15.2 → 2.16.3

package/lib/api/request/kuzzleRequest.d.ts

@@ -103,6 +103,38 @@ export declare class KuzzleRequest {
         data: JSONObject;
         options: JSONObject;
     };
+    /**
+     * Return a POJO representing the request.
+     *
+     * This can be used to match Koncorde filter rather than the Request object
+     * because it has properties defined with invisible unicode characters.
+     */
+    pojo(): {
+        context: {
+            connection: import("./requestContext").Connection;
+            token: import("../../types").Token;
+            user: User;
+        };
+        deprecations: void | Deprecation[];
+        error: KuzzleError;
+        id: string;
+        input: {
+            action: string;
+            args: JSONObject;
+            body: JSONObject;
+            controller: string;
+            jwt: string;
+            volatile: JSONObject;
+        };
+        internalId: string;
+        response: {
+            headers: JSONObject;
+            raw: boolean;
+        };
+        result: any;
+        status: number;
+        timestamp: number;
+    };
     /**
      * Returns the `lang` param of the request.
      *

package/lib/api/request/kuzzleRequest.js

@@ -277,6 +277,40 @@ class KuzzleRequest {
         Object.assign(serialized.options, this[_context].toJSON());
         return serialized;
     }
+    /**
+     * Return a POJO representing the request.
+     *
+     * This can be used to match Koncorde filter rather than the Request object
+     * because it has properties defined with invisible unicode characters.
+     */
+    pojo() {
+        return {
+            context: {
+                connection: this.context.connection,
+                token: this.context.token,
+                user: this.context.user,
+            },
+            deprecations: this.deprecations,
+            error: this.error,
+            id: this.id,
+            input: {
+                action: this.input.action,
+                args: this.input.args,
+                body: this.input.body,
+                controller: this.input.controller,
+                jwt: this.input.jwt,
+                volatile: this.input.volatile,
+            },
+            internalId: this.internalId,
+            response: {
+                headers: this.response.headers,
+                raw: this.response.raw,
+            },
+            result: this.result,
+            status: this.status,
+            timestamp: this.timestamp,
+        };
+    }
     /**
      * Returns the `lang` param of the request.
      *

package/lib/api/request/requestInput.d.ts

@@ -157,6 +157,8 @@ export declare class RequestInput {
     set body(obj: JSONObject);
     /**
      * Request headers (Http only).
+     *
+     * @deprecated Use RequestContext.connection.misc.headers instead
      */
     get headers(): JSONObject | null;
     set headers(obj: JSONObject);

package/lib/api/request/requestInput.js

@@ -245,6 +245,8 @@ class RequestInput {
     }
     /**
      * Request headers (Http only).
+     *
+     * @deprecated Use RequestContext.connection.misc.headers instead
      */
     get headers() {
         return this[_headers];

package/lib/config/default.config.js

@@ -46,7 +46,7 @@ module.exports = {
        (see https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS)
    */
   http: {
-    routes: require('./httpRoutes'),
+    routes: require('./../api/httpRoutes'),
     accessControlAllowOrigin: '*',
     accessControlAllowOriginUseRegExp: false,
     accessControlAllowMethods: 'GET,POST,PUT,PATCH,DELETE,OPTIONS,HEAD',

package/lib/core/network/router.js

@@ -138,6 +138,39 @@ class Router {
         this._executeFromHttp(route.verb, request, cb);
       });
     }
+
+    /**
+     * Returns inner metrics from the router
+     * @returns {Object}
+     */
+    global.kuzzle.onAsk(
+      'core:network:router:metrics',
+      () => this.metrics());
+  }
+
+  /**
+   * Returns the metrics of the router
+   * @returns {Object}
+   */
+  metrics () {
+    const connectionsByProtocol = {};
+
+    for (const connection of this.connections.values()) {
+      const protocol = connection.connection.protocol.toLowerCase();
+      if (protocol === 'internal') {
+        continue;
+      }
+
+      if (connectionsByProtocol[protocol] === undefined) {
+        connectionsByProtocol[protocol] = 0;
+      }
+
+      connectionsByProtocol[protocol]++;
+    }
+
+    return {
+      connections: connectionsByProtocol,
+    };
   }
 
   /**

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

@@ -118,6 +118,13 @@ export declare class HotelClerk {
      *
      */
     unsubscribe(connectionId: string, roomId: string, notify?: boolean): Promise<void>;
+    /**
+     * Returns inner metrics from the HotelClerk
+     */
+    metrics(): {
+        rooms: number;
+        subscriptions: number;
+    };
     /**
      * Deletes a room if no user has subscribed to it, and removes it also from the
      * real-time engine

package/lib/core/realtime/hotelClerk.js

@@ -136,6 +136,11 @@ class HotelClerk {
         global.kuzzle.onAsk('core:realtime:unsubscribe', (connectionId, roomId, notify) => {
             return this.unsubscribe(connectionId, roomId, notify);
         });
+        /**
+         * Returns inner metrics from the HotelClerk
+         * @return {{rooms: number, subscriptions: number}}
+         */
+        global.kuzzle.onAsk('core:realtime:hotelClerk:metrics', () => this.metrics());
         /**
          * Clear the hotel clerk and properly disconnect connections.
          */
@@ -410,6 +415,15 @@ class HotelClerk {
             subscription,
         });
     }
+    /**
+     * Returns inner metrics from the HotelClerk
+     */
+    metrics() {
+        return {
+            rooms: this.roomsCount,
+            subscriptions: this.subscriptions.size,
+        };
+    }
     /**
      * Deletes a room if no user has subscribed to it, and removes it also from the
      * real-time engine

package/lib/util/readYamlFile.d.ts

@@ -0,0 +1,2 @@
+import { JSONObject } from '../../index';
+export declare function readYamlFile(path: string): JSONObject;

package/lib/util/readYamlFile.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readYamlFile = void 0;
+const fs_1 = require("fs");
+const js_yaml_1 = require("js-yaml");
+function readYamlFile(path) {
+    return (0, js_yaml_1.load)((0, fs_1.readFileSync)(path, 'utf-8'));
+}
+exports.readYamlFile = readYamlFile;
+//# sourceMappingURL=readYamlFile.js.map