feat(error): use util.inspect() so CastError never prints "[object Ob…

…ject]" Fix #4398
Automattic · Aug 16, 2016 · f35cbde · f35cbde
1 parent 9b254ed
commit f35cbde
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 3 deletions.
diff --git a/lib/error/cast.js b/lib/error/cast.js
@@ -3,6 +3,7 @@
  */
 
 var MongooseError = require('../error.js');
+var util = require('util');
 
 /**
  * Casting Error constructor.
@@ -14,7 +15,13 @@ var MongooseError = require('../error.js');
  */
 
 function CastError(type, value, path, reason) {
-  MongooseError.call(this, 'Cast to ' + type + ' failed for value "' + value + '" at path "' + path + '"');
+  var stringValue = util.inspect(value);
+  stringValue = stringValue.replace(/^'/, '"').replace(/'$/, '"');
+  if (stringValue.charAt(0) !== '"') {
+    stringValue = '"' + stringValue + '"';
+  }
+  MongooseError.call(this, 'Cast to ' + type + ' failed for value ' +
+    stringValue + ' at path "' + path + '"');
   if (Error.captureStackTrace) {
     Error.captureStackTrace(this);
   } else {

diff --git a/test/model.querying.test.js b/test/model.querying.test.js
@@ -961,7 +961,7 @@ describe('model: querying:', function() {
             assert.equal(nes1.length, 1);
 
             NE.find({b: {$ne: [1]}}, function(err) {
-              assert.equal(err.message, 'Cast to ObjectId failed for value "1" at path "b"');
+              assert.equal(err.message, 'Cast to ObjectId failed for value "[ 1 ]" at path "b"');
 
               NE.find({b: {$ne: 4}}, function(err) {
                 assert.equal(err.message, 'Cast to ObjectId failed for value "4" at path "b"');

diff --git a/test/types.buffer.test.js b/test/types.buffer.test.js
@@ -72,7 +72,7 @@ describe('types.buffer', function() {
           assert.equal(err.name, 'ValidationError');
           assert.equal(err.errors.required.name, 'CastError');
           assert.equal(err.errors.required.kind, 'Buffer');
-          assert.equal(err.errors.required.message, 'Cast to Buffer failed for value "[object Object]" at path "required"');
+          assert.equal(err.errors.required.message, 'Cast to Buffer failed for value "{ x: [ 20 ] }" at path "required"');
           assert.deepEqual(err.errors.required.value, {x: [20]});
           t.required = new Buffer('hello');