kuzzle 2.16.11 → 2.17.2

package/lib/core/validation/validation.js

@@ -36,7 +36,7 @@ const assertionError = kerror.wrap('validation', 'assert');
  * @class Validation
  */
 class Validation {
-  constructor() {
+  constructor () {
     /** @type {...ValidationType} */
     this.types = {};
 
@@ -55,7 +55,7 @@ class Validation {
   /**
    * Walks through all types in "defaultTypesFiles" initializes all types
    */
-  init() {
+  init () {
     [
       'anything',
       'boolean',
@@ -123,7 +123,8 @@ class Validation {
             collectionSpec.strict,
             errorMessages,
             verbose);
-        } catch (error) {
+        }
+        catch (error) {
           // The strictness message can be received here only if it happens at
           // the validation of the document's root
           if (error.message !== 'strictness') {
@@ -153,7 +154,7 @@ class Validation {
       }
     }
 
-    if (!verbose) {
+    if (! verbose) {
       // We only modify the request if the validation succeeds
       if (collectionSpec.fields && collectionSpec.fields.children) {
         request.input.body = this.recurseApplyDefault(
@@ -165,7 +166,7 @@ class Validation {
       return request;
     }
 
-    return {errorMessages, valid: isValid};
+    return { errorMessages, valid: isValid };
   }
 
   /**
@@ -173,7 +174,7 @@ class Validation {
    * @param {*} documentSubset
    * @param {...StructuredFieldSpecification} collectionSpecSubset
    */
-  recurseApplyDefault(isUpdate, documentSubset, collectionSpecSubset) {
+  recurseApplyDefault (isUpdate, documentSubset, collectionSpecSubset) {
     Object.keys(collectionSpecSubset).forEach(fieldName => {
       const
         specSubset = collectionSpecSubset[fieldName],
@@ -189,14 +190,16 @@ class Validation {
               field[i],
               specSubset.children);
           }
-        } else {
+        }
+        else {
           documentSubset[fieldName] = this.recurseApplyDefault(
             isUpdate,
             field,
             specSubset.children);
         }
-      } else if (specSubset.defaultValue
-        && (field === null || (!isUpdate && !has(documentSubset, fieldName)))
+      }
+      else if (specSubset.defaultValue
+        && (field === null || (! isUpdate && ! has(documentSubset, fieldName)))
       ) {
         documentSubset[fieldName] = specSubset.defaultValue;
       }
@@ -212,7 +215,7 @@ class Validation {
    * @param {string[]} errorMessages
    * @param {boolean} verbose
    */
-  recurseFieldValidation(
+  recurseFieldValidation (
     documentSubset,
     collectionSpecSubset,
     strictness,
@@ -221,7 +224,7 @@ class Validation {
   ) {
     if (strictness) {
       for (const field of Object.keys(documentSubset)) {
-        if (!collectionSpecSubset[field]) {
+        if (! collectionSpecSubset[field]) {
           const error = new Error('strictness');
           error.details = { field };
           throw error;
@@ -229,7 +232,7 @@ class Validation {
       }
     }
 
-    if (!verbose) {
+    if (! verbose) {
       // We stop as soon as one field is not valid
       return Object.keys(collectionSpecSubset).every(fieldName =>
         this.isValidField(
@@ -262,7 +265,7 @@ class Validation {
    * @param {boolean} verbose
    * @returns {boolean}
    */
-  isValidField(
+  isValidField (
     fieldName,
     documentSubset,
     collectionSpecSubset,
@@ -275,7 +278,7 @@ class Validation {
     let result = true;
 
     if (field.mandatory
-      && !has(field, 'defaultValue')
+      && ! has(field, 'defaultValue')
       && _.isNil(documentSubset[fieldName])
     ) {
       manageErrorMessage(
@@ -286,13 +289,13 @@ class Validation {
       return false;
     }
 
-    if (!_.isNil(documentSubset[fieldName])) {
+    if (! _.isNil(documentSubset[fieldName])) {
       let
         nestedStrictness = false,
         fieldValues;
 
       if (field.multivalued.value) {
-        if (!Array.isArray(documentSubset[fieldName])) {
+        if (! Array.isArray(documentSubset[fieldName])) {
           manageErrorMessage(
             field.path,
             errorMessages,
@@ -324,7 +327,8 @@ class Validation {
         }
 
         fieldValues = documentSubset[fieldName];
-      } else {
+      }
+      else {
         if (Array.isArray(documentSubset[fieldName])) {
           manageErrorMessage(
             field.path,
@@ -346,7 +350,7 @@ class Validation {
       for (const val of fieldValues) {
         const fieldErrors = [];
 
-        if (!this.types[field.type].validate(
+        if (! this.types[field.type].validate(
           field.typeOptions,
           val,
           fieldErrors)
@@ -358,7 +362,8 @@ class Validation {
               errorMessages,
               'An error has occurred during validation.',
               verbose);
-          } else {
+          }
+          else {
             fieldErrors.forEach(
               message => manageErrorMessage(
                 field.path,
@@ -371,7 +376,7 @@ class Validation {
 
         if (this.types[field.type].allowChildren && field.children) {
           try {
-            if (!this.recurseFieldValidation(
+            if (! this.recurseFieldValidation(
               val,
               field.children,
               nestedStrictness,
@@ -380,20 +385,23 @@ class Validation {
             )) {
               result = false;
             }
-          } catch (error) {
+          }
+          catch (error) {
             if (error.message === 'strictness') {
               manageErrorMessage(
                 field.path,
                 errorMessages,
                 `The field is set to "strict"; cannot add unspecified sub-field "${error.details.field}".`,
                 verbose);
-            } else if (verbose) {
+            }
+            else if (verbose) {
               manageErrorMessage(
                 field.path,
                 errorMessages,
                 error.message,
                 verbose);
-            } else {
+            }
+            else {
               throw error;
             }
 
@@ -408,7 +416,7 @@ class Validation {
   /**
    * @returns {Promise.<T>}
    */
-  curateSpecification() {
+  curateSpecification () {
     const
       promises = [],
       specification = {};
@@ -428,7 +436,7 @@ class Validation {
             )
               .then(curatedSpec => {
 
-                if (!has(specification, indexName)) {
+                if (! has(specification, indexName)) {
                   specification[indexName] = {};
                 }
 
@@ -462,7 +470,7 @@ class Validation {
    * @param {boolean} [verboseErrors]
    * @returns {Promise<object>}
    */
-  validateFormat(
+  validateFormat (
     indexName,
     collectionName,
     collectionSpec,
@@ -481,11 +489,11 @@ class Validation {
         if (verboseErrors && result.isValid === false) {
           return result;
         }
-        return {isValid: true};
+        return { isValid: true };
       })
       // we do not want to reject since this method goal is
       // to know what is going wrong with the given spec
-      .catch(error => ({errors: [error], isValid: false}));
+      .catch(error => ({ errors: [error], isValid: false }));
   }
 
   /**
@@ -497,7 +505,7 @@ class Validation {
    * @returns {Promise<CollectionSpecification>}
    * @rejects PreconditionError
    */
-  async curateCollectionSpecification(
+  async curateCollectionSpecification (
     index,
     collection,
     spec,
@@ -512,14 +520,14 @@ class Validation {
     };
     const allowed = ['strict', 'fields', 'validators'];
 
-    if (!checkAllowedProperties(spec, allowed)) {
+    if (! checkAllowedProperties(spec, allowed)) {
       error = assertionError.get(
         'unexpected_properties',
         `${index}.${collection}`,
         allowed.join(', '));
 
       if (verbose) {
-        return {errors: [error.message], isValid: false};
+        return { errors: [error.message], isValid: false };
       }
 
       throw error;
@@ -553,7 +561,7 @@ class Validation {
 
         processed.validators = filterId;
       }
-      catch(e) {
+      catch (e) {
         global.kuzzle.log.error(e);
         throw assertionError.getFrom(e, 'invalid_filters', e.message);
       }
@@ -562,7 +570,7 @@ class Validation {
     return processed;
   }
 
-  structureCollectionValidation(
+  structureCollectionValidation (
     collectionSpec,
     indexName,
     collectionName,
@@ -600,20 +608,21 @@ class Validation {
             maxDepth = field.depth;
           }
 
-          if (!fields[field.depth]) {
+          if (! fields[field.depth]) {
             fields[field.depth] = [];
           }
 
           fields[field.depth].push(field);
         }
-      } catch (error) {
+      }
+      catch (error) {
         global.kuzzle.log.error(error);
         throwOrStoreError(error, verboseErrors, errors);
       }
     }
 
     if (errors.length > 0) {
-      return {errors, isValid: false};
+      return { errors, isValid: false };
     }
 
     if (Object.keys(fields).length > 0) {
@@ -631,7 +640,7 @@ class Validation {
    * @returns {object}
    * @throws PreconditionError
    */
-  curateFieldSpecification(
+  curateFieldSpecification (
     fieldSpec,
     indexName,
     collectionName,
@@ -659,13 +668,13 @@ class Validation {
       }
     });
 
-    if (!has(fieldSpec, 'typeOptions')) {
+    if (! has(fieldSpec, 'typeOptions')) {
       fieldSpec.typeOptions = {};
     }
 
     const allowed = this.types[fieldSpec.type].allowedTypeOptions || [];
 
-    if (!checkAllowedProperties(fieldSpec.typeOptions, allowed)) {
+    if (! checkAllowedProperties(fieldSpec.typeOptions, allowed)) {
       throwOrStoreError(
         assertionError.get(
           'unexpected_properties',
@@ -678,8 +687,9 @@ class Validation {
     try {
       fieldSpec.typeOptions = this.types[fieldSpec.type]
         .validateFieldSpecification(fieldSpec.typeOptions);
-    } catch (e) {
-      if (!verboseErrors) {
+    }
+    catch (e) {
+      if (! verboseErrors) {
         if (e instanceof KuzzleError) {
           throw e;
         }
@@ -695,7 +705,7 @@ class Validation {
     }
 
     if (errors.length > 0) {
-      return {errors, isValid: false};
+      return { errors, isValid: false };
     }
 
     debug(
@@ -705,7 +715,7 @@ class Validation {
       fieldName,
       fieldSpec);
 
-    return {fieldSpec, isValid: true};
+    return { fieldSpec, isValid: true };
   }
 
   /**
@@ -717,7 +727,7 @@ class Validation {
    * @returns {object}
    * @throws PreconditionError
    */
-  curateFieldSpecificationFormat(
+  curateFieldSpecificationFormat (
     fieldSpec,
     indexName,
     collectionName,
@@ -735,7 +745,7 @@ class Validation {
       'typeOptions'
     ];
 
-    if (!checkAllowedProperties(fieldSpec, props)) {
+    if (! checkAllowedProperties(fieldSpec, props)) {
       throwOrStoreError(
         assertionError.get(
           'unexpected_properties',
@@ -745,7 +755,7 @@ class Validation {
         errors);
     }
 
-    if (!has(fieldSpec, 'type')) {
+    if (! has(fieldSpec, 'type')) {
       throwOrStoreError(
         assertionError.get(
           'missing_type',
@@ -754,7 +764,7 @@ class Validation {
         errors);
     }
 
-    if (!has(this.types, fieldSpec.type)) {
+    if (! has(this.types, fieldSpec.type)) {
       throwOrStoreError(
         assertionError.get(
           'unknown_type',
@@ -766,7 +776,7 @@ class Validation {
 
     if (has(fieldSpec, 'multivalued')) {
       const multivaluedProps = ['value', 'minCount', 'maxCount'];
-      if (!checkAllowedProperties(fieldSpec.multivalued, multivaluedProps)) {
+      if (! checkAllowedProperties(fieldSpec.multivalued, multivaluedProps)) {
         throwOrStoreError(
           assertionError.get(
             'unexpected_properties',
@@ -776,7 +786,7 @@ class Validation {
           errors);
       }
 
-      if (!has(fieldSpec.multivalued, 'value')) {
+      if (! has(fieldSpec.multivalued, 'value')) {
         throwOrStoreError(
           assertionError.get(
             'missing_value',
@@ -796,7 +806,7 @@ class Validation {
       }
 
       for (const unexpected of ['minCount', 'maxCount']) {
-        if ( !fieldSpec.multivalued.value
+        if ( ! fieldSpec.multivalued.value
           && has(fieldSpec.multivalued, unexpected)
         ) {
           throwOrStoreError(
@@ -825,10 +835,10 @@ class Validation {
     }
 
     if (errors.length > 0) {
-      return {errors, isValid: false};
+      return { errors, isValid: false };
     }
 
-    return {isValid: true};
+    return { isValid: true };
   }
 
   /**
@@ -838,7 +848,7 @@ class Validation {
    * @param {boolean} dryRun
    * @returns {string}
    */
-  curateValidatorFilter(indexName, collectionName, validatorFilter, dryRun) {
+  curateValidatorFilter (indexName, collectionName, validatorFilter, dryRun) {
     const query = {
       bool: {
         must: validatorFilter
@@ -847,7 +857,7 @@ class Validation {
 
     this.koncorde.validate(query);
 
-    if (!dryRun) {
+    if (! dryRun) {
       debug(
         'Registering filter validator %s/%s: %O',
         indexName,
@@ -866,12 +876,12 @@ class Validation {
    * @param {ValidationType} validationType
    * @throws {PluginImplementationError}
    */
-  addType(validationType) {
-    if (!validationType.typeName) {
+  addType (validationType) {
+    if (! validationType.typeName) {
       throw kerror.get('validation', 'types', 'missing_type_name');
     }
 
-    if ( !validationType.validate
+    if ( ! validationType.validate
       || typeof validationType.validate !== 'function'
     ) {
       throw kerror.get(
@@ -882,7 +892,7 @@ class Validation {
         'validate');
     }
 
-    if ( !validationType.validateFieldSpecification
+    if ( ! validationType.validateFieldSpecification
       || typeof validationType.validateFieldSpecification !== 'function'
     ) {
       throw kerror.get(
@@ -896,7 +906,7 @@ class Validation {
     if (has(validationType, 'allowChildren')
       && validationType.allowChildren
     ) {
-      if (!validationType.getStrictness
+      if (! validationType.getStrictness
         || typeof validationType.getStrictness !== 'function'
       ) {
         throw kerror.get(
@@ -928,13 +938,13 @@ class Validation {
  * @param {string[]} allowedProperties
  * @returns {boolean}
  */
-function checkAllowedProperties(object, allowedProperties) {
-  if (!isPlainObject(object)) {
+function checkAllowedProperties (object, allowedProperties) {
+  if (! isPlainObject(object)) {
     return false;
   }
 
-  return !Object.keys(object).some(
-    propertyName => !allowedProperties.includes(propertyName));
+  return ! Object.keys(object).some(
+    propertyName => ! allowedProperties.includes(propertyName));
 }
 
 /**
@@ -943,7 +953,7 @@ function checkAllowedProperties(object, allowedProperties) {
  * @param {number} maxDepth : depth of the fields; counting starts at 1
  * @throws PreconditionError
  */
-function curateStructuredFields(typeAllowsChildren, fields, maxDepth) {
+function curateStructuredFields (typeAllowsChildren, fields, maxDepth) {
   const
     /** @type StructuredFieldSpecification */
     structuredFields = {
@@ -952,7 +962,7 @@ function curateStructuredFields(typeAllowsChildren, fields, maxDepth) {
     };
 
   for (let i = 1; i <= maxDepth; i++) {
-    if (!has(fields, i)) {
+    if (! has(fields, i)) {
       throw assertionError.get('missing_nested_spec');
     }
 
@@ -961,11 +971,11 @@ function curateStructuredFields(typeAllowsChildren, fields, maxDepth) {
         parent = getParent(structuredFields, field.path),
         childKey = field.path[field.path.length - 1];
 
-      if (!parent.root && typeAllowsChildren.indexOf(parent.type) === -1) {
+      if (! parent.root && typeAllowsChildren.indexOf(parent.type) === -1) {
         throw assertionError.get('unexpected_children', parent.type);
       }
 
-      if (!has(parent, 'children')) {
+      if (! has(parent, 'children')) {
         parent.children = {};
       }
 
@@ -981,7 +991,7 @@ function curateStructuredFields(typeAllowsChildren, fields, maxDepth) {
  * @param {string[]}fieldPath
  * @returns {StructuredFieldSpecification}
  */
-function getParent(structuredFields, fieldPath) {
+function getParent (structuredFields, fieldPath) {
   if (fieldPath.length === 1) {
     return structuredFields;
   }
@@ -989,7 +999,7 @@ function getParent(structuredFields, fieldPath) {
   let pointer = structuredFields;
 
   for (let i = 0; i < fieldPath.length - 1; i++) {
-    if (!has(pointer.children, fieldPath[i])) {
+    if (! has(pointer.children, fieldPath[i])) {
       throw assertionError.get('missing_parent', fieldPath.join('.'));
     }
 
@@ -1004,8 +1014,8 @@ function getParent(structuredFields, fieldPath) {
  * @param {boolean} doNotThrow
  * @param {string[]} errors
  */
-function throwOrStoreError(error, doNotThrow, errorMessages) {
-  if (!doNotThrow) {
+function throwOrStoreError (error, doNotThrow, errorMessages) {
+  if (! doNotThrow) {
     throw error;
   }
 
@@ -1018,33 +1028,34 @@ function throwOrStoreError(error, doNotThrow, errorMessages) {
  * @param {string} message
  * @param {boolean} structured
  */
-function manageErrorMessage(errorContext, errorHolder, message, structured) {
+function manageErrorMessage (errorContext, errorHolder, message, structured) {
   if (structured) {
     if (errorContext === 'document') {
-      if (!errorHolder.documentScope) {
+      if (! errorHolder.documentScope) {
         errorHolder.documentScope = [];
       }
 
       errorHolder.documentScope.push(message);
-    } else {
-      if (!errorHolder.fieldScope) {
+    }
+    else {
+      if (! errorHolder.fieldScope) {
         errorHolder.fieldScope = {};
       }
 
       let pointer = errorHolder.fieldScope;
 
       for (let i = 0; i < errorContext.length; i++) {
-        if (!pointer.children) {
+        if (! pointer.children) {
           pointer.children = {};
         }
 
-        if (!has(pointer.children, errorContext[i])) {
+        if (! has(pointer.children, errorContext[i])) {
           pointer.children[errorContext[i]] = {};
         }
         pointer = pointer.children[errorContext[i]];
       }
 
-      if (!has(pointer, 'messages')) {
+      if (! has(pointer, 'messages')) {
         pointer.messages = [];
       }
 
@@ -1070,9 +1081,9 @@ function manageErrorMessage(errorContext, errorHolder, message, structured) {
  *
  * @returns {Promise}
  */
-function getValidationConfiguration() {
+function getValidationConfiguration () {
   return global.kuzzle.internalIndex
-    .search('validations', {}, {from: 0, size: 1000})
+    .search('validations', {}, { from: 0, size: 1000 })
     .then(result => {
       let validation = {};
 
@@ -1083,28 +1094,28 @@ function getValidationConfiguration() {
         for (const { _source, _id } of result.hits) {
           const collectionName = `${_id.split('#')[0]}/${_id.split('#')[1]}`;
 
-          if (!get(_source, 'index')) {
+          if (! get(_source, 'index')) {
             throw assertionError.get(
               'incorrect_validation_format',
               collectionName,
               'index');
           }
 
-          if (!get(_source, 'collection')) {
+          if (! get(_source, 'collection')) {
             throw assertionError.get(
               'incorrect_validation_format',
               collectionName,
               'collection');
           }
 
-          if (!get(_source, 'validation')) {
+          if (! get(_source, 'validation')) {
             throw assertionError.get(
               'incorrect_validation_format',
               collectionName,
               'validation');
           }
 
-          if (!has(validation, _source.index)) {
+          if (! has(validation, _source.index)) {
             validation[_source.index] = {};
           }
 

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

@@ -275,6 +275,18 @@
           "code": 48,
           "message": "An \"%s\" is not allowed to be associated with multiple \"%\". This is probably not linked to this request but rather the consequence of previous actions on ElasticSearch.",
           "class": "PreconditionError"
+        },
+        "invalid_multi_index_collection_usage": {
+          "description": "Searches on multiple collections should be achieved with the \"targets\" argument who contains list of indexes and collections to search within.",
+          "message": "Searches on multiple collections should be achieved with the \"targets\" argument who contains list of indexes and collections to search within.",
+          "code": 49,
+          "class": "BadRequestError"
+        },
+        "invalid_target_format": {
+          "description": "When a target index or collections contains invalid characters used for multi index search or \"_all\"",
+          "message": "The %s (\"%s\") contains invalid characters \",+*\" or is equal to \"_all\" which is forbidden",
+          "code": 50,
+          "class": "BadRequestError"
         }
       }
     },

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

@@ -87,6 +87,18 @@
           "code": 14,
           "message": "%s",
           "class": "BadRequestError"
+        },
+        "forbidden_stream": {
+          "description": "A forbidden HttpStream has been provided in a response",
+          "code": 15,
+          "message": "Cannot set an HttpStream as a request's response in a non-http protocol",
+          "class": "InternalError"
+        },
+        "unsupported_protocol": {
+          "description": "A request has been made with an unsupported protocol",
+          "code": 16,
+          "message": "The protocol \"%s\" is not supported by the API action \"%s\".",
+          "class": "InternalError"
         }
       }
     },

package/lib/kerror/codes/3-network.json

@@ -81,6 +81,18 @@
           "code": 13,
           "message": "Maximum HTTP file size exceeded",
           "class": "SizeLimitError"
+        },
+        "stream_closed": {
+          "description": "The stream has been closed or destroyed before sending the response",
+          "code": 14,
+          "message": "Stream closed or destroyed.",
+          "class": "InternalError"
+        },
+        "stream_errored": {
+          "description": "The stream is errored",
+          "code": 15,
+          "message": "Stream errored: %s",
+          "class": "InternalError"
         }
       }
     },