@tryghost/mw-error-handler 0.1.8 → 0.2.0

package/lib/mw-error-handler.js

@@ -1,4 +1,5 @@
 const _ = require('lodash');
+const semver = require('semver');
 const debug = require('@tryghost/debug')('error-handler');
 const errors = require('@tryghost/errors');
 const {prepareStackForUser} = require('@tryghost/errors').utils;
@@ -7,6 +8,16 @@ const tpl = require('@tryghost/tpl');
 const messages = {
     pageNotFound: 'Page not found',
     resourceNotFound: 'Resource not found',
+    methodNotAcceptableVersionBehind: {
+        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: {
+        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.'
+    },
     actions: {
         images: {
             upload: 'upload image'
@@ -174,7 +185,43 @@ const prepareUserMessage = (err, req) => {
 };
 
 module.exports.resourceNotFound = (req, res, next) => {
-    next(new errors.NotFoundError({message: tpl(messages.resourceNotFound)}));
+    if (req && req.headers && req.headers['accept-version']
+        && res.locals && res.locals.safeVersion
+        && semver.compare(semver.coerce(req.headers['accept-version']), semver.coerce(res.locals.safeVersion)) !== 0) {
+        const versionComparison = semver.compare(
+            semver.coerce(req.headers['accept-version']),
+            semver.coerce(res.locals.safeVersion)
+        );
+
+        let errorOptions;
+        if (versionComparison === 1) {
+            errorOptions = {
+                message: tpl(
+                    messages.methodNotAcceptableVersionBehind.message
+                ),
+                context: tpl(messages.methodNotAcceptableVersionBehind.context, {
+                    acceptVersion: req.headers['accept-version'],
+                    ghostVersion: `v${res.locals.safeVersion}`
+                }),
+                help: tpl(messages.methodNotAcceptableVersionBehind.help)
+            };
+        } else {
+            errorOptions = {
+                message: tpl(
+                    messages.methodNotAcceptableVersionAhead.message
+                ),
+                context: tpl(messages.methodNotAcceptableVersionAhead.context, {
+                    acceptVersion: req.headers['accept-version'],
+                    ghostVersion: `v${res.locals.safeVersion}`
+                }),
+                help: tpl(messages.methodNotAcceptableVersionAhead.help)
+            };
+        }
+
+        next(new errors.RequestNotAcceptableError(errorOptions));
+    } else {
+        next(new errors.NotFoundError({message: tpl(messages.resourceNotFound)}));
+    }
 };
 
 module.exports.pageNotFound = (req, res, next) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/mw-error-handler",
-  "version": "0.1.8",
+  "version": "0.2.0",
   "repository": "https://github.com/TryGhost/Utils/tree/main/packages/mw-error-handler",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -26,9 +26,10 @@
   },
   "dependencies": {
     "@tryghost/debug": "^0.1.9",
-    "@tryghost/errors": "1.2.8",
+    "@tryghost/errors": "1.2.10",
     "@tryghost/tpl": "^0.1.8",
-    "lodash": "^4.17.21"
+    "lodash": "^4.17.21",
+    "semver": "^7.3.6"
   },
-  "gitHead": "d49b83751cb42ecbf40c60d3ee9ade27732eeee2"
+  "gitHead": "c2b9000721dc2113cf3338db58a139da3bb37fb0"
 }