@tryghost/mw-error-handler 0.2.2 → 1.0.0

package/lib/mw-error-handler.js

@@ -9,14 +9,14 @@ const messages = {
     pageNotFound: 'Page not found',
     resourceNotFound: 'Resource not found',
     methodNotAcceptableVersionAhead: {
-        message: 'Request not acceptable for provided Accept-Version header.',
-        context: 'Provided client version {acceptVersion} is ahead of current Ghost instance version {ghostVersion}.',
-        help: 'Upgrade your Ghost instance.'
+        message: 'Request could not be served, the endpoint was not found.',
+        context: 'Provided client accept-version {acceptVersion} is ahead of current Ghost version {ghostVersion}.',
+        help: 'Try upgrading your Ghost install.'
     },
     methodNotAcceptableVersionBehind: {
-        message: 'Request not acceptable for provided Accept-Version header.',
-        context: 'Provided client version {acceptVersion} is outdated and is behind current Ghost version {ghostVersion}.',
-        help: 'Upgrade your Ghost API client.'
+        message: 'Request could not be served, the endpoint was not found.',
+        context: 'Provided client accept-version {acceptVersion} is behind current Ghost version {ghostVersion}.',
+        help: 'Try upgrading your Ghost API client.'
     },
     actions: {
         images: {
@@ -105,31 +105,19 @@ module.exports.prepareStack = (err, req, res, next) => { // eslint-disable-line
 };
 
 const jsonErrorRenderer = (err, req, res, next) => { // eslint-disable-line no-unused-vars
-    res.json({
-        errors: [{
-            message: err.message,
-            context: err.context,
-            help: err.help,
-            errorType: err.errorType,
-            errorDetails: err.errorDetails,
-            ghostErrorCode: err.ghostErrorCode
-        }]
-    });
-};
-
-const jsonErrorRendererV2 = (err, req, res, next) => { // eslint-disable-line no-unused-vars
     const userError = prepareUserMessage(err, req);
 
     res.json({
         errors: [{
-            message: userError.message || null,
+            message: userError.message,
             context: userError.context || null,
             type: err.errorType || null,
             details: err.errorDetails || null,
             property: err.property || null,
             help: err.help || null,
             code: err.code || null,
-            id: err.id || null
+            id: err.id || null,
+            ghostErrorCode: err.ghostErrorCode || null
         }]
     });
 };
@@ -193,9 +181,9 @@ module.exports.resourceNotFound = (req, res, next) => {
             semver.coerce(res.locals.safeVersion)
         );
 
-        let errorOptions;
+        let notAcceptableError;
         if (versionComparison === 1) {
-            errorOptions = {
+            notAcceptableError = new errors.RequestNotAcceptableError({
                 message: tpl(
                     messages.methodNotAcceptableVersionAhead.message
                 ),
@@ -205,9 +193,9 @@ module.exports.resourceNotFound = (req, res, next) => {
                 }),
                 help: tpl(messages.methodNotAcceptableVersionAhead.help),
                 code: 'UPDATE_GHOST'
-            };
+            });
         } else {
-            errorOptions = {
+            notAcceptableError = new errors.RequestNotAcceptableError({
                 message: tpl(
                     messages.methodNotAcceptableVersionBehind.message
                 ),
@@ -217,10 +205,10 @@ module.exports.resourceNotFound = (req, res, next) => {
                 }),
                 help: tpl(messages.methodNotAcceptableVersionBehind.help),
                 code: 'UPDATE_CLIENT'
-            };
+            });
         }
 
-        next(new errors.RequestNotAcceptableError(errorOptions));
+        next(notAcceptableError);
     } else {
         next(new errors.NotFoundError({message: tpl(messages.resourceNotFound)}));
     }
@@ -241,17 +229,6 @@ module.exports.handleJSONResponse = sentry => [
     jsonErrorRenderer
 ];
 
-module.exports.handleJSONResponseV2 = sentry => [
-    // Make sure the error can be served
-    module.exports.prepareError,
-    // Handle the error in Sentry
-    sentry.errorHandler,
-    // Format the stack for the user
-    module.exports.prepareStack,
-    // Render the error using JSON format
-    jsonErrorRendererV2
-];
-
 module.exports.handleHTMLResponse = sentry => [
     // Make sure the error can be served
     module.exports.prepareError,
@@ -260,4 +237,3 @@ module.exports.handleHTMLResponse = sentry => [
     // Format the stack for the user
     module.exports.prepareStack
 ];
-

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@tryghost/mw-error-handler",
-  "version": "0.2.2",
+  "version": "1.0.0",
   "repository": "https://github.com/TryGhost/Utils/tree/main/packages/mw-error-handler",
   "author": "Ghost Foundation",
   "license": "MIT",
   "main": "index.js",
   "scripts": {
     "dev": "echo \"Implement me!\"",
-    "test": "NODE_ENV=testing c8 --all --check-coverage --reporter text --reporter cobertura mocha './test/**/*.test.js'",
+    "test": "NODE_ENV=testing c8 --all --check-coverage --100 --reporter text --reporter cobertura mocha './test/**/*.test.js'",
     "lint": "eslint . --ext .js --cache",
     "posttest": "yarn lint"
   },
@@ -20,9 +20,9 @@
   },
   "devDependencies": {
     "c8": "7.11.2",
-    "mocha": "9.1.3",
+    "mocha": "10.0.0",
     "should": "13.2.3",
-    "sinon": "12.0.1"
+    "sinon": "13.0.2"
   },
   "dependencies": {
     "@tryghost/debug": "^0.1.9",
@@ -31,5 +31,5 @@
     "lodash": "^4.17.21",
     "semver": "^7.3.6"
   },
-  "gitHead": "9a90e404200df76c6e4e3056f89d73eb69c9013e"
+  "gitHead": "9bce5a81753e041e55b86f654c97924562eb7709"
 }