kuzzle 2.17.0 → 2.17.1

package/lib/core/backend/index.d.ts

@@ -11,3 +11,4 @@ export * from './backendStorage';
 export * from './backendVault';
 export * from './backendOpenApi';
 export * from './internalLogger';
+export * from './backendErrors';

package/lib/core/backend/index.js

@@ -23,4 +23,5 @@ __exportStar(require("./backendStorage"), exports);
 __exportStar(require("./backendVault"), exports);
 __exportStar(require("./backendOpenApi"), exports);
 __exportStar(require("./internalLogger"), exports);
+__exportStar(require("./backendErrors"), exports);
 //# sourceMappingURL=index.js.map

package/lib/core/network/protocols/httpwsProtocol.js

@@ -77,6 +77,9 @@ const HTTP_ALLOWED_CONTENT_TYPES = [
   'application/x-www-form-urlencoded',
   'multipart/form-data',
 ];
+const HTTP_SKIPPED_HEADERS = [
+  'content-length',
+];
 const HTTP_HEADER_CONNECTION = Buffer.from('Connection');
 const HTTP_HEADER_CONTENT_LENGTH = Buffer.from('Content-Length');
 const HTTP_HEADER_ACCESS_CONTROL_ALLOW_ORIGIN = Buffer.from('Access-Control-Allow-Origin');
@@ -351,7 +354,7 @@ class HttpWsProtocol extends Protocol {
       request = new Request(parsed, { connection });
     }
     catch (e) {
-      this.wsSendError(socket, connection, e);
+      this.wsSendError(socket, connection, e, parsed.requestId);
       return;
     }
 
@@ -392,9 +395,14 @@ class HttpWsProtocol extends Protocol {
    * @param  {uWS.WebSocket} socket
    * @param  {ClientConnection} connection
    * @param  {Error} error
+   * @param  {String} requestId @optional
    */
-  wsSendError (socket, connection, error) {
+  wsSendError (socket, connection, error, requestId) {
     const request = new Request({}, { connection, error });
+
+    // If a requestId is provided we use it instead of the generated one
+    request.id = requestId || request.id;
+
     const sanitized = removeErrorStack(request.response.toJSON()).content;
 
     this.wsSend(socket, Buffer.from(JSON.stringify(sanitized)));
@@ -656,6 +664,11 @@ class HttpWsProtocol extends Protocol {
     }
 
     for (const [key, value] of Object.entries(request.response.headers)) {
+      // Skip some headers that are not allowed to be sent or modified
+      if (HTTP_SKIPPED_HEADERS.includes(key.toLowerCase())) {
+        continue;
+      }
+
       response.writeHeader(Buffer.from(key), Buffer.from(value.toString()));
     }
   }

package/lib/core/plugin/pluginContext.js

@@ -19,6 +19,25 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -33,12 +52,12 @@ const elasticsearch_1 = __importDefault(require("../../service/storage/elasticse
 const safeObject_1 = require("../../util/safeObject");
 const promback_1 = __importDefault(require("../../util/promback"));
 const mutex_1 = require("../../util/mutex");
-const kerror_1 = __importDefault(require("../../kerror"));
+const kerror = __importStar(require("../../kerror"));
 const storeScopeEnum_1 = __importDefault(require("../storage/storeScopeEnum"));
 const errors_1 = require("../../kerror/errors");
 const index_1 = require("../../../index");
 const backend_1 = require("../backend");
-const contextError = kerror_1.default.wrap('plugin', 'context');
+const contextError = kerror.wrap('plugin', 'context');
 class PluginContext {
     constructor(pluginName) {
         this.config = JSON.parse(JSON.stringify(global.kuzzle.config));
@@ -60,7 +79,7 @@ class PluginContext {
             TooManyRequestsError: errors_1.TooManyRequestsError,
             UnauthorizedError: errors_1.UnauthorizedError,
         };
-        this.kerror = kerror_1.default.wrap('plugin', pluginName);
+        this.kerror = kerror.wrap('plugin', pluginName);
         // @deprecated - backward compatibility only
         this.errorsManager = this.kerror;
         /* context.secrets ====================================================== */

package/lib/core/realtime/channel.js

@@ -19,13 +19,29 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Channel = void 0;
-const kerror_1 = __importDefault(require("../../kerror"));
-const realtimeError = kerror_1.default.wrap('core', 'realtime');
+const kerror = __importStar(require("../../kerror"));
+const realtimeError = kerror.wrap('core', 'realtime');
 /**
  * A channel define how notifications should be send for a particular realtime
  * room.

package/lib/core/realtime/hotelClerk.js

@@ -19,6 +19,25 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -26,14 +45,14 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.HotelClerk = void 0;
 const bluebird_1 = __importDefault(require("bluebird"));
 const request_1 = require("../../api/request");
-const kerror_1 = __importDefault(require("../../kerror"));
+const kerror = __importStar(require("../../kerror"));
 const debug_1 = __importDefault(require("../../util/debug"));
 const koncordeCompat_1 = require("../../util/koncordeCompat");
 const channel_1 = require("./channel");
 const connectionRooms_1 = require("./connectionRooms");
 const room_1 = require("./room");
 const subscription_1 = require("./subscription");
-const realtimeError = kerror_1.default.wrap('core', 'realtime');
+const realtimeError = kerror.wrap('core', 'realtime');
 const debug = (0, debug_1.default)('kuzzle:realtime:hotelClerk');
 /**
  * The HotelClerk is responsible of keeping the list of rooms and subscriptions
@@ -168,10 +187,10 @@ class HotelClerk {
     async subscribe(request) {
         const { index, collection } = request.input.resource;
         if (!index) {
-            return kerror_1.default.reject('api', 'assert', 'missing_argument', 'index');
+            return kerror.reject('api', 'assert', 'missing_argument', 'index');
         }
         if (!collection) {
-            return kerror_1.default.reject('api', 'assert', 'missing_argument', 'collection');
+            return kerror.reject('api', 'assert', 'missing_argument', 'collection');
         }
         /*
          * /!\ This check is a duplicate to the one already made by the
@@ -192,7 +211,7 @@ class HotelClerk {
             normalized = this.koncorde.normalize(request.input.body, (0, koncordeCompat_1.toKoncordeIndex)(index, collection));
         }
         catch (e) {
-            throw kerror_1.default.get('api', 'assert', 'koncorde_dsl_error', e.message);
+            throw kerror.get('api', 'assert', 'koncorde_dsl_error', e.message);
         }
         this.createRoom(normalized);
         const { channel, subscribed } = await this.subscribeToRoom(normalized.id, request);

package/lib/core/security/profileRepository.js

@@ -19,6 +19,25 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -28,7 +47,7 @@ const lodash_1 = require("lodash");
 const bluebird_1 = __importDefault(require("bluebird"));
 const profile_1 = require("../../model/security/profile");
 const repository_1 = __importDefault(require("../shared/repository"));
-const kerror_1 = __importDefault(require("../../kerror"));
+const kerror = __importStar(require("../../kerror"));
 const cacheDbEnum_1 = __importDefault(require("../cache/cacheDbEnum"));
 /**
  * @class ProfileRepository
@@ -159,7 +178,7 @@ class ProfileRepository extends repository_1.default {
     async loadProfiles(profileIds = []) {
         const profiles = [];
         if (profileIds.some(p => typeof p !== 'string')) {
-            throw kerror_1.default.get('api', 'assert', 'invalid_type', 'profileIds', 'string[]');
+            throw kerror.get('api', 'assert', 'invalid_type', 'profileIds', 'string[]');
         }
         for (const id of profileIds) {
             let profile = this.profiles.get(id);
@@ -184,7 +203,7 @@ class ProfileRepository extends repository_1.default {
         }
         catch (err) {
             if (err.status === 404) {
-                throw kerror_1.default.get('security', 'profile', 'not_found', id);
+                throw kerror.get('security', 'profile', 'not_found', id);
             }
             throw err;
         }
@@ -283,7 +302,7 @@ class ProfileRepository extends repository_1.default {
      */
     async delete(profile, { refresh = 'false', onAssignedUsers = 'fail', userId = '-1', } = {}) {
         if (['admin', 'default', 'anonymous'].includes(profile._id)) {
-            throw kerror_1.default.get('security', 'profile', 'cannot_delete');
+            throw kerror.get('security', 'profile', 'cannot_delete');
         }
         const query = {
             terms: {
@@ -316,7 +335,7 @@ class ProfileRepository extends repository_1.default {
         else {
             const hits = await this.module.user.search({ query }, { from: 0, size: 1 });
             if (hits.total > 0) {
-                throw kerror_1.default.get('security', 'profile', 'in_use');
+                throw kerror.get('security', 'profile', 'in_use');
             }
         }
         await this.deleteFromDatabase(profile._id, { refresh });
@@ -353,7 +372,7 @@ class ProfileRepository extends repository_1.default {
         await profile.validateDefinition({ strict });
         if (profile._id === 'anonymous'
             && policiesRoles.indexOf('anonymous') === -1) {
-            throw kerror_1.default.get('security', 'profile', 'missing_anonymous_role');
+            throw kerror.get('security', 'profile', 'missing_anonymous_role');
         }
         profile.optimizedPolicies = undefined; // Remove optimized policies
         await super.persistToDatabase(profile, { method, refresh, retryOnConflict });
@@ -380,7 +399,7 @@ class ProfileRepository extends repository_1.default {
         const roles = await this.module.role.loadRoles(policiesRoles);
         // Fail if not all roles are found
         if (roles.some(r => r === null)) {
-            throw kerror_1.default.get('security', 'profile', 'cannot_hydrate');
+            throw kerror.get('security', 'profile', 'cannot_hydrate');
         }
         return profile;
     }

package/lib/core/shared/sdk/embeddedSdk.js

@@ -19,6 +19,25 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -27,9 +46,9 @@ exports.EmbeddedSDK = void 0;
 const kuzzle_sdk_1 = require("kuzzle-sdk");
 const funnelProtocol_1 = __importDefault(require("./funnelProtocol"));
 const safeObject_1 = require("../../../util/safeObject");
-const kerror_1 = __importDefault(require("../../../kerror"));
+const kerror = __importStar(require("../../../kerror"));
 const impersonatedSdk_1 = __importDefault(require("./impersonatedSdk"));
-const contextError = kerror_1.default.wrap('plugin', 'context');
+const contextError = kerror.wrap('plugin', 'context');
 /**
  * Kuzzle embedded SDK to make API calls inside applications or plugins.
  */

package/lib/core/storage/indexCache.js

@@ -19,13 +19,29 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IndexCache = void 0;
-const kerror_1 = __importDefault(require("../../kerror"));
-const storageError = kerror_1.default.wrap('services', 'storage');
+const kerror = __importStar(require("../../kerror"));
+const storageError = kerror.wrap('services', 'storage');
 class IndexCache {
     constructor() {
         /**

package/lib/kerror/errors/multipleErrorsError.d.ts

@@ -2,6 +2,6 @@ import { KuzzleError } from './kuzzleError';
 export declare class MultipleErrorsError extends KuzzleError {
     errors: Array<KuzzleError>;
     count: number;
-    constructor(message: string, body?: Array<KuzzleError>, id?: string, code?: number);
+    constructor(message: string, errors?: KuzzleError[], id?: string, code?: number);
     toJSON(): import("kuzzle-sdk").JSONObject;
 }

package/lib/kerror/errors/multipleErrorsError.js

@@ -23,10 +23,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MultipleErrorsError = void 0;
 const kuzzleError_1 = require("./kuzzleError");
 class MultipleErrorsError extends kuzzleError_1.KuzzleError {
-    constructor(message, body = [], id, code) {
+    constructor(message, errors = [], id, code) {
         super(message, 400, id, code);
-        this.errors = body;
-        this.count = body.length;
+        this.errors = errors;
+        this.count = errors.length;
     }
     toJSON() {
         const serialized = super.toJSON();

package/lib/kerror/index.d.ts

@@ -0,0 +1,82 @@
+import * as errors from './errors';
+import { KuzzleError } from './errors';
+import { ErrorDomains } from '../types';
+/**
+ * Construct and return the corresponding error
+ *
+ * @param  domains - Domains object with subdomains and error names
+ * @param  domain - Domain (eg: 'external')
+ * @param  subdomain - Subdomain (eg: 'elasticsearch')
+ * @param  error - Error name: (eg: 'index_not_found')
+ * @param  placeholders - Placeholders value to inject in error message
+ * @param  options - Last param can be additional options { message }
+ */
+export declare function rawGet(domains: ErrorDomains, domain: string, subdomain: string, error: string, ...placeholders: any[]): KuzzleError;
+/**
+ * Returns a promise rejected with the corresponding error
+ *
+ * @param  domains - Domains object with subdomains and error names
+ * @param  domain - Domain (eg: 'external')
+ * @param  subdomain - Subdomain (eg: 'elasticsearch')
+ * @param  error - Error name: (eg: 'index_not_found')
+ * @param  placeholders - Placeholders value to inject in error message
+ */
+export declare function rawReject(domains: ErrorDomains, domain: string, subdomain: string, error: string, ...placeholders: any[]): Promise<any>;
+/**
+ * Construct and return the corresponding error, with its stack
+ * trace derivated from a provided source error
+ *
+ * @param  domains - Domains object with subdomains and error names
+ * @param  source - Original error
+ * @param  domain - Domain (eg: 'external')
+ * @param  subdomain - Subdomain (eg: 'elasticsearch')
+ * @param  error - Error name: (eg: 'index_not_found')
+ * @param  placeholders - Placeholders value to inject in error message
+ */
+export declare function rawGetFrom(domains: ErrorDomains, source: Error, domain: string, subdomain: string, error: string, ...placeholders: any[]): KuzzleError;
+/**
+ * Wrap error functions with the provided domain and subdomain.
+ */
+export declare function rawWrap(domains: ErrorDomains, domain: string, subdomain: string): {
+    get: (error: any, ...placeholders: any[]) => errors.KuzzleError;
+    getFrom: (source: any, error: any, ...placeholders: any[]) => errors.KuzzleError;
+    reject: (error: any, ...placeholders: any[]) => Promise<any>;
+};
+/**
+ * Construct and return the corresponding error
+ *
+ * @param  domain - Domain (eg: 'external')
+ * @param  subdomain - Subdomain (eg: 'elasticsearch')
+ * @param  error - Error name: (eg: 'index_not_found')
+ * @param  placeholders - Placeholders value to inject in error message
+ * @param  options - Last param can be additional options { message }
+ */
+export declare function get(domain: string, subdomain: string, error: string, ...placeholders: any[]): KuzzleError;
+/**
+ * Returns a promise rejected with the corresponding error
+ *
+ * @param  domain - Domain (eg: 'external')
+ * @param  subdomain - Subdomain (eg: 'elasticsearch')
+ * @param  error - Error name: (eg: 'index_not_found')
+ * @param  placeholders - Placeholders value to inject in error message
+ */
+export declare function reject(domain: string, subdomain: string, error: string, ...placeholders: any[]): Promise<any>;
+/**
+ * Construct and return the corresponding error, with its stack
+ * trace derivated from a provided source error
+ *
+ * @param  source - Original error
+ * @param  domain - Domain (eg: 'external')
+ * @param  subdomain - Subdomain (eg: 'elasticsearch')
+ * @param  error - Error name: (eg: 'index_not_found')
+ * @param  placeholders - Placeholders value to inject in error message
+ */
+export declare function getFrom(source: Error, domain: string, subdomain: string, error: string, ...placeholders: any[]): KuzzleError;
+/**
+ * Wrap error functions with the provided domain and subdomain.
+ */
+export declare function wrap(domain: string, subdomain: string): {
+    get: (error: any, ...placeholders: any[]) => errors.KuzzleError;
+    getFrom: (source: any, error: any, ...placeholders: any[]) => errors.KuzzleError;
+    reject: (error: any, ...placeholders: any[]) => Promise<any>;
+};