@tryghost/errors 1.2.3 → 1.2.6

package/lib/errors.js

@@ -4,9 +4,7 @@ const isString = require('lodash/isString');
 const utils = require('./utils');
 
 class GhostError extends Error {
-    constructor(options) {
-        options = options || {};
-
+    constructor(options = {}) {
         super();
 
         /**
@@ -34,7 +32,7 @@ class GhostError extends Error {
         this.redirect = options.redirect || null;
 
         this.message = options.message || this.message;
-        this.hideStack = options.hideStack;
+        this.hideStack = options.hideStack || false;
 
         // NOTE: Error to inherit from, override!
         //       Nested objects are getting copied over in one piece (can be changed, but not needed right now)
@@ -52,16 +50,13 @@ class GhostError extends Error {
                 }
 
                 // CASE: `code` should put options as priority over err
-                if (property === 'code') {  
+                if (property === 'code') {
                     // @ts-ignore
                     this[property] = this[property] || options.err[property];
                     return;
                 }
 
-                if (property === 'stack') {
-                    if (this.hideStack) {
-                        return;
-                    }
+                if (property === 'stack' && !this.hideStack) {
                     this[property] = utils.wrapStack(this, options.err);
                     return;
                 }
@@ -206,7 +201,8 @@ const ghostErrors = {
         constructor(options) {
             super(merge({
                 statusCode: 500,
-                errorType: 'DataExportError'
+                errorType: 'DataExportError',
+                message: 'The server encountered an error whilst exporting data.'
             }, options));
         }
     },
@@ -214,16 +210,8 @@ const ghostErrors = {
         constructor(options) {
             super(merge({
                 statusCode: 500,
-                errorType: 'DataImportError'
-            }, options));
-        }
-    },
-    DatabaseVersionError: class DatabaseVersionError extends GhostError {
-        constructor(options) {
-            super(merge({
-                hideStack: true,
-                statusCode: 500,
-                errorType: 'DatabaseVersionError'
+                errorType: 'DataImportError',
+                message: 'The server encountered an error whilst importing data.'
             }, options));
         }
     },
@@ -231,7 +219,8 @@ const ghostErrors = {
         constructor(options) {
             super(merge({
                 statusCode: 500,
-                errorType: 'EmailError'
+                errorType: 'EmailError',
+                message: 'The server encountered an error whilst sending email.'
             }, options));
         }
     },
@@ -240,6 +229,7 @@ const ghostErrors = {
             super(merge({
                 statusCode: 422,
                 errorType: 'ThemeValidationError',
+                message: 'The theme has a validation error.',
                 errorDetails: {}
             }, options));
         }
@@ -248,7 +238,8 @@ const ghostErrors = {
         constructor(options) {
             super(merge({
                 statusCode: 409,
-                errorType: 'DisabledFeatureError'
+                errorType: 'DisabledFeatureError',
+                message: 'Unable to complete the request, this feature is disabled.'
             }, options));
         }
     },
@@ -256,7 +247,8 @@ const ghostErrors = {
         constructor(options) {
             super(merge({
                 statusCode: 409,
-                errorType: 'UpdateCollisionError'
+                errorType: 'UpdateCollisionError',
+                message: 'Unable to complete the request, there was a conflict.'
             }, options));
         }
     },
@@ -265,7 +257,8 @@ const ghostErrors = {
             super(merge({
                 errorType: 'HostLimitError',
                 hideStack: true,
-                statusCode: 403
+                statusCode: 403,
+                message: 'Unable to complete the request, this resource is limited.'
             }, options));
         }
     },
@@ -273,7 +266,9 @@ const ghostErrors = {
         constructor(options) {
             super(merge({
                 errorType: 'HelperWarning',
-                hideStack: true
+                hideStack: true,
+                statusCode: 400,
+                message: 'A theme helper has done something unexpected.'
             }, options));
         }
     },
@@ -308,7 +303,8 @@ const ghostErrors = {
         constructor(options) {
             super(merge({
                 errorType: 'ConflictError',
-                statusCode: 409
+                statusCode: 409,
+                message: 'The server has encountered an conflict.'
             }, options));
         }
     }

package/lib/utils.js

@@ -1,6 +1,7 @@
 const omit = require('lodash/omit');
 const merge = require('lodash/merge');
 const extend = require('lodash/extend');
+const cloneError = require('utils-copy-error');
 const _private = {};
 
 _private.serialize = function serialize(err) {
@@ -27,21 +28,15 @@ _private.serialize = function serialize(err) {
 };
 
 _private.deserialize = function deserialize(obj) {
-    try {
-        return {
-            id: obj.id,
-            message: obj.detail || obj.error_description || obj.message,
-            statusCode: obj.status,
-            code: obj.code || obj.error,
-            level: obj.meta && obj.meta.level,
-            help: obj.meta && obj.meta.help,
-            context: obj.meta && obj.meta.context
-        };
-    } catch (err) {
-        return {
-            message: 'Something went wrong.'
-        };
-    }
+    return {
+        id: obj.id,
+        message: obj.detail || obj.error_description || obj.message,
+        statusCode: obj.status,
+        code: obj.code || obj.error,
+        level: obj.meta && obj.meta.level,
+        help: obj.meta && obj.meta.help,
+        context: obj.meta && obj.meta.context
+    };
 };
 
 /**
@@ -186,6 +181,7 @@ exports.deserialize = function deserialize(errorFormat) {
 /**
  * @description Replace the stack with a user-facing one
  * @params {Error} err
+ * @returns {Error} Clone of the original error with a user-facing stack
  */
 exports.prepareStackForUser = function prepareStackForUser(error) {
     let stackbits = error.stack.split(/\n/);
@@ -200,17 +196,17 @@ exports.prepareStackForUser = function prepareStackForUser(error) {
     }
 
     // Add in our custom cotext and help methods
-
-    if (this.help) {
-        stackbits.splice(1, 0, `${this.help}`);
+    if (error.help) {
+        stackbits.splice(1, 0, `${error.help}`);
     }
 
-    if (this.context) {
-        stackbits.splice(1, 0, `${this.context}`);
+    if (error.context) {
+        stackbits.splice(1, 0, `${error.context}`);
     }
 
-    error.stack = stackbits.join('\n');
-    return error;
+    const errorClone = cloneError(error);
+    errorClone.stack = stackbits.join('\n');
+    return errorClone;
 };
 
 /**
@@ -234,4 +230,4 @@ exports.isGhostError = function isGhostError(err) {
     };
 
     return recursiveIsGhostError(err.constructor);
-};
+};

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@tryghost/errors",
-  "version": "1.2.3",
+  "version": "1.2.6",
   "repository": "https://github.com/TryGhost/framework/tree/main/packages/errors",
   "author": "Ghost Foundation",
   "license": "MIT",
   "main": "index.js",
   "scripts": {
     "dev": "echo \"Implement me!\"",
-    "test": "NODE_ENV=testing c8 --all --reporter text --reporter cobertura mocha './test/**/*.test.js'",
+    "test": "NODE_ENV=testing c8 --check-coverage --all --reporter text --reporter cobertura  mocha './test/**/*.test.js'",
     "lint": "eslint . --ext .js --cache",
     "posttest": "yarn lint"
   },
@@ -20,13 +20,14 @@
   },
   "devDependencies": {
     "c8": "7.11.0",
-    "mocha": "9.2.1",
+    "mocha": "9.2.2",
     "should": "13.2.3",
     "sinon": "13.0.1"
   },
   "dependencies": {
     "lodash": "^4.17.21",
+    "utils-copy-error": "1.0.1",
     "uuid": "^8.3.2"
   },
-  "gitHead": "64606b3f53d3ec8e6bf988f694d9dc4bbf5fac70"
+  "gitHead": "b71a3cb711cae3a1981e925d29780c9bfaacf3c3"
 }