fix(errors): stacktraces of custom errors should include error message

lo1tuma · lo1tuma · commit 63eb59b11424 · 2017-08-23T16:57:01.000+02:00
diff --git a/lib/errors/cancelled-error.js b/lib/errors/cancelled-error.js
@@ -2,10 +2,7 @@
 
 module.exports = class CancelledError extends Error {
     constructor() {
-        super();
-
+        super('Browser request was cancelled');
         this.name = 'CancelledError';
-        this.message = 'Browser request was cancelled';
-        Error.captureStackTrace(this, CancelledError);
     }
 };
diff --git a/lib/errors/gemini-error.js b/lib/errors/gemini-error.js
@@ -1,16 +1,10 @@
 'use strict';
-/**
- * Special type of error that intended to be reported
- * to user. Will not print stack trace by default.
- */
-function GeminiError(message, advice) {
-    Error.captureStackTrace(this, GeminiError);
-    this.name = 'GeminiError';
-    this.message = message;
-    this.advice = advice;
-}
 
-GeminiError.prototype = Object.create(Error.prototype);
-GeminiError.prototype.constructor = GeminiError;
+module.exports = class GeminiError extends Error {
+    constructor(message, advice) {
+        super(message);
 
-module.exports = GeminiError;
+        this.name = 'GeminiError';
+        this.advice = advice;
+    }
+};
diff --git a/lib/errors/no-ref-image-error.js b/lib/errors/no-ref-image-error.js
@@ -1,22 +1,14 @@
 'use strict';
 
-var inherit = require('inherit'),
-    StateError = require('./state-error');
+const StateError = require('./state-error');
 
-var NoRefImageError = inherit(StateError, {
-    /**
-     * @constructor
-     * @param {String} refImagePath
-     * @param {StateResult} result
-     */
-    __constructor: function(refImagePath, currentPath) {
-        this.name = 'NoRefImageError';
-        this.message = 'Can not find reference image at ' + refImagePath + '.\n' +
-            'Run `gemini update` command to capture all reference images.';
+module.exports = class NoRefImageError extends StateError {
+    constructor(refImagePath, currentPath) {
+        super(`Can not find reference image at ${refImagePath}.\n` +
+            'Run `gemini update` command to capture all reference images.');
 
+        this.name = 'NoRefImageError';
         this.currentPath = currentPath;
         this.refImagePath = refImagePath;
     }
-});
-
-module.exports = NoRefImageError;
+};
diff --git a/lib/errors/state-error.js b/lib/errors/state-error.js
@@ -4,14 +4,12 @@
  * Non-fatal error, occurred during state run.
  * Fails only single state, not the whole app.
  */
-function StateError(message, originalError) {
-    Error.captureStackTrace(this, StateError);
-    this.name = 'StateError';
-    this.message = message;
-    this.originalError = originalError;
-}
 
-StateError.prototype = Object.create(Error.prototype);
-StateError.prototype.constructor = StateError;
+module.exports = class StateError extends Error {
+    constructor(message, originalError) {
+        super(message);
 
-module.exports = StateError;
+        this.name = 'StateError';
+        this.originalError = originalError;
+    }
+};
diff --git a/test/unit/errors/cancelled-error.js b/test/unit/errors/cancelled-error.js
@@ -0,0 +1,11 @@
+'use strict';
+
+const CancelledError = require('lib/errors/cancelled-error');
+
+describe('CancelledError', function() {
+    it('should include the error message in the stacktrace', function() {
+        const error = new CancelledError();
+
+        assert.match(error.stack, /^CancelledError: Browser request was cancelled\n/);
+    });
+});
diff --git a/test/unit/errors/gemini-error.js b/test/unit/errors/gemini-error.js
@@ -0,0 +1,11 @@
+'use strict';
+
+const GeminiError = require('lib/errors/gemini-error');
+
+describe('GeminiError', function() {
+    it('should include the given error message in the stacktrace', function() {
+        const error = new GeminiError('MyCustomErrorMessage');
+
+        assert.match(error.stack, /^GeminiError: MyCustomErrorMessage\n/);
+    });
+});
diff --git a/test/unit/errors/no-ref-image-error.js b/test/unit/errors/no-ref-image-error.js
@@ -0,0 +1,11 @@
+'use strict';
+
+const NoRefImageError = require('lib/errors/no-ref-image-error');
+
+describe('NoRefImageError', function() {
+    it('should include the error message in the stacktrace', function() {
+        const error = new NoRefImageError('anyPath');
+
+        assert.match(error.stack, /^NoRefImageError: Can not find reference image at anyPath.\n/);
+    });
+});
diff --git a/test/unit/errors/state-error.js b/test/unit/errors/state-error.js
@@ -0,0 +1,11 @@
+'use strict';
+
+const StateError = require('lib/errors/state-error');
+
+describe('StateError', function() {
+    it('should include the given error message in the stacktrace', function() {
+        const error = new StateError('MyCustomErrorMessage');
+
+        assert.match(error.stack, /^StateError: MyCustomErrorMessage\n/);
+    });
+});
