Merge pull request #4538 from iclanton/remove-variants

[rush] Remove the installation variants feature.

Author: iclanton

common/changes/@microsoft/rush/main_2024-02-23-01-25.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "(BREAKING CHANGE) Remove the 'installation variants' feature and its related APIs, which have been superceded by the Subspaces feature.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}

common/changes/@rushstack/ts-command-line/remove-variants_2024-02-23-18-12.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/ts-command-line",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@rushstack/ts-command-line"
+}

common/reviews/api/rush-lib.api.md

@@ -251,7 +251,6 @@ export const EnvironmentVariableNames: {
     readonly RUSH_PREVIEW_VERSION: "RUSH_PREVIEW_VERSION";
     readonly RUSH_ALLOW_UNSUPPORTED_NODEJS: "RUSH_ALLOW_UNSUPPORTED_NODEJS";
     readonly RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD: "RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD";
-    readonly RUSH_VARIANT: "RUSH_VARIANT";
     readonly RUSH_PARALLELISM: "RUSH_PARALLELISM";
     readonly RUSH_ABSOLUTE_SYMLINKS: "RUSH_ABSOLUTE_SYMLINKS";
     readonly RUSH_PNPM_STORE_PATH: "RUSH_PNPM_STORE_PATH";
@@ -1070,8 +1069,6 @@ export class RushConfiguration {
     readonly commonTempFolder: string;
     // @deprecated
     get commonVersions(): CommonVersionsConfiguration;
-    get currentInstalledVariant(): string | undefined;
-    readonly currentVariantJsonFilename: string;
     // @beta
     readonly customTipsConfiguration: CustomTipsConfiguration;
     // @beta
@@ -1091,7 +1088,7 @@ export class RushConfiguration {
     getCommonVersions(subspace?: Subspace): CommonVersionsConfiguration;
     // @deprecated (undocumented)
     getCommonVersionsFilePath(subspace?: Subspace): string;
-    getImplicitlyPreferredVersions(variant?: string | undefined): Map<string, string>;
+    getImplicitlyPreferredVersions(): Map<string, string>;
     // @deprecated (undocumented)
     getPnpmfilePath(subspace?: Subspace): string;
     getProjectByName(projectName: string): RushConfigurationProject | undefined;
@@ -1111,6 +1108,8 @@ export class RushConfiguration {
     readonly gitSampleEmail: string;
     readonly gitTagSeparator: string | undefined;
     readonly gitVersionBumpCommitMessage: string | undefined;
+    // @internal @deprecated
+    readonly _hasVariantsField: boolean;
     readonly hotfixChangeEnabled: boolean;
     static loadFromConfigurationFile(rushJsonFilename: string): RushConfiguration;
     // (undocumented)
@@ -1272,7 +1271,6 @@ export class RushConstants {
     static readonly rushTempNpmScope: '@rush-temp';
     static readonly rushTempProjectsFolderName: 'projects';
     static readonly rushUserConfigurationFolderName: '.rush-user';
-    static readonly rushVariantsFolderName: 'variants';
     static readonly rushWebSiteUrl: 'https://rushjs.io';
     static readonly subspacesConfigFilename: 'subspaces.json';
     // (undocumented)

libraries/rush-lib/assets/rush-init/rush.json

@@ -279,39 +279,6 @@
     "postRushx": []
   },
 
-  /**
-   * Installation variants allow you to maintain a parallel set of configuration files that can be
-   * used to build the entire monorepo with an alternate set of dependencies.  For example, suppose
-   * you upgrade all your projects to use a new release of an important framework, but during a transition period
-   * you intend to maintain compatibility with the old release.  In this situation, you probably want your
-   * CI validation to build the entire repo twice: once with the old release, and once with the new release.
-   *
-   * Rush "installation variants" correspond to sets of config files located under this folder:
-   *
-   *   common/config/rush/variants/<variant_name>
-   *
-   * The variant folder can contain an alternate common-versions.json file.  Its "preferredVersions" field can be used
-   * to select older versions of dependencies (within a loose SemVer range specified in your package.json files).
-   * To install a variant, run "rush install --variant <variant_name>".
-   *
-   * For more details and instructions, see this article:  https://rushjs.io/pages/advanced/installation_variants/
-   */
-  "variants": [
-    /*[BEGIN "HYPOTHETICAL"]*/
-    {
-      /**
-       * The folder name for this variant.
-       */
-      "variantName": "old-sdk",
-
-      /**
-       * An informative description
-       */
-      "description": "Build this repo using the previous release of the SDK"
-    }
-    /*[END "HYPOTHETICAL"]*/
-  ],
-
   /**
    * Rush can collect anonymous telemetry about everyday developer activity such as
    * success/failure of installs, builds, and other operations.  You can use this to identify
@@ -330,13 +297,13 @@
   /*[LINE "HYPOTHETICAL"]*/ "hotfixChangeEnabled": false,
 
   /**
-    * This is an optional, but recommended, list of allowed tags that can be applied to Rush projects
-    * using the "tags" setting in this file.  This list is useful for preventing mistakes such as misspelling,
-    * and it also provides a centralized place to document your tags.  If "allowedProjectTags" list is
-    * not specified, then any valid tag is allowed.  A tag name must be one or more words
-    * separated by hyphens or slashes, where a word may contain lowercase ASCII letters, digits,
-    * ".", and "@" characters.
-    */
+   * This is an optional, but recommended, list of allowed tags that can be applied to Rush projects
+   * using the "tags" setting in this file.  This list is useful for preventing mistakes such as misspelling,
+   * and it also provides a centralized place to document your tags.  If "allowedProjectTags" list is
+   * not specified, then any valid tag is allowed.  A tag name must be one or more words
+   * separated by hyphens or slashes, where a word may contain lowercase ASCII letters, digits,
+   * ".", and "@" characters.
+   */
   /*[LINE "HYPOTHETICAL"]*/ "allowedProjectTags": [ "tools", "frontend-team", "1.0.0-release" ],
 
   /**

libraries/rush-lib/src/api/EnvironmentConfiguration.ts

@@ -50,14 +50,6 @@ export const EnvironmentVariableNames = {
    */
   RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD: 'RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD',
 
-  /**
-   * This variable selects a specific installation variant for Rush to use when installing
-   * and linking package dependencies.
-   * For more information, see the command-line help for the `--variant` parameter
-   * and this article:  https://rushjs.io/pages/advanced/installation_variants/
-   */
-  RUSH_VARIANT: 'RUSH_VARIANT',
-
   /**
    * Specifies the maximum number of concurrent processes to launch during a build.
    * For more information, see the command-line help for the `--parallelism` parameter for "rush build".
@@ -541,7 +533,6 @@ export class EnvironmentConfiguration {
 
           case EnvironmentVariableNames.RUSH_PARALLELISM:
           case EnvironmentVariableNames.RUSH_PREVIEW_VERSION:
-          case EnvironmentVariableNames.RUSH_VARIANT:
           case EnvironmentVariableNames.RUSH_DEPLOY_TARGET_FOLDER:
             // Handled by @microsoft/rush front end
             break;

libraries/rush-lib/src/api/LastLinkFlag.ts

@@ -58,6 +58,6 @@ export class LastLinkFlagFactory {
    * @internal
    */
   public static getCommonTempFlag(subspace: Subspace): LastLinkFlag {
-    return new LastLinkFlag(subspace.getSubspaceTempFolder(), {});
+    return new LastLinkFlag(subspace.getSubspaceTempFolder());
   }
 }

libraries/rush-lib/src/api/RushConfiguration.ts

@@ -8,7 +8,6 @@ import * as semver from 'semver';
 import {
   JsonFile,
   JsonSchema,
-  type JsonNull,
   Path,
   FileSystem,
   type PackageNameParser,
@@ -144,14 +143,6 @@ export interface IRushRepositoryJsonMultipleUrls extends IRushRepositoryJsonBase
 
 export type IRushRepositoryJson = IRushRepositoryJsonSingleUrl | IRushRepositoryJsonMultipleUrls;
 
-/**
- * Options defining an allowed variant as part of IRushConfigurationJson.
- */
-export interface IRushVariantOptionsJson {
-  variantName: string;
-  description: string;
-}
-
 /**
  * This represents the JSON data structure for the "rush.json" configuration file.
  * See rush.schema.json for documentation.
@@ -180,14 +171,7 @@ export interface IRushConfigurationJson {
   pnpmOptions?: IPnpmOptionsJson;
   yarnOptions?: IYarnOptionsJson;
   ensureConsistentVersions?: boolean;
-  variants?: IRushVariantOptionsJson[];
-}
-
-/**
- * This represents the JSON data structure for the "current-variant.json" data file.
- */
-export interface ICurrentVariantJson {
-  variant: string | JsonNull;
+  variants?: unknown;
 }
 
 /**
@@ -224,7 +208,6 @@ export interface ITryFindRushJsonLocationOptions {
 export class RushConfiguration {
   private static _jsonSchema: JsonSchema = JsonSchema.fromLoadedObject(schemaJson);
 
-  private _variants: Set<string>;
   private readonly _pathTrees: Map<string, LookupByPath<RushConfigurationProject>>;
 
   // Lazily loaded when the projects() getter is called.
@@ -236,9 +219,6 @@ export class RushConfiguration {
   // Lazily loaded when the projectsByTag() getter is called.
   private _projectsByTag: ReadonlyMap<string, ReadonlySet<RushConfigurationProject>> | undefined;
 
-  // variant -> common-versions configuration
-  private _commonVersionsConfigurationsByVariant: Map<string, CommonVersionsConfiguration> | undefined;
-
   // subspaceName -> subspace
   private readonly _subspacesByName: Map<string, Subspace>;
   private readonly _subspaces: Subspace[] = [];
@@ -358,13 +338,12 @@ export class RushConfiguration {
   public readonly subspacesFeatureEnabled: boolean;
 
   /**
-   * The filename of the variant dependency data file.  By default this is
-   * called 'current-variant.json' resides in the Rush common folder.
-   * Its data structure is defined by ICurrentVariantJson.
+   * If true, the `variants` field is present in rush.json.
    *
-   * Example: `C:\MyRepo\common\temp\current-variant.json`
+   * @internal
+   * @deprecated - Remove when the field is removed from the rush.json schema.
    */
-  public readonly currentVariantJsonFilename: string;
+  public readonly _hasVariantsField: boolean;
 
   /**
    * The version of the locally package manager tool.  (Example: "1.2.3")
@@ -625,8 +604,6 @@ export class RushConfiguration {
 
     this.changesFolder = path.join(this.commonFolder, RushConstants.changeFilesFolderName);
 
-    this.currentVariantJsonFilename = path.join(this.commonTempFolder, 'current-variant.json');
-
     this.suppressNodeLtsWarning = !!rushConfigurationJson.suppressNodeLtsWarning;
 
     this.ensureConsistentVersions = !!rushConfigurationJson.ensureConsistentVersions;
@@ -834,19 +811,7 @@ export class RushConfiguration {
     );
     this.customTipsConfiguration = new CustomTipsConfiguration(this.customTipsConfigurationFilePath);
 
-    this._variants = new Set<string>();
-
-    if (rushConfigurationJson.variants) {
-      for (const variantOptions of rushConfigurationJson.variants) {
-        const { variantName } = variantOptions;
-
-        if (this._variants.has(variantName)) {
-          throw new Error(`Duplicate variant named '${variantName}' specified in configuration.`);
-        }
-
-        this._variants.add(variantName);
-      }
-    }
+    this._hasVariantsField = !!rushConfigurationJson.variants;
 
     this._pathTrees = new Map();
   }
@@ -1383,31 +1348,12 @@ export class RushConfiguration {
    * Instead it will be initialized in an empty state, and calling CommonVersionsConfiguration.save()
    * will create the file.
    *
-   * @deprecated Use `getCommonVersions` instead, which gets the correct common version data
-   * for a given active variant.
+   * @deprecated Use `getCommonVersions` instead, which gets the correct common version data.
    */
   public get commonVersions(): CommonVersionsConfiguration {
     return this.defaultSubspace.getCommonVersions();
   }
 
-  /**
-   * Gets the currently-installed variant, if an installation has occurred.
-   * For Rush operations which do not take a --variant parameter, this method
-   * determines which variant, if any, was last specified when performing "rush install"
-   * or "rush update".
-   */
-  public get currentInstalledVariant(): string | undefined {
-    let variant: string | undefined;
-
-    if (FileSystem.exists(this.currentVariantJsonFilename)) {
-      const currentVariantJson: ICurrentVariantJson = JsonFile.load(this.currentVariantJsonFilename);
-
-      variant = currentVariantJson.variant || undefined;
-    }
-
-    return variant;
-  }
-
   /**
    * @deprecated Use {@link Subspace.getCommonVersionsFilePath} instead
    */
@@ -1424,18 +1370,17 @@ export class RushConfiguration {
 
   /**
    * Returns a map of all direct dependencies that only have a single semantic version specifier.
-   * @param variant - The name of the current variant in use by the active command.
    *
    * @returns A map of dependency name --\> version specifier for implicitly preferred versions.
    */
-  public getImplicitlyPreferredVersions(variant?: string | undefined): Map<string, string> {
+  public getImplicitlyPreferredVersions(): Map<string, string> {
     // TODO: During the next major release of Rush, replace this `require` call with a dynamic import, and
     // change this function to be async.
     const DependencyAnalyzerModule: typeof DependencyAnalyzerModuleType = require('../logic/DependencyAnalyzer');
     const dependencyAnalyzer: DependencyAnalyzerModuleType.DependencyAnalyzer =
       DependencyAnalyzerModule.DependencyAnalyzer.forRushConfiguration(this);
     const dependencyAnalysis: DependencyAnalyzerModuleType.IDependencyAnalysis =
-      dependencyAnalyzer.getAnalysis(variant);
+      dependencyAnalyzer.getAnalysis();
     return dependencyAnalysis.implicitlyPreferredVersionByPackageName;
   }
 

libraries/rush-lib/src/api/Subspace.ts

@@ -193,8 +193,7 @@ export class Subspace {
   }
 
   /**
-   * Gets the settings from the common-versions.json config file for a specific variant.
-   * @param variant - The name of the current variant in use by the active command.
+   * Gets the settings from the common-versions.json config file.
    * @beta
    */
   public getCommonVersions(): CommonVersionsConfiguration {
@@ -206,18 +205,16 @@ export class Subspace {
   }
 
   /**
-   * Gets the path to the repo-state.json file for a specific variant.
-   * @param variant - The name of the current variant in use by the active command.
+   * Gets the path to the repo-state.json file.
    * @beta
    */
   public getRepoStateFilePath(): string {
     return this._ensureDetail().subspaceConfigFolder + '/' + RushConstants.repoStateFilename;
   }
 
   /**
-   * Gets the contents from the repo-state.json file for a specific variant.
+   * Gets the contents from the repo-state.json file.
    * @param subspaceName - The name of the subspace in use by the active command.
-   * @param variant - The name of the current variant in use by the active command.
    * @beta
    */
   public getRepoState(): RepoStateFile {
@@ -226,8 +223,7 @@ export class Subspace {
   }
 
   /**
-   * Gets the committed shrinkwrap file name for a specific variant.
-   * @param variant - The name of the current variant in use by the active command.
+   * Gets the committed shrinkwrap file name.
    * @beta
    */
   public getCommittedShrinkwrapFilename(): string {

libraries/rush-lib/src/api/Variants.ts

@@ -469,7 +469,6 @@ export class RushPnpmCommandLineParser {
       networkConcurrency: undefined,
       offline: false,
       collectLogFile: false,
-      variant: undefined,
       maxInstallAttempts: RushConstants.defaultMaxInstallAttempts,
       pnpmFilterArguments: [],
       checkOnly: false,