Release the instant navs lock without clearing the whole cookie jar

The `instant()` helper in `@next/playwright` released the navigation
lock by calling `page.context().clearCookies({ name: INSTANT_COOKIE })`.
Playwright implements a filtered `clearCookies` non-atomically: it
clears the entire cookie jar and then re-adds the cookies that don't
match the filter, briefly removing the application's own cookies too.
Because Next.js reacts to the instant cookie's deletion by immediately
re-rendering (a soft refresh or a full reload), a render whose request
raced that empty window observed none of the test's cookies, so a page
reading `cookies()` rendered as if nothing was set, for example
`testCookie: not set`. Resource contention widened the clear-then-re-add
window, which is why the instant navigation suite failed intermittently
in CI.

We now release the lock by reading the instant cookie's stored entries
(Next.js may have updated the value, e.g. from `[0]` to `[1, null]`, but
preserves the domain and path) and re-adding each with a past expiry,
which deletes only those entries and leaves every other cookie
untouched. This removes the transient empty-jar window while still
firing the CookieStore deletion event that releases the lock.

To exercise the fix under the conditions that surfaced it, we want CI's
flake-detection job to replay the instant navigation suite, which only
happens when the suite's test file changes. We trigger that by
un-skipping the `renders runtime-prefetched content instantly during
navigation` test. That test had been skipped as flaky because of a real
bug in the dev runtime-prefetch decode, which #94866 has since fixed, so
it passes reliably now and no longer needs to be skipped.
parent 4b519bee
...@@ -14,14 +14,12 @@ interface PlaywrightBrowserContext { ...@@ -14,14 +14,12 @@ interface PlaywrightBrowserContext {
url?: string url?: string
domain?: string domain?: string
path?: string path?: string
expires?: number
}> }>
): Promise<void> ): Promise<void>
cookies(): Promise<Array<{ name: string; value: string }>> cookies(): Promise<
clearCookies(options?: { Array<{ name: string; value: string; domain: string; path: string }>
name?: string >
domain?: string
path?: string
}): Promise<void>
} }
interface PlaywrightPage { interface PlaywrightPage {
...@@ -86,14 +84,39 @@ export async function instant<T>( ...@@ -86,14 +84,39 @@ export async function instant<T>(
try { try {
return await fn() return await fn()
} finally { } finally {
// Release the lock by clearing the cookie. Next.js may have updated the // Release the lock by expiring the instant cookie, leaving every other
// cookie value (e.g. from [0] to [1,null]) during the lock scope. We // cookie untouched.
// clear by name to remove the cookie regardless of its current value or //
// which domain variant it was stored under. // We must NOT use `context.clearCookies({ name: INSTANT_COOKIE })` here.
await step('Release Instant Lock', () => // Playwright implements a filtered `clearCookies` by clearing the ENTIRE
page.context().clearCookies({ name: INSTANT_COOKIE }) // cookie jar and then re-adding the cookies that don't match the filter.
// That briefly removes the application's own cookies too. Next.js reacts
// to the instant cookie's deletion by immediately re-rendering, and if
// that render's request races the empty window it observes none of the
// app's cookies (e.g. a navigated page renders as if no cookies were set).
//
// Instead we read the instant cookie's stored entries (Next.js may have
// updated the value, e.g. from [0] to [1,null], but preserves the domain
// and path) and re-add each with a past expiry, which deletes only those
// entries without disturbing the rest of the jar.
await step('Release Instant Lock', async () => {
const instantCookies = (await page.context().cookies()).filter(
(cookie) => cookie.name === INSTANT_COOKIE
)
if (instantCookies.length > 0) {
await page.context().addCookies(
instantCookies.map((cookie) => ({
name: cookie.name,
value: cookie.value,
domain: cookie.domain,
path: cookie.path,
// A past expiry (Unix epoch seconds) deletes the cookie.
expires: 1,
}))
) )
} }
})
}
} }
/** /**
......
...@@ -93,8 +93,7 @@ describe('instant-navigation-testing-api', () => { ...@@ -93,8 +93,7 @@ describe('instant-navigation-testing-api', () => {
) )
}) })
// TODO: This has been flaky in CI for weeks and needs further investigation. it('renders runtime-prefetched content instantly during navigation', async () => {
it.skip('renders runtime-prefetched content instantly during navigation', async () => {
const page = await openPage(next, '/') const page = await openPage(next, '/')
await instant(page, async () => { await instant(page, async () => {
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment