feat: added cache-control response header w/sensible defaults

Author: niftylettuce

index.js

@@ -1,11 +1,15 @@
-const { pathToRegexp } = require('path-to-regexp');
 const _ = require('lodash');
+const ms = require('ms');
+const { pathToRegexp } = require('path-to-regexp');
 
 class CacheResponses {
   constructor(config = {}) {
     this.config = {
       pathToRegexp: { sensitive: true, strict: true },
       routes: [],
+      // <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control>
+      // <https://web.dev/uses-long-cache-ttl/?utm_source=lighthouse&utm_medium=unknown>
+      cacheControl: ['public', `max-age=${ms('1y') / 1000}`],
       ...config
     };
 
@@ -34,6 +38,15 @@ class CacheResponses {
     }
 
     if (!match) return next();
+
+    // inspired by @redpill-paris/koa-cache-control
+    // <https://github.com/RedPillGroup/koa-cache-control>
+    if (
+      Array.isArray(this.config.cacheControl) &&
+      this.config.cacheControl.length > 0
+    )
+      ctx.set('Cache-Control', this.config.cacheControl.join(', '));
+
     const cashed = await ctx.cashed();
     if (cashed) return;
     return next();

package.json

@@ -20,12 +20,13 @@
   ],
   "dependencies": {
     "lodash": "^4.17.15",
+    "ms": "^2.1.2",
     "path-to-regexp": "^6.1.0"
   },
   "devDependencies": {
     "@commitlint/cli": "latest",
     "@commitlint/config-conventional": "latest",
-    "@ladjs/redis": "^1.0.3",
+    "@ladjs/redis": "^1.0.4",
     "ava": "latest",
     "codecov": "latest",
     "cross-env": "latest",
@@ -34,10 +35,10 @@
     "fast-safe-stringify": "^2.0.7",
     "fixpack": "latest",
     "husky": "latest",
-    "koa": "^2.12.0",
-    "koa-cash": "^3.0.3",
+    "koa": "^2.12.1",
+    "koa-cash": "^4.0.3",
     "lint-staged": "latest",
-    "node-cache": "^5.1.0",
+    "node-cache": "^5.1.1",
     "nyc": "latest",
     "remark-cli": "latest",
     "remark-preset-github": "latest",

yarn.lock

@@ -329,12 +329,12 @@
   resolved "https://registry.yarnpkg.com/@istanbuljs/schema/-/schema-0.1.2.tgz#26520bf09abe4a5644cd5414e37125a8954241dd"
   integrity sha512-tsAQNx32a8CoFhjhijUIhI4kccIAgmGhy8LZMZgGfmXcpMbPRUqn5LWmgRttILi6yeGmBJd2xsPkFMs0PzgPCw==
 
-"@ladjs/redis@^1.0.3":
-  version "1.0.3"
-  resolved "https://registry.yarnpkg.com/@ladjs/redis/-/redis-1.0.3.tgz#4232bfea8af56c07a7b43e651c1f0762e888e917"
-  integrity sha512-oO/vSfhkMkxwtnx4oXZtE8zIhOz2sAC+AdoAsPtRBedO5qvUqARIffUcu5TMtK4ubI2Dq3wm+TA0cDN1euzY1g==
+"@ladjs/redis@^1.0.4":
+  version "1.0.4"
+  resolved "https://registry.yarnpkg.com/@ladjs/redis/-/redis-1.0.4.tgz#b225d508943d6a5b65e757e1fe4c19adda41f6c3"
+  integrity sha512-2PgOsLIQ9taJ3B4fhG6RXZQjKh5r7BkoQpQ7iIwreOPoLwCjCiLWuSempJbY3nwnxx1+TyOI2yRPPUcxPdssdA==
   dependencies:
-    ioredis "^4.14.0"
+    ioredis "^4.17.1"
 
 "@marionebl/sander@^0.6.0":
   version "0.6.1"
@@ -3015,10 +3015,10 @@ inquirer@^7.0.0:
     strip-ansi "^6.0.0"
     through "^2.3.6"
 
-ioredis@^4.14.0:
-  version "4.17.1"
-  resolved "https://registry.yarnpkg.com/ioredis/-/ioredis-4.17.1.tgz#06ef3d3b2cb96b7e6bc90a7b8839a33e743843ad"
-  integrity sha512-kfxkN/YO1dnyaoAGyNdH3my4A1eoGDy4QOfqn6o86fo4dTboxyxYVW0S0v/d3MkwCWlvSWhlwq6IJMY9BlWs6w==
+ioredis@^4.17.1:
+  version "4.17.3"
+  resolved "https://registry.yarnpkg.com/ioredis/-/ioredis-4.17.3.tgz#9938c60e4ca685f75326337177bdc2e73ae9c9dc"
+  integrity sha512-iRvq4BOYzNFkDnSyhx7cmJNOi1x/HWYe+A4VXHBu4qpwJaGT1Mp+D2bVGJntH9K/Z/GeOM/Nprb8gB3bmitz1Q==
   dependencies:
     cluster-key-slot "^1.1.0"
     debug "^4.1.1"
@@ -3606,10 +3606,10 @@ kind-of@^6.0.0, kind-of@^6.0.2, kind-of@^6.0.3:
   resolved "https://registry.yarnpkg.com/kind-of/-/kind-of-6.0.3.tgz#07c05034a6c349fa06e24fa35aa76db4580ce4dd"
   integrity sha512-dcS1ul+9tmeD95T+x28/ehLgd9mENa3LsvDTtzm3vyBEO7RPptvAD+t44WVXaUjTBRcrpFeFlC8WCruUR456hw==
 
-koa-cash@^3.0.3:
-  version "3.0.3"
-  resolved "https://registry.yarnpkg.com/koa-cash/-/koa-cash-3.0.3.tgz#9203e2f7d7e9fa6f7d191c47e0d4950a7814bca6"
-  integrity sha512-ME3/0l746F2B73bfF9E1F9WsaTbqm5rkUQTT2tzuFFZhaRzTHxvWL7kRcDDV31WMEjRJ2e6dbpEHEUynuXjRlw==
+koa-cash@^4.0.3:
+  version "4.0.3"
+  resolved "https://registry.yarnpkg.com/koa-cash/-/koa-cash-4.0.3.tgz#b9e840b58e1fc21f86bcb1672bd49d52b4217c1f"
+  integrity sha512-w1qMKViGDV8FVrZdXaOhYlbkI2zqKbHpo0YJ0ZZQ1EK67EvBvWOfyI27tDNA4zBlFLbWh92CvsU4GtggdmjXYw==
   dependencies:
     bytes "^3.1.0"
     compressible "^2.0.18"
@@ -3643,10 +3643,10 @@ koa-is-json@^1.0.0:
   resolved "https://registry.yarnpkg.com/koa-is-json/-/koa-is-json-1.0.0.tgz#273c07edcdcb8df6a2c1ab7d59ee76491451ec14"
   integrity sha1-JzwH7c3Ljfaiwat9We52SRRR7BQ=
 
-koa@^2.12.0:
-  version "2.12.0"
-  resolved "https://registry.yarnpkg.com/koa/-/koa-2.12.0.tgz#c92bfb42defd86f365c31bf63fe918db11fc5c74"
-  integrity sha512-WlUBj6PXoVhjI5ljMmlyK+eqkbVFW5XQu8twz6bd4WM2E67IwKgPMu5wIFXGxAsZT7sW5xAB54KhY8WAEkLPug==
+koa@^2.12.1:
+  version "2.12.1"
+  resolved "https://registry.yarnpkg.com/koa/-/koa-2.12.1.tgz#a0ab4dcfebe3cc1b6f0875cbfd686edd7e926643"
+  integrity sha512-NuYVKjnBxeEe19VljPO9yNcaKKVrMagcax3jjzZtOlxRY2nThWKQqgnI3Pr1OG7mFtvySoDRixoUWZIt6R9C3A==
   dependencies:
     accepts "^1.3.5"
     cache-content-type "^1.0.0"
@@ -4402,10 +4402,10 @@ nlcst-to-string@^2.0.0:
   resolved "https://registry.yarnpkg.com/nlcst-to-string/-/nlcst-to-string-2.0.4.tgz#9315dfab80882bbfd86ddf1b706f53622dc400cc"
   integrity sha512-3x3jwTd6UPG7vi5k4GEzvxJ5rDA7hVUIRNHPblKuMVP9Z3xmlsd9cgLcpAMkc5uPOBna82EeshROFhsPkbnTZg==
 
-node-cache@^5.1.0:
-  version "5.1.0"
-  resolved "https://registry.yarnpkg.com/node-cache/-/node-cache-5.1.0.tgz#266786c28dcec0fd34385ee29c383e6d6f1aa5de"
-  integrity sha512-gFQwYdoOztBuPlwg6DKQEf50G+gkK69aqLnw4djkmlHCzeVrLJfwvg9xl4RCAGviTIMUVoqcyoZ/V/wPEu/VVg==
+node-cache@^5.1.1:
+  version "5.1.1"
+  resolved "https://registry.yarnpkg.com/node-cache/-/node-cache-5.1.1.tgz#5fcc887176b23bdcd19cd1461b9544d2d501e786"
+  integrity sha512-bJ9nH25Z51HG2QIu66K4dMVyMs6o8bNQpviDnXzG+O/gfNxPU9IpIig0j4pzlO707GcGZ6QA4rWhlRxjJsjnZw==
   dependencies:
     clone "2.x"