fix(pnp): ensure URL is imported on Node.js < 20 (#6060)

merceyz · web-flow · commit c111ea733bac · 2024-01-15T19:42:20.000+01:00
**What's the problem this PR addresses?** Before nodejs/node#46904 using a custom global URL class wasn't supported by `fileURLToPath`. Closes #6030 Fixes #5915 **How did you fix it?** - Created a rollup plugin to ensure that the builtin URL class is always used on Node.js < v20. - Removed all imports of `URL` since it's a global and to avoid mixing custom and builtin URL class instances. **Checklist** - [x] I have read the [Contributing Guide](https://yarnpkg.com/advanced/contributing). - [x] I have set the packages that need to be released for my changes to be effective. - [x] I will check that all automated PR checks pass before the PR gets reviewed.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -44,5 +44,17 @@ module.exports = {
         message: `Use 'httpUtils' instead`,
       },
     ],
+    'no-restricted-imports': [
+      `error`,
+      {
+        patterns: [
+          {
+            group: [`url`, `node:url`],
+            importNames: [`URL`],
+            message: `URL is a global, no need to import it`,
+          },
+        ],
+      },
+    ],
   },
 };
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/.pnp.loader.mjs b/.pnp.loader.mjs
diff --git a/.yarn/versions/ae9dd917.yml b/.yarn/versions/ae9dd917.yml
@@ -0,0 +1,39 @@
+releases:
+  "@yarnpkg/cli": patch
+  "@yarnpkg/core": patch
+  "@yarnpkg/fslib": patch
+  "@yarnpkg/plugin-essentials": patch
+  "@yarnpkg/plugin-npm": patch
+  "@yarnpkg/pnp": patch
+
+declined:
+  - "@yarnpkg/plugin-compat"
+  - "@yarnpkg/plugin-constraints"
+  - "@yarnpkg/plugin-dlx"
+  - "@yarnpkg/plugin-exec"
+  - "@yarnpkg/plugin-file"
+  - "@yarnpkg/plugin-git"
+  - "@yarnpkg/plugin-github"
+  - "@yarnpkg/plugin-http"
+  - "@yarnpkg/plugin-init"
+  - "@yarnpkg/plugin-interactive-tools"
+  - "@yarnpkg/plugin-link"
+  - "@yarnpkg/plugin-nm"
+  - "@yarnpkg/plugin-npm-cli"
+  - "@yarnpkg/plugin-pack"
+  - "@yarnpkg/plugin-patch"
+  - "@yarnpkg/plugin-pnp"
+  - "@yarnpkg/plugin-pnpm"
+  - "@yarnpkg/plugin-stage"
+  - "@yarnpkg/plugin-typescript"
+  - "@yarnpkg/plugin-version"
+  - "@yarnpkg/plugin-workspace-tools"
+  - vscode-zipfs
+  - "@yarnpkg/builder"
+  - "@yarnpkg/doctor"
+  - "@yarnpkg/extensions"
+  - "@yarnpkg/libzip"
+  - "@yarnpkg/nm"
+  - "@yarnpkg/pnpify"
+  - "@yarnpkg/sdks"
+  - "@yarnpkg/shell"
diff --git a/packages/acceptance-tests/pkg-tests-core/sources/utils/makeTemporaryEnv.ts b/packages/acceptance-tests/pkg-tests-core/sources/utils/makeTemporaryEnv.ts
@@ -1,6 +1,5 @@
 import {npath}     from '@yarnpkg/fslib';
 import {delimiter} from 'path';
-import {URL}       from 'url';
 
 import * as exec   from './exec';
 import * as tests  from './tests';
diff --git a/packages/plugin-essentials/sources/commands/plugin/import.ts b/packages/plugin-essentials/sources/commands/plugin/import.ts
@@ -5,7 +5,6 @@ import {YarnVersion, formatUtils, httpUtils, structUtils, hashUtils}
 import {PortablePath, npath, ppath, xfs}                                        from '@yarnpkg/fslib';
 import {Command, Option, Usage}                                                 from 'clipanion';
 import semver                                                                   from 'semver';
-import {URL}                                                                    from 'url';
 import {runInNewContext}                                                        from 'vm';
 
 import {getAvailablePlugins}                                                    from './list';
diff --git a/packages/plugin-npm/sources/NpmSemverFetcher.ts b/packages/plugin-npm/sources/NpmSemverFetcher.ts
@@ -2,7 +2,6 @@ import {Configuration, Fetcher, FetchOptions, MinimalFetchOptions} from '@yarnpk
 import {structUtils, tgzUtils, semverUtils}                        from '@yarnpkg/core';
 import {Locator, MessageName, ReportError}                         from '@yarnpkg/core';
 import semver                                                      from 'semver';
-import {URL}                                                       from 'url';
 
 import {PROTOCOL}                                                  from './constants';
 import * as npmConfigUtils                                         from './npmConfigUtils';
diff --git a/packages/plugin-npm/sources/npmHttpUtils.ts b/packages/plugin-npm/sources/npmHttpUtils.ts
@@ -4,7 +4,6 @@ import {Filename, PortablePath, ppath, xfs}
 import {prompt}                                                                                                                              from 'enquirer';
 import pick                                                                                                                                  from 'lodash/pick';
 import semver                                                                                                                                from 'semver';
-import {URL}                                                                                                                                 from 'url';
 
 import {Hooks}                                                                                                                               from './index';
 import * as npmConfigUtils                                                                                                                   from './npmConfigUtils';
diff --git a/packages/plugin-npm/sources/npmPublishUtils.ts b/packages/plugin-npm/sources/npmPublishUtils.ts
@@ -4,7 +4,6 @@ import {PortablePath, xfs, npath} from '@yarnpkg/fslib';
 import {packUtils}                from '@yarnpkg/plugin-pack';
 import {createHash}               from 'crypto';
 import ssri                       from 'ssri';
-import {URL}                      from 'url';
 
 import {normalizeRegistry}        from './npmConfigUtils';
 
diff --git a/packages/yarnpkg-core/sources/Plugin.ts b/packages/yarnpkg-core/sources/Plugin.ts
@@ -1,7 +1,6 @@
 import {PortablePath}                                                                         from '@yarnpkg/fslib';
 import {CommandClass}                                                                         from 'clipanion';
 import {Writable, Readable}                                                                   from 'stream';
-import {URL}                                                                                  from 'url';
 
 import {PluginConfiguration, Configuration, ConfigurationDefinitionMap, PackageExtensionData} from './Configuration';
 import {Fetcher}                                                                              from './Fetcher';
diff --git a/packages/yarnpkg-core/sources/httpUtils.ts b/packages/yarnpkg-core/sources/httpUtils.ts
@@ -4,7 +4,6 @@ import {Agent as HttpsAgent}                     from 'https';
 import {Agent as HttpAgent, IncomingHttpHeaders} from 'http';
 import micromatch                                from 'micromatch';
 import tunnel, {ProxyOptions}                    from 'tunnel';
-import {URL}                                     from 'url';
 
 import {ConfigurationValueMap, Configuration}    from './Configuration';
 import {MessageName}                             from './MessageName';
diff --git a/packages/yarnpkg-fslib/sources/NodePathFS.ts b/packages/yarnpkg-fslib/sources/NodePathFS.ts
@@ -1,10 +1,10 @@
-import buffer               from 'buffer';
-import {URL, fileURLToPath} from 'url';
-import {inspect}            from 'util';
+import buffer              from 'buffer';
+import {fileURLToPath}     from 'url';
+import {inspect}           from 'util';
 
-import {FakeFS}             from './FakeFS';
-import {ProxiedFS}          from './ProxiedFS';
-import {npath, NativePath}  from './path';
+import {FakeFS}            from './FakeFS';
+import {ProxiedFS}         from './ProxiedFS';
+import {npath, NativePath} from './path';
 
 /**
  * Adds support for file URLs and Buffers to the wrapped `baseFs`, but *not* inside the typings.
diff --git a/packages/yarnpkg-pnp/rollup.config.js b/packages/yarnpkg-pnp/rollup.config.js
@@ -8,6 +8,9 @@ import {brotliCompressSync} from 'zlib';
 
 import pkg                  from './package.json';
 
+/**
+ * @returns {import('rollup').Plugin}
+ */
 function wrapOutput() {
   return {
     name: `wrap-output`,
@@ -25,6 +28,39 @@ function wrapOutput() {
   };
 }
 
+/**
+ * Before https://github.com/nodejs/node/pull/46904 using a custom global URL class
+ * wasn't supported by `fileURLToPath` so this plugin ensures that for Node.js < 20
+ * we always use the builtin URL class.
+ * TODO: Remove this plugin when dropping support for Node.js < 20
+ * @returns {import('rollup').Plugin}
+ */
+function importURL() {
+  return {
+    name: `import-url`,
+    resolveId(id) {
+      if (id === `virtual:url`) return `\0virtual:url`;
+
+      return undefined;
+    },
+    load(id) {
+      if (id === `\0virtual:url`) {
+        return `
+          import { URL as nodeURL } from 'url';
+          export const URL = Number(process.versions.node.split('.', 1)[0]) < 20 ? nodeURL : globalThis.URL;
+        `;
+      }
+      return undefined;
+    },
+    transform(code, id) {
+      if (code.includes(`new URL`) || code.includes(`instanceof URL`))
+        return `import {URL} from 'virtual:url';\n${code}`;
+
+      return undefined;
+    },
+  };
+}
+
 // eslint-disable-next-line arca/no-default-export
 export default defineConfig([
   {
@@ -53,6 +89,7 @@ export default defineConfig([
         },
       }),
       cjs({transformMixedEsModules: true, extensions: [`.js`, `.ts`]}),
+      importURL(),
       wrapOutput(),
     ],
   },
@@ -80,6 +117,7 @@ export default defineConfig([
         },
       }),
       cjs({requireReturnsDefault: `preferred`}),
+      importURL(),
       wrapOutput(),
     ],
   },
diff --git a/packages/yarnpkg-pnp/sources/esm-loader/built-loader.js b/packages/yarnpkg-pnp/sources/esm-loader/built-loader.js
diff --git a/packages/yarnpkg-pnp/sources/esm-loader/loaderUtils.ts b/packages/yarnpkg-pnp/sources/esm-loader/loaderUtils.ts
@@ -1,7 +1,6 @@
 import {NativePath}   from '@yarnpkg/fslib';
 import fs             from 'fs';
 import path           from 'path';
-import {URL}          from 'url';
 
 import * as nodeUtils from '../loader/nodeUtils';
 
diff --git a/packages/yarnpkg-pnp/sources/hook.js b/packages/yarnpkg-pnp/sources/hook.js
diff --git a/packages/yarnpkg-pnp/sources/loader/applyPatch.ts b/packages/yarnpkg-pnp/sources/loader/applyPatch.ts
@@ -1,7 +1,7 @@
 import {FakeFS, PosixFS, npath, patchFs, PortablePath, NativePath, VirtualFS} from '@yarnpkg/fslib';
 import fs                                                                     from 'fs';
 import {Module, isBuiltin}                                                    from 'module';
-import {URL, fileURLToPath}                                                   from 'url';
+import {fileURLToPath}                                                        from 'url';
 
 import {PnpApi}                                                               from '../types';
 
