Ensure timed out prefetches are cleaned up correctly #28899

ijjk · 2021-09-07T21:08:50Z

This applies the fix from the awesome investigation done in #28797 by @jayphelps and adds a test to ensure this is working as expected. It seems that the route-loader has a race condition while prefetching and if a script is executed before we have created a current "future" entry to resolve the entry stays in a pending state causing routes to hang so this handles the condition by ensuring pending/errored entries do not stay around.

Bug

Related issues linked using fixes #number
Integration tests added
Errors have helpful link attached, see contributing.md

Fixes: #28797
Fixes: #27783
x-ref: #28038

jayphelps · 2021-09-07T22:19:21Z

Thanks for PRing!

ijjk · 2021-09-08T00:17:25Z

Stats from current PR

Default Build (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	ijjk/next.js fix/timed-out-prefetch	Change
buildDuration	15.8s	15.9s	⚠️ +64ms
buildDurationCached	4.1s	3.9s	-110ms
nodeModulesSize	48.2 MB	48.2 MB	⚠️ +325 B

Page Load Tests Overall increase ✓

	vercel/next.js canary	ijjk/next.js fix/timed-out-prefetch	Change
/ failed reqs	0	0	✓
/ total time (seconds)	3.154	3.122	-0.03
/ avg req/sec	792.63	800.72	+8.09
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.89	1.89	✓
/error-in-render avg req/sec	1322.67	1322.76	+0.09

Client Bundles (main, webpack, commons) Overall increase ⚠️

	vercel/next.js canary	ijjk/next.js fix/timed-out-prefetch	Change
745.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42.2 kB	42.2 kB	✓
main-HASH.js gzip	23.3 kB	23.3 kB	⚠️ +15 B
webpack-HASH.js gzip	1.45 kB	1.45 kB	✓
Overall change	67.2 kB	67.2 kB	⚠️ +15 B

Legacy Client Bundles (polyfills)

	vercel/next.js canary	ijjk/next.js fix/timed-out-prefetch	Change
polyfills-a4..dd70.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	ijjk/next.js fix/timed-out-prefetch	Change
_app-HASH.js gzip	979 B	979 B	✓
_error-HASH.js gzip	194 B	194 B	✓
amp-HASH.js gzip	312 B	312 B	✓
css-HASH.js gzip	329 B	329 B	✓
dynamic-HASH.js gzip	2.67 kB	2.67 kB	✓
head-HASH.js gzip	351 B	351 B	✓
hooks-HASH.js gzip	918 B	918 B	✓
image-HASH.js gzip	4.14 kB	4.14 kB	✓
index-HASH.js gzip	261 B	261 B	✓
link-HASH.js gzip	1.66 kB	1.66 kB	✓
routerDirect..HASH.js gzip	318 B	318 B	✓
script-HASH.js gzip	387 B	387 B	✓
withRouter-HASH.js gzip	320 B	320 B	✓
bb14e60e810b..30f.css gzip	125 B	125 B	✓
Overall change	13 kB	13 kB	✓

Client Build Manifests

	vercel/next.js canary	ijjk/next.js fix/timed-out-prefetch	Change
_buildManifest.js gzip	492 B	492 B	✓
Overall change	492 B	492 B	✓

Rendered Page Sizes Overall decrease ✓

	vercel/next.js canary	ijjk/next.js fix/timed-out-prefetch	Change
index.html gzip	541 B	537 B	-4 B
link.html gzip	553 B	552 B	-1 B
withRouter.html gzip	534 B	532 B	-2 B
Overall change	1.63 kB	1.62 kB	-7 B

Diffs

Diff for main-HASH.js

@@ -2589,9 +2589,14 @@
           })
         );
         return generator
-          ? generator().then(function(value) {
-              return resolver(value), value;
-            })
+          ? generator() // eslint-disable-next-line no-sequences
+              .then(function(value) {
+                return resolver(value), value;
+              })
+              ["catch"](function(err) {
+                map["delete"](key);
+                throw err;
+              })
           : prom;
       }

Diff for index.html

@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-c7a05ccfe26316f478d0.js"
+      src="/_next/static/chunks/main-3bd5cfe48d7f624169dd.js"
       defer=""
     ></script>
     <script

Diff for link.html

@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-c7a05ccfe26316f478d0.js"
+      src="/_next/static/chunks/main-3bd5cfe48d7f624169dd.js"
       defer=""
     ></script>
     <script

Diff for withRouter.html

@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-c7a05ccfe26316f478d0.js"
+      src="/_next/static/chunks/main-3bd5cfe48d7f624169dd.js"
       defer=""
     ></script>
     <script

Webpack 4 Mode (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	ijjk/next.js fix/timed-out-prefetch	Change
buildDuration	12.7s	12.8s	⚠️ +121ms
buildDurationCached	5.3s	5.3s	-78ms
nodeModulesSize	48.2 MB	48.2 MB	⚠️ +325 B

Page Load Tests Overall increase ✓

	vercel/next.js canary	ijjk/next.js fix/timed-out-prefetch	Change
/ failed reqs	0	0	✓
/ total time (seconds)	3.15	3.139	-0.01
/ avg req/sec	793.53	796.31	+2.78
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.887	1.88	-0.01
/error-in-render avg req/sec	1324.64	1329.51	+4.87

Client Bundles (main, webpack, commons) Overall increase ⚠️

	vercel/next.js canary	ijjk/next.js fix/timed-out-prefetch	Change
16.HASH.js gzip	186 B	186 B	✓
677f882d2ed8..HASH.js gzip	14.1 kB	14.1 kB	⚠️ +15 B
framework.HASH.js gzip	41.9 kB	41.9 kB	✓
main-HASH.js gzip	10.7 kB	10.7 kB	✓
webpack-HASH.js gzip	1.19 kB	1.19 kB	✓
Overall change	68.1 kB	68.1 kB	⚠️ +15 B

Legacy Client Bundles (polyfills)

	vercel/next.js canary	ijjk/next.js fix/timed-out-prefetch	Change
polyfills-a4..dd70.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	ijjk/next.js fix/timed-out-prefetch	Change
_app-HASH.js gzip	964 B	964 B	✓
_error-HASH.js gzip	3.8 kB	3.8 kB	✓
amp-HASH.js gzip	552 B	552 B	✓
css-HASH.js gzip	333 B	333 B	✓
dynamic-HASH.js gzip	2.87 kB	2.87 kB	✓
head-HASH.js gzip	3.06 kB	3.06 kB	✓
hooks-HASH.js gzip	924 B	924 B	✓
index-HASH.js gzip	231 B	231 B	✓
link-HASH.js gzip	1.64 kB	1.64 kB	✓
routerDirect..HASH.js gzip	298 B	298 B	✓
script-HASH.js gzip	3.03 kB	3.03 kB	✓
withRouter-HASH.js gzip	295 B	295 B	✓
30809af5c834..565.css gzip	125 B	125 B	✓
Overall change	18.1 kB	18.1 kB	✓

Client Build Manifests

	vercel/next.js canary	ijjk/next.js fix/timed-out-prefetch	Change
_buildManifest.js gzip	500 B	500 B	✓
Overall change	500 B	500 B	✓

Rendered Page Sizes Overall increase ⚠️

	vercel/next.js canary	ijjk/next.js fix/timed-out-prefetch	Change
index.html gzip	585 B	586 B	⚠️ +1 B
link.html gzip	596 B	597 B	⚠️ +1 B
withRouter.html gzip	577 B	578 B	⚠️ +1 B
Overall change	1.76 kB	1.76 kB	⚠️ +3 B

Diffs

Diff for 677f882d2ed8..c4df.HASH.js

@@ -834,9 +834,14 @@
           })
         );
         return generator
-          ? generator().then(function(value) {
-              return resolver(value), value;
-            })
+          ? generator() // eslint-disable-next-line no-sequences
+              .then(function(value) {
+                return resolver(value), value;
+              })
+              ["catch"](function(err) {
+                map["delete"](key);
+                throw err;
+              })
           : prom;
       }

Diff for index.html

@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.891f3d9eee23571a9bfc.js"
+      src="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.c612937c8a419d7aa025.js"
       defer=""
     ></script>
     <script

Diff for link.html

@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.891f3d9eee23571a9bfc.js"
+      src="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.c612937c8a419d7aa025.js"
       defer=""
     ></script>
     <script

Diff for withRouter.html

@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.891f3d9eee23571a9bfc.js"
+      src="/_next/static/chunks/677f882d2ed86fa3467b8979053c1a4c3f8bc4df.c612937c8a419d7aa025.js"
       defer=""
     ></script>
     <script

Commit: 55b9f2c

* canary: v11.1.3-canary.14 Ensure timed out prefetches are cleaned up correctly (vercel#28899) Fix/swc minify (vercel#28898) Update concurrent tests and enable experimental streaming (vercel#28892) Fix Typo in "with-eslint" Example docs (vercel#28601) Examples Prepr CMS update (vercel#28871) fixes with-typescript-graphql: unable to resolve dependency tree (vercel#28637) Update `next/link` API docs to mention a11y and ESLint rule. (vercel#28841) Trim large test output to not exceed limit (vercel#28881) Updates @react-three/drei version and other dependencies. (vercel#28755) Remove unused dependencies (vercel#28876)

akshaysura · 2021-09-08T13:48:16Z

can't wait to test this out!

drewpc · 2021-10-21T03:23:27Z

@ijjk will this fix be ported back to the 10.2 version for those of us that have not yet upgraded to 11.x?

Ensure timed out prefetches are cleaned up correctly

553c676

ijjk requested review from huozhi, padmaia, shuding, styfle and timneutkens as code owners September 7, 2021 21:08

ijjk added created-by: Next.js team PRs by the Next.js team type: next labels Sep 7, 2021

fix-lint

5d72070

fix test

162b96d

This comment has been minimized.

Sign in to view

Merge branch 'canary' into fix/timed-out-prefetch

55b9f2c

timneutkens approved these changes Sep 8, 2021

View reviewed changes

kodiakhq bot merged commit b71df19 into vercel:canary Sep 8, 2021

ijjk deleted the fix/timed-out-prefetch branch September 8, 2021 13:12

dtothefp mentioned this pull request Sep 14, 2021

Links randomly not working and the Routing system is broken. (Let's Fix it) #27783

Closed

vercel locked as resolved and limited conversation to collaborators Jan 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ensure timed out prefetches are cleaned up correctly #28899

Ensure timed out prefetches are cleaned up correctly #28899

ijjk commented Sep 7, 2021 •

edited

jayphelps commented Sep 7, 2021

This comment has been minimized.

ijjk commented Sep 8, 2021

Diffs

Diffs

akshaysura commented Sep 8, 2021

drewpc commented Oct 21, 2021 •

edited

Ensure timed out prefetches are cleaned up correctly #28899

Ensure timed out prefetches are cleaned up correctly #28899

Conversation

ijjk commented Sep 7, 2021 • edited

Bug

jayphelps commented Sep 7, 2021

This comment has been minimized.

ijjk commented Sep 8, 2021

Stats from current PR

Diffs

Diffs

akshaysura commented Sep 8, 2021

drewpc commented Oct 21, 2021 • edited

ijjk commented Sep 7, 2021 •

edited

drewpc commented Oct 21, 2021 •

edited