@tryghost/errors 1.0.3 → 1.2.0

package/lib/errors.js

@@ -59,7 +59,10 @@ class GhostError extends Error {
                 }
 
                 if (property === 'stack') {
-                    this[property] += '\n\n' + options.err[property];
+                    if (this.hideStack) {
+                        return;
+                    }
+                    this[property] = utils.wrapStack(this, options.err);
                     return;
                 }
 
@@ -95,7 +98,8 @@ const ghostErrors = {
             super(merge({
                 statusCode: 404,
                 errorType: 'NotFoundError',
-                message: 'Resource could not be found.'
+                message: 'Resource could not be found.',
+                hideStack: true
             }, options));
         }
     },
@@ -299,6 +303,14 @@ const ghostErrors = {
                 hideStack: true
             }, options));
         }
+    },
+    ConflictError: class ConflictError extends GhostError {
+        constructor(options) {
+            super(merge({
+                errorType: 'ConflictError',
+                statusCode: 409
+            }, options));
+        }
     }
 };
 
@@ -308,5 +320,6 @@ const ghostErrorsWithBase = Object.assign({}, ghostErrors, {GhostError});
 module.exports.utils = {
     serialize: utils.serialize.bind(ghostErrorsWithBase),
     deserialize: utils.deserialize.bind(ghostErrorsWithBase),
-    isGhostError: utils.isGhostError.bind(ghostErrorsWithBase)
+    isGhostError: utils.isGhostError.bind(ghostErrorsWithBase),
+    prepareStackForUser: utils.prepareStackForUser
 };

package/lib/utils.js

@@ -127,6 +127,12 @@ _private.JSONAPIDeserialize = function JSONAPIDeserialize(errorFormat) {
     return internalError;
 };
 
+exports.wrapStack = function wrapStack(err, internalErr) {
+    const extraLine = err.stack.split(/\n/g)[1];
+    const [firstLine, ...rest] = internalErr.stack.split(/\n/g);
+    return [firstLine, extraLine, ...rest].join('\n');
+};
+
 /**
  * @description Serialize GhostError instance to error JSON format
  *
@@ -177,11 +183,42 @@ exports.deserialize = function deserialize(errorFormat) {
     return internalError;
 };
 
+/**
+ * @description Replace the stack with a user-facing one
+ * @params {Error} err
+ */
+exports.prepareStackForUser = function prepareStackForUser(error) {
+    let stackbits = error.stack.split(/\n/);
+
+    // We build this up backwards, so we always insert at position 1
+
+    if (process.env.NODE_ENV === 'production') {
+        stackbits.splice(1, stackbits.length - 1);
+    } else {
+        // Clearly mark the strack trace
+        stackbits.splice(1, 0, `Stack Trace:`);
+    }
+
+    // Add in our custom cotext and help methods
+
+    if (this.help) {
+        stackbits.splice(1, 0, `${this.help}`);
+    }
+
+    if (this.context) {
+        stackbits.splice(1, 0, `${this.context}`);
+    }
+
+    error.stack = stackbits.join('\n');
+    return error;
+};
+
 /**
  * @description Check whether an error instance is a GhostError.
  */
 exports.isGhostError = function isGhostError(err) {
     const errorName = this.GhostError.name;
+    const legacyErrorName = 'IgnitionError';
 
     const recursiveIsGhostError = function recursiveIsGhostError(obj) {
         // no super constructor available anymore
@@ -189,7 +226,7 @@ exports.isGhostError = function isGhostError(err) {
             return false;
         }
 
-        if (obj.name === errorName) {
+        if (obj.name === errorName || obj.name === legacyErrorName) {
             return true;
         }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/errors",
-  "version": "1.0.3",
+  "version": "1.2.0",
   "repository": "https://github.com/TryGhost/Utils/tree/main/packages/errors",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -28,5 +28,5 @@
     "lodash": "^4.17.21",
     "uuid": "^8.3.2"
   },
-  "gitHead": "d4cd268b6c74e681b17497db0a50af9d87d1d4e3"
+  "gitHead": "8ecf8264002298829fbce686a1bd0ad413e2e01b"
 }