kuzzle 2.16.5 → 2.16.9

package/README.md

@@ -138,3 +138,14 @@ Check our [contributing documentation](./CONTRIBUTING.md) to know about our codi
 ## License
 
 Kuzzle is published under [Apache 2 License](./LICENSE.md).
+
+## About Mac M1
+
+First of all make sure that you have at least `4GB` of ram allocated to your vm **docker desktop** and that it is running.
+
+Run the following command to install all the dependencies in your container:
+```bash
+npm run docker:install
+```
+
+finally run the command `docker-compose up` to launch your kuzzle stack.

package/lib/api/controllers/adminController.js

@@ -156,7 +156,7 @@ class AdminController extends NativeController {
     const fixtures = request.getBody();
 
     return this._waitForAction(
-      request.getRefresh('true'),
+      request.getRefresh('wait_for'),
       global.kuzzle.ask('core:storage:public:document:import', fixtures));
   }
 
@@ -164,7 +164,7 @@ class AdminController extends NativeController {
     const mappings = request.getBody();
 
     return this._waitForAction(
-      request.getRefresh('true'),
+      request.getRefresh('wait_for'),
       global.kuzzle.ask(
         'core:storage:public:mappings:import',
         mappings,
@@ -176,11 +176,12 @@ class AdminController extends NativeController {
     const user = request.getUser();
     const onExistingUsers = request.input.args.onExistingUsers;
     const force = request.getBoolean('force');
-    const waitForRefresh = request.getRefresh('true');
+    const waitForRefresh = request.getRefresh('wait_for');
 
     const promise = this.ask('core:security:load', permissions, {
       force,
       onExistingUsers,
+      refresh: waitForRefresh,
       user,
     });
 

package/lib/api/controllers/authController.js

@@ -430,11 +430,11 @@ class AuthController extends NativeController {
       token = request.input.jwt;
     }
     else {
-      token = request.getBodyString('token');
+      token = request.getBodyString('token', '') || null;
     }
 
     try {
-      const { expiresAt, userId } = await this.ask('core:security:token:verify', token);
+      const { expiresAt = -1, userId } = await this.ask('core:security:token:verify', token);
 
       return { expiresAt, kuid: userId, valid: true };
     }

package/lib/api/controllers/collectionController.js

@@ -269,7 +269,7 @@ class CollectionController extends NativeController {
   }
 
   /**
-   * Reset a collection by removing all documents
+   * Reset a collection by removing all documents while keeping the existing mapping
    *
    * @param {KuzzleRequest} request
    * @returns {Promise.<Object>}
@@ -277,13 +277,7 @@ class CollectionController extends NativeController {
   async truncate (request) {
     const { index, collection } = request.getIndexAndCollection();
 
-    await this.ask('core:storage:public:collection:refresh', index, collection);
-    await this.ask(
-      'core:storage:public:document:deleteByQuery',
-      index,
-      collection,
-      {},
-      { fetch: false, refresh: 'wait_for' });
+    await this.ask('core:storage:public:collection:truncate', index, collection);
 
     return {
       acknowledged: true

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

@@ -161,7 +161,7 @@ export declare class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not a number
      */
-    getBodyNumber(name: string, def?: number | null): number;
+    getBodyNumber(name: string, def?: number | undefined): number;
     /**
      * Gets a parameter from a request body and checks that it is a integer
      *
@@ -174,7 +174,7 @@ export declare class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not an integer
      */
-    getBodyInteger(name: string, def?: number | null): number;
+    getBodyInteger(name: string, def?: number | undefined): number;
     /**
      * Gets a parameter from a request body and checks that it is a string
      *
@@ -187,7 +187,7 @@ export declare class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not a string
      */
-    getBodyString(name: string, def?: string | null): string;
+    getBodyString(name: string, def?: string | undefined): string;
     /**
      * Gets a parameter from a request body and checks that it is an array
      *
@@ -200,7 +200,7 @@ export declare class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not an array
      */
-    getBodyArray(name: string, def?: [] | null): any[];
+    getBodyArray(name: string, def?: [] | undefined): any[];
     /**
      * Gets a parameter from a request body and checks that it is an object
      *
@@ -213,7 +213,7 @@ export declare class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not an object
      */
-    getBodyObject(name: string, def?: JSONObject | null): JSONObject;
+    getBodyObject(name: string, def?: JSONObject | undefined): JSONObject;
     /**
      * Gets a parameter from a request arguments and checks that it is a boolean
      * Contrary to other parameter types, an unset boolean does not trigger an
@@ -232,7 +232,7 @@ export declare class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not a number
      */
-    getNumber(name: string, def?: number | null): number;
+    getNumber(name: string, def?: number | undefined): number;
     /**
      * Gets a parameter from a request arguments and checks that it is an integer
      *
@@ -243,7 +243,7 @@ export declare class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not an integer
      */
-    getInteger(name: string, def?: number | null): number;
+    getInteger(name: string, def?: number | undefined): number;
     /**
      * Gets a parameter from a request arguments and checks that it is a string
      *
@@ -254,7 +254,7 @@ export declare class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not a string
      */
-    getString(name: string, def?: string | null): string;
+    getString(name: string, def?: string | undefined): string;
     /**
      * Gets a parameter from a request arguments and checks that it is an array
      *
@@ -265,7 +265,7 @@ export declare class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not an array
      */
-    getArray(name: string, def?: [] | null): any[];
+    getArray(name: string, def?: [] | undefined): any[];
     /**
      * Gets a parameter from a request arguments and checks that it is an object
      *
@@ -276,7 +276,7 @@ export declare class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not an object
      */
-    getObject(name: string, def?: JSONObject | null): JSONObject;
+    getObject(name: string, def?: JSONObject | undefined): JSONObject;
     /**
      * Returns the index specified in the request
      */
@@ -300,7 +300,7 @@ export declare class KuzzleRequest {
      * @throws {api.assert.body_required} If the body is not set and if no default
      *                                    value is provided
      */
-    getBody(def?: JSONObject | null): JSONObject;
+    getBody(def?: JSONObject | undefined): JSONObject;
     /**
      * Returns the `_id` specified in the request.
      *

package/lib/api/request/kuzzleRequest.js

@@ -52,6 +52,7 @@ const errors_1 = require("../../kerror/errors");
 const kerror_1 = __importDefault(require("../../kerror"));
 const assert = __importStar(require("../../util/assertType"));
 const safeObject_1 = require("../../util/safeObject");
+const lodash_1 = require("lodash");
 const assertionError = kerror_1.default.wrap('api', 'assert');
 // private properties
 // \u200b is a zero width space, used to masquerade console.log output
@@ -349,10 +350,10 @@ class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not a number
      */
-    getBodyNumber(name, def = null) {
+    getBodyNumber(name, def = undefined) {
         const body = this.input.body;
         if (body === null) {
-            if (def !== null) {
+            if (def !== undefined) {
                 return def;
             }
             throw assertionError.get('body_required');
@@ -371,10 +372,10 @@ class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not an integer
      */
-    getBodyInteger(name, def = null) {
+    getBodyInteger(name, def = undefined) {
         const body = this.input.body;
         if (body === null) {
-            if (def !== null) {
+            if (def !== undefined) {
                 return def;
             }
             throw assertionError.get('body_required');
@@ -393,10 +394,10 @@ class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not a string
      */
-    getBodyString(name, def = null) {
+    getBodyString(name, def = undefined) {
         const body = this.input.body;
         if (body === null) {
-            if (def !== null) {
+            if (def !== undefined) {
                 return def;
             }
             throw assertionError.get('body_required');
@@ -415,10 +416,10 @@ class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not an array
      */
-    getBodyArray(name, def = null) {
+    getBodyArray(name, def = undefined) {
         const body = this.input.body;
         if (body === null) {
-            if (def !== null) {
+            if (def !== undefined) {
                 return def;
             }
             throw assertionError.get('body_required');
@@ -437,10 +438,10 @@ class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not an object
      */
-    getBodyObject(name, def = null) {
+    getBodyObject(name, def = undefined) {
         const body = this.input.body;
         if (body === null) {
-            if (def !== null) {
+            if (def !== undefined) {
                 return def;
             }
             throw assertionError.get('body_required');
@@ -467,7 +468,7 @@ class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not a number
      */
-    getNumber(name, def = null) {
+    getNumber(name, def = undefined) {
         return this._getNumber(this.input.args, name, name, def);
     }
     /**
@@ -480,7 +481,7 @@ class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not an integer
      */
-    getInteger(name, def = null) {
+    getInteger(name, def = undefined) {
         return this._getInteger(this.input.args, name, name, def);
     }
     /**
@@ -493,7 +494,7 @@ class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not a string
      */
-    getString(name, def = null) {
+    getString(name, def = undefined) {
         return this._getString(this.input.args, name, name, def);
     }
     /**
@@ -506,7 +507,7 @@ class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not an array
      */
-    getArray(name, def = null) {
+    getArray(name, def = undefined) {
         return this._getArray(this.input.args, name, name, def);
     }
     /**
@@ -519,7 +520,7 @@ class KuzzleRequest {
      *                                       value provided
      * @throws {api.assert.invalid_type} If the fetched parameter is not an object
      */
-    getObject(name, def = null) {
+    getObject(name, def = undefined) {
         return this._getObject(this.input.args, name, name, def);
     }
     /**
@@ -565,9 +566,9 @@ class KuzzleRequest {
      * @throws {api.assert.body_required} If the body is not set and if no default
      *                                    value is provided
      */
-    getBody(def = null) {
+    getBody(def = undefined) {
         if (this.input.body === null) {
-            if (def !== null) {
+            if (def !== undefined) {
                 return def;
             }
             throw assertionError.get('body_required');
@@ -685,7 +686,7 @@ class KuzzleRequest {
      * @param errorName name to use in error messages
      */
     _getBoolean(obj, name, errorName) {
-        let value = (0, safeObject_1.get)(obj, name);
+        let value = (0, lodash_1.get)(obj, name);
         // In HTTP, booleans are flags: if it's in the querystring, it's set,
         // whatever its value.
         // If a user needs to unset the option, they need to remove it from the
@@ -713,12 +714,9 @@ class KuzzleRequest {
      * @param errorName - name to use in error messages
      * @param def default value
      */
-    _getNumber(obj, name, errorName, def = null) {
-        let value = (0, safeObject_1.get)(obj, name);
-        if (value === undefined || value === null) {
-            if (def !== null) {
-                return def;
-            }
+    _getNumber(obj, name, errorName, def = undefined) {
+        let value = (0, lodash_1.get)(obj, name, def);
+        if (value === undefined) {
             throw assertionError.get('missing_argument', errorName);
         }
         value = Number.parseFloat(value);
@@ -735,12 +733,9 @@ class KuzzleRequest {
      * @param errorName name to use in error messages
      * @param def default value
      */
-    _getInteger(obj, name, errorName, def = null) {
-        let value = (0, safeObject_1.get)(obj, name);
-        if (value === undefined || value === null) {
-            if (def !== null) {
-                return def;
-            }
+    _getInteger(obj, name, errorName, def = undefined) {
+        let value = (0, lodash_1.get)(obj, name, def);
+        if (value === undefined) {
             throw assertionError.get('missing_argument', errorName);
         }
         value = Number.parseFloat(value);
@@ -757,12 +752,9 @@ class KuzzleRequest {
      * @param errorName name to use in error messages
      * @param def default value
      */
-    _getString(obj, name, errorName, def = null) {
-        const value = (0, safeObject_1.get)(obj, name);
-        if (value === undefined || value === null) {
-            if (def !== null) {
-                return def;
-            }
+    _getString(obj, name, errorName, def = undefined) {
+        const value = (0, lodash_1.get)(obj, name, def);
+        if (value === undefined) {
             throw assertionError.get('missing_argument', errorName);
         }
         if (typeof value !== 'string') {
@@ -778,12 +770,9 @@ class KuzzleRequest {
      * @param errorName name to use in error messages
      * @param def default value
      */
-    _getArray(obj, name, errorName, def = null) {
-        const value = (0, safeObject_1.get)(obj, name);
-        if (value === undefined || value === null) {
-            if (def !== null) {
-                return def;
-            }
+    _getArray(obj, name, errorName, def = undefined) {
+        const value = (0, lodash_1.get)(obj, name, def);
+        if (value === undefined) {
             throw assertionError.get('missing_argument', errorName);
         }
         if (!Array.isArray(value)) {
@@ -799,12 +788,9 @@ class KuzzleRequest {
      * @param errorName name to use in error messages
      * @param def default value
      */
-    _getObject(obj, name, errorName, def = null) {
-        const value = (0, safeObject_1.get)(obj, name);
-        if (value === undefined || value === null) {
-            if (def !== null) {
-                return def;
-            }
+    _getObject(obj, name, errorName, def = undefined) {
+        const value = (0, lodash_1.get)(obj, name, def);
+        if (value === undefined) {
             throw assertionError.get('missing_argument', errorName);
         }
         if (!(0, safeObject_1.isPlainObject)(value)) {

package/lib/cluster/workers/IDCardRenewer.js

@@ -55,8 +55,9 @@ class IDCardRenewer {
   }
 
   async initRedis (config, name) {
-    this.redis = new Redis(config, name);
-    await this.redis.init();
+    const redis = new Redis(config, name);
+    await redis.init();
+    this.redis = redis;
   }
 
   async renewIDCard () {
@@ -89,8 +90,16 @@ class IDCardRenewer {
     }
 
     this.disposed = true;
+
     clearInterval(this.refreshTimer);
     this.refreshTimer = null;
+
+    // If the worker is disposed before it had time to starts, redis service
+    // may not have been initialized
+    if (! this.redis) {
+      return;
+    }
+
     try {
       await this.redis.commands.del(this.nodeIdKey);
     }

package/lib/config/default.config.d.ts

@@ -0,0 +1,13 @@
+import { KuzzleConfiguration } from '../types/config/KuzzleConfiguration';
+/**
+ * /!\ DO NOT MODIFY THIS FILE
+ *
+ * To customize your Kuzzle installation, create a
+ * ".kuzzlerc" file and put your overrides there.
+ * Please check the ".kuzzlerc.sample" file to get
+ * started.
+ *
+ * @class KuzzleConfiguration
+ */
+declare const defaultConfig: KuzzleConfiguration;
+export default defaultConfig;