Ensure dev overlay is triggered for more _app/_document errors #24328

ijjk · 2021-04-21T20:28:17Z

This expands on #24070 and ensures we show the dev overlay for additional cases like where _app or _document have syntax errors causing compilation to not be able to complete. This achieves showing the dev overlay even when compilation fails from a syntax error by doing a third minimal compilation in development with the needed client-side assets to render the dev overlay.

Bug

Related issues linked using fixes #number
Integration tests added

x-ref: #24070

…errors

ijjk · 2021-04-22T02:05:12Z

Stats from current PR

Default Server Mode (Decrease detected ✓)

General Overall increase ⚠️

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
buildDuration	16.2s	16.1s	-70ms
buildDurationCached	5.3s	4.9s	-375ms
nodeModulesSize	46.6 MB	46.6 MB	⚠️ +9.08 kB

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.832	2.806	-0.03
/ avg req/sec	882.92	891.06	+8.14
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.54	1.602	⚠️ +0.06
/error-in-render avg req/sec	1623.85	1560.53	⚠️ -63.32

Client Bundles (main, webpack, commons)

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
597-HASH.js gzip	13.3 kB	13.3 kB	✓
778-HASH.js gzip	7.12 kB	7.12 kB	✓
framework-HASH.js gzip	39.3 kB	39.3 kB	✓
main-HASH.js gzip	151 B	151 B	✓
webpack-HASH.js gzip	993 B	993 B	✓
Overall change	60.8 kB	60.8 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
polyfills-HASH.js gzip	31.1 kB	31.1 kB	✓
Overall change	31.1 kB	31.1 kB	✓

Client Pages

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
_app-HASH.js gzip	1.3 kB	1.3 kB	✓
_error-HASH.js gzip	3.68 kB	3.68 kB	✓
amp-HASH.js gzip	558 B	558 B	✓
css-HASH.js gzip	363 B	363 B	✓
hooks-HASH.js gzip	924 B	924 B	✓
index-HASH.js gzip	243 B	243 B	✓
link-HASH.js gzip	1.66 kB	1.66 kB	✓
routerDirect..HASH.js gzip	336 B	336 B	✓
withRouter-HASH.js gzip	334 B	334 B	✓
99a142a5cfae..804.css gzip	125 B	125 B	✓
Overall change	9.52 kB	9.52 kB	✓

Client Build Manifests

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
_buildManifest.js gzip	390 B	390 B	✓
Overall change	390 B	390 B	✓

Rendered Page Sizes

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
index.html gzip	610 B	610 B	✓
link.html gzip	615 B	615 B	✓
withRouter.html gzip	604 B	604 B	✓
Overall change	1.83 kB	1.83 kB	✓

Serverless Mode (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
buildDuration	19.8s	19.9s	⚠️ +136ms
buildDurationCached	7.3s	7.2s	-105ms
nodeModulesSize	46.6 MB	46.6 MB	⚠️ +9.08 kB

Client Bundles (main, webpack, commons)

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
597-HASH.js gzip	13.3 kB	13.3 kB	✓
778-HASH.js gzip	7.12 kB	7.12 kB	✓
framework-HASH.js gzip	39.3 kB	39.3 kB	✓
main-HASH.js gzip	151 B	151 B	✓
webpack-HASH.js gzip	993 B	993 B	✓
Overall change	60.8 kB	60.8 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
polyfills-HASH.js gzip	31.1 kB	31.1 kB	✓
Overall change	31.1 kB	31.1 kB	✓

Client Pages

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
_app-HASH.js gzip	1.3 kB	1.3 kB	✓
_error-HASH.js gzip	3.68 kB	3.68 kB	✓
amp-HASH.js gzip	558 B	558 B	✓
css-HASH.js gzip	363 B	363 B	✓
hooks-HASH.js gzip	924 B	924 B	✓
index-HASH.js gzip	243 B	243 B	✓
link-HASH.js gzip	1.66 kB	1.66 kB	✓
routerDirect..HASH.js gzip	336 B	336 B	✓
withRouter-HASH.js gzip	334 B	334 B	✓
99a142a5cfae..804.css gzip	125 B	125 B	✓
Overall change	9.52 kB	9.52 kB	✓

Client Build Manifests

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
_buildManifest.js gzip	390 B	390 B	✓
Overall change	390 B	390 B	✓

Serverless bundles Overall increase ⚠️

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
_error.js	1.39 MB	1.39 MB	⚠️ +65 B
404.html	2.76 kB	2.76 kB	✓
500.html	2.75 kB	2.75 kB	✓
amp.amp.html	10.8 kB	10.8 kB	✓
amp.html	1.96 kB	1.96 kB	✓
css.html	2.13 kB	2.13 kB	✓
hooks.html	2.01 kB	2.01 kB	✓
index.js	1.39 MB	1.39 MB	⚠️ +65 B
link.js	1.45 MB	1.45 MB	⚠️ +65 B
routerDirect.js	1.44 MB	1.44 MB	⚠️ +65 B
withRouter.js	1.44 MB	1.44 MB	⚠️ +65 B
Overall change	7.15 MB	7.15 MB	⚠️ +325 B

Webpack 4 Mode (Decrease detected ✓)

General Overall increase ⚠️

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
buildDuration	13.1s	13.5s	⚠️ +387ms
buildDurationCached	5.6s	5.5s	-82ms
nodeModulesSize	46.6 MB	46.6 MB	⚠️ +9.08 kB

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.779	2.817	⚠️ +0.04
/ avg req/sec	899.65	887.6	⚠️ -12.05
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.646	1.647	0
/error-in-render avg req/sec	1518.67	1517.94	⚠️ -0.73

Client Bundles (main, webpack, commons)

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
677f882d2ed8..HASH.js gzip	13.4 kB	13.4 kB	✓
framework.HASH.js gzip	39 kB	39 kB	✓
main-HASH.js gzip	7.2 kB	7.2 kB	✓
webpack-HASH.js gzip	751 B	751 B	✓
Overall change	60.3 kB	60.3 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
polyfills-HASH.js gzip	31.3 kB	31.3 kB	✓
Overall change	31.3 kB	31.3 kB	✓

Client Pages

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
_app-HASH.js gzip	1.28 kB	1.28 kB	✓
_error-HASH.js gzip	3.71 kB	3.71 kB	✓
amp-HASH.js gzip	536 B	536 B	✓
css-HASH.js gzip	339 B	339 B	✓
hooks-HASH.js gzip	887 B	887 B	✓
index-HASH.js gzip	227 B	227 B	✓
link-HASH.js gzip	1.65 kB	1.65 kB	✓
routerDirect..HASH.js gzip	303 B	303 B	✓
withRouter-HASH.js gzip	302 B	302 B	✓
21c68fa65a48..217.css gzip	125 B	125 B	✓
Overall change	9.36 kB	9.36 kB	✓

Client Build Manifests

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
_buildManifest.js gzip	419 B	419 B	✓
Overall change	419 B	419 B	✓

Rendered Page Sizes

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
index.html gzip	612 B	612 B	✓
link.html gzip	619 B	619 B	✓
withRouter.html gzip	605 B	605 B	✓
Overall change	1.84 kB	1.84 kB	✓

Commit: c1b12ba

ijjk · 2021-04-22T10:51:49Z

Stats from current PR

Default Server Mode (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
buildDuration	12.3s	12.5s	⚠️ +240ms
buildDurationCached	4.1s	3.9s	-243ms
nodeModulesSize	46.6 MB	46.6 MB	⚠️ +9.08 kB

Page Load Tests Overall increase ✓

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.162	2.154	-0.01
/ avg req/sec	1156.2	1160.81	+4.61
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.078	1.068	-0.01
/error-in-render avg req/sec	2320.06	2339.89	+19.83

Client Bundles (main, webpack, commons)

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
597-HASH.js gzip	13.3 kB	13.3 kB	✓
778-HASH.js gzip	7.12 kB	7.12 kB	✓
framework-HASH.js gzip	39.3 kB	39.3 kB	✓
main-HASH.js gzip	151 B	151 B	✓
webpack-HASH.js gzip	993 B	993 B	✓
Overall change	60.8 kB	60.8 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
polyfills-HASH.js gzip	31.1 kB	31.1 kB	✓
Overall change	31.1 kB	31.1 kB	✓

Client Pages

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
_app-HASH.js gzip	1.3 kB	1.3 kB	✓
_error-HASH.js gzip	3.68 kB	3.68 kB	✓
amp-HASH.js gzip	558 B	558 B	✓
css-HASH.js gzip	363 B	363 B	✓
hooks-HASH.js gzip	924 B	924 B	✓
index-HASH.js gzip	243 B	243 B	✓
link-HASH.js gzip	1.66 kB	1.66 kB	✓
routerDirect..HASH.js gzip	336 B	336 B	✓
withRouter-HASH.js gzip	334 B	334 B	✓
99a142a5cfae..804.css gzip	125 B	125 B	✓
Overall change	9.52 kB	9.52 kB	✓

Client Build Manifests

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
_buildManifest.js gzip	390 B	390 B	✓
Overall change	390 B	390 B	✓

Rendered Page Sizes

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
index.html gzip	609 B	609 B	✓
link.html gzip	615 B	615 B	✓
withRouter.html gzip	604 B	604 B	✓
Overall change	1.83 kB	1.83 kB	✓

Serverless Mode (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
buildDuration	15.2s	15.4s	⚠️ +180ms
buildDurationCached	5.8s	5.9s	⚠️ +46ms
nodeModulesSize	46.6 MB	46.6 MB	⚠️ +9.08 kB

Client Bundles (main, webpack, commons)

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
597-HASH.js gzip	13.3 kB	13.3 kB	✓
778-HASH.js gzip	7.12 kB	7.12 kB	✓
framework-HASH.js gzip	39.3 kB	39.3 kB	✓
main-HASH.js gzip	151 B	151 B	✓
webpack-HASH.js gzip	993 B	993 B	✓
Overall change	60.8 kB	60.8 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
polyfills-HASH.js gzip	31.1 kB	31.1 kB	✓
Overall change	31.1 kB	31.1 kB	✓

Client Pages

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
_app-HASH.js gzip	1.3 kB	1.3 kB	✓
_error-HASH.js gzip	3.68 kB	3.68 kB	✓
amp-HASH.js gzip	558 B	558 B	✓
css-HASH.js gzip	363 B	363 B	✓
hooks-HASH.js gzip	924 B	924 B	✓
index-HASH.js gzip	243 B	243 B	✓
link-HASH.js gzip	1.66 kB	1.66 kB	✓
routerDirect..HASH.js gzip	336 B	336 B	✓
withRouter-HASH.js gzip	334 B	334 B	✓
99a142a5cfae..804.css gzip	125 B	125 B	✓
Overall change	9.52 kB	9.52 kB	✓

Client Build Manifests

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
_buildManifest.js gzip	390 B	390 B	✓
Overall change	390 B	390 B	✓

Serverless bundles Overall increase ⚠️

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
_error.js	1.39 MB	1.39 MB	⚠️ +67 B
404.html	2.76 kB	2.76 kB	✓
500.html	2.75 kB	2.75 kB	✓
amp.amp.html	10.8 kB	10.8 kB	✓
amp.html	1.96 kB	1.96 kB	✓
css.html	2.13 kB	2.13 kB	✓
hooks.html	2.01 kB	2.01 kB	✓
index.js	1.39 MB	1.39 MB	⚠️ +69 B
link.js	1.45 MB	1.45 MB	⚠️ +65 B
routerDirect.js	1.44 MB	1.44 MB	⚠️ +65 B
withRouter.js	1.44 MB	1.44 MB	⚠️ +65 B
Overall change	7.15 MB	7.15 MB	⚠️ +331 B

Webpack 4 Mode (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
buildDuration	10.5s	10.6s	⚠️ +124ms
buildDurationCached	4.4s	4.4s	-32ms
nodeModulesSize	46.6 MB	46.6 MB	⚠️ +9.08 kB

Page Load Tests Overall increase ✓

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.067	2.098	⚠️ +0.03
/ avg req/sec	1209.61	1191.39	⚠️ -18.22
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.104	1.075	-0.03
/error-in-render avg req/sec	2263.53	2326.66	+63.13

Client Bundles (main, webpack, commons)

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
677f882d2ed8..HASH.js gzip	13.4 kB	13.4 kB	✓
framework.HASH.js gzip	39 kB	39 kB	✓
main-HASH.js gzip	7.2 kB	7.2 kB	✓
webpack-HASH.js gzip	751 B	751 B	✓
Overall change	60.3 kB	60.3 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
polyfills-HASH.js gzip	31.3 kB	31.3 kB	✓
Overall change	31.3 kB	31.3 kB	✓

Client Pages

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
_app-HASH.js gzip	1.28 kB	1.28 kB	✓
_error-HASH.js gzip	3.71 kB	3.71 kB	✓
amp-HASH.js gzip	536 B	536 B	✓
css-HASH.js gzip	339 B	339 B	✓
hooks-HASH.js gzip	887 B	887 B	✓
index-HASH.js gzip	227 B	227 B	✓
link-HASH.js gzip	1.65 kB	1.65 kB	✓
routerDirect..HASH.js gzip	303 B	303 B	✓
withRouter-HASH.js gzip	302 B	302 B	✓
21c68fa65a48..217.css gzip	125 B	125 B	✓
Overall change	9.36 kB	9.36 kB	✓

Client Build Manifests

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
_buildManifest.js gzip	419 B	419 B	✓
Overall change	419 B	419 B	✓

Rendered Page Sizes

	vercel/next.js canary	ijjk/next.js fix/app-document-errors	Change
index.html gzip	611 B	611 B	✓
link.html gzip	620 B	620 B	✓
withRouter.html gzip	605 B	605 B	✓
Overall change	1.84 kB	1.84 kB	✓

Commit: 60a0537

PepijnSenders · 2021-04-28T23:36:19Z

@ijjk this will also swallow the original error. If say; the page component has a JS error (MODULE_NOT_FOUND in this case), you won't be able to see it and you will only be able to see the page not found for /whatever error.

Created a PR to address that #24577

## Bug - [x] Related issues linked using [`fixes #24328`](#24328 (comment)) - [ ] Integration tests added The change in #24328 will swallow any `MODULE_NOT_FOUND` errors triggered in the page. If you for example have a page with a broken import, it will tell you `Error: Failed to load /whatever`. This of course doesn't really tell people what is going on internally (a broken import). I added a check to see if the error actually happened in the page.

## Bug - [x] Related issues linked using [`fixes vercel#24328`](vercel#24328 (comment)) - [ ] Integration tests added The change in vercel#24328 will swallow any `MODULE_NOT_FOUND` errors triggered in the page. If you for example have a page with a broken import, it will tell you `Error: Failed to load /whatever`. This of course doesn't really tell people what is going on internally (a broken import). I added a check to see if the error actually happened in the page.

ijjk added 2 commits April 21, 2021 15:23

Ensure dev overlay is triggered for more _app/_document errors

89c9aa5

Merge remote-tracking branch 'upstream/canary' into fix/app-document-…

5973959

…errors

ijjk added the type: next label Apr 21, 2021

This comment has been minimized.

Sign in to view

ijjk added 2 commits April 21, 2021 17:00

use separate webpack instance

afbcb46

Merge remote-tracking branch 'upstream/canary' into fix/app-document-…

c21d08e

…errors

This comment has been minimized.

Sign in to view

update test wait time and close watcher

f71c5b2

This comment has been minimized.

Sign in to view

only run fallback build when needed

c1b12ba

ijjk marked this pull request as ready for review April 22, 2021 02:21

ijjk requested review from divmain, lfades, shuding and timneutkens as code owners April 22, 2021 02:21

timneutkens approved these changes Apr 22, 2021

View reviewed changes

Merge branch 'canary' into fix/app-document-errors

60a0537

kodiakhq bot merged commit 85d87a3 into vercel:canary Apr 22, 2021

PepijnSenders mentioned this pull request Apr 28, 2021

Don't swallow MODULE_NOT_FOUND error #24577

Merged

2 tasks

sync-by-unito bot mentioned this pull request May 18, 2021

chore(deps): bump next from 10.0.7 to 10.2.0 filecoin-project/slate#736

Closed

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ensure dev overlay is triggered for more _app/_document errors #24328

Ensure dev overlay is triggered for more _app/_document errors #24328

ijjk commented Apr 21, 2021

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ijjk commented Apr 22, 2021

ijjk commented Apr 22, 2021

PepijnSenders commented Apr 28, 2021

Ensure dev overlay is triggered for more _app/_document errors #24328

Ensure dev overlay is triggered for more _app/_document errors #24328

Conversation

ijjk commented Apr 21, 2021

Bug

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ijjk commented Apr 22, 2021

Stats from current PR

ijjk commented Apr 22, 2021

Stats from current PR

PepijnSenders commented Apr 28, 2021