@tryghost/mw-error-handler 0.2.3 → 0.2.5

package/lib/mw-error-handler.js

@@ -3,20 +3,21 @@ const semver = require('semver');
 const debug = require('@tryghost/debug')('error-handler');
 const errors = require('@tryghost/errors');
 const {prepareStackForUser} = require('@tryghost/errors').utils;
+const {isReqResUserSpecific, cacheControlValues} = require('@tryghost/http-cache-utils');
 const tpl = require('@tryghost/tpl');
 
 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: {
@@ -62,8 +63,8 @@ module.exports.prepareError = (err, req, res, next) => {
     }
 
     if (!errors.utils.isGhostError(err)) {
-        // We need a special case for 404 errors
-        if (err.statusCode && err.statusCode === 404) {
+        // We need a special case for 404 errors & bookshelf empty errors
+        if ((err.statusCode && err.statusCode === 404) || err.message === 'EmptyResponse') {
             err = new errors.NotFoundError({
                 err: err
             });
@@ -90,11 +91,6 @@ module.exports.prepareError = (err, req, res, next) => {
     // alternative for res.status();
     res.statusCode = err.statusCode;
 
-    // never cache errors
-    res.set({
-        'Cache-Control': 'no-cache, private, no-store, must-revalidate, max-stale=0, post-check=0, pre-check=0'
-    });
-
     next(err);
 };
 
@@ -104,6 +100,13 @@ module.exports.prepareStack = (err, req, res, next) => { // eslint-disable-line
     next(clonedError);
 };
 
+/**
+ * @private the method is exposed for testing purposes only
+ * @param {Object} err
+ * @param {import('express').Request} req
+ * @param {import('express').Response} res
+ * @param {import('express').NextFunction} next
+ */
 const jsonErrorRenderer = (err, req, res, next) => { // eslint-disable-line no-unused-vars
     res.json({
         errors: [{
@@ -135,6 +138,31 @@ const jsonErrorRendererV2 = (err, req, res, next) => { // eslint-disable-line no
     });
 };
 
+/**
+ * 
+ * @param {String} [cacheControlHeaderValue] cache-control header value
+ */
+module.exports.prepareErrorCacheControl = (cacheControlHeaderValue) => {
+    return (err, req, res, next) => {
+        let cacheControl = cacheControlHeaderValue;
+        if (!cacheControlHeaderValue) {
+            // never cache errors unless it's a 404
+            cacheControl = cacheControlValues.private;
+
+            // Do not include 'private' cache-control directive for 404 responses
+            if (err.statusCode === 404 && req.method === 'GET' && !isReqResUserSpecific(req, res)) {
+                cacheControl = cacheControlValues.noCacheDynamic;
+            }
+        }
+
+        res.set({
+            'Cache-Control': cacheControl
+        });
+
+        next(err);
+    };
+};
+
 const prepareUserMessage = (err, req) => {
     const userError = {
         message: err.message,
@@ -238,6 +266,8 @@ module.exports.handleJSONResponse = sentry => [
     // Make sure the error can be served
     module.exports.prepareError,
     // Handle the error in Sentry
+    // Add cache-control header
+    module.exports.prepareErrorCacheControl(),
     sentry.errorHandler,
     // Format the stack for the user
     module.exports.prepareStack,
@@ -252,6 +282,8 @@ module.exports.handleJSONResponse = sentry => [
 module.exports.handleJSONResponseV2 = sentry => [
     // Make sure the error can be served
     module.exports.prepareError,
+    // Add cache-control header
+    module.exports.prepareErrorCacheControl(),
     // Handle the error in Sentry
     sentry.errorHandler,
     // Format the stack for the user
@@ -263,6 +295,8 @@ module.exports.handleJSONResponseV2 = sentry => [
 module.exports.handleHTMLResponse = sentry => [
     // Make sure the error can be served
     module.exports.prepareError,
+    // Add cache-control header
+    module.exports.prepareErrorCacheControl(cacheControlValues.private),
     // Handle the error in Sentry
     sentry.errorHandler,
     // Format the stack for the user

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/mw-error-handler",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "repository": "https://github.com/TryGhost/Utils/tree/main/packages/mw-error-handler",
   "author": "Ghost Foundation",
   "license": "MIT",
@@ -27,9 +27,10 @@
   "dependencies": {
     "@tryghost/debug": "^0.1.9",
     "@tryghost/errors": "1.2.12",
+    "@tryghost/http-cache-utils": "0.1.3",
     "@tryghost/tpl": "^0.1.8",
     "lodash": "^4.17.21",
     "semver": "^7.3.6"
   },
-  "gitHead": "e14f269ad87fee8f5c7c9fa6c2bc69d587f26e38"
+  "gitHead": "ebfd454e760c61ef69cf69d9eb9ac5889aacded2"
 }