feat(plugin-essentials): yarn dedupe

.yarn/versions/e9b298c7.yml

@@ -0,0 +1,30 @@
+releases:
+  "@yarnpkg/cli": prerelease
+  "@yarnpkg/core": minor
+  "@yarnpkg/plugin-essentials": minor
+  "@yarnpkg/plugin-exec": patch
+  "@yarnpkg/plugin-file": patch
+  "@yarnpkg/plugin-git": patch
+  "@yarnpkg/plugin-http": patch
+  "@yarnpkg/plugin-link": patch
+  "@yarnpkg/plugin-npm": patch
+  "@yarnpkg/plugin-patch": patch
+
+declined:
+  - "@yarnpkg/plugin-compat"
+  - "@yarnpkg/plugin-constraints"
+  - "@yarnpkg/plugin-dlx"
+  - "@yarnpkg/plugin-github"
+  - "@yarnpkg/plugin-init"
+  - "@yarnpkg/plugin-interactive-tools"
+  - "@yarnpkg/plugin-node-modules"
+  - "@yarnpkg/plugin-npm-cli"
+  - "@yarnpkg/plugin-pack"
+  - "@yarnpkg/plugin-pnp"
+  - "@yarnpkg/plugin-stage"
+  - "@yarnpkg/plugin-typescript"
+  - "@yarnpkg/plugin-version"
+  - "@yarnpkg/plugin-workspace-tools"
+  - "@yarnpkg/builder"
+  - "@yarnpkg/doctor"
+  - "@yarnpkg/pnpify"

packages/acceptance-tests/pkg-tests-core/sources/utils/exec.ts

@@ -10,7 +10,7 @@ export type ExecResult = {
   stdout: string;
   stderr: string;
   code: number;
-} | Error & {
+} | cp.ExecException & {
   stdout: string;
   stderr: string;
 };

packages/acceptance-tests/pkg-tests-fixtures/packages/one-range-dep-too-1.0.0/index.js

@@ -0,0 +1,10 @@
+/* @flow */
+
+module.exports = require(`./package.json`);
+
+for (const key of [`dependencies`, `devDependencies`, `peerDependencies`]) {
+  for (const dep of Object.keys(module.exports[key] || {})) {
+    // $FlowFixMe The whole point of this file is to be dynamic
+    module.exports[key][dep] = require(dep);
+  }
+}

packages/acceptance-tests/pkg-tests-fixtures/packages/one-range-dep-too-1.0.0/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "one-range-dep-too",
+  "version": "1.0.0",
+  "dependencies": {
+      "no-deps": "^1.0.0"
+  }
+}

packages/acceptance-tests/pkg-tests-fixtures/packages/two-range-deps-1.0.0/index.js

@@ -0,0 +1,10 @@
+/* @flow */
+
+module.exports = require(`./package.json`);
+
+for (const key of [`dependencies`, `devDependencies`, `peerDependencies`]) {
+  for (const dep of Object.keys(module.exports[key] || {})) {
+    // $FlowFixMe The whole point of this file is to be dynamic
+    module.exports[key][dep] = require(dep);
+  }
+}

packages/acceptance-tests/pkg-tests-fixtures/packages/two-range-deps-1.0.0/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "two-range-deps",
+  "version": "1.0.0",
+  "dependencies": {
+      "no-deps": "^1.0.0",
+      "@types/is-number": ">=1.0.0"
+  }
+}

packages/acceptance-tests/pkg-tests-specs/sources/commands/dedupe.test.ts

@@ -0,0 +1,269 @@
+import {tests} from 'pkg-tests-core';
+
+const {setPackageWhitelist} = tests;
+
+describe(`Commands`, () => {
+  describe(`dedupe`, () => {
+    it(
+      `should include a footer`,
+      makeTemporaryEnv({}, async ({path, run, source}) => {
+        await setPackageWhitelist(new Map([
+          [`no-deps`, new Set([`1.0.0`])],
+          [`@types/is-number`, new Set([`1.0.0`])],
+        ]), async () => {
+          await run(`add`, `two-range-deps`);
+        });
+
+        await run(`add`, `no-deps@1.1.0`, `@types/is-number@2.0.0`);
+
+        await expect(run(`dedupe`, `--check`)).rejects.toMatchObject({
+          stdout: expect.stringContaining(`2 packages can be deduped using the highest strategy`),
+        });
+      })
+    );
+
+    describe(`strategies`, () => {
+      describe(`highest`, () => {
+        it(
+          `should dedupe dependencies`,
+          makeTemporaryEnv({}, async ({path, run, source}) => {
+            await setPackageWhitelist(new Map([[`no-deps`, new Set([`1.0.0`])]]), async () => {
+              await run(`add`, `one-range-dep`);
+            });
+
+            await run(`add`, `no-deps@1.1.0`);
+
+            await run(`dedupe`);
+
+            await expect(run(`dedupe`, `--check`)).resolves.toMatchObject({
+              code: 0,
+            });
+
+            await expect(source(`require('no-deps')`)).resolves.toMatchObject({
+              version: `1.1.0`,
+            });
+            await expect(source(`require('one-range-dep')`)).resolves.toMatchObject({
+              dependencies: {
+                [`no-deps`]: {
+                  version: `1.1.0`,
+                },
+              },
+            });
+          })
+        );
+
+        it(
+          `should dedupe dependencies to the highest possible version`,
+          makeTemporaryEnv({}, async ({path, run, source}) => {
+            await setPackageWhitelist(new Map([[`no-deps`, new Set([`1.0.0`])]]), async () => {
+              await run(`add`, `one-range-dep`, `one-range-dep-too`);
+            });
+
+            await run(`add`, `no-deps@1.1.0`);
+
+            await run(`dedupe`);
+
+            await expect(source(`require('no-deps')`)).resolves.toMatchObject({
+              version: `1.1.0`,
+            });
+            await expect(source(`require('one-range-dep')`)).resolves.toMatchObject({
+              dependencies: {
+                [`no-deps`]: {
+                  version: `1.1.0`,
+                },
+              },
+            });
+            await expect(source(`require('one-range-dep-too')`)).resolves.toMatchObject({
+              dependencies: {
+                [`no-deps`]: {
+                  version: `1.1.0`,
+                },
+              },
+            });
+          })
+        );
+      });
+    });
+
+    describe(`patterns`, () => {
+      it(
+        `should support selective dedupe (ident)`,
+        makeTemporaryEnv({}, async ({path, run, source}) => {
+          await setPackageWhitelist(new Map([
+            [`no-deps`, new Set([`1.0.0`])],
+            [`@types/is-number`, new Set([`1.0.0`])],
+          ]), async () => {
+            await run(`add`, `two-range-deps`);
+          });
+
+          await run(`add`, `no-deps@1.1.0`, `@types/is-number@2.0.0`);
+
+          await run(`dedupe`, `no-deps`);
+
+          await expect(source(`require('two-range-deps')`)).resolves.toMatchObject({
+            dependencies: {
+              [`no-deps`]: {
+                version: `1.1.0`,
+              },
+              [`@types/is-number`]: {
+                version: `1.0.0`,
+              },
+            },
+          });
+        })
+      );
+
+      it(
+        `should support selective dedupe (scoped ident)`,
+        makeTemporaryEnv({}, async ({path, run, source}) => {
+          await setPackageWhitelist(new Map([
+            [`no-deps`, new Set([`1.0.0`])],
+            [`@types/is-number`, new Set([`1.0.0`])],
+          ]), async () => {
+            await run(`add`, `two-range-deps`);
+          });
+
+          await run(`add`, `no-deps@1.1.0`, `@types/is-number@2.0.0`);
+
+          await run(`dedupe`, `@types/is-number`);
+
+          await expect(source(`require('two-range-deps')`)).resolves.toMatchObject({
+            dependencies: {
+              [`no-deps`]: {
+                version: `1.0.0`,
+              },
+              [`@types/is-number`]: {
+                version: `2.0.0`,
+              },
+            },
+          });
+        })
+      );
+
+      it(
+        `should support selective dedupe (ident glob)`,
+        makeTemporaryEnv({}, async ({path, run, source}) => {
+          await setPackageWhitelist(new Map([
+            [`no-deps`, new Set([`1.0.0`])],
+            [`@types/is-number`, new Set([`1.0.0`])],
+          ]), async () => {
+            await run(`add`, `two-range-deps`);
+          });
+
+          await run(`add`, `no-deps@1.1.0`, `@types/is-number@2.0.0`);
+
+          await run(`dedupe`, `no-*`);
+
+          await expect(source(`require('two-range-deps')`)).resolves.toMatchObject({
+            dependencies: {
+              [`no-deps`]: {
+                version: `1.1.0`,
+              },
+              [`@types/is-number`]: {
+                version: `1.0.0`,
+              },
+            },
+          });
+        })
+      );
+
+      it(
+        `should support selective dedupe (scoped ident glob)`,
+        makeTemporaryEnv({}, async ({path, run, source}) => {
+          await setPackageWhitelist(new Map([
+            [`no-deps`, new Set([`1.0.0`])],
+            [`@types/is-number`, new Set([`1.0.0`])],
+          ]), async () => {
+            await run(`add`, `two-range-deps`);
+          });
+
+          await run(`add`, `no-deps@1.1.0`, `@types/is-number@2.0.0`);
+
+          await run(`dedupe`, `@types/*`);
+
+          await expect(source(`require('two-range-deps')`)).resolves.toMatchObject({
+            dependencies: {
+              [`no-deps`]: {
+                version: `1.0.0`,
+              },
+              [`@types/is-number`]: {
+                version: `2.0.0`,
+              },
+            },
+          });
+        })
+      );
+    });
+
+    describe(`flags`, () => {
+      describe(`-c,--check`, () => {
+        it(
+          `should reject with error code 1 when there are duplicates`,
+          makeTemporaryEnv({}, async ({path, run, source}) => {
+            await setPackageWhitelist(new Map([[`no-deps`, new Set([`1.0.0`])]]), async () => {
+              await run(`add`, `one-range-dep`);
+            });
+
+            await run(`add`, `no-deps@1.1.0`);
+
+            await expect(run(`dedupe`, `--check`)).rejects.toMatchObject({
+              code: 1,
+            });
+          })
+        );
+
+        it(
+          `should resolve with error code 0 when there are no duplicates`,
+          makeTemporaryEnv({}, async ({path, run, source}) => {
+            await setPackageWhitelist(new Map([[`no-deps`, new Set([`1.0.0`])]]), async () => {
+              await run(`add`, `one-range-dep`);
+            });
+
+            await run(`add`, `no-deps@2.0.0`);
+
+            await expect(run(`dedupe`, `--check`)).resolves.toMatchObject({
+              code: 0,
+            });
+          })
+        );
+      });
+
+      test(
+        `--json`,
+        makeTemporaryEnv({}, async ({path, run, source}) => {
+          await setPackageWhitelist(new Map([[`no-deps`, new Set([`1.0.0`])]]), async () => {
+            await run(`add`, `one-range-dep`);
+          });
+
+          await run(`add`, `no-deps@1.1.0`);
+
+          // We also use the check flag so that the stdout doesn't include the install report
+          await run(`dedupe`, `--json`, `--check`).catch(({stdout}) => {
+            expect(JSON.parse(stdout.trim())).toMatchObject({
+              descriptor: `no-deps@npm:^1.0.0`,
+              currentResolution: `no-deps@npm:1.0.0`,
+              updatedResolution: `no-deps@npm:1.1.0`,
+            });
+          });
+
+          expect.assertions(1);
+        })
+      );
+
+      test(
+        `-s,--strategy`,
+        makeTemporaryEnv({}, async ({path, run, source}) => {
+          await setPackageWhitelist(new Map([[`no-deps`, new Set([`1.0.0`])]]), async () => {
+            await run(`add`, `one-range-dep`);
+          });
+
+          await run(`add`, `no-deps@1.1.0`);
+
+          await expect(run(`dedupe`, `--check`, `--strategy`, `highest`)).rejects.toMatchObject({
+            code: 1,
+          });
+        })
+      );
+    });
+  });
+});

packages/plugin-essentials/package.json

@@ -27,6 +27,7 @@
     "@types/micromatch": "^4.0.1",
     "@types/semver": "^7.1.0",
     "@types/treeify": "^1.0.0",
+    "@types/yup": "0.26.12",
     "@yarnpkg/cli": "workspace:^2.1.1",
     "@yarnpkg/core": "workspace:^2.1.1"
   },