Prevent unpredictable dependency hosting by explicitly resolve module path on webpack.ProvidePlugin #20971

simnalamburt · 2021-01-11T10:57:05Z

ProvidePlugin replaces certain identifiers with another modules. As a result, 'buffer' and 'process' modules are added as implicit dependencies to all Next.js plugins. This can be problematic. With "Plug'n'Play" strategy, it don't work at all since they fail-fast with implicit dependencies. With "node_modules" strategy, it might seem OK but actually it can be result into unpredictable behavior since in uses dependency hoisting.

For example, currently users cannot use next-auth plugin with Plug'n'Play strategy:

This patch let Next.js properly handles such cases with require.resolve.

Closes #20955

References:

Support Yarn 2 PnP nextauthjs/next-auth#1034

ProvidePlugin replaces certain identifiers with another modules. As a result, 'buffer' and 'process' modules are added as implicit dependencies to all Next.js plugins. Which is OK for "node_modules" strategy, but problematic with "Plug'n'Play" strategy. This patch let Next.js properly handles such cases with Yarn PnP mode and PNPM's PnP mode. References: nextauthjs/next-auth#1034

ijjk · 2021-01-11T11:06:10Z

Stats from current PR

Default Server Mode (Decrease detected ✓)

General Overall decrease ✓

	vercel/next.js canary	simnalamburt/next.js pnp-plugin	Change
buildDuration	10.6s	10.6s	⚠️ +83ms
nodeModulesSize	80.9 MB	76.2 MB	-4.68 MB

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	simnalamburt/next.js pnp-plugin	Change
/ failed reqs	0	0	✓
/ total time (seconds)	2.031	2.077	⚠️ +0.05
/ avg req/sec	1230.91	1203.74	⚠️ -27.17
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	1.255	1.253	0
/error-in-render avg req/sec	1991.97	1995.56	+3.59

Client Bundles (main, webpack, commons)

	vercel/next.js canary	simnalamburt/next.js pnp-plugin	Change
677f882d2ed8..89aa.js gzip	13.1 kB	13.1 kB	✓
framework.HASH.js gzip	39 kB	39 kB	✓
main-dba4ec1..27c0.js gzip	6.63 kB	6.63 kB	✓
webpack-50be..df5b.js gzip	751 B	751 B	✓
Overall change	59.4 kB	59.4 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	simnalamburt/next.js pnp-plugin	Change
polyfills-81..14d7.js gzip	31.2 kB	31.2 kB	✓
Overall change	31.2 kB	31.2 kB	✓

Client Pages

	vercel/next.js canary	simnalamburt/next.js pnp-plugin	Change
_app-b6fc6bc..222c.js gzip	1.28 kB	1.28 kB	✓
_error-e2ffa..0f3f.js gzip	3.46 kB	3.46 kB	✓
hooks-010c20..8411.js gzip	887 B	887 B	✓
index-bbee2f..528b.js gzip	227 B	227 B	✓
link-d979103..c5ff.js gzip	1.64 kB	1.64 kB	✓
routerDirect..bf84.js gzip	303 B	303 B	✓
withRouter-a..5826.js gzip	302 B	302 B	✓
Overall change	8.09 kB	8.09 kB	✓

Client Build Manifests

	vercel/next.js canary	simnalamburt/next.js pnp-plugin	Change
_buildManifest.js gzip	323 B	323 B	✓
Overall change	323 B	323 B	✓

Rendered Page Sizes

	vercel/next.js canary	simnalamburt/next.js pnp-plugin	Change
index.html gzip	614 B	614 B	✓
link.html gzip	619 B	619 B	✓
withRouter.html gzip	606 B	606 B	✓
Overall change	1.84 kB	1.84 kB	✓

Serverless Mode (Decrease detected ✓)

General Overall decrease ✓

	vercel/next.js canary	simnalamburt/next.js pnp-plugin	Change
buildDuration	12.3s	12.1s	-104ms
nodeModulesSize	80.9 MB	80.9 MB	-210 B

Client Bundles (main, webpack, commons)

	vercel/next.js canary	simnalamburt/next.js pnp-plugin	Change
677f882d2ed8..89aa.js gzip	13.1 kB	13.1 kB	✓
framework.HASH.js gzip	39 kB	39 kB	✓
main-dba4ec1..27c0.js gzip	6.63 kB	6.63 kB	✓
webpack-50be..df5b.js gzip	751 B	751 B	✓
Overall change	59.4 kB	59.4 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	simnalamburt/next.js pnp-plugin	Change
polyfills-81..14d7.js gzip	31.2 kB	31.2 kB	✓
Overall change	31.2 kB	31.2 kB	✓

Client Pages

	vercel/next.js canary	simnalamburt/next.js pnp-plugin	Change
_app-b6fc6bc..222c.js gzip	1.28 kB	1.28 kB	✓
_error-e2ffa..0f3f.js gzip	3.46 kB	3.46 kB	✓
hooks-010c20..8411.js gzip	887 B	887 B	✓
index-bbee2f..528b.js gzip	227 B	227 B	✓
link-d979103..c5ff.js gzip	1.64 kB	1.64 kB	✓
routerDirect..bf84.js gzip	303 B	303 B	✓
withRouter-a..5826.js gzip	302 B	302 B	✓
Overall change	8.09 kB	8.09 kB	✓

Client Build Manifests

	vercel/next.js canary	simnalamburt/next.js pnp-plugin	Change
_buildManifest.js gzip	323 B	323 B	✓
Overall change	323 B	323 B	✓

Serverless bundles

	vercel/next.js canary	simnalamburt/next.js pnp-plugin	Change
_error.js	1 MB	1 MB	✓
404.html	2.67 kB	2.67 kB	✓
hooks.html	1.92 kB	1.92 kB	✓
index.js	1 MB	1 MB	✓
link.js	1.06 MB	1.06 MB	✓
routerDirect.js	1.05 MB	1.05 MB	✓
withRouter.js	1.05 MB	1.05 MB	✓
Overall change	5.18 MB	5.18 MB	✓

Commit: 06c8ec8

merceyz · 2021-01-11T11:17:59Z

Again, as I said in #20955 (comment), this is not a PnP issue, please don't label it as such.

It's an issue that PnP just so happens to highlight, this is an issue for node_modules as well (Yarn 1, Yarn 2 w/ node_modules, and pnpm) see https://yarnpkg.com/advanced/rulebook#packages-should-only-ever-require-what-they-formally-list-in-their-dependencies for an explainer on hoisting

simnalamburt · 2021-01-11T11:28:40Z

Again, as I said in #20955 (comment), this is not a PnP issue, please don't label it as such.

Oops I didn't know a discussion regarding this issue was going on at there. Yeah actually this is an issue even for node_modules since requiring implicit dependencies results into unpredictable behavior as you said.

simnalamburt · 2021-01-11T11:42:46Z

@merceyz Thanks! I updated the title and description of this PR. Actually I knew that this is not an issue of only PnP but.. you know.. many node.js developers don't think relying on hoisting is a problem. So saying "it doesn't work with Yarn 2" was the best way for me to let maintainers know the situation. :)

simnalamburt · 2021-01-11T12:10:30Z

Let me investigate the failed CI, but I'm not sure if it was really due to this patch.

timneutkens · 2021-01-11T12:31:57Z

Thanks @simnalamburt, great PR 👍

JakubKoralewski · 2021-02-12T15:14:01Z

@simnalamburt, The error that you mention with Module not found: can't resolve 'process' is still here for me in a project with next-auth and next.js. Were you able to build a next.js app with yarn2 pnp?

Also while I write this, please paste the error in the issue next time cause I couldn't find it while googling 😅

simnalamburt · 2021-02-12T15:27:56Z

Hi @JakubKoralewski! To use next-auth with Yarn 2 PnP:

Before this PR: Need to add "process" dependency to the next-auth and manually patch next-auth.
After this PR: Still need to add "process" dependency to the next-auth. Just no need to patch.

This is how it is. 🤦

Yes this PR has been merged and we don't need to manually patch the next-auth but still we need to fix the dependency list of next-auth like this:

# .yarnrc.yml
packageExtensions:
  next-auth@*:
    dependencies:
      process: "^0.11.10"

Actually I sent a PR to the next-auth to fix this issue, but they rejected it. Contrary to what they think, your issue did originate from next-auth but looks like they don't understand the full situation.

I don't have the time or energy to persuade them, so I'm just using next-auth like this, but if you're confident you'll change their minds, try send them a PR.

JakubKoralewski · 2021-02-12T15:56:05Z

Thanks for the snippet! Looks like I got a different error, so I guess it works :D

I don't have the time or energy to persuade them, so I'm just using next-auth like this, but if you're confident you'll change their minds, try send them a PR.

Not confident at all, but let's give them some time. Whether it will be Yarn or another package manager, plug and play is the future and once they start using it themselves they'll fix it 🤣

I tried to patch NextAuth.js first but they rejected it. So I'm fixing Next.js and Yarn instead. I already have fixed the Next.js side and this is the remaining piece. References: nextauthjs/next-auth#1034 vercel/next.js#20971

simnalamburt · 2021-02-20T17:07:02Z

Good news for @JakubKoralewski! I've opened a PR to fix next-auth's dependency by default! Take a look at yarnpkg/berry#2493 :)

ijjk added the type: next label Jan 11, 2021

simnalamburt mentioned this pull request Jan 11, 2021

Support Yarn 2 PnP nextauthjs/next-auth#1034

Closed

3 tasks

simnalamburt marked this pull request as ready for review January 11, 2021 11:28

simnalamburt requested review from ijjk, lfades, Timer and timneutkens as code owners January 11, 2021 11:28

simnalamburt changed the title ~~Handle Plug'n'Play properly while using webpack.ProvidePlugin~~ Prevent unpredictable dependency hosting by explicitly resolve module path on webpack.ProvidePlugin Jan 11, 2021

timneutkens approved these changes Jan 11, 2021

View reviewed changes

kodiakhq bot merged commit 552aa9d into vercel:canary Jan 11, 2021

balazsorban44 mentioned this pull request Feb 12, 2021

yarn2: Can't resolve 'process' nextauthjs/next-auth#1306

Closed

5 tasks

simnalamburt mentioned this pull request Feb 20, 2021

Adds an extension for NextAuth.js yarnpkg/berry#2493

Closed

3 tasks

lobsterkatie mentioned this pull request Jan 28, 2022

Can't resolve 'node:tty' with @sentry/nextjs getsentry/sentry-javascript#4458

Closed

1 task

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Prevent unpredictable dependency hosting by explicitly resolve module path on webpack.ProvidePlugin #20971

Prevent unpredictable dependency hosting by explicitly resolve module path on webpack.ProvidePlugin #20971

simnalamburt commented Jan 11, 2021 •

edited

ijjk commented Jan 11, 2021

merceyz commented Jan 11, 2021 •

edited

simnalamburt commented Jan 11, 2021

simnalamburt commented Jan 11, 2021

simnalamburt commented Jan 11, 2021

timneutkens commented Jan 11, 2021

JakubKoralewski commented Feb 12, 2021

simnalamburt commented Feb 12, 2021

JakubKoralewski commented Feb 12, 2021

simnalamburt commented Feb 20, 2021

Prevent unpredictable dependency hosting by explicitly resolve module path on webpack.ProvidePlugin #20971

Prevent unpredictable dependency hosting by explicitly resolve module path on webpack.ProvidePlugin #20971

Conversation

simnalamburt commented Jan 11, 2021 • edited

References:

ijjk commented Jan 11, 2021

Stats from current PR

merceyz commented Jan 11, 2021 • edited

simnalamburt commented Jan 11, 2021

simnalamburt commented Jan 11, 2021

simnalamburt commented Jan 11, 2021

timneutkens commented Jan 11, 2021

JakubKoralewski commented Feb 12, 2021

simnalamburt commented Feb 12, 2021

JakubKoralewski commented Feb 12, 2021

simnalamburt commented Feb 20, 2021

simnalamburt commented Jan 11, 2021 •

edited

merceyz commented Jan 11, 2021 •

edited