Add nodejs version check

[huozhi]

There're some reports related to using incorrect Node.js version, sometimes users ended up in weird errors. As pkg manager like pnpm only gives a warning  WARN  Unsupported engine: wanted: {"node":">=18.17.0"} (current: {"node":"v16.18.0","pnpm":"8.9.0"}) which is not easy to investigate the issue.

We're adding a version check at the beginning of the Next.js process so if Node.js version is mis-match the version specified in package.json, bail with error.

Examples

node 16.x

You are using Node.js 16.18.0. Node.js >= v18.17.0 is required.

node.18.16

You are using Node.js 18.16.1. Node.js >= v18.17.0 is required.

[ijjk]

Tests Passed

[ijjk]

Stats from current PR

Default Build

General

	vercel/next.js canary	vercel/next.js bail-on-bad-node-version	Change
buildDuration	12s	12s	N/A
buildDurationCached	6.8s	7.4s	⚠️ +561ms
nodeModulesSize	199 MB	199 MB	N/A
nextStartRea..uration (ms)	438ms	442ms	N/A

Client Bundles (main, webpack)

	vercel/next.js canary	vercel/next.js bail-on-bad-node-version	Change
199-HASH.js gzip	28.7 kB	28.7 kB	N/A
3f784ff6-HASH.js gzip	53.3 kB	53.3 kB	✓
494.HASH.js gzip	180 B	181 B	N/A
framework-HASH.js gzip	45.2 kB	45.2 kB	✓
main-app-HASH.js gzip	241 B	239 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	✓
Overall change	100 kB	100 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	vercel/next.js bail-on-bad-node-version	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	vercel/next.js bail-on-bad-node-version	Change
_app-HASH.js gzip	194 B	195 B	N/A
_error-HASH.js gzip	182 B	181 B	N/A
amp-HASH.js gzip	501 B	503 B	N/A
css-HASH.js gzip	322 B	323 B	N/A
dynamic-HASH.js gzip	2.5 kB	2.5 kB	✓
edge-ssr-HASH.js gzip	253 B	255 B	N/A
head-HASH.js gzip	348 B	347 B	N/A
hooks-HASH.js gzip	369 B	368 B	N/A
image-HASH.js gzip	4.27 kB	4.27 kB	N/A
index-HASH.js gzip	256 B	256 B	✓
link-HASH.js gzip	2.61 kB	2.6 kB	N/A
routerDirect..HASH.js gzip	311 B	311 B	✓
script-HASH.js gzip	384 B	383 B	N/A
withRouter-HASH.js gzip	307 B	308 B	N/A
1afbb74e6ecf..834.css gzip	106 B	106 B	✓
Overall change	3.17 kB	3.17 kB	✓

Client Build Manifests

	vercel/next.js canary	vercel/next.js bail-on-bad-node-version	Change
_buildManifest.js gzip	484 B	483 B	N/A
Overall change	0 B	0 B	✓

Rendered Page Sizes

	vercel/next.js canary	vercel/next.js bail-on-bad-node-version	Change
index.html gzip	528 B	527 B	N/A
link.html gzip	541 B	541 B	✓
withRouter.html gzip	524 B	523 B	N/A
Overall change	541 B	541 B	✓

Edge SSR bundle Size

	vercel/next.js canary	vercel/next.js bail-on-bad-node-version	Change
edge-ssr.js gzip	92.5 kB	92.5 kB	N/A
page.js gzip	145 kB	145 kB	N/A
Overall change	0 B	0 B	✓

Middleware size

	vercel/next.js canary	vercel/next.js bail-on-bad-node-version	Change
middleware-b..fest.js gzip	626 B	625 B	N/A
middleware-r..fest.js gzip	150 B	151 B	N/A
middleware.js gzip	35.6 kB	35.6 kB	N/A
edge-runtime..pack.js gzip	1.92 kB	1.92 kB	✓
Overall change	1.92 kB	1.92 kB	✓

Next Runtimes

	vercel/next.js canary	vercel/next.js bail-on-bad-node-version	Change
app-page-exp...dev.js gzip	167 kB	167 kB	✓
app-page-exp..prod.js gzip	93.4 kB	93.4 kB	✓
app-page-tur..prod.js gzip	94.2 kB	94.2 kB	✓
app-page-tur..prod.js gzip	88.7 kB	88.7 kB	✓
app-page.run...dev.js gzip	137 kB	137 kB	✓
app-page.run..prod.js gzip	88 kB	88 kB	✓
app-route-ex...dev.js gzip	23.8 kB	23.8 kB	✓
app-route-ex..prod.js gzip	16.4 kB	16.4 kB	✓
app-route-tu..prod.js gzip	16.5 kB	16.5 kB	✓
app-route-tu..prod.js gzip	16 kB	16 kB	✓
app-route.ru...dev.js gzip	23.2 kB	23.2 kB	✓
app-route.ru..prod.js gzip	16 kB	16 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.8 kB	21.8 kB	✓
pages.runtim...dev.js gzip	22.5 kB	22.5 kB	✓
pages.runtim..prod.js gzip	21.8 kB	21.8 kB	✓
server.runti..prod.js gzip	49.2 kB	49.2 kB	✓
Overall change	925 kB	925 kB	✓

Commit: d18cdcb

[abenhamdine]

By doing this, you add some duplicated logic with package.json engines property, wouldn't it be better to read package.json to have a single place where this logic resides ?

[pvdz]

Nit: Can we add the source of this message to state explicitly being from nextjs? Otherwise it's almost as cryptic as the package manager itself. (It also works around that awkward "Node.js vx. Node.js vy" back to back)

[huozhi]

@pvdz thanks for checking, update the error message!
@abenhamdine good suggestion, I've updated the PR to pre-compile the required nodejs version into process.env and check it here

[danielbarion]

A simple change but helpful while debugging node error-related, thanks!

[ztanner]

Seems like with this change we can remove this check: https://github.com/vercel/next.js/blob/canary/packages/next/src/build/webpack/plugins/flight-client-entry-plugin.ts#L791-L800