Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix unhandled rejection on route change in dev #31554

Merged
merged 1 commit into from
Nov 17, 2021
Merged

Fix unhandled rejection on route change in dev #31554

merged 1 commit into from
Nov 17, 2021

Conversation

ijjk
Copy link
Member

@ijjk ijjk commented Nov 17, 2021

This ensures we properly catch the rejection on route change failure in development so the dev overlay doesn't flash with the unhandled rejection. A test case isn't able to be added for this specific scenario as the unhandled rejection is fired right before the page is navigated so we can't consistently check if the rejection was unhandled or not.

Bug

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

Fixes: #28560

@ijjk ijjk added created-by: Next.js team PRs by the Next.js team. type: next labels Nov 17, 2021
@ijjk ijjk marked this pull request as ready for review November 17, 2021 21:02
@ijjk
Copy link
Member Author

ijjk commented Nov 17, 2021

Stats from current PR

Default Build (Increase detected ⚠️)
General Overall decrease ✓
vercel/next.js canary ijjk/next.js fix/dev-unhandled-rejection Change
buildDuration 24.1s 24.3s ⚠️ +193ms
buildDurationCached 4.7s 4.7s -60ms
nodeModulesSize 338 MB 338 MB -15 B
Page Load Tests Overall increase ✓
vercel/next.js canary ijjk/next.js fix/dev-unhandled-rejection Change
/ failed reqs 0 0 ✓
/ total time (seconds) 4.111 4.08 -0.03
/ avg req/sec 608.05 612.73 +4.68
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 2.19 2.056 -0.13
/error-in-render avg req/sec 1141.77 1215.81 +74.04
Client Bundles (main, webpack, commons) Overall increase ⚠️
vercel/next.js canary ijjk/next.js fix/dev-unhandled-rejection Change
450.HASH.js gzip 179 B 179 B ✓
framework-HASH.js gzip 42.2 kB 42.2 kB ✓
main-HASH.js gzip 28.3 kB 28.3 kB ⚠️ +8 B
webpack-HASH.js gzip 1.45 kB 1.45 kB ✓
Overall change 72.2 kB 72.2 kB ⚠️ +8 B
Legacy Client Bundles (polyfills)
vercel/next.js canary ijjk/next.js fix/dev-unhandled-rejection Change
polyfills-HASH.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary ijjk/next.js fix/dev-unhandled-rejection Change
_app-HASH.js gzip 1.37 kB 1.37 kB ✓
_error-HASH.js gzip 194 B 194 B ✓
amp-HASH.js gzip 312 B 312 B ✓
css-HASH.js gzip 327 B 327 B ✓
dynamic-HASH.js gzip 2.38 kB 2.38 kB ✓
head-HASH.js gzip 350 B 350 B ✓
hooks-HASH.js gzip 635 B 635 B ✓
image-HASH.js gzip 4.44 kB 4.44 kB ✓
index-HASH.js gzip 263 B 263 B ✓
link-HASH.js gzip 1.87 kB 1.87 kB ✓
routerDirect..HASH.js gzip 321 B 321 B ✓
script-HASH.js gzip 383 B 383 B ✓
withRouter-HASH.js gzip 318 B 318 B ✓
85e02e95b279..7e3.css gzip 107 B 107 B ✓
Overall change 13.3 kB 13.3 kB ✓
Client Build Manifests
vercel/next.js canary ijjk/next.js fix/dev-unhandled-rejection Change
_buildManifest.js gzip 460 B 460 B ✓
Overall change 460 B 460 B ✓
Rendered Page Sizes Overall decrease ✓
vercel/next.js canary ijjk/next.js fix/dev-unhandled-rejection Change
index.html gzip 524 B 523 B -1 B
link.html gzip 536 B 536 B ✓
withRouter.html gzip 517 B 517 B ✓
Overall change 1.58 kB 1.58 kB -1 B

Diffs

Diff for main-HASH.js 
@@ -2272,31 +2272,31 @@
             var _this = this;
             return withFuture(route, routes, function() {
               var _this1 = _this;
-              var routeFilesPromise = getFilesForRoute(assetPrefix, route)
-                .then(function(param) {
-                  var scripts = param.scripts,
-                    css = param.css;
-                  return Promise.all([
-                    entrypoints.has(route)
-                      ? []
-                      : Promise.all(scripts.map(maybeExecuteScript)),
-                    Promise.all(css.map(fetchStyleSheet))
-                  ]);
-                })
-                .then(function(res) {
-                  return _this1
-                    .whenEntrypoint(route)
-                    .then(function(entrypoint) {
-                      return {
-                        entrypoint: entrypoint,
-                        styles: res[1]
-                      };
-                    });
-                });
+              var devBuildPromiseResolve;
               if (false) {
               }
               return resolvePromiseWithTimeout(
-                routeFilesPromise,
+                getFilesForRoute(assetPrefix, route)
+                  .then(function(param) {
+                    var scripts = param.scripts,
+                      css = param.css;
+                    return Promise.all([
+                      entrypoints.has(route)
+                        ? []
+                        : Promise.all(scripts.map(maybeExecuteScript)),
+                      Promise.all(css.map(fetchStyleSheet))
+                    ]);
+                  })
+                  .then(function(res) {
+                    return _this1
+                      .whenEntrypoint(route)
+                      .then(function(entrypoint) {
+                        return {
+                          entrypoint: entrypoint,
+                          styles: res[1]
+                        };
+                      });
+                  }),
                 MS_MAX_IDLE_DELAY,
                 markAssetError(
                   new Error("Route did not complete loading: ".concat(route))
@@ -2321,6 +2321,12 @@
                   return {
                     error: err
                   };
+                })
+                .finally(function() {
+                  return devBuildPromiseResolve === null ||
+                    devBuildPromiseResolve === void 0
+                    ? void 0
+                    : devBuildPromiseResolve();
                 });
             });
           },
Diff for index.html 
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-651a7836c7044f58.js"
+      src="/_next/static/chunks/main-339e07ccb2e8aec5.js"
       defer=""
     ></script>
     <script
Diff for link.html 
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-651a7836c7044f58.js"
+      src="/_next/static/chunks/main-339e07ccb2e8aec5.js"
       defer=""
     ></script>
     <script
Diff for withRouter.html 
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-651a7836c7044f58.js"
+      src="/_next/static/chunks/main-339e07ccb2e8aec5.js"
       defer=""
     ></script>
     <script
Default Build with SWC (Increase detected ⚠️)
General Overall decrease ✓
vercel/next.js canary ijjk/next.js fix/dev-unhandled-rejection Change
buildDuration 25.9s 26s ⚠️ +125ms
buildDurationCached 4.8s 4.4s -331ms
nodeModulesSize 338 MB 338 MB -15 B
Page Load Tests Overall decrease ⚠️
vercel/next.js canary ijjk/next.js fix/dev-unhandled-rejection Change
/ failed reqs 0 0 ✓
/ total time (seconds) 4.087 4.144 ⚠️ +0.06
/ avg req/sec 611.76 603.21 ⚠️ -8.55
/error-in-render failed reqs 0 0 ✓
/error-in-render total time (seconds) 2.091 2.092 0
/error-in-render avg req/sec 1195.52 1195.07 ⚠️ -0.45
Client Bundles (main, webpack, commons) Overall increase ⚠️
vercel/next.js canary ijjk/next.js fix/dev-unhandled-rejection Change
450.HASH.js gzip 179 B 179 B ✓
framework-HASH.js gzip 42.3 kB 42.3 kB ✓
main-HASH.js gzip 28.6 kB 28.6 kB ⚠️ +11 B
webpack-HASH.js gzip 1.44 kB 1.44 kB ✓
Overall change 72.5 kB 72.5 kB ⚠️ +11 B
Legacy Client Bundles (polyfills)
vercel/next.js canary ijjk/next.js fix/dev-unhandled-rejection Change
polyfills-HASH.js gzip 31 kB 31 kB ✓
Overall change 31 kB 31 kB ✓
Client Pages
vercel/next.js canary ijjk/next.js fix/dev-unhandled-rejection Change
_app-HASH.js gzip 1.35 kB 1.35 kB ✓
_error-HASH.js gzip 180 B 180 B ✓
amp-HASH.js gzip 305 B 305 B ✓
css-HASH.js gzip 321 B 321 B ✓
dynamic-HASH.js gzip 2.38 kB 2.38 kB ✓
head-HASH.js gzip 342 B 342 B ✓
hooks-HASH.js gzip 622 B 622 B ✓
image-HASH.js gzip 4.46 kB 4.46 kB ✓
index-HASH.js gzip 256 B 256 B ✓
link-HASH.js gzip 1.91 kB 1.91 kB ✓
routerDirect..HASH.js gzip 314 B 314 B ✓
script-HASH.js gzip 375 B 375 B ✓
withRouter-HASH.js gzip 309 B 309 B ✓
85e02e95b279..7e3.css gzip 107 B 107 B ✓
Overall change 13.2 kB 13.2 kB ✓
Client Build Manifests
vercel/next.js canary ijjk/next.js fix/dev-unhandled-rejection Change
_buildManifest.js gzip 460 B 460 B ✓
Overall change 460 B 460 B ✓
Rendered Page Sizes Overall decrease ✓
vercel/next.js canary ijjk/next.js fix/dev-unhandled-rejection Change
index.html gzip 524 B 523 B -1 B
link.html gzip 536 B 535 B -1 B
withRouter.html gzip 517 B 516 B -1 B
Overall change 1.58 kB 1.57 kB -3 B

Diffs

Diff for main-HASH.js 
@@ -2272,31 +2272,31 @@
             var _this = this;
             return withFuture(route, routes, function() {
               var _this1 = _this;
-              var routeFilesPromise = getFilesForRoute(assetPrefix, route)
-                .then(function(param) {
-                  var scripts = param.scripts,
-                    css = param.css;
-                  return Promise.all([
-                    entrypoints.has(route)
-                      ? []
-                      : Promise.all(scripts.map(maybeExecuteScript)),
-                    Promise.all(css.map(fetchStyleSheet))
-                  ]);
-                })
-                .then(function(res) {
-                  return _this1
-                    .whenEntrypoint(route)
-                    .then(function(entrypoint) {
-                      return {
-                        entrypoint: entrypoint,
-                        styles: res[1]
-                      };
-                    });
-                });
+              var devBuildPromiseResolve;
               if (false) {
               }
               return resolvePromiseWithTimeout(
-                routeFilesPromise,
+                getFilesForRoute(assetPrefix, route)
+                  .then(function(param) {
+                    var scripts = param.scripts,
+                      css = param.css;
+                    return Promise.all([
+                      entrypoints.has(route)
+                        ? []
+                        : Promise.all(scripts.map(maybeExecuteScript)),
+                      Promise.all(css.map(fetchStyleSheet))
+                    ]);
+                  })
+                  .then(function(res) {
+                    return _this1
+                      .whenEntrypoint(route)
+                      .then(function(entrypoint) {
+                        return {
+                          entrypoint: entrypoint,
+                          styles: res[1]
+                        };
+                      });
+                  }),
                 MS_MAX_IDLE_DELAY,
                 markAssetError(
                   new Error("Route did not complete loading: ".concat(route))
@@ -2321,6 +2321,12 @@
                   return {
                     error: err
                   };
+                })
+                .finally(function() {
+                  return devBuildPromiseResolve === null ||
+                    devBuildPromiseResolve === void 0
+                    ? void 0
+                    : devBuildPromiseResolve();
                 });
             });
           },
Diff for index.html 
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-651a7836c7044f58.js"
+      src="/_next/static/chunks/main-339e07ccb2e8aec5.js"
       defer=""
     ></script>
     <script
Diff for link.html 
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-651a7836c7044f58.js"
+      src="/_next/static/chunks/main-339e07ccb2e8aec5.js"
       defer=""
     ></script>
     <script
Diff for withRouter.html 
@@ -19,7 +19,7 @@
       defer=""
     ></script>
     <script
-      src="/_next/static/chunks/main-651a7836c7044f58.js"
+      src="/_next/static/chunks/main-339e07ccb2e8aec5.js"
       defer=""
     ></script>
     <script
Commit: 1c75206

@kodiakhq kodiakhq bot merged commit 36d3198 into vercel:canary Nov 17, 2021
@ijjk ijjk deleted the fix/dev-unhandled-rejection branch November 17, 2021 21:37
@vercel vercel locked as resolved and limited conversation to collaborators Jan 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@huozhi huozhi huozhi approved these changes

@shuding shuding Awaiting requested review from shuding

@timneutkens timneutkens Awaiting requested review from timneutkens

Assignees
No one assigned
Labels
created-by: Next.js team PRs by the Next.js team. type: next
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Next/link triggering momentary 'Unhandled Runtime Error' only in dev mode
2 participants
@ijjk @huozhi