Skip to content

fix: bypass next tag cache when there are no tags to check #988

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
merged 2 commits into from
Oct 1, 2025
Merged

fix: bypass next tag cache when there are no tags to check #988

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67d86b0
fix: bypass next tag cache when there are no tags to check
vicb Oct 1, 2025
b9e64fb
fixup! test
vicb Oct 1, 2025
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
5 changes: 5 additions & 0 deletions .changeset/rude-trains-know.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@opennextjs/aws": patch
---

fix: bypass next tag cache when there are no tags to check
4 changes: 3 additions & 1 deletion packages/open-next/src/utils/cache.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,9 @@ export async function hasBeenRevalidated(
}
const lastModified = cacheEntry.lastModified ?? Date.now();
if (globalThis.tagCache.mode === "nextMode") {
return await globalThis.tagCache.hasBeenRevalidated(tags, lastModified);
return tags.length === 0
? false
: await globalThis.tagCache.hasBeenRevalidated(tags, lastModified);
}
// TODO: refactor this, we should introduce a new method in the tagCache interface so that both implementations use hasBeenRevalidated
const _lastModified = await globalThis.tagCache.getLastModified(
Expand Down
53 changes: 30 additions & 23 deletions packages/tests-unit/tests/adapters/cache.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* eslint-disable sonarjs/no-duplicate-string */
import Cache, { SOFT_TAG_PREFIX } from "@opennextjs/aws/adapters/cache.js";
import { vi } from "vitest";
import { type Mock, vi } from "vitest";

declare global {
var openNextConfig: {
Expand Down Expand Up @@ -40,6 +40,7 @@ describe("CacheHandler", () => {
.fn()
.mockResolvedValue(new Date("2024-01-02T00:00:00Z").getTime()),
writeTags: vi.fn(),
getPathsByTags: undefined as Mock | undefined,
};
globalThis.tagCache = tagCache;

Expand Down Expand Up @@ -71,6 +72,8 @@ describe("CacheHandler", () => {
},
};
globalThis.isNextAfter15 = false;
tagCache.mode = "original";
tagCache.getPathsByTags = undefined;
});

describe("get", () => {
Expand Down Expand Up @@ -147,11 +150,13 @@ describe("CacheHandler", () => {
tagCache.mode = "nextMode";
tagCache.hasBeenRevalidated.mockResolvedValueOnce(true);

const result = await cache.get("key", { kind: "FETCH" });
const result = await cache.get("key", {
kind: "FETCH",
tags: ["tag"],
});
expect(getFetchCacheSpy).toHaveBeenCalled();
expect(tagCache.hasBeenRevalidated).toHaveBeenCalled();
expect(result).toBeNull();
// Reset the tagCache mode
tagCache.mode = "original";
});

it("Should return null when incremental cache throws", async () => {
Expand Down Expand Up @@ -198,16 +203,20 @@ describe("CacheHandler", () => {
incrementalCache.get.mockResolvedValueOnce({
value: {
type: "route",
meta: {
headers: {
"x-next-cache-tags": "tag",
},
},
},
lastModified: Date.now(),
});

const result = await cache.get("key", { kindHint: "app" });

expect(getIncrementalCache).toHaveBeenCalled();
expect(tagCache.hasBeenRevalidated).toHaveBeenCalled();
expect(result).toBeNull();
// Reset the tagCache mode
tagCache.mode = "original";
});

it("Should return value when cache data type is route", async () => {
Expand Down Expand Up @@ -536,10 +545,10 @@ describe("CacheHandler", () => {
});

it("Should call tagCache.writeTags", async () => {
globalThis.tagCache.getByTag.mockResolvedValueOnce(["/path"]);
tagCache.getByTag.mockResolvedValueOnce(["/path"]);
await cache.revalidateTag("tag");

expect(globalThis.tagCache.getByTag).toHaveBeenCalledWith("tag");
expect(tagCache.getByTag).toHaveBeenCalledWith("tag");

expect(tagCache.writeTags).toHaveBeenCalledTimes(1);
expect(tagCache.writeTags).toHaveBeenCalledWith([
Expand All @@ -551,8 +560,8 @@ describe("CacheHandler", () => {
});

it("Should call invalidateCdnHandler.invalidatePaths", async () => {
globalThis.tagCache.getByTag.mockResolvedValueOnce(["/path"]);
globalThis.tagCache.getByPath.mockResolvedValueOnce([]);
tagCache.getByTag.mockResolvedValueOnce(["/path"]);
tagCache.getByPath.mockResolvedValueOnce([]);
await cache.revalidateTag(`${SOFT_TAG_PREFIX}path`);

expect(tagCache.writeTags).toHaveBeenCalledTimes(1);
Expand All @@ -567,7 +576,7 @@ describe("CacheHandler", () => {
});

it("Should not call invalidateCdnHandler.invalidatePaths for fetch cache key ", async () => {
globalThis.tagCache.getByTag.mockResolvedValueOnce(["123456"]);
tagCache.getByTag.mockResolvedValueOnce(["123456"]);
await cache.revalidateTag("tag");

expect(tagCache.writeTags).toHaveBeenCalledTimes(1);
Expand All @@ -582,7 +591,7 @@ describe("CacheHandler", () => {
});

it("Should only call writeTags for nextMode", async () => {
globalThis.tagCache.mode = "nextMode";
tagCache.mode = "nextMode";
await cache.revalidateTag(["tag1", "tag2"]);

expect(tagCache.writeTags).toHaveBeenCalledTimes(1);
Expand All @@ -591,18 +600,16 @@ describe("CacheHandler", () => {
});

it("Should not call writeTags when the tag list is empty for nextMode", async () => {
globalThis.tagCache.mode = "nextMode";
tagCache.mode = "nextMode";
await cache.revalidateTag([]);

expect(tagCache.writeTags).not.toHaveBeenCalled();
expect(invalidateCdnHandler.invalidatePaths).not.toHaveBeenCalled();
});

it("Should call writeTags and invalidateCdnHandler.invalidatePaths for nextMode that supports getPathsByTags", async () => {
globalThis.tagCache.mode = "nextMode";
globalThis.tagCache.getPathsByTags = vi
.fn()
.mockResolvedValueOnce(["/path"]);
tagCache.mode = "nextMode";
tagCache.getPathsByTags = vi.fn().mockResolvedValueOnce(["/path"]);
await cache.revalidateTag("tag");

expect(tagCache.writeTags).toHaveBeenCalledTimes(1);
Expand All @@ -619,8 +626,6 @@ describe("CacheHandler", () => {
],
},
]);
// Reset the getPathsByTags
globalThis.tagCache.getPathsByTags = undefined;
});
});

Expand Down Expand Up @@ -662,7 +667,7 @@ describe("CacheHandler", () => {
});

it("Should not bypass tag cache validation when shouldBypassTagCache is false", async () => {
globalThis.tagCache.mode = "nextMode";
tagCache.mode = "nextMode";
incrementalCache.get.mockResolvedValueOnce({
value: {
kind: "FETCH",
Expand All @@ -688,7 +693,7 @@ describe("CacheHandler", () => {
});

it("Should not bypass tag cache validation when shouldBypassTagCache is undefined", async () => {
globalThis.tagCache.mode = "nextMode";
tagCache.mode = "nextMode";
tagCache.hasBeenRevalidated.mockResolvedValueOnce(false);
incrementalCache.get.mockResolvedValueOnce({
value: {
Expand Down Expand Up @@ -762,11 +767,12 @@ describe("CacheHandler", () => {
});

it("Should not bypass tag cache validation when shouldBypassTagCache is false", async () => {
globalThis.tagCache.mode = "nextMode";
tagCache.mode = "nextMode";
incrementalCache.get.mockResolvedValueOnce({
value: {
type: "route",
body: "{}",
meta: { headers: { "x-next-cache-tags": "tag" } },
},
lastModified: Date.now(),
shouldBypassTagCache: false,
Expand All @@ -780,12 +786,13 @@ describe("CacheHandler", () => {
});

it("Should return null when tag cache indicates revalidation and shouldBypassTagCache is false", async () => {
globalThis.tagCache.mode = "nextMode";
tagCache.mode = "nextMode";
tagCache.hasBeenRevalidated.mockResolvedValueOnce(true);
incrementalCache.get.mockResolvedValueOnce({
value: {
type: "route",
body: "{}",
meta: { headers: { "x-next-cache-tags": "tag" } },
},
lastModified: Date.now(),
shouldBypassTagCache: false,
Expand Down