Skip to content

fix: Ensure to delete cookies when switching from single to chunks and vica versa #2013

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.

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 3 commits into from
Apr 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
49 changes: 48 additions & 1 deletion src/server/chunked-cookies.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,49 @@ describe("Chunked Cookie Utils", () => {
);
});

it("should clear existing chunked cookies when setting a single cookie", () => {
const name = "testCookie";
const value = "small value";
const options = { path: "/" } as CookieOptions;

const chunk0 = "chunk0 value";
const chunk1 = "chunk1 value";
const chunk2 = "chunk2 value";

cookieStore.set(`${name}__1`, chunk1);
cookieStore.set(`${name}__0`, chunk0);
cookieStore.set(`${name}__2`, chunk2);

setChunkedCookie(name, value, options, reqCookies, resCookies);

expect(resCookies.set).toHaveBeenCalledTimes(1);
expect(resCookies.set).toHaveBeenCalledWith(name, value, options);
expect(reqCookies.set).toHaveBeenCalledTimes(1);
expect(reqCookies.set).toHaveBeenCalledWith(name, value);
expect(reqCookies.delete).toHaveBeenCalledTimes(3);
expect(reqCookies.delete).toHaveBeenCalledWith(`${name}__0`);
expect(reqCookies.delete).toHaveBeenCalledWith(`${name}__1`);
expect(reqCookies.delete).toHaveBeenCalledWith(`${name}__2`);
});

it("should clear existing single cookies when setting a chunked cookie", () => {
const name = "testCookie";
const value = "small value";

cookieStore.set(`${name}`, value);

// Create a large string (8000 bytes)
const largeValue = "a".repeat(8000);
const options = { path: "/" } as CookieOptions;

setChunkedCookie(name, largeValue, options, reqCookies, resCookies);

expect(reqCookies.delete).toHaveBeenCalledTimes(1);
expect(reqCookies.delete).toHaveBeenCalledWith(`${name}`);
expect(resCookies.set).toHaveBeenCalledTimes(3);
expect(reqCookies.set).toHaveBeenCalledTimes(3);
});

it("should clean up unused chunks when cookie shrinks", () => {
const name = "testCookie";
const options = { path: "/" } as CookieOptions;
Expand All @@ -185,9 +228,13 @@ describe("Chunked Cookie Utils", () => {
const largeValue = "a".repeat(8000);
setChunkedCookie(name, largeValue, options, reqCookies, resCookies);

expect(reqCookies.delete).toHaveBeenCalledTimes(2);
// It is called 3 times.
// 2 times for the chunks
// 1 time for the non chunked cookie
expect(reqCookies.delete).toHaveBeenCalledTimes(3);
expect(reqCookies.delete).toHaveBeenCalledWith(`${name}__3`);
expect(reqCookies.delete).toHaveBeenCalledWith(`${name}__4`);
expect(reqCookies.delete).toHaveBeenCalledWith(name);
});

describe("getChunkedCookie", () => {
Expand Down
11 changes: 11 additions & 0 deletions src/server/cookies.ts
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,13 @@ export function setChunkedCookie(
resCookies.set(name, value, options);
// to enable read-after-write in the same request for middleware
reqCookies.set(name, value);

// When we are writing a non-chunked cookie, we should remove the chunked cookies
getAllChunkedCookies(reqCookies, name).forEach(cookieChunk => {
resCookies.delete(cookieChunk.name);
reqCookies.delete(cookieChunk.name);
});

return;
}

Expand Down Expand Up @@ -215,6 +222,10 @@ export function setChunkedCookie(
reqCookies.delete(chunkName);
}
}

// When we have written chunked cookies, we should remove the non-chunked cookie
resCookies.delete(name);
reqCookies.delete(name);
}

/**
Expand Down