Variants

.yarnrc.yml

@@ -44,3 +44,8 @@ preferInteractive: true
 telemetryUserId: yarnpkg/berry
 
 yarnPath: scripts/run-yarn.js
+
+cacheParameters:
+  matrix:
+    platform: [darwin, linux, windows, freebsd, openbsd]
+    arch: [32, 64, arm, arm64, mips64le, ppc64le]

packages/acceptance-tests/pkg-tests-fixtures/packages/variants-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/variants-1.0.0/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "variants",
+  "version": "1.0.0",
+  "variants": [
+    {
+      "pattern": "variants-%par1-%par2@%version",
+      "matrix": {
+        "par1": [
+          "a",
+          "b",
+          "c"
+        ],
+        "par2": [
+          1,
+          2
+        ]
+      },
+      "exclude": [
+        {
+          "par1": "c",
+          "par2": 1
+        }
+      ]
+    },
+    {
+      "pattern": "variants-%par1@%version",
+      "matrix": {
+        "par1": [
+          "d"
+        ]
+      }
+    },
+    {
+      "pattern": "variants-fallback@%version"
+    }
+  ]
+}

packages/acceptance-tests/pkg-tests-fixtures/packages/variants-a-1-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/variants-a-1-1.0.0/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "variants-a-1",
+  "version": "1.0.0"
+}

packages/acceptance-tests/pkg-tests-fixtures/packages/variants-a-2-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/variants-a-2-1.0.0/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "variants-a-2",
+  "version": "1.0.0"
+}

packages/acceptance-tests/pkg-tests-fixtures/packages/variants-b-1-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/variants-b-1-1.0.0/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "variants-b-1",
+  "version": "1.0.0"
+}

packages/acceptance-tests/pkg-tests-fixtures/packages/variants-b-2-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/variants-b-2-1.0.0/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "variants-b-2",
+  "version": "1.0.0"
+}

packages/acceptance-tests/pkg-tests-fixtures/packages/variants-c-2-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/variants-c-2-1.0.0/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "variants-c-2",
+  "version": "1.0.0"
+}

packages/acceptance-tests/pkg-tests-fixtures/packages/variants-d-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/variants-d-1.0.0/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "variants-d",
+  "version": "1.0.0"
+}

packages/acceptance-tests/pkg-tests-fixtures/packages/variants-fallback-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/variants-fallback-1.0.0/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "variants-fallback",
+  "version": "1.0.0"
+}

packages/acceptance-tests/pkg-tests-specs/sources/variants.test.ts

@@ -0,0 +1,88 @@
+import {PortablePath, xfs} from '@yarnpkg/fslib';
+import {yarn}              from 'pkg-tests-core';
+
+const {writeConfiguration} = yarn;
+
+describe(`Variant tests`, () => {
+  test(
+    `it should install the fallback dependency when no matching pattern can be found`,
+    makeTemporaryEnv(
+      {
+        dependencies: {[`variants`]: `1.0.0`},
+      },
+      async ({run, source}) => {
+        await run(`install`);
+
+        await expect(source(`require('variants')`)).resolves.toMatchObject({
+          name: `variants-fallback`,
+          version: `1.0.0`,
+        });
+      },
+    ),
+  );
+
+  test(
+    `it should correctly install a dependency matching parameters set in the dependenciesMeta`,
+    makeTemporaryEnv(
+      {
+        dependencies: {[`variants`]: `1.0.0`},
+        dependenciesMeta: {
+          [`variants`]: {
+            parameters: {
+              par1: `a`,
+              par2: 1,
+            },
+          },
+        },
+      },
+      async ({run, source}) => {
+        await run(`install`);
+
+        await expect(source(`require('variants')`)).resolves.toMatchObject({
+          name: `variants-a-1`,
+          version: `1.0.0`,
+        });
+      },
+    ),
+  );
+
+  test(
+    `it should fetch the matrix of cached variants set in the yarnrc`,
+    makeTemporaryEnv(
+      {
+        dependencies: {[`variants`]: `1.0.0`},
+        dependenciesMeta: {
+          [`variants`]: {
+            parameters: {
+              par1: `a`,
+              par2: 1,
+            },
+          },
+        },
+      },
+      async ({path, run}) => {
+        await writeConfiguration(path, {
+          cacheParameters: {
+            matrix: {
+              par1: [`a`, `b`, `c`],
+              par2: [1],
+            },
+          },
+        });
+
+        await run(`install`);
+
+
+        const cache = await xfs.readdirPromise(`${path}/.yarn/cache` as PortablePath);
+
+        const variantA1 = cache.find(file => file.startsWith(`variants-a-1-npm-1.0.0`));
+        const variantB1 = cache.find(file => file.startsWith(`variants-b-1-npm-1.0.0`));
+        const variantC1 = cache.find(file => file.startsWith(`variants-c-1-npm-1.0.0`));
+
+        expect(variantA1).toBeDefined();
+        expect(variantB1).toBeDefined();
+        expect(variantC1).not.toBeDefined(); // C1 is excluded by the variants package
+      },
+    ),
+  );
+});

packages/plugin-exec/sources/ExecResolver.ts

@@ -89,6 +89,7 @@ export class ExecResolver implements Resolver {
       peerDependenciesMeta: manifest.peerDependenciesMeta,
 
       bin: manifest.bin,
+      variants: manifest.variants,
     };
   }
 }

packages/plugin-file/sources/FileResolver.ts

@@ -101,6 +101,7 @@ export class FileResolver implements Resolver {
       peerDependenciesMeta: manifest.peerDependenciesMeta,
 
       bin: manifest.bin,
+      variants: manifest.variants,
     };
   }
 }

packages/plugin-file/sources/TarballFileResolver.ts

@@ -85,6 +85,7 @@ export class TarballFileResolver implements Resolver {
       peerDependenciesMeta: manifest.peerDependenciesMeta,
 
       bin: manifest.bin,
+      variants: manifest.variants,
     };
   }
 }

packages/plugin-git/sources/GitResolver.ts

@@ -62,6 +62,7 @@ export class GitResolver implements Resolver {
       peerDependenciesMeta: manifest.peerDependenciesMeta,
 
       bin: manifest.bin,
+      variants: manifest.variants,
     };
   }
 }

packages/plugin-http/sources/TarballHttpResolver.ts

@@ -71,6 +71,7 @@ export class TarballHttpResolver implements Resolver {
       peerDependenciesMeta: manifest.peerDependenciesMeta,
 
       bin: manifest.bin,
+      variants: manifest.variants,
     };
   }
 }

packages/plugin-link/sources/LinkResolver.ts

@@ -70,6 +70,7 @@ export class LinkResolver implements Resolver {
       peerDependenciesMeta: manifest.peerDependenciesMeta,
 
       bin: manifest.bin,
+      variants: manifest.variants,
     };
   }
 }

packages/plugin-link/sources/RawLinkResolver.ts

@@ -61,6 +61,7 @@ export class RawLinkResolver implements Resolver {
       peerDependenciesMeta: new Map(),
 
       bin: new Map(),
+      variants: null,
     };
   }
 }

packages/plugin-npm/sources/NpmSemverResolver.ts

@@ -150,6 +150,7 @@ export class NpmSemverResolver implements Resolver {
     if (typeof manifest.raw.deprecated === `string`)
       opts.report.reportWarningOnce(MessageName.DEPRECATED_PACKAGE, `${structUtils.prettyLocator(opts.project.configuration, locator)} is deprecated: ${manifest.raw.deprecated}`);
 
+
     return {
       ...locator,
 
@@ -165,6 +166,8 @@ export class NpmSemverResolver implements Resolver {
       peerDependenciesMeta: manifest.peerDependenciesMeta,
 
       bin: manifest.bin,
+
+      variants: manifest.variants,
     };
   }
 }

packages/variant-fallback/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/variant-fallback/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "variant-fallback",
+  "version": "0.12.22"
+}

packages/variant-test/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);
+  }
+}