Merge pull request #5146 from Automattic/3064

feat(validation): include failed paths in error message and inspect output

Author: vkarpov15

lib/error/validation.js

@@ -14,10 +14,13 @@ var MongooseError = require('../error.js');
 
 function ValidationError(instance) {
   this.errors = {};
+  this._message = '';
   if (instance && instance.constructor.name === 'model') {
-    MongooseError.call(this, instance.constructor.modelName + ' validation failed');
+    this._message = instance.constructor.modelName + ' validation failed';
+    MongooseError.call(this, this._message);
   } else {
-    MongooseError.call(this, 'Validation failed');
+    this._message = 'Validation failed';
+    MongooseError.call(this, this._message);
   }
   if (Error.captureStackTrace) {
     Error.captureStackTrace(this);
@@ -37,24 +40,49 @@ function ValidationError(instance) {
 ValidationError.prototype = Object.create(MongooseError.prototype);
 ValidationError.prototype.constructor = MongooseError;
 
+Object.defineProperty(ValidationError.prototype, 'message', {
+  get: function() {
+    return this._message + ': ' + _generateMessage(this);
+  },
+  enumerable: true
+});
 
 /**
  * Console.log helper
  */
 
 ValidationError.prototype.toString = function() {
-  var ret = this.name + ': ';
+  return this.name + ': ' + _generateMessage(this);
+};
+
+/*!
+ * inspect helper
+ */
+
+ValidationError.prototype.inspect = function() {
+  return Object.assign(new Error(this.message), this);
+};
+
+/*!
+ * ignore
+ */
+
+function _generateMessage(err) {
+  var keys = Object.keys(err.errors || {});
+  var len = keys.length;
   var msgs = [];
+  var key;
 
-  Object.keys(this.errors || {}).forEach(function(key) {
-    if (this === this.errors[key]) {
-      return;
+  for (var i = 0; i < len; ++i) {
+    key = keys[i];
+    if (err === err.errors[key]) {
+      continue;
     }
-    msgs.push(String(this.errors[key]));
-  }, this);
+    msgs.push(key + ': ' + err.errors[key].message);
+  }
 
-  return ret + msgs.join(', ');
-};
+  return msgs.join(', ');
+}
 
 /*!
  * Module exports

test/document.test.js

@@ -1272,7 +1272,7 @@ describe('document', function() {
         var m = new M({name: 'gh1109-2', arr: [1]});
         assert.equal(called, false);
         m.save(function(err) {
-          assert.equal(String(err), 'ValidationError: BAM');
+          assert.equal(String(err), 'ValidationError: arr: BAM');
           assert.equal(called, true);
           m.arr.push(2);
           called = false;
@@ -1301,7 +1301,7 @@ describe('document', function() {
           assert.equal(err.errors.arr.message, 'Path `arr` is required.');
           m.arr.push({nice: true});
           m.save(function(err) {
-            assert.equal(String(err), 'ValidationError: BAM');
+            assert.equal(String(err), 'ValidationError: arr: BAM');
             m.arr.push(95);
             m.save(function(err) {
               assert.ifError(err);

test/model.populate.test.js

@@ -2023,7 +2023,8 @@ describe('model: populate:', function() {
       });
 
       comment.save(function(err) {
-        assert.equal('CommentWithRequiredField validation failed', err && err.message);
+        assert.ok(err);
+        assert.ok(err.message.indexOf('CommentWithRequiredField validation failed') === 0, err.message);
         assert.ok('num' in err.errors);
         assert.ok('str' in err.errors);
         assert.ok('user' in err.errors);

test/model.test.js

@@ -1139,7 +1139,7 @@ describe('Model', function() {
         db.close();
         assert.equal(err.errors.name.message, 'Name cannot be greater than 1 character for path "name" with value `hi`');
         assert.equal(err.name, 'ValidationError');
-        assert.equal(err.message, 'IntrospectionValidation validation failed');
+        assert.ok(err.message.indexOf('IntrospectionValidation validation failed') !== -1, err.message);
         done();
       });
     });

test/schema.validation.test.js

@@ -1057,7 +1057,7 @@ describe('schema', function() {
       bad.foods = 'waffles';
       bad.validate(function(error) {
         assert.ok(error);
-        var errorMessage = 'CastError: Cast to Object failed for value ' +
+        var errorMessage = 'foods: Cast to Object failed for value ' +
             '"waffles" at path "foods"';
         assert.ok(error.toString().indexOf(errorMessage) !== -1, error.toString());
         done();
@@ -1071,7 +1071,7 @@ describe('schema', function() {
       var bad = new Breakfast({});
       bad.validate(function(error) {
         assert.ok(error);
-        var errorMessage = 'ValidationError: Path `description` is required.';
+        var errorMessage = 'ValidationError: description: Path `description` is required.';
         assert.equal(errorMessage, error.toString());
         done();
       });
@@ -1085,7 +1085,7 @@ describe('schema', function() {
       var error = bad.validateSync();
 
       assert.ok(error);
-      var errorMessage = 'ValidationError: Path `description` is required.';
+      var errorMessage = 'ValidationError: description: Path `description` is required.';
       assert.equal(errorMessage, error.toString());
       done();
     });
@@ -1114,7 +1114,7 @@ describe('schema', function() {
       var bad = new Breakfast({});
       bad.validate(function(error) {
         assert.ok(error);
-        var errorMessage = 'ValidationError: Path `description` is required.';
+        var errorMessage = 'ValidationError: description: Path `description` is required.';
         assert.equal(errorMessage, error.toString());
         done();
       });
@@ -1132,7 +1132,7 @@ describe('schema', function() {
       var Breakfast = mongoose.model('gh2832', breakfast, 'gh2832');
       Breakfast.create({description: undefined}, function(error) {
         assert.ok(error);
-        var errorMessage = 'ValidationError: CastError: Cast to String failed for value "undefined" at path "description"';
+        var errorMessage = 'ValidationError: description: Cast to String failed for value "undefined" at path "description"';
         assert.equal(errorMessage, error.toString());
         assert.ok(error.errors.description);
         assert.equal(error.errors.description.reason.toString(), 'Error: oops');

test/types.buffer.test.js

@@ -69,7 +69,7 @@ describe('types.buffer', function() {
       });
 
       t.validate(function(err) {
-        assert.equal(err.message, 'UserBuffer validation failed');
+        assert.ok(err.message.indexOf('UserBuffer validation failed') === 0, err.message);
         assert.equal(err.errors.required.kind, 'required');
         t.required = {x: [20]};
         t.save(function(err) {
@@ -83,11 +83,11 @@ describe('types.buffer', function() {
 
           t.sub.push({name: 'Friday Friday'});
           t.save(function(err) {
-            assert.equal(err.message, 'UserBuffer validation failed');
+            assert.ok(err.message.indexOf('UserBuffer validation failed') === 0, err.message);
             assert.equal(err.errors['sub.0.buf'].kind, 'required');
             t.sub[0].buf = new Buffer('well well');
             t.save(function(err) {
-              assert.equal(err.message, 'UserBuffer validation failed');
+              assert.ok(err.message.indexOf('UserBuffer validation failed') === 0, err.message);
               assert.equal(err.errors['sub.0.buf'].kind, 'user defined');
               assert.equal(err.errors['sub.0.buf'].message, 'valid failed');