fix: align cacheImmutable and Cache-Control semantics (#32)

Author: chenjiahan

README.md

@@ -72,7 +72,7 @@ See [below](#other-servers) for examples of use with other servers.
 |               **[`etag`](#tag)**                |   `boolean\| "weak"\| "strong"`   |                  `undefined`                  | Enable or disable etag generation.                                                                                   |
 |       **[`lastModified`](#lastmodified)**       |             `boolean`             |                  `undefined`                  | Enable or disable `Last-Modified` header. Uses the file system's last modified value.                                |
 |       **[`cacheControl`](#cachecontrol)**       | `boolean\|number\|string\|Object` |                  `undefined`                  | Enable or disable setting `Cache-Control` response header.                                                           |
-|     **[`cacheImmutable`](#cacheimmutable)**     |            `boolean\`             |                  `undefined`                  | Enable or disable setting `Cache-Control: public, max-age=31536000, immutable` response header for immutable assets. |
+|     **[`cacheImmutable`](#cacheimmutable)**     |             `boolean`             |                    `true`                     | Enable or disable setting `Cache-Control: public, max-age=31536000, immutable` response header for immutable assets. |
 |         **[`publicPath`](#publicpath)**         |             `string`              |                  `undefined`                  | The public path that the middleware is bound to.                                                                     |
 |              **[`stats`](#stats)**              |     `boolean\|string\|Object`     |        `stats` (from a configuration)         | Stats options object or preset name.                                                                                 |
 |   **[`serverSideRender`](#serversiderender)**   |             `boolean`             |                  `undefined`                  | Instructs the module to enable or disable the server-side rendering mode.                                            |
@@ -196,21 +196,25 @@ Default: `undefined`
 
 Depending on the setting, the following headers will be generated:
 
-- `Boolean` - `Cache-Control: public, max-age=31536000000`
-- `Number` - `Cache-Control: public, max-age=YOUR_NUMBER`
+- `Boolean` - `Cache-Control: public, max-age=31536000`
+- `Number` - `Cache-Control: public, max-age=YOUR_NUMBER_IN_SECONDS`
 - `String` - `Cache-Control: YOUR_STRING`
-- `{ maxAge?: number, immutable?: boolean }` - `Cache-Control: public, max-age=YOUR_MAX_AGE_or_31536000000`, also `, immutable` can be added if you set the `immutable` option to `true`
+- `{ maxAge?: number, immutable?: boolean }` - `Cache-Control: public, max-age=YOUR_MAX_AGE_IN_SECONDS_or_31536000`, also `, immutable` is added when you set the `immutable` option to `true`
+
+Numeric `cacheControl` and `cacheControl.maxAge` values are interpreted as milliseconds, clamped to `0..31536000000`, and converted to seconds for the response header.
 
 Enable or disable setting `Cache-Control` response header.
 
 ### cacheImmutable
 
 Type: `Boolean`
-Default: `undefined`
+Default: `true`
 
 Enable or disable setting `Cache-Control: public, max-age=31536000, immutable` response header for immutable assets (i.e. asset with a hash like `image.a4c12bde.jpg`).
 Immutable assets are assets that have their hash in the file name therefore they can be cached, because if you change their contents the file name will be changed.
-Take preference over the `cacheControl` option if the asset was defined as immutable.
+When omitted, immutable assets use this header by default.
+Set `cacheImmutable: false` to fall back to the `cacheControl` option even for immutable assets.
+This takes precedence over the `cacheControl` option only when the asset was defined as immutable and `cacheImmutable` is not `false`.
 
 ### publicPath
 

src/index.js

@@ -126,7 +126,7 @@ const noop = () => {};
  * @property {"weak" | "strong"=} etag options to generate etag header
  * @property {boolean=} lastModified options to generate last modified header
  * @property {(boolean | number | string | { maxAge?: number, immutable?: boolean })=} cacheControl options to generate cache headers
- * @property {boolean=} cacheImmutable is cache immutable
+ * @property {boolean=} cacheImmutable enable immutable cache headers for immutable assets (defaults to true when omitted)
  */
 
 /**

src/middleware.js

@@ -605,40 +605,36 @@ function wrapper(context) {
       }
 
       if (!getResponseHeader(res, "Cache-Control")) {
-        // TODO enable the `cacheImmutable` by default for the next major release
-        const cacheControl =
-          context.options.cacheImmutable && extra.immutable
-            ? { immutable: true }
-            : context.options.cacheControl;
-
-        if (cacheControl) {
-          let cacheControlValue;
-
-          if (typeof cacheControl === "boolean") {
-            cacheControlValue = "public, max-age=31536000";
-          } else if (typeof cacheControl === "number") {
-            const maxAge = Math.floor(
-              Math.min(Math.max(0, cacheControl), MAX_MAX_AGE) / 1000,
-            );
-
-            cacheControlValue = `public, max-age=${maxAge}`;
-          } else if (typeof cacheControl === "string") {
-            cacheControlValue = cacheControl;
-          } else {
-            const maxAge = cacheControl.maxAge
-              ? Math.floor(
-                  Math.min(Math.max(0, cacheControl.maxAge), MAX_MAX_AGE) /
-                    1000,
-                )
-              : MAX_MAX_AGE / 1000;
-
-            cacheControlValue = `public, max-age=${maxAge}`;
-
-            if (cacheControl.immutable) {
-              cacheControlValue += ", immutable";
-            }
+        const { cacheControl, cacheImmutable } = context.options;
+        const useImmutableCache =
+          (cacheImmutable === undefined || cacheImmutable) && extra.immutable;
+
+        let cacheControlValue;
+
+        if (useImmutableCache) {
+          cacheControlValue = `public, max-age=${Math.floor(MAX_MAX_AGE / 1000)}, immutable`;
+        } else if (cacheControl === true) {
+          cacheControlValue = `public, max-age=${Math.floor(MAX_MAX_AGE / 1000)}`;
+        } else if (typeof cacheControl === "number") {
+          const maxAge = Math.min(Math.max(0, cacheControl), MAX_MAX_AGE);
+
+          cacheControlValue = `public, max-age=${Math.floor(maxAge / 1000)}`;
+        } else if (typeof cacheControl === "string") {
+          cacheControlValue = cacheControl;
+        } else if (cacheControl) {
+          const maxAge =
+            cacheControl.maxAge !== undefined
+              ? Math.min(Math.max(0, cacheControl.maxAge), MAX_MAX_AGE)
+              : MAX_MAX_AGE;
+
+          cacheControlValue = `public, max-age=${Math.floor(maxAge / 1000)}`;
+
+          if (cacheControl.immutable) {
+            cacheControlValue += ", immutable";
           }
+        }
 
+        if (cacheControlValue) {
           setResponseHeader(res, "Cache-Control", cacheControlValue);
         }
       }