fix: allPreferredVerions and allowedAlternativeVersions are not recorded in the subspace pnpmfileSettings.json

Author: LPegasus

libraries/rush-lib/src/logic/pnpm/IPnpmfile.ts

@@ -32,8 +32,7 @@ export interface IWorkspaceProjectInfo
  * The `settings` parameter passed to {@link IPnpmfileShim.hooks.readPackage} and
  * {@link IPnpmfileShim.hooks.afterAllResolved}.
  */
-export interface ISubspacePnpmfileShimSettings {
-  semverPath: string;
+export interface ISubspacePnpmfileShimSettings extends Omit<IPnpmfileShimSettings, 'workspaceVersions'> {
   workspaceProjects: Record<string, IWorkspaceProjectInfo>;
   subspaceProjects: Record<string, IWorkspaceProjectInfo>;
   userPnpmfilePath?: string;

libraries/rush-lib/src/logic/pnpm/SubspacePnpmfileConfiguration.ts

@@ -3,13 +3,22 @@
 
 import * as path from 'node:path';
 
-import { FileSystem, Import, JsonFile, type IDependenciesMetaTable } from '@rushstack/node-core-library';
+import * as semver from 'semver';
+
+import {
+  FileSystem,
+  Import,
+  JsonFile,
+  MapExtensions,
+  type IDependenciesMetaTable
+} from '@rushstack/node-core-library';
 
 import { subspacePnpmfileShimFilename, scriptsFolderPath } from '../../utilities/PathConstants';
 import type { ISubspacePnpmfileShimSettings, IWorkspaceProjectInfo } from './IPnpmfile';
 import type { RushConfiguration } from '../../api/RushConfiguration';
 import type { RushConfigurationProject } from '../../api/RushConfigurationProject';
 import type { PnpmPackageManager } from '../../api/packageManager/PnpmPackageManager';
+import type { CommonVersionsConfiguration } from '../../api/CommonVersionsConfiguration';
 import { RushConstants } from '../RushConstants';
 import type { Subspace } from '../../api/Subspace';
 import type { PnpmOptionsConfiguration } from './PnpmOptionsConfiguration';
@@ -80,9 +89,35 @@ export class SubspacePnpmfileConfiguration {
       (subspace.contains(project) ? subspaceProjects : workspaceProjects)[packageName] = workspaceProjectInfo;
     }
 
+    let allPreferredVersions: { [dependencyName: string]: string } = {};
+    let allowedAlternativeVersions: { [dependencyName: string]: readonly string[] } = {};
+
+    // Populate preferred versions from subspace's common-versions.json (same as non-subspace pnpmfile shim)
+    const pnpmOptions: PnpmOptionsConfiguration =
+      rushConfiguration.packageManagerOptions as PnpmOptionsConfiguration;
+    if (pnpmOptions?.useWorkspaces) {
+      const commonVersionsConfiguration: CommonVersionsConfiguration = subspace.getCommonVersions(variant);
+      const preferredVersions: Map<string, string> = new Map();
+      MapExtensions.mergeFromMap(
+        preferredVersions,
+        rushConfiguration.getImplicitlyPreferredVersions(subspace, variant)
+      );
+      for (const [name, version] of commonVersionsConfiguration.getAllPreferredVersions()) {
+        if (!preferredVersions.has(name) || semver.subset(version, preferredVersions.get(name)!)) {
+          preferredVersions.set(name, version);
+        }
+      }
+      allPreferredVersions = MapExtensions.toObject(preferredVersions);
+      allowedAlternativeVersions = MapExtensions.toObject(
+        commonVersionsConfiguration.allowedAlternativeVersions
+      );
+    }
+
     const settings: ISubspacePnpmfileShimSettings = {
       workspaceProjects,
       subspaceProjects,
+      allPreferredVersions,
+      allowedAlternativeVersions,
       semverPath: Import.resolveModule({ modulePath: 'semver', baseFolderPath: __dirname })
     };
 

libraries/rush-lib/src/logic/pnpm/test/SubspacePnpmfileConfiguration.test.ts

@@ -0,0 +1,41 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+import { RushConfiguration } from '../../../api/RushConfiguration';
+import { SubspacePnpmfileConfiguration } from '../SubspacePnpmfileConfiguration';
+import { JsonFile, type JsonObject } from '@rushstack/node-core-library';
+
+describe(SubspacePnpmfileConfiguration.name, () => {
+  const repoPath: string = `${__dirname}/repo-with-subspace`;
+  const rushFilename: string = `${repoPath}/rush.json`;
+  const rushConfiguration: RushConfiguration = RushConfiguration.loadFromConfigurationFile(rushFilename);
+  const shimPath: string = `${rushConfiguration.defaultSubspace.getSubspaceTempFolderPath()}/pnpmfileSettings.json`;
+
+  beforeAll(async () => {
+    const subspace = rushConfiguration.defaultSubspace;
+    await SubspacePnpmfileConfiguration.writeCommonTempSubspaceGlobalPnpmfileAsync(
+      rushConfiguration,
+      subspace,
+      undefined
+    );
+  });
+
+  it('should use the smallest-available SemVer range (preferredVersions)', async () => {
+    const shimJson: JsonObject = await JsonFile.loadAsync(shimPath);
+    expect(shimJson.allPreferredVersions).toHaveProperty('@rushstack/terminal', '0.19.2');
+  });
+
+  it('should record allPreferredVersions in pnpmfileSettings.json', async () => {
+    const shimJson: JsonObject = await JsonFile.loadAsync(shimPath);
+    expect(shimJson.allPreferredVersions).toHaveProperty('@rushstack/terminal', '0.19.2');
+  });
+
+  it('should record allowedAlternativeVersions in pnpmfileSettings.json', async () => {
+    const shimJson: JsonObject = await JsonFile.loadAsync(shimPath);
+    const allowedAlternativeVersions = shimJson.allowedAlternativeVersions as
+      | Record<string, readonly string[]>
+      | undefined;
+    expect(allowedAlternativeVersions).toBeDefined();
+    expect(allowedAlternativeVersions).toHaveProperty('foo', ['1.0.0']);
+  });
+});

libraries/rush-lib/src/logic/pnpm/test/repo-with-subspace/a/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "a",
+  "version": "1.0.0",
+  "description": "Test package a to test subspace pnpmfile shim with preferred versions",
+  "dependencies": {
+    "@rushstack/terminal": "~0.19.0"
+  }
+}