kuzzle 2.57.0-beta.2 → 2.57.0-beta.3

package/dist/lib/core/network/accessLogger.d.ts

@@ -8,6 +8,7 @@ import type ClientConnection from "./clientConnection";
 export interface AccessLogExtra {
     method: string;
     url: string;
+    connection?: ClientConnection;
 }
 declare class AccessLogger {
     isActive: boolean;

package/dist/lib/core/network/accessLogger.js

@@ -51,6 +51,7 @@ exports.AccessLoggerWorker = exports.AccessLogger = void 0;
 // efficient CPU resources management, and more performances in the end
 const node_worker_threads_1 = require("node:worker_threads");
 const node_assert_1 = __importDefault(require("node:assert"));
+const lodash_1 = require("lodash");
 const moment_1 = __importDefault(require("moment"));
 const pino = __importStar(require("pino"));
 const request_1 = require("../../api/request");
@@ -207,10 +208,14 @@ class AccessLoggerWorker {
     logAccess(connection, request, size, extra = null) {
         if (this.config.logs.accessLogFormat === "logstash") {
             // custom kuzzle logs to be exported to logstash
+            // The request headers are logged once, under `extra.headers`, where
+            // v2.56.0 already logged them (its connections had no headers): the
+            // same values under `connection` and `extra.connection` only tripled
+            // the size of every entry.
             this.logger.info({
-                connection,
+                connection: (0, lodash_1.omit)(connection, "headers"),
                 error: request.error,
-                extra,
+                extra: withoutConnectionHeaders(extra),
                 namespace: "kuzzle:accessLogs",
                 nodeId: global.kuzzle.id,
                 request: request.input,
@@ -271,6 +276,12 @@ class AccessLoggerWorker {
     }
 }
 exports.AccessLoggerWorker = AccessLoggerWorker;
+function withoutConnectionHeaders(extra) {
+    if (!extra?.connection) {
+        return extra;
+    }
+    return { ...extra, connection: (0, lodash_1.omit)(extra.connection, "headers") };
+}
 /**
  * For protocols other than http, we rebuild a pseudo url out of the request's
  * controller, action and arguments.

package/dist/lib/model/storage/apiKey.d.ts

@@ -57,6 +57,14 @@ declare class ApiKey extends BaseModel {
      * @param fingerprint - API key fingerprint
      */
     static loadByFingerprint(userId: string, fingerprint: string): Promise<ApiKey>;
+    /**
+     * Finds a user's API key by comparing the fingerprint stored in each of
+     * their keys, for collections where `fingerprint` is not indexed.
+     *
+     * @param userId - User ID
+     * @param fingerprint - API key fingerprint
+     */
+    static scanByFingerprint(userId: string, fingerprint: string): Promise<ApiKey | null>;
     /**
      * Loads a user's API key from a request, identified by its `_id`, its
      * clear-text `key` or its `fingerprint` (in that order of precedence).

package/dist/lib/model/storage/apiKey.js

@@ -156,6 +156,14 @@ class ApiKey extends baseModel_1.default {
             },
         }, { size: 1 });
         if (!apiKey) {
+            // An install upgraded from a version without the `fingerprint` mapping
+            // keeps its old one (existing internal collections are never
+            // re-mapped), so the term query above finds nothing there — for any key.
+            // Every key stores its fingerprint in `_source`, so scan the user's keys.
+            const scanned = await this.scanByFingerprint(userId, fingerprint);
+            if (scanned) {
+                return scanned;
+            }
             throw kerror.get("services", "storage", "not_found", fingerprint, {
                 message: `ApiKey with fingerprint "${fingerprint}" not found for user "${userId}".`,
             });
@@ -163,6 +171,23 @@ class ApiKey extends baseModel_1.default {
         // @ts-expect-error We fetch from the api key collection so this is safe
         return apiKey;
     }
+    /**
+     * Finds a user's API key by comparing the fingerprint stored in each of
+     * their keys, for collections where `fingerprint` is not indexed.
+     *
+     * @param userId - User ID
+     * @param fingerprint - API key fingerprint
+     */
+    static async scanByFingerprint(userId, fingerprint) {
+        let foundId = null;
+        await this.batchExecute({ term: { userId } }, (hits) => {
+            const hit = hits.find((document) => document._source.fingerprint === fingerprint);
+            if (hit && !foundId) {
+                foundId = hit._id;
+            }
+        });
+        return foundId ? this.load(userId, foundId) : null;
+    }
     /**
      * Loads a user's API key from a request, identified by its `_id`, its
      * clear-text `key` or its `fingerprint` (in that order of precedence).

package/dist/lib/model/storage/baseModel.d.ts

@@ -92,7 +92,7 @@ declare class BaseModel {
     static truncate({ refresh, }?: {
         refresh?: boolean | string;
     }): Promise<void>;
-    static batchExecute(query: JSONObject, callback: (...args: unknown[]) => unknown): Promise<any>;
+    static batchExecute(query: JSONObject, callback: (hits: StorageDocument[]) => unknown): Promise<any>;
     /**
      * Must be overriden by children
      */

package/dist/lib/model/storage/baseModel.js

@@ -166,7 +166,6 @@ class BaseModel {
     static truncate({ refresh, } = {}) {
         return this.deleteByQuery({ match_all: {} }, { refresh });
     }
-    // ? This looks not in use anymore ?
     static batchExecute(query, callback) {
         return global.kuzzle.internalIndex.mExecute(this.collection, query, callback);
     }

package/dist/package.json

@@ -1,7 +1,7 @@
 {
     "name": "kuzzle",
     "author": "The Kuzzle Team <support@kuzzle.io>",
-    "version": "2.57.0-beta.2",
+    "version": "2.57.0-beta.3",
     "description": "Kuzzle is an open-source solution that handles all the data management through a secured API, with a large choice of protocols.",
     "scripts": {
         "build": "rm -Rf ./dist && tsc && node -r ts-node/register/transpile-only ./bin/copy-binaries.ts",
@@ -32,6 +32,8 @@
         "lib": "lib"
     },
     "dependencies": {
+        "@types/bluebird": "3.5.42",
+        "@types/passport": "1.0.17",
         "aedes": "0.51.3",
         "bluebird": "3.7.2",
         "cli-color": "2.0.4",
@@ -83,10 +85,8 @@
     "devDependencies": {
         "@cucumber/cucumber": "12.5.0",
         "@types/async": "^3.2.24",
-        "@types/bluebird": "3.5.42",
         "@types/cookie": "1.0.0",
         "@types/lodash": "4.17.21",
-        "@types/passport": "1.0.17",
         "@types/validator": "^13.15.10",
         "@types/yargs": "17.0.35",
         "@vitest/coverage-v8": "4.0.16",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "kuzzle",
   "author": "The Kuzzle Team <support@kuzzle.io>",
-  "version": "2.57.0-beta.2",
+  "version": "2.57.0-beta.3",
   "description": "Kuzzle is an open-source solution that handles all the data management through a secured API, with a large choice of protocols.",
   "scripts": {
     "build": "rm -Rf ./dist && tsc && node -r ts-node/register/transpile-only ./bin/copy-binaries.ts",
@@ -32,6 +32,8 @@
     "lib": "lib"
   },
   "dependencies": {
+    "@types/bluebird": "3.5.42",
+    "@types/passport": "1.0.17",
     "aedes": "0.51.3",
     "bluebird": "3.7.2",
     "cli-color": "2.0.4",
@@ -83,10 +85,8 @@
   "devDependencies": {
     "@cucumber/cucumber": "12.5.0",
     "@types/async": "^3.2.24",
-    "@types/bluebird": "3.5.42",
     "@types/cookie": "1.0.0",
     "@types/lodash": "4.17.21",
-    "@types/passport": "1.0.17",
     "@types/validator": "^13.15.10",
     "@types/yargs": "17.0.35",
     "@vitest/coverage-v8": "4.0.16",