fix hmr in multi-zone handling

[ztanner]

What?

When running a multi-zone app in dev, app pages would infinitely reload

Why?

The HMR upgrade request would fail and get caught into a retry loop. In the multi-zone case, they fail because the upgrade request would be sent again for a request that had already been upgraded. This resulted in a "server.handleUpgrade() was called more than once with the same socket" error, causing the upgrade request to fail.

Every time a retry occurred, the page would trigger a full refresh since certain HMR errors cause the browser to reload.

How?

This ensures the upgrade handler only responds to requests that match the configured basePath.

Closes NEXT-1797
Fixes #59161
Fixes #56615
Fixes #54454

[ztanner]

Current dependencies on/for this PR:

• canary
  • PR fix hmr in multi-zone handling #59307 👈

This stack of pull requests is managed by Graphite.

[ijjk]

Tests Passed

[ijjk]

Stats from current PR

Default Build

General Overall increase ⚠️

	vercel/next.js canary	vercel/next.js 12-05-fix_hmr_in_multi-zone_handling	Change
buildDuration	10.5s	10.3s	N/A
buildDurationCached	5.9s	5.9s	N/A
nodeModulesSize	199 MB	199 MB	⚠️ +1.9 kB
nextStartRea..uration (ms)	419ms	424ms	N/A

Client Bundles (main, webpack)

	vercel/next.js canary	vercel/next.js 12-05-fix_hmr_in_multi-zone_handling	Change
170-HASH.js gzip	30.6 kB	30.6 kB	N/A
199.HASH.js gzip	181 B	185 B	N/A
3f784ff6-HASH.js gzip	53.3 kB	53.3 kB	✓
framework-HASH.js gzip	45.2 kB	45.2 kB	✓
main-app-HASH.js gzip	240 B	241 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	N/A
Overall change	98.5 kB	98.5 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js 12-05-fix_hmr_in_multi-zone_handling	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js 12-05-fix_hmr_in_multi-zone_handling	Change
_app-HASH.js gzip	195 B	194 B	N/A
_error-HASH.js gzip	183 B	182 B	N/A
amp-HASH.js gzip	501 B	501 B	✓
css-HASH.js gzip	321 B	321 B	✓
dynamic-HASH.js gzip	2.5 kB	2.5 kB	N/A
edge-ssr-HASH.js gzip	255 B	255 B	✓
head-HASH.js gzip	349 B	350 B	N/A
hooks-HASH.js gzip	368 B	369 B	N/A
image-HASH.js gzip	4.27 kB	4.27 kB	N/A
index-HASH.js gzip	255 B	256 B	N/A
link-HASH.js gzip	2.6 kB	2.6 kB	N/A
routerDirect..HASH.js gzip	311 B	309 B	N/A
script-HASH.js gzip	384 B	384 B	✓
withRouter-HASH.js gzip	307 B	306 B	N/A
1afbb74e6ecf..834.css gzip	106 B	106 B	✓
Overall change	1.57 kB	1.57 kB	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js 12-05-fix_hmr_in_multi-zone_handling	Change
_buildManifest.js gzip	483 B	483 B	✓
Overall change	483 B	483 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js 12-05-fix_hmr_in_multi-zone_handling	Change
index.html gzip	528 B	529 B	N/A
link.html gzip	543 B	541 B	N/A
withRouter.html gzip	523 B	524 B	N/A
Overall change	0 B	0 B	✓

Edge SSR bundle Size

	vercel/next.js canary	vercel/next.js 12-05-fix_hmr_in_multi-zone_handling	Change
edge-ssr.js gzip	93.5 kB	93.5 kB	N/A
page.js gzip	146 kB	146 kB	N/A
Overall change	0 B	0 B	✓

Middleware size

	vercel/next.js canary	vercel/next.js 12-05-fix_hmr_in_multi-zone_handling	Change
middleware-b..fest.js gzip	623 B	625 B	N/A
middleware-r..fest.js gzip	151 B	151 B	✓
middleware.js gzip	37.5 kB	37.5 kB	N/A
edge-runtime..pack.js gzip	1.92 kB	1.92 kB	✓
Overall change	2.07 kB	2.07 kB	✓

Next Runtimes

	vercel/next.js canary	vercel/next.js 12-05-fix_hmr_in_multi-zone_handling	Change
app-page-exp...dev.js gzip	168 kB	168 kB	✓
app-page-exp..prod.js gzip	93.8 kB	93.8 kB	✓
app-page-tur..prod.js gzip	94.5 kB	94.5 kB	✓
app-page-tur..prod.js gzip	89.1 kB	89.1 kB	✓
app-page.run...dev.js gzip	138 kB	138 kB	✓
app-page.run..prod.js gzip	88.4 kB	88.4 kB	✓
app-route-ex...dev.js gzip	24.2 kB	24.2 kB	✓
app-route-ex..prod.js gzip	16.8 kB	16.8 kB	✓
app-route-tu..prod.js gzip	16.9 kB	16.9 kB	✓
app-route-tu..prod.js gzip	16.4 kB	16.4 kB	✓
app-route.ru...dev.js gzip	23.6 kB	23.6 kB	✓
app-route.ru..prod.js gzip	16.4 kB	16.4 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.9 kB	21.9 kB	✓
pages.runtim...dev.js gzip	22.6 kB	22.6 kB	✓
pages.runtim..prod.js gzip	21.9 kB	21.9 kB	✓
server.runti..prod.js gzip	49.4 kB	49.4 kB	✓
Overall change	930 kB	930 kB	✓

Commit: f5d1c48

[9vfQbg7z4ajrGQxR]

Thanks a lot for the fix @ztanner 🙏, but it seems that now the hot reload doesn't work once on the zones, we are forced to refresh the browser.