Skip to content

refactor: logic for cacheImmutable #2254

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexander-akait merged 1 commit into from
Jan 27, 2026
Merged

refactor: logic for cacheImmutable #2254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ See [below](#other-servers) for an example of use with fastify.
| **[`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` | `undefined` | 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. |
Expand Down
38 changes: 19 additions & 19 deletions src/middleware.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -571,36 +571,36 @@ function wrapper(context) {
}

if (!getResponseHeader(res, "Cache-Control")) {
const hasCacheImmutable =
context.options.cacheImmutable === undefined
? true
: context.options.cacheImmutable;

let { cacheControl } = context.options;

// Normalize cacheControl to object
if (typeof cacheControl === "string") {
setResponseHeader(res, "Cache-Control", cacheControl);
} else if (hasCacheImmutable && extra.immutable) {
cacheControl = { immutable: true };
const { cacheControl, cacheImmutable } = context.options;

let cacheControlValue;

if (
(cacheImmutable === undefined || cacheImmutable) &&
extra.immutable
) {
cacheControlValue = `public, max-age=${Math.floor(MAX_MAX_AGE / 1000)}, immutable`;
} else if (typeof cacheControl === "boolean") {
cacheControl = { maxAge: MAX_MAX_AGE };
cacheControlValue = `public, max-age=${Math.floor(MAX_MAX_AGE / 1000)}`;
} else if (typeof cacheControl === "number") {
cacheControl = { maxAge: cacheControl };
}

if (cacheControl && typeof cacheControl === "object") {
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;

let cacheControlValue = `public, max-age=${Math.floor(maxAge / 1000)}`;
cacheControlValue = `public, max-age=${Math.floor(maxAge / 1000)}`;

if (cacheControl.immutable && hasCacheImmutable) {
if (cacheControl.immutable) {
cacheControlValue += ", immutable";
}
}
Copy link
Copy Markdown
Member Author

@alexander-akait alexander-akait Jan 27, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bjohansebas

Refactor logic:

  • based on type (boolean, number, string or object) we will write header value directly into cacheControlValue
  • cacheImmutable always takes preference
  • if you set cacheControl: { immutable: true } we will always write , immutable even cacheImmutable is false


if (cacheControlValue) {
setResponseHeader(res, "Cache-Control", cacheControlValue);
}
}
Expand Down
6 changes: 3 additions & 3 deletions test/middleware.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6393,7 +6393,7 @@ describe.each([
});
});

describe("should use cacheControl object option (with only immutable: true) when cacheImmutable is false, and not add 'immutable' to Cache-Control header", () => {
describe("should use cacheControl object option (with only immutable: true) when cacheImmutable is false, and add 'immutable' to Cache-Control header", () => {
Copy link
Copy Markdown
Member Author

@alexander-akait alexander-akait Jan 27, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@bjohansebas

We should always write , immutable even if cacheControl is false, developers literally indicated that everything is immutable

beforeEach(async () => {
const compiler = getCompiler({
...webpackConfigImmutable,
Expand All @@ -6420,7 +6420,7 @@ describe.each([
expect(response.statusCode).toBe(200);
expect(response.headers["cache-control"]).toBeDefined();
expect(response.headers["cache-control"]).toBe(
"public, max-age=31536000",
"public, max-age=31536000, immutable",
);
});

Expand All @@ -6430,7 +6430,7 @@ describe.each([
expect(response.statusCode).toBe(200);
expect(response.headers["cache-control"]).toBeDefined();
expect(response.headers["cache-control"]).toBe(
"public, max-age=31536000",
"public, max-age=31536000, immutable",
);
});
});
Expand Down