@tryghost/mw-error-handler 0.2.0 → 0.2.3

package/lib/mw-error-handler.js

@@ -8,12 +8,12 @@ const tpl = require('@tryghost/tpl');
 const messages = {
     pageNotFound: 'Page not found',
     resourceNotFound: 'Resource not found',
-    methodNotAcceptableVersionBehind: {
+    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.'
     },
-    methodNotAcceptableVersionAhead: {
+    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.'
@@ -130,6 +130,7 @@ const jsonErrorRendererV2 = (err, req, res, next) => { // eslint-disable-line no
             help: err.help || null,
             code: err.code || null,
             id: err.id || null
+            // @TODO: add ghostErrorCode here in a major (I thought V2 was for the V2 api, but it's actually the newer/correct handler)
         }]
     });
 };
@@ -193,32 +194,34 @@ 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.methodNotAcceptableVersionBehind.message
+                    messages.methodNotAcceptableVersionAhead.message
                 ),
-                context: tpl(messages.methodNotAcceptableVersionBehind.context, {
+                context: tpl(messages.methodNotAcceptableVersionAhead.context, {
                     acceptVersion: req.headers['accept-version'],
                     ghostVersion: `v${res.locals.safeVersion}`
                 }),
-                help: tpl(messages.methodNotAcceptableVersionBehind.help)
-            };
+                help: tpl(messages.methodNotAcceptableVersionAhead.help),
+                code: 'UPDATE_GHOST'
+            });
         } else {
-            errorOptions = {
+            notAcceptableError = new errors.RequestNotAcceptableError({
                 message: tpl(
-                    messages.methodNotAcceptableVersionAhead.message
+                    messages.methodNotAcceptableVersionBehind.message
                 ),
-                context: tpl(messages.methodNotAcceptableVersionAhead.context, {
+                context: tpl(messages.methodNotAcceptableVersionBehind.context, {
                     acceptVersion: req.headers['accept-version'],
                     ghostVersion: `v${res.locals.safeVersion}`
                 }),
-                help: tpl(messages.methodNotAcceptableVersionAhead.help)
-            };
+                help: tpl(messages.methodNotAcceptableVersionBehind.help),
+                code: 'UPDATE_CLIENT'
+            });
         }
 
-        next(new errors.RequestNotAcceptableError(errorOptions));
+        next(notAcceptableError);
     } else {
         next(new errors.NotFoundError({message: tpl(messages.resourceNotFound)}));
     }
@@ -228,6 +231,9 @@ module.exports.pageNotFound = (req, res, next) => {
     next(new errors.NotFoundError({message: tpl(messages.pageNotFound)}));
 };
 
+/**
+ * @deprecated: not used as of Ghost v5 and should be removed in a major bump
+ */
 module.exports.handleJSONResponse = sentry => [
     // Make sure the error can be served
     module.exports.prepareError,
@@ -239,6 +245,10 @@ module.exports.handleJSONResponse = sentry => [
     jsonErrorRenderer
 ];
 
+/**
+ * @deprecated with above
+ * @TODO: rename this without the v2 in a major bump
+ */
 module.exports.handleJSONResponseV2 = sentry => [
     // Make sure the error can be served
     module.exports.prepareError,
@@ -258,4 +268,3 @@ module.exports.handleHTMLResponse = sentry => [
     // Format the stack for the user
     module.exports.prepareStack
 ];
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/mw-error-handler",
-  "version": "0.2.0",
+  "version": "0.2.3",
   "repository": "https://github.com/TryGhost/Utils/tree/main/packages/mw-error-handler",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -19,17 +19,17 @@
     "access": "public"
   },
   "devDependencies": {
-    "c8": "7.11.0",
-    "mocha": "9.1.3",
+    "c8": "7.11.2",
+    "mocha": "10.0.0",
     "should": "13.2.3",
-    "sinon": "12.0.1"
+    "sinon": "13.0.2"
   },
   "dependencies": {
     "@tryghost/debug": "^0.1.9",
-    "@tryghost/errors": "1.2.10",
+    "@tryghost/errors": "1.2.12",
     "@tryghost/tpl": "^0.1.8",
     "lodash": "^4.17.21",
     "semver": "^7.3.6"
   },
-  "gitHead": "c2b9000721dc2113cf3338db58a139da3bb37fb0"
+  "gitHead": "e14f269ad87fee8f5c7c9fa6c2bc69d587f26e38"
 }