Fix next node buildin module error message for edge runtime #36434

nkzawa · 2022-04-25T09:28:17Z

improve the message for importing node builtin module on edge runtime
fix to show the message on overlay of error browser with next dev
fix Invalid "Native Node.js APIs are not supported in the Edge Runtime" error message #36237

The message is NOT shown when using edge runtime (not middleware) since I cannot find a way to detect a webpack compilation is for edge runtime.

Bug

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

Feature

Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR.
Related issues linked using fixes #number
Integration tests added
Documentation added
Telemetry added. In case of a feature if it's used or not.
Errors have helpful link attached, see contributing.md

Documentation / Examples

Make sure the linting passes by running yarn lint

ijjk · 2022-04-25T09:46:44Z

Failing test suites

Commit: 74338ec

yarn testheadless test/e2e/yarn-pnp/test/with-styled-components-babel.test.ts

yarn PnP > should compile and serve the index page correctly with-styled-components-babel

Expand output

● yarn PnP › should compile and serve the index page correctly with-styled-components-babel

thrown: "Exceeded timeout of 120000 ms for a hook.
Use jest.setTimeout(newTimeout) to increase the timeout value, if this is a long-running test."

  21 |     let next: NextInstance
  22 |
> 23 |     beforeAll(async () => {
     |     ^
  24 |       const srcDir = join(__dirname, '../../../../examples', example)
  25 |       const srcFiles = await fs.readdir(srcDir)
  26 |

  at Object.runTests (e2e/yarn-pnp/test/utils.ts:23:5)
  at e2e/yarn-pnp/test/with-styled-components-babel.test.ts:4:43
  at Object.<anonymous> (e2e/yarn-pnp/test/with-styled-components-babel.test.ts:3:1)

Read more about building and testing Next.js in contributing.md.

ijjk · 2022-04-25T10:23:06Z

Stats from current PR

Default Build (Decrease detected ✓)

General Overall increase ⚠️

	vercel/next.js canary	nkzawa/next.js fix-next-node-buildin-module-error-message	Change
buildDuration	19.2s	19.3s	⚠️ +143ms
buildDurationCached	7.7s	7.6s	-84ms
nodeModulesSize	463 MB	463 MB	⚠️ +6.3 kB

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	nkzawa/next.js fix-next-node-buildin-module-error-message	Change
/ failed reqs	0	0	✓
/ total time (seconds)	4.439	4.496	⚠️ +0.06
/ avg req/sec	563.23	556.09	⚠️ -7.14
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.651	1.653	0
/error-in-render avg req/sec	1513.93	1512.21	⚠️ -1.72

Client Bundles (main, webpack)

	vercel/next.js canary	nkzawa/next.js fix-next-node-buildin-module-error-message	Change
925.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42 kB	42 kB	✓
main-HASH.js gzip	28.7 kB	28.7 kB	✓
webpack-HASH.js gzip	1.44 kB	1.44 kB	✓
Overall change	72.3 kB	72.3 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	nkzawa/next.js fix-next-node-buildin-module-error-message	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	nkzawa/next.js fix-next-node-buildin-module-error-message	Change
_app-HASH.js gzip	1.36 kB	1.36 kB	✓
_error-HASH.js gzip	193 B	193 B	✓
amp-HASH.js gzip	308 B	308 B	✓
css-HASH.js gzip	327 B	327 B	✓
dynamic-HASH.js gzip	3.08 kB	3.08 kB	✓
head-HASH.js gzip	359 B	359 B	✓
hooks-HASH.js gzip	920 B	920 B	✓
image-HASH.js gzip	5.71 kB	5.71 kB	✓
index-HASH.js gzip	263 B	263 B	✓
link-HASH.js gzip	2.64 kB	2.64 kB	✓
routerDirect..HASH.js gzip	320 B	320 B	✓
script-HASH.js gzip	391 B	391 B	✓
withRouter-HASH.js gzip	318 B	318 B	✓
85e02e95b279..7e3.css gzip	107 B	107 B	✓
Overall change	16.3 kB	16.3 kB	✓

Client Build Manifests

	vercel/next.js canary	nkzawa/next.js fix-next-node-buildin-module-error-message	Change
_buildManifest.js gzip	459 B	459 B	✓
Overall change	459 B	459 B	✓

Rendered Page Sizes

	vercel/next.js canary	nkzawa/next.js fix-next-node-buildin-module-error-message	Change
index.html gzip	533 B	533 B	✓
link.html gzip	546 B	546 B	✓
withRouter.html gzip	528 B	528 B	✓
Overall change	1.61 kB	1.61 kB	✓

Default Build with SWC (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	nkzawa/next.js fix-next-node-buildin-module-error-message	Change
buildDuration	21.3s	21.2s	-36ms
buildDurationCached	7.6s	7.7s	⚠️ +130ms
nodeModulesSize	463 MB	463 MB	⚠️ +6.3 kB

Page Load Tests Overall increase ✓

	vercel/next.js canary	nkzawa/next.js fix-next-node-buildin-module-error-message	Change
/ failed reqs	0	0	✓
/ total time (seconds)	4.517	4.554	⚠️ +0.04
/ avg req/sec	553.43	549.01	⚠️ -4.42
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.682	1.65	-0.03
/error-in-render avg req/sec	1486.14	1515.12	+28.98

Client Bundles (main, webpack)

	vercel/next.js canary	nkzawa/next.js fix-next-node-buildin-module-error-message	Change
925.HASH.js gzip	178 B	178 B	✓
framework-HASH.js gzip	42.2 kB	42.2 kB	✓
main-HASH.js gzip	29.1 kB	29.1 kB	✓
webpack-HASH.js gzip	1.45 kB	1.45 kB	✓
Overall change	73 kB	73 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	nkzawa/next.js fix-next-node-buildin-module-error-message	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	nkzawa/next.js fix-next-node-buildin-module-error-message	Change
_app-HASH.js gzip	1.35 kB	1.35 kB	✓
_error-HASH.js gzip	179 B	179 B	✓
amp-HASH.js gzip	312 B	312 B	✓
css-HASH.js gzip	324 B	324 B	✓
dynamic-HASH.js gzip	3.08 kB	3.08 kB	✓
head-HASH.js gzip	357 B	357 B	✓
hooks-HASH.js gzip	921 B	921 B	✓
image-HASH.js gzip	5.76 kB	5.76 kB	✓
index-HASH.js gzip	261 B	261 B	✓
link-HASH.js gzip	2.76 kB	2.76 kB	✓
routerDirect..HASH.js gzip	322 B	322 B	✓
script-HASH.js gzip	392 B	392 B	✓
withRouter-HASH.js gzip	317 B	317 B	✓
85e02e95b279..7e3.css gzip	107 B	107 B	✓
Overall change	16.5 kB	16.5 kB	✓

Client Build Manifests

	vercel/next.js canary	nkzawa/next.js fix-next-node-buildin-module-error-message	Change
_buildManifest.js gzip	458 B	458 B	✓
Overall change	458 B	458 B	✓

Rendered Page Sizes

	vercel/next.js canary	nkzawa/next.js fix-next-node-buildin-module-error-message	Change
index.html gzip	527 B	527 B	✓
link.html gzip	541 B	541 B	✓
withRouter.html gzip	525 B	525 B	✓
Overall change	1.59 kB	1.59 kB	✓

Commit: 242ca9a

packages/next/build/webpack/plugins/wellknown-errors-plugin/parseNotFoundError.ts

test/integration/middleware/with-builtin-module/test/index.test.js

…rseNotFoundError.ts Co-authored-by: Tobias Koppers <tobias.koppers@googlemail.com>

nkzawa requested review from timneutkens, ijjk, shuding, padmaia and huozhi as code owners April 25, 2022 09:28

ijjk added the type: next label Apr 25, 2022

nkzawa force-pushed the fix-next-node-buildin-module-error-message branch from 17746c4 to 04eff87 Compare April 25, 2022 09:36

sokra reviewed Apr 28, 2022

View reviewed changes

packages/next/build/webpack/plugins/wellknown-errors-plugin/parseNotFoundError.ts Outdated Show resolved Hide resolved

ijjk reviewed Apr 28, 2022

View reviewed changes

test/integration/middleware/with-builtin-module/test/index.test.js Show resolved Hide resolved

nkzawa and others added 12 commits April 29, 2022 15:18

remove use of process polyfill

e4aae7d

fix a test

0999aa6

fix error message for using node buildin modules on edge functions

6226162

fix for lint

41fcdf5

do not use replaceAll

f89b2a5

add null check

7cd047b

fix error message

1fcdf63

fix runtime name to check

539bb2e

fix test, remove irrelevant code

e8d9faa

detect runtime using getPageRuntime

d6c74cc

add a comment

bf6bcd2

Update packages/next/build/webpack/plugins/wellknown-errors-plugin/pa…

55eb819

…rseNotFoundError.ts Co-authored-by: Tobias Koppers <tobias.koppers@googlemail.com>

nkzawa requested a review from ijjk April 29, 2022 08:30

nkzawa force-pushed the fix-next-node-buildin-module-error-message branch from 8f992a6 to 55eb819 Compare April 29, 2022 08:30

nkzawa added 4 commits April 29, 2022 20:26

add link to the issue

4146511

Merge branch 'canary' into fix-next-node-buildin-module-error-message

3db507a

Merge branch 'canary' into fix-next-node-buildin-module-error-message

b8ea7fa

Merge branch 'canary' into fix-next-node-buildin-module-error-message

3d3f658

ijjk approved these changes May 2, 2022

View reviewed changes

Merge branch 'canary' into fix-next-node-buildin-module-error-message

242ca9a

kodiakhq bot merged commit 9e53af8 into vercel:canary May 2, 2022

nkzawa deleted the fix-next-node-buildin-module-error-message branch May 3, 2022 06:49

balazsorban44 mentioned this pull request May 10, 2022

Build fails to compile - module not found: can't resolve "child_process" 12.1.6 #36776

Closed

1 task

feugy mentioned this pull request May 17, 2022

feat(middleware): issues warnings when using node.js global APIs in middleware #36980

Merged

7 tasks

NOUIY mentioned this pull request May 23, 2022

[Snyk] Upgrade next from 12.0.7 to 12.1.6 NOUIY/next.js#293

Open

github-actions bot locked as resolved and limited conversation to collaborators Jun 2, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix next node buildin module error message for edge runtime #36434

Fix next node buildin module error message for edge runtime #36434

nkzawa commented Apr 25, 2022 •

edited

ijjk commented Apr 25, 2022 •

edited

ijjk commented Apr 25, 2022 •

edited

Fix next node buildin module error message for edge runtime #36434

Fix next node buildin module error message for edge runtime #36434

Conversation

nkzawa commented Apr 25, 2022 • edited

Bug

Feature

Documentation / Examples

ijjk commented Apr 25, 2022 • edited

Failing test suites

ijjk commented Apr 25, 2022 • edited

Stats from current PR

nkzawa commented Apr 25, 2022 •

edited

ijjk commented Apr 25, 2022 •

edited

ijjk commented Apr 25, 2022 •

edited