Fixing validation problem with sets

Author: Gerkin

build/isolated/dist/diaspora.js

@@ -1958,8 +1958,9 @@ Diaspora.components = {
 	Set:    require( './set' ),
 	Model:  require( './model' ),
 	Errors: {
-		ValidationError:  require( './errors/validationError' ),
-		EntityStateError: require( './errors/entityStateError' ),
+		EntityValidationError: require( './errors/entityValidationError' ),
+		SetValidationError:    require( './errors/setValidationError' ),
+		EntityStateError:      require( './errors/entityStateError' ),
 	},
 	DiasporaAdapter: require( './adapters/baseAdapter' ),
 	DataStoreEntity: require( './dataStoreEntities/baseEntity' ),
@@ -1973,15 +1974,15 @@ if ( process.browser ) {
 }
 
 }).call(this,require('_process'))
-},{"./adapters/baseAdapter":2,"./adapters/browserStorageAdapter":3,"./adapters/inMemoryAdapter":4,"./dataStoreEntities/baseEntity":5,"./dependencies":8,"./entityFactory":10,"./errors/entityStateError":11,"./errors/validationError":13,"./model":14,"./set":15,"_process":17,"winston":undefined}],10:[function(require,module,exports){
+},{"./adapters/baseAdapter":2,"./adapters/browserStorageAdapter":3,"./adapters/inMemoryAdapter":4,"./dataStoreEntities/baseEntity":5,"./dependencies":8,"./entityFactory":10,"./errors/entityStateError":11,"./errors/entityValidationError":12,"./errors/setValidationError":14,"./model":15,"./set":16,"_process":18,"winston":undefined}],10:[function(require,module,exports){
 'use strict';
 
 const {
 	_, Promise, SequentialEvent,
 } = require( './dependencies' );
 const Diaspora = require( './diaspora' );
 const DataStoreEntity = require( './dataStoreEntities/baseEntity' );
-const ValidationError = require( './errors/validationError' );
+const EntityValidationError = require( './errors/entityValidationError' );
 const EntityStateError = require( './errors/entityStateError' );
 const Utils = require( './utils' );
 
@@ -2275,14 +2276,14 @@ function EntityFactory( name, modelDesc, model ) {
 				 * @memberof EntityFactory.Entity
 				 * @instance
 				 * @author gerkin
-				 * @throws ValidationError Thrown if validation failed. This breaks event chain and prevent persistance.
+				 * @throws EntityValidationError Thrown if validation failed. This breaks event chain and prevent persistance.
 				 * @returns {undefined} This function does not return anything.
 				 * @see Diaspora.check
 				 */
 				validate() {
 					const validationErrors = Diaspora.check( attributes, modelDesc.attributes );
 					if ( !_.isEmpty( validationErrors )) {
-						throw new ValidationError( validationErrors, 'Validation failed' );
+						throw new EntityValidationError( validationErrors, 'Validation failed' );
 					}
 				},
 			};
@@ -2471,7 +2472,7 @@ function EntityFactory( name, modelDesc, model ) {
 
 module.exports = EntityFactory;
 
-},{"./dataStoreEntities/baseEntity":5,"./dependencies":8,"./diaspora":9,"./errors/entityStateError":11,"./errors/validationError":13,"./utils":16}],11:[function(require,module,exports){
+},{"./dataStoreEntities/baseEntity":5,"./dependencies":8,"./diaspora":9,"./errors/entityStateError":11,"./errors/entityValidationError":12,"./utils":17}],11:[function(require,module,exports){
 'use strict';
 
 const ExtendableError = require( './extendableError' );
@@ -2495,7 +2496,49 @@ class EntityStateError extends ExtendableError {
 
 module.exports = EntityStateError;
 
-},{"./extendableError":12}],12:[function(require,module,exports){
+},{"./extendableError":13}],12:[function(require,module,exports){
+'use strict';
+
+const {
+	_,
+} = require( '../dependencies' );
+const ExtendableError = require( './extendableError' );
+
+const stringifyValidationObject = validationErrors => {
+	return _( validationErrors ).mapValues(( error, key ) => {
+		return `${ key } => ${ JSON.stringify( error.value ) }
+* ${ _( error ).omit([ 'value' ]).values().map( _.identity ).value() }`;
+	}).values().join( '\n* ' );
+};
+
+/**
+ * This class represents an error related to validation.
+ *
+ * @extends Error
+ * @memberof Errors
+ */
+class EntityValidationError extends ExtendableError {
+	/**
+	 * Construct a new validation error.
+	 *
+	 * @author gerkin
+	 * @see Diaspora.check
+	 * @memberof Errors
+	 * @param {Object} validationErrors - Object describing validation errors, usually returned by {@link Diaspora.check}.
+	 * @param {string} message          - Message of this error.
+	 * @param {*}      errorArgs        - Arguments to transfer to parent Error.
+	 */
+	constructor( validationErrors, message, ...errorArgs ) {
+		message += `
+${ stringifyValidationObject( validationErrors ) }`;
+		super( message, ...errorArgs );
+		this.validationErrors = validationErrors;
+	}
+}
+
+module.exports = EntityValidationError;
+
+},{"../dependencies":8,"./extendableError":13}],13:[function(require,module,exports){
 'use strict';
 
 /**
@@ -2527,47 +2570,48 @@ class ExtendableError extends Error {
 
 module.exports = ExtendableError;
 
-},{}],13:[function(require,module,exports){
+},{}],14:[function(require,module,exports){
 'use strict';
 
 const {
 	_,
 } = require( '../dependencies' );
 const ExtendableError = require( './extendableError' );
 
-const stringifyValidationObject = validationErrors => {
-	return _( validationErrors ).mapValues(( error, key ) => {
-		return `${ key } => ${ JSON.stringify( error.value ) }
-* ${ _( error ).omit([ 'value' ]).values().map( _.identity ).value() }`;
-	}).values().join( '\n* ' );
-};
 
 /**
- * This class represents an error related to validation.
+ * This class represents an error related to validation on a set.
+ *
  * @extends Error
+ * @memberof Errors
  */
-class ValidationError extends ExtendableError {
+class SetValidationError extends ExtendableError {
 	/**
 	 * Construct a new validation error.
-	 * 
+	 *
 	 * @author gerkin
 	 * @see Diaspora.check
 	 * @memberof Errors
-	 * @param {Object} validationErrors - Object describing validation errors, usually returned by {@link Diaspora.check}.
-	 * @param {string} message          - Message of this error.
-	 * @param {*}      errorArgs        - Arguments to transfer to parent Error.
-	 */
-	constructor( validationErrors, message, ...errorArgs ) {
-		message += `
-${ stringifyValidationObject( validationErrors ) }`;
+	 * @param {string}                         message          - Message of this error.
+	 * @param {Errors.EntityValidationError[]} validationErrors - Array of validation errors.
+	 * @param {*}                              errorArgs        - Arguments to transfer to parent Error.
+	 */
+	constructor( message, validationErrors, ...errorArgs ) {
+		message += `[\n${ _( validationErrors ).map(( error, index ) => {
+			if ( _.isNil( error )) {
+				return false;
+			} else {
+				return `${ index  }: ${  error.message.replace( /\n/g, '\n	' ) }`;
+			}
+		}).filter( _.identity ).join( ',\n' ) }\n]`;
 		super( message, ...errorArgs );
 		this.validationErrors = validationErrors;
 	}
 }
 
-module.exports = ValidationError;
+module.exports = SetValidationError;
 
-},{"../dependencies":8,"./extendableError":12}],14:[function(require,module,exports){
+},{"../dependencies":8,"./extendableError":13}],15:[function(require,module,exports){
 'use strict';
 
 const {
@@ -2860,21 +2904,22 @@ class Model {
 
 module.exports = Model;
 
-},{"./dependencies":8,"./diaspora":9,"./entityFactory":10,"./set":15}],15:[function(require,module,exports){
+},{"./dependencies":8,"./diaspora":9,"./entityFactory":10,"./set":16}],16:[function(require,module,exports){
 'use strict';
 
 const {
 	_, Promise,
 } = require( './dependencies' );
 const Utils = require( './utils' );
+const SetValidationError = require( './errors/setValidationError' );
 
 /**
  * Collections are used to manage multiple entities at the same time. You may try to use this class as an array.
  */
 class Set {
 	/**
 	 * Create a new set, managing provided `entities` that must be generated from provided `model`.
-	 * 
+	 *
 	 * @param {Model}           model    - Model describing entities managed by this set.
 	 * @param {Entity|Entity[]} entities - Entities to manage with this set. Arguments are flattened, so you can provide as many nested arrays as you want.
 	 */
@@ -2887,7 +2932,7 @@ class Set {
 		const defined = Utils.defineEnumerableProperties( this, {
 			/**
 			 * List entities of this set.
-			 * 
+			 *
 			 * @name entities
 			 * @readonly
 			 * @memberof Set
@@ -2898,7 +2943,7 @@ class Set {
 			entities: entities,
 			/**
 			 * Model that generated this set.
-			 * 
+			 *
 			 * @name model
 			 * @readonly
 			 * @memberof Set
@@ -2909,7 +2954,7 @@ class Set {
 			model:    model,
 			/**
 			 * Number of entities in this set.
-			 * 
+			 *
 			 * @name length
 			 * @readonly
 			 * @memberof Set
@@ -2947,7 +2992,7 @@ class Set {
 
 	/**
 	 * Check if all entities in the first argument are from the expected model.
-	 * 
+	 *
 	 * @author gerkin
 	 * @throws {TypeError} Thrown if one of the entity is not from provided `model`.
 	 * @param {Entity[]} entities - Array of entities to check.
@@ -2964,7 +3009,7 @@ class Set {
 
 	/**
 	 * Persist all entities of this collection.
-	 * 
+	 *
 	 * @fires EntityFactory.Entity#beforeUpdate
 	 * @fires EntityFactory.Entity#afterUpdate
 	 * @author gerkin
@@ -2977,7 +3022,21 @@ class Set {
 		return Promise.all( this.entities.map( entity => entity.emit( 'beforePersist' ))).then(() => {
 			return Promise.all( this.entities.map( entity => entity.emit( 'beforeValidate' )));
 		}).then(() => {
-			return this.entities.map( entity => entity.validate());
+			let errors = 0;
+			const validationResults = this.entities.map( entity => {
+				try {
+					entity.validate();
+					return undefined;
+				} catch ( e ) {
+					errors++;
+					return e;
+				}
+			}).value();
+			if ( errors > 0 ) {
+				return Promise.reject( new SetValidationError( `Set validation failed for ${ errors } elements (on ${ this.length }): `, validationResults ));
+			} else {
+				return Promise.resolve();
+			}
 		}).then(() => {
 			return Promise.all( this.entities.map( entity => entity.emit( 'afterValidate' )));
 		}).then(() => {
@@ -2995,7 +3054,7 @@ class Set {
 
 	/**
 	 * Reload all entities of this collection.
-	 * 
+	 *
 	 * @fires EntityFactory.Entity#beforeFind
 	 * @fires EntityFactory.Entity#afterFind
 	 * @author gerkin
@@ -3015,7 +3074,7 @@ class Set {
 
 	/**
 	 * Destroy all entities from this collection.
-	 * 
+	 *
 	 * @fires EntityFactory.Entity#beforeDelete
 	 * @fires EntityFactory.Entity#afterDelete
 	 * @author gerkin
@@ -3035,7 +3094,7 @@ class Set {
 
 	/**
 	 * Update all entities in the set with given object.
-	 * 
+	 *
 	 * @author gerkin
 	 * @param   {Object} newData - Attributes to change in each entity of the collection.
 	 * @returns {Collection} `this`.
@@ -3056,7 +3115,7 @@ class Set {
 
 module.exports = Set;
 
-},{"./dependencies":8,"./utils":16}],16:[function(require,module,exports){
+},{"./dependencies":8,"./errors/setValidationError":14,"./utils":17}],17:[function(require,module,exports){
 'use strict';
 
 const {
@@ -3084,7 +3143,7 @@ module.exports = {
 	},
 };
 
-},{"./dependencies":8}],17:[function(require,module,exports){
+},{"./dependencies":8}],18:[function(require,module,exports){
 // shim for using process in browser
 var process = module.exports = {};