Unverified Commit a46f27f5 authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Use provided waitUntil for pending revalidates (#74164) (#74604)

This backports https://github.com/vercel/next.js/pull/74164 to leverage
built-in waitUntil if available instead of using the approach that keeps
the stream open until the waitUntil promise resolves.

x-ref: [slack
thread](https://vercel.slack.com/archives/C02K2HCH5V4/p1736211642221149?thread_ts=1734707275.666089&cid=C02K2HCH5V4)
parent bc6acf62
...@@ -1276,13 +1276,23 @@ async function renderToHTMLOrFlightImpl( ...@@ -1276,13 +1276,23 @@ async function renderToHTMLOrFlightImpl(
workStore.pendingRevalidateWrites || workStore.pendingRevalidateWrites ||
workStore.revalidatedTags workStore.revalidatedTags
) { ) {
options.waitUntil = Promise.all([ const pendingPromise = Promise.all([
workStore.incrementalCache?.revalidateTag( workStore.incrementalCache?.revalidateTag(
workStore.revalidatedTags || [] workStore.revalidatedTags || []
), ),
...Object.values(workStore.pendingRevalidates || {}), ...Object.values(workStore.pendingRevalidates || {}),
...(workStore.pendingRevalidateWrites || []), ...(workStore.pendingRevalidateWrites || []),
]) ]).finally(() => {
if (process.env.NEXT_PRIVATE_DEBUG_CACHE) {
console.log('pending revalidates promise finished for:', url)
}
})
if (renderOpts.waitUntil) {
renderOpts.waitUntil(pendingPromise)
} else {
options.waitUntil = pendingPromise
}
} }
if (response.collectedTags) { if (response.collectedTags) {
...@@ -1433,13 +1443,23 @@ async function renderToHTMLOrFlightImpl( ...@@ -1433,13 +1443,23 @@ async function renderToHTMLOrFlightImpl(
workStore.pendingRevalidateWrites || workStore.pendingRevalidateWrites ||
workStore.revalidatedTags workStore.revalidatedTags
) { ) {
options.waitUntil = Promise.all([ const pendingPromise = Promise.all([
workStore.incrementalCache?.revalidateTag( workStore.incrementalCache?.revalidateTag(
workStore.revalidatedTags || [] workStore.revalidatedTags || []
), ),
...Object.values(workStore.pendingRevalidates || {}), ...Object.values(workStore.pendingRevalidates || {}),
...(workStore.pendingRevalidateWrites || []), ...(workStore.pendingRevalidateWrites || []),
]) ]).finally(() => {
if (process.env.NEXT_PRIVATE_DEBUG_CACHE) {
console.log('pending revalidates promise finished for:', url)
}
})
if (renderOpts.waitUntil) {
renderOpts.waitUntil(pendingPromise)
} else {
options.waitUntil = pendingPromise
}
} }
// Create the new render result for the response. // Create the new render result for the response.
......
...@@ -2541,6 +2541,16 @@ export default abstract class Server< ...@@ -2541,6 +2541,16 @@ export default abstract class Server<
return cacheEntry return cacheEntry
} }
let pendingWaitUntil = context.renderOpts.pendingWaitUntil
// Attempt using provided waitUntil if available
// if it's not we fallback to sendResponse's handling
if (pendingWaitUntil) {
if (context.renderOpts.waitUntil) {
context.renderOpts.waitUntil(pendingWaitUntil)
pendingWaitUntil = undefined
}
}
// Send the response now that we have copied it into the cache. // Send the response now that we have copied it into the cache.
await sendResponse( await sendResponse(
......
...@@ -597,7 +597,14 @@ export class AppRouteRouteModule extends RouteModule< ...@@ -597,7 +597,14 @@ export class AppRouteRouteModule extends RouteModule<
workStore.revalidatedTags || [] workStore.revalidatedTags || []
), ),
...Object.values(workStore.pendingRevalidates || {}), ...Object.values(workStore.pendingRevalidates || {}),
]) ]).finally(() => {
if (process.env.NEXT_PRIVATE_DEBUG_CACHE) {
console.log(
'pending revalidates promise finished for:',
requestStore.url
)
}
})
if (prerenderStore) { if (prerenderStore) {
context.renderOpts.collectedTags = prerenderStore.tags?.join(',') context.renderOpts.collectedTags = prerenderStore.tags?.join(',')
......
import { findPort, waitFor } from 'next-test-utils' import { findPort, retry } from 'next-test-utils'
import http from 'http' import http from 'http'
import url from 'url' import url from 'url'
import { outdent } from 'outdent' import { outdent } from 'outdent'
...@@ -112,11 +112,10 @@ describe('app-fetch-deduping', () => { ...@@ -112,11 +112,10 @@ describe('app-fetch-deduping', () => {
expect(invocation(next.cliOutput)).toBe(1) expect(invocation(next.cliOutput)).toBe(1)
// wait for the revalidation to finish // wait for the revalidation to finish
await waitFor(revalidate * 1000 + 1000) await retry(async () => {
await next.render('/test') await next.render('/test')
expect(invocation(next.cliOutput)).toBe(2) expect(invocation(next.cliOutput)).toBe(2)
}, 10_000)
}) })
}) })
} else { } else {
......
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