-
Notifications
You must be signed in to change notification settings - Fork 26.7k
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.
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
feat(middleware): issues warnings when using node.js global APIs in middleware #36980
Merged
timneutkens
merged 5 commits into
vercel:canary
from
feugy:feat/warn-for-nodejs-global-apis-in-middleware
May 23, 2022
Merged
feat(middleware): issues warnings when using node.js global APIs in middleware #36980
timneutkens
merged 5 commits into
vercel:canary
from
feugy:feat/warn-for-nodejs-global-apis-in-middleware
May 23, 2022
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Stats from current PRDefault Build (Decrease detected ✓)General Overall increase
|
vercel/next.js canary | feugy/next.js feat/warn-for-nodejs-global-apis-in-middleware | Change | |
---|---|---|---|
buildDuration | 20.3s | 20.3s | |
buildDurationCached | 7.8s | 7.8s | |
nodeModulesSize | 479 MB | 479 MB |
Page Load Tests Overall decrease ⚠️
vercel/next.js canary | feugy/next.js feat/warn-for-nodejs-global-apis-in-middleware | Change | |
---|---|---|---|
/ failed reqs | 0 | 0 | ✓ |
/ total time (seconds) | 5.347 | 5.234 | -0.11 |
/ avg req/sec | 467.58 | 477.69 | +10.11 |
/error-in-render failed reqs | 0 | 0 | ✓ |
/error-in-render total time (seconds) | 2.07 | 2.136 | |
/error-in-render avg req/sec | 1207.54 | 1170.47 |
Client Bundles (main, webpack)
vercel/next.js canary | feugy/next.js feat/warn-for-nodejs-global-apis-in-middleware | Change | |
---|---|---|---|
925.HASH.js gzip | 179 B | 179 B | ✓ |
framework-HASH.js gzip | 42 kB | 42 kB | ✓ |
main-HASH.js gzip | 29 kB | 29 kB | ✓ |
webpack-HASH.js gzip | 1.44 kB | 1.44 kB | ✓ |
Overall change | 72.6 kB | 72.6 kB | ✓ |
Legacy Client Bundles (polyfills)
vercel/next.js canary | feugy/next.js feat/warn-for-nodejs-global-apis-in-middleware | Change | |
---|---|---|---|
polyfills-HASH.js gzip | 31 kB | 31 kB | ✓ |
Overall change | 31 kB | 31 kB | ✓ |
Client Pages
vercel/next.js canary | feugy/next.js feat/warn-for-nodejs-global-apis-in-middleware | 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 | 2.71 kB | 2.71 kB | ✓ |
head-HASH.js gzip | 359 B | 359 B | ✓ |
hooks-HASH.js gzip | 920 B | 920 B | ✓ |
image-HASH.js gzip | 5.73 kB | 5.73 kB | ✓ |
index-HASH.js gzip | 263 B | 263 B | ✓ |
link-HASH.js gzip | 2.65 kB | 2.65 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 kB | 16 kB | ✓ |
Client Build Manifests
vercel/next.js canary | feugy/next.js feat/warn-for-nodejs-global-apis-in-middleware | Change | |
---|---|---|---|
_buildManifest.js gzip | 458 B | 458 B | ✓ |
Overall change | 458 B | 458 B | ✓ |
Rendered Page Sizes
vercel/next.js canary | feugy/next.js feat/warn-for-nodejs-global-apis-in-middleware | Change | |
---|---|---|---|
index.html gzip | 533 B | 533 B | ✓ |
link.html gzip | 547 B | 547 B | ✓ |
withRouter.html gzip | 528 B | 528 B | ✓ |
Overall change | 1.61 kB | 1.61 kB | ✓ |
Default Build with SWC (Decrease detected ✓)
General Overall increase ⚠️
vercel/next.js canary | feugy/next.js feat/warn-for-nodejs-global-apis-in-middleware | Change | |
---|---|---|---|
buildDuration | 23.2s | 23s | -179ms |
buildDurationCached | 7.9s | 7.9s | -44ms |
nodeModulesSize | 479 MB | 479 MB |
Page Load Tests Overall decrease ⚠️
vercel/next.js canary | feugy/next.js feat/warn-for-nodejs-global-apis-in-middleware | Change | |
---|---|---|---|
/ failed reqs | 0 | 0 | ✓ |
/ total time (seconds) | 5.317 | 5.474 | |
/ avg req/sec | 470.17 | 456.7 | |
/error-in-render failed reqs | 0 | 0 | ✓ |
/error-in-render total time (seconds) | 2.126 | 2.153 | |
/error-in-render avg req/sec | 1175.92 | 1161.05 |
Client Bundles (main, webpack)
vercel/next.js canary | feugy/next.js feat/warn-for-nodejs-global-apis-in-middleware | Change | |
---|---|---|---|
925.HASH.js gzip | 178 B | 178 B | ✓ |
framework-HASH.js gzip | 42.7 kB | 42.7 kB | ✓ |
main-HASH.js gzip | 29.5 kB | 29.5 kB | ✓ |
webpack-HASH.js gzip | 1.45 kB | 1.45 kB | ✓ |
Overall change | 73.8 kB | 73.8 kB | ✓ |
Legacy Client Bundles (polyfills)
vercel/next.js canary | feugy/next.js feat/warn-for-nodejs-global-apis-in-middleware | Change | |
---|---|---|---|
polyfills-HASH.js gzip | 31 kB | 31 kB | ✓ |
Overall change | 31 kB | 31 kB | ✓ |
Client Pages
vercel/next.js canary | feugy/next.js feat/warn-for-nodejs-global-apis-in-middleware | Change | |
---|---|---|---|
_app-HASH.js gzip | 1.35 kB | 1.35 kB | ✓ |
_error-HASH.js gzip | 179 B | 179 B | ✓ |
amp-HASH.js gzip | 311 B | 311 B | ✓ |
css-HASH.js gzip | 324 B | 324 B | ✓ |
dynamic-HASH.js gzip | 2.89 kB | 2.89 kB | ✓ |
head-HASH.js gzip | 357 B | 357 B | ✓ |
hooks-HASH.js gzip | 920 B | 920 B | ✓ |
image-HASH.js gzip | 5.82 kB | 5.82 kB | ✓ |
index-HASH.js gzip | 261 B | 261 B | ✓ |
link-HASH.js gzip | 2.78 kB | 2.78 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.3 kB | 16.3 kB | ✓ |
Client Build Manifests
vercel/next.js canary | feugy/next.js feat/warn-for-nodejs-global-apis-in-middleware | Change | |
---|---|---|---|
_buildManifest.js gzip | 457 B | 457 B | ✓ |
Overall change | 457 B | 457 B | ✓ |
Rendered Page Sizes
vercel/next.js canary | feugy/next.js feat/warn-for-nodejs-global-apis-in-middleware | Change | |
---|---|---|---|
index.html gzip | 532 B | 532 B | ✓ |
link.html gzip | 546 B | 546 B | ✓ |
withRouter.html gzip | 527 B | 527 B | ✓ |
Overall change | 1.6 kB | 1.6 kB | ✓ |
feugy
force-pushed
the
feat/warn-for-nodejs-global-apis-in-middleware
branch
from
May 17, 2022 15:47
1c40e11
to
7d59361
Compare
feugy
requested review from
timneutkens,
ijjk,
shuding,
padmaia and
huozhi
as code owners
May 18, 2022 08:51
feugy
force-pushed
the
feat/warn-for-nodejs-global-apis-in-middleware
branch
from
May 18, 2022 08:51
7d59361
to
33bda80
Compare
Schniz
reviewed
May 18, 2022
nuta
reviewed
May 18, 2022
test/integration/middleware/with-node.js-apis/test/index.test.ts
Outdated
Show resolved
Hide resolved
Failing test suitesCommit: 9e2a6d1
Expand output● CLI Usage › info › should print output
Read more about building and testing Next.js in contributing.md. |
timneutkens
approved these changes
May 23, 2022
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's in there?
Middleware, since they are ran on edge runtime, do not have access to Node.js globals. While #36434 addressed cases where a middleware would import a node.js module, this PR issues warning when trying to access unsupported globals, such as:
clearImmediate()
,process.cwd()
,Event
orTextDecoderStream
(full list inpackages/next/shared/lib/constants.ts
).The new behavior is:
process.env
is always allowedprocess
are not supported, but could be overriddenHow to test?
First, build next:
yarn workspace next release
Then, using integration tests:
yarn jest test/integration/middleware-with-node.js-apis
(checks both build and run time behavior)yarn jest test/integration/middleware-overrides-node.js-api
(ability to overrideprocess.XYZ
and useprocess.env
with no warning)Finally, as an example:
examples/with-node-api/middleware.js
, with this content:examples/with-node-api/pages/index.js
, with this content:yarn next dev examples/with-node-api/
and browse to https://localhost:3000:yarn next build examples/with-node-api/
:Notes to reviewers
build/webpack/plugins/middleware-plugin.ts
does the build-time validation.server/web/sandbox/context.ts
does the run-time behavior.To determine unsupported APIs, I compared the list from node.js docs to the our edge-runtime.
Please note that
__dirname
and__filename
are still allowed because webpack uses them.Feature
fixes #number
contributing.md
Documentation / Examples
yarn lint