fix waitUntil handling in pipeToNodeResponse

[ztanner]

What?

Calls to revalidateTag when using the data cache would sometimes be ignored. This would result in stale data being displayed even after manually triggering a revalidation.

Why?

Revalidation calls are pushed onto a pendingRevalidates array and, in the case of a route handler, are awaited here.

Previously this took place as part of the former pipeReadable implementation (ref) which awaited the promise before calling res.end (ref). There was a subtle change in behavior here in a recent refactor that seems to cause a race between awaiting the promise and ending the response, which results in this unpredictable behavior.

How?

This applies similar logic that used to be in the pipeReadable function to the new pipeToNodeResponse function. Namely, we plumb waitUntil into the writeable stream close handler and await it before calling res.end().

This is a very difficult edge case to test, and as such resorted to rigorous manual testing when deployed to an environment that uses the data cache.

Fixes #52962
Fixes #57632

[ztanner]

Current dependencies on/for this PR:

• canary
  • PR fix waitUntil handling in pipeToNodeResponse #58744 👈

This stack of pull requests is managed by Graphite.

[ijjk]

Stats from current PR

Default Build

General Overall increase ⚠️

	vercel/next.js canary	vercel/next.js 11-21-fix_waitUntil_handling_in_pipeToNodeResponse	Change
buildDuration	19.8s	22s	⚠️ +2.2s
buildDurationCached	12s	11.9s	N/A
nodeModulesSize	199 MB	199 MB	⚠️ +2.65 kB
nextStartRea..uration (ms)	740ms	807ms	N/A

Client Bundles (main, webpack)

	vercel/next.js canary	vercel/next.js 11-21-fix_waitUntil_handling_in_pipeToNodeResponse	Change
199-HASH.js gzip	28.7 kB	28.7 kB	N/A
3f784ff6-HASH.js gzip	53.3 kB	53.3 kB	✓
494.HASH.js gzip	180 B	181 B	N/A
framework-HASH.js gzip	45.2 kB	45.2 kB	✓
main-app-HASH.js gzip	240 B	238 B	N/A
main-HASH.js gzip	31.7 kB	31.7 kB	N/A
webpack-HASH.js gzip	1.7 kB	1.7 kB	✓
Overall change	100 kB	100 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js 11-21-fix_waitUntil_handling_in_pipeToNodeResponse	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js 11-21-fix_waitUntil_handling_in_pipeToNodeResponse	Change
_app-HASH.js gzip	194 B	195 B	N/A
_error-HASH.js gzip	182 B	181 B	N/A
amp-HASH.js gzip	501 B	503 B	N/A
css-HASH.js gzip	322 B	323 B	N/A
dynamic-HASH.js gzip	2.5 kB	2.5 kB	✓
edge-ssr-HASH.js gzip	253 B	255 B	N/A
head-HASH.js gzip	348 B	347 B	N/A
hooks-HASH.js gzip	369 B	368 B	N/A
image-HASH.js gzip	4.28 kB	4.27 kB	N/A
index-HASH.js gzip	256 B	256 B	✓
link-HASH.js gzip	2.61 kB	2.6 kB	N/A
routerDirect..HASH.js gzip	311 B	311 B	✓
script-HASH.js gzip	384 B	383 B	N/A
withRouter-HASH.js gzip	307 B	308 B	N/A
1afbb74e6ecf..834.css gzip	106 B	106 B	✓
Overall change	3.17 kB	3.17 kB	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js 11-21-fix_waitUntil_handling_in_pipeToNodeResponse	Change
_buildManifest.js gzip	484 B	483 B	N/A
Overall change	0 B	0 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js 11-21-fix_waitUntil_handling_in_pipeToNodeResponse	Change
index.html gzip	527 B	528 B	N/A
link.html gzip	539 B	541 B	N/A
withRouter.html gzip	524 B	523 B	N/A
Overall change	0 B	0 B	✓

Edge SSR bundle Size

	vercel/next.js canary	vercel/next.js 11-21-fix_waitUntil_handling_in_pipeToNodeResponse	Change
edge-ssr.js gzip	92.4 kB	92.4 kB	N/A
page.js gzip	145 kB	145 kB	N/A
Overall change	0 B	0 B	✓

Middleware size

	vercel/next.js canary	vercel/next.js 11-21-fix_waitUntil_handling_in_pipeToNodeResponse	Change
middleware-b..fest.js gzip	626 B	625 B	N/A
middleware-r..fest.js gzip	150 B	151 B	N/A
middleware.js gzip	24.8 kB	24.8 kB	N/A
edge-runtime..pack.js gzip	1.92 kB	1.92 kB	✓
Overall change	1.92 kB	1.92 kB	✓

Next Runtimes

	vercel/next.js canary	vercel/next.js 11-21-fix_waitUntil_handling_in_pipeToNodeResponse	Change
app-page-exp...dev.js gzip	167 kB	167 kB	N/A
app-page-exp..prod.js gzip	93.3 kB	93.3 kB	N/A
app-page-tur..prod.js gzip	94 kB	94 kB	N/A
app-page-tur..prod.js gzip	88.6 kB	88.6 kB	N/A
app-page.run...dev.js gzip	137 kB	137 kB	N/A
app-page.run..prod.js gzip	87.9 kB	87.9 kB	N/A
app-route-ex...dev.js gzip	23.8 kB	23.8 kB	✓
app-route-ex..prod.js gzip	16.4 kB	16.4 kB	✓
app-route-tu..prod.js gzip	16.5 kB	16.5 kB	✓
app-route-tu..prod.js gzip	16 kB	16 kB	✓
app-route.ru...dev.js gzip	23.2 kB	23.2 kB	✓
app-route.ru..prod.js gzip	16 kB	16 kB	✓
pages-api-tu..prod.js gzip	9.37 kB	9.37 kB	✓
pages-api.ru...dev.js gzip	9.64 kB	9.64 kB	✓
pages-api.ru..prod.js gzip	9.37 kB	9.37 kB	✓
pages-turbo...prod.js gzip	21.8 kB	21.8 kB	N/A
pages.runtim...dev.js gzip	22.5 kB	22.5 kB	N/A
pages.runtim..prod.js gzip	21.8 kB	21.8 kB	N/A
server.runti..prod.js gzip	49.1 kB	49.1 kB	N/A
Overall change	140 kB	140 kB	✓

Diff details

Diff for page.js

Diff too large to display

Diff for edge-ssr.js

Diff too large to display

Diff for app-page-exp..ntime.dev.js

Diff too large to display

Diff for app-page-exp..time.prod.js

Diff too large to display

Diff for app-page-tur..time.prod.js

Diff too large to display

Diff for app-page-tur..time.prod.js

Diff too large to display

Diff for app-page.runtime.dev.js

Diff too large to display

Diff for app-page.runtime.prod.js

Diff too large to display

Diff for pages-turbo...time.prod.js

Diff too large to display

Diff for pages.runtime.dev.js

Diff too large to display

Diff for pages.runtime.prod.js

Diff too large to display

Diff for server.runtime.prod.js

Diff too large to display

Commit: 9f449e7

[ijjk]

Tests Passed