Adds support for multiple concurrent runtimes (#630)

* Adds support for multiple concurrent runtimes

* More fixes

* Adds documentation

* More fixes

* Updates snapshots

* Fixes tests for Windows

Author: arcanis

.pnp.js

@@ -600,6 +600,41 @@ describe(`Plug'n'Play`, () => {
     ),
   );
 
+  test(
+    `it should be able to require files from a different dependency tree`,
+    makeTemporaryEnv({
+      dependencies: {
+        [`no-deps`]: `1.0.0`,
+      },
+    }, async ({path, run, source}) => {
+      await run(`install`);
+
+      const tmp = await createTemporaryFolder();
+
+      await xfs.writeJsonPromise(ppath.join(tmp, `package.json`), {
+        dependencies: {
+          [`no-deps`]: `2.0.0`,
+        },
+      });
+
+      await xfs.writeFilePromise(ppath.join(tmp, `index.js`), `
+        module.exports = require('no-deps');
+      `);
+
+      await run(`install`, {cwd: tmp});
+
+      await expect(source(`require('no-deps')`)).resolves.toEqual({
+        name: `no-deps`,
+        version: `1.0.0`,
+      });
+
+      await expect(source(`require(${JSON.stringify(tmp)})`)).resolves.toEqual({
+        name: `no-deps`,
+        version: `2.0.0`,
+      });
+    }),
+  );
+
   testIf(
     () => satisfies(process.versions.node, `>=8.9.0`),
     `it should throw when using require.resolve with unsupported options`,
@@ -641,7 +676,7 @@ describe(`Plug'n'Play`, () => {
         await writeFile(`${tmp}/index.js`, `require(process.argv[2])`);
         await writeFile(`${path}/index.js`, `require('no-deps')`);
 
-        await run(`node`, `${npath.fromPortablePath(tmp)}/index.js`, `${path}/index.js`);
+        await run(`node`, `${npath.fromPortablePath(tmp)}/index.js`, `${npath.fromPortablePath(path)}/index.js`);
       },
     ),
   );

packages/acceptance-tests/pkg-tests-specs/sources/commands/__snapshots__/config.test.js.snap

@@ -285,11 +285,12 @@ describe(`Plug'n'Play API`, () => {
           const virtualPath = await source(`require.resolve('peer-deps')`);
 
           // Sanity check: to ensure that the test actually tests something :)
-          expect(xfs.existsSync(virtualPath)).toEqual(false);
+          expect(virtualPath).toMatch(`${npath.sep}$$virtual${npath.sep}`);
 
           const physicalPath = await source(`require('pnpapi').resolveVirtual(require.resolve('peer-deps'))`);
 
           expect(typeof physicalPath).toEqual(`string`);
+          expect(physicalPath).not.toEqual(virtualPath);
           expect(xfs.existsSync(physicalPath)).toEqual(true);
         }),
       );

packages/acceptance-tests/pkg-tests-specs/sources/pnp.test.js

@@ -133,7 +133,7 @@ const PackageJsonDoc = () => <>
       <JsonObjectProperty
         name={`peerDependencies`}
         description={<>
-          Peer dependencies are inherited dependencies - the consumer of your package will be tasked to provide them. This is typically what you want when writing plugins, for example. Be careful: listing peer dependencies will have side effects on the way your package will be executed by your consumers. Check the documentation for more information.
+          Peer dependencies are inherited dependencies - the consumer of your package will be tasked to provide them. This is typically what you want when writing plugins, for example. Note that peer dependencies can also be listed as regular dependencies; in this case, Yarn will use the package provided by the ancestors if possible, but will fallback to the regular dependencies otherwise.
         </>}
       >
         <JsonScalarProperty

packages/acceptance-tests/pkg-tests-specs/sources/pnpapi.test.js

@@ -382,9 +382,9 @@ const YarnrcDoc = () => <>
       </SymlArrayProperty>
       <SymlScalarProperty
         name={`virtualFolder`}
-        placeholder={`./.yarn/virtual`}
+        placeholder={`./.yarn/$$virtual`}
         description={<>
-          Due to a particularity in how Yarn installs packages which list peer dependencies, some packages will be mapped to multiple virtual directories that don't actually exist on the filesystem. This settings tells Yarn where to put them.
+          Due to a particularity in how Yarn installs packages which list peer dependencies, some packages will be mapped to multiple virtual directories that don't actually exist on the filesystem. This settings tells Yarn where to put them. Note that the folder name *must* be <code>$$virtual</code>.
         </>}
       />
       <SymlScalarProperty

packages/gatsby/src/pages/configuration/manifest.js

@@ -83,7 +83,7 @@ export default class DlxCommand extends BaseCommand {
 
 function createTemporaryDirectory(name?: Filename) {
   return new Promise<PortablePath>((resolve, reject) => {
-    tmp.dir({unsafeCleanup: true}, (error, dirPath) => {
+    tmp.dir({unsafeCleanup: false}, (error, dirPath) => {
       if (error) {
         reject(error);
       } else {

packages/gatsby/src/pages/configuration/yarnrc.js

@@ -2,7 +2,7 @@ import {Installer, Linker, LinkOptions, MinimalLinkOptions, Manifest, LinkType,
 import {FetchResult, Descriptor, Ident, Locator, Package, BuildDirective, BuildType}                         from '@yarnpkg/core';
 import {miscUtils, structUtils}                                                                              from '@yarnpkg/core';
 import {CwdFS, FakeFS, PortablePath, npath, ppath, toFilename, xfs}                                          from '@yarnpkg/fslib';
-import {PackageRegistry, generateInlinedScript, generateSplitScript}                                         from '@yarnpkg/pnp';
+import {PackageRegistry, generateInlinedScript, generateSplitScript, PnpSettings}                            from '@yarnpkg/pnp';
 import {UsageError}                                                                                          from 'clipanion';
 
 import {getPnpPath}                                                                                          from './index';
@@ -165,7 +165,6 @@ class PnpInstaller implements Installer {
     const ignorePattern = this.opts.project.configuration.get(`pnpIgnorePattern`);
     const packageRegistry = this.packageRegistry;
     const shebang = this.opts.project.configuration.get(`pnpShebang`);
-    const virtualRoots = [this.normalizeDirectoryPath(this.opts.project.configuration.get(`virtualFolder`))];
 
     if (pnpFallbackMode === `dependencies-only`)
       for (const pkg of this.opts.project.storedPackages.values())
@@ -175,15 +174,14 @@ class PnpInstaller implements Installer {
     const pnpPath = getPnpPath(this.opts.project);
     const pnpDataPath = this.opts.project.configuration.get(`pnpDataPath`);
 
-    const pnpSettings = {
+    const pnpSettings: PnpSettings = {
       blacklistedLocations,
       dependencyTreeRoots,
       enableTopLevelFallback,
       fallbackExclusionList,
       ignorePattern,
       packageRegistry,
       shebang,
-      virtualRoots,
     };
 
     if (this.opts.project.configuration.get(`pnpEnableInlining`)) {

packages/plugin-dlx/sources/commands/dlx.ts

@@ -84,7 +84,7 @@ export default class BuildBundleCommand extends Command {
       plugins: [
         new webpack.BannerPlugin({
           entryOnly: true,
-          banner: `#!/usr/bin/env node`,
+          banner: `#!/usr/bin/env node\n/* eslint-disable */`,
           raw: true,
         }),
         new webpack.DefinePlugin({

packages/plugin-pnp/sources/PnpLinker.ts

@@ -65,14 +65,14 @@ export default class BuildPluginCommand extends Command {
               for (const chunk of chunks) {
                 for (const file of chunk.files) {
                   compilation.assets[file] = new RawSource(reindent(`
-                    module.exports = {};
-
-                    module.exports.factory = function (require) {
-${reindent(compilation.assets[file].source().replace(/^ +/, ``), 11)}
-                      return plugin;
+                    /* eslint-disable*/
+                    module.exports = {
+                      name: ${JSON.stringify(name)},
+                      factory: function (require) {
+                        ${reindent(compilation.assets[file].source().replace(/^ +/, ``), 11)}
+                        return plugin;
+                      },
                     };
-
-                    module.exports.name = ${JSON.stringify(name)};
                   `));
                 }
               }