[rush] Add PnpmWorkspaceFile.loadAsync to read pnpm-workspace.yaml once

Replace the per-field loadPatchedDependenciesAsync/loadAllowBuildsAsync helpers with a single loadAsync that parses the file once and returns a populated PnpmWorkspaceFile, and use it from the rush-pnpm patch-commit and approve-builds commands.

Author: iclanton

libraries/rush-lib/src/cli/RushPnpmCommandLineParser.ts

@@ -545,9 +545,10 @@ export class RushPnpmCommandLineParser {
         let newGlobalPatchedDependencies: Record<string, string> | undefined;
         if (semver.gte(pnpmVersion, '11.0.0')) {
           // PNPM 11+ stores patchedDependencies in pnpm-workspace.yaml instead of the package.json "pnpm" field
-          newGlobalPatchedDependencies = await PnpmWorkspaceFile.loadPatchedDependenciesAsync(
+          const workspaceFile: PnpmWorkspaceFile = await PnpmWorkspaceFile.loadAsync(
             `${subspaceTempFolder}/${RushConstants.pnpmWorkspaceFileName}`
           );
+          newGlobalPatchedDependencies = workspaceFile.patchedDependencies;
         } else {
           // PNPM 10.x and earlier store patchedDependencies in the package.json "pnpm" field
           // Example: "C:\MyRepo\common\temp\package.json"
@@ -612,13 +613,10 @@ export class RushPnpmCommandLineParser {
 
         if (semver.gte(pnpmVersion, '11.0.0')) {
           // PNPM 11+ uses allowBuilds in pnpm-workspace.yaml instead of onlyBuiltDependencies in package.json
-          const workspaceYamlFilename: string = `${subspaceTempFolder}/${RushConstants.pnpmWorkspaceFileName}`;
-          const yamlModule: typeof import('js-yaml') = await import('js-yaml');
-          const workspaceYamlContent: string = await FileSystem.readFileAsync(workspaceYamlFilename);
-          const workspaceYaml: { allowBuilds?: Record<string, boolean> } = (yamlModule.load(
-            workspaceYamlContent
-          ) ?? {}) as { allowBuilds?: Record<string, boolean> };
-          const newGlobalAllowBuilds: Record<string, boolean> | undefined = workspaceYaml?.allowBuilds;
+          const workspaceFile: PnpmWorkspaceFile = await PnpmWorkspaceFile.loadAsync(
+            `${subspaceTempFolder}/${RushConstants.pnpmWorkspaceFileName}`
+          );
+          const newGlobalAllowBuilds: Record<string, boolean> | undefined = workspaceFile.allowBuilds;
           const currentGlobalAllowBuilds: Record<string, boolean> | undefined =
             pnpmOptions?.globalAllowBuilds;
 

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

@@ -114,18 +114,37 @@ export class PnpmWorkspaceFile extends BaseWorkspaceFile {
   }
 
   /**
-   * Reads the `patchedDependencies` field from an existing `pnpm-workspace.yaml` file.
+   * Reads an existing `pnpm-workspace.yaml` file and returns a {@link PnpmWorkspaceFile} whose
+   * settings properties are populated from its contents.
+   *
+   * @remarks
+   * The workspace `packages` list is not loaded; the returned instance is intended for reading the
+   * generated pnpm settings (such as `allowBuilds` and `patchedDependencies`), not for
+   * re-serialization.
+   *
    * @param workspaceYamlFilename - The path to the `pnpm-workspace.yaml` file
    */
-  public static async loadPatchedDependenciesAsync(
-    workspaceYamlFilename: string
-  ): Promise<Record<string, string> | undefined> {
+  public static async loadAsync(workspaceYamlFilename: string): Promise<PnpmWorkspaceFile> {
     const workspaceYamlContent: string = await FileSystem.readFileAsync(workspaceYamlFilename);
     const yamlModule: typeof import('js-yaml') = await import('js-yaml');
     const workspaceYaml: IPnpmWorkspaceYaml | undefined = yamlModule.load(workspaceYamlContent) as
       | IPnpmWorkspaceYaml
       | undefined;
-    return workspaceYaml?.patchedDependencies;
+
+    const workspaceFile: PnpmWorkspaceFile = new PnpmWorkspaceFile(workspaceYamlFilename);
+    if (workspaceYaml) {
+      workspaceFile.catalogs = workspaceYaml.catalogs;
+      workspaceFile.allowBuilds = workspaceYaml.allowBuilds;
+      workspaceFile.overrides = workspaceYaml.overrides;
+      workspaceFile.packageExtensions = workspaceYaml.packageExtensions;
+      workspaceFile.peerDependencyRules = workspaceYaml.peerDependencyRules;
+      workspaceFile.allowedDeprecatedVersions = workspaceYaml.allowedDeprecatedVersions;
+      workspaceFile.patchedDependencies = workspaceYaml.patchedDependencies;
+      workspaceFile.minimumReleaseAge = workspaceYaml.minimumReleaseAge;
+      workspaceFile.minimumReleaseAgeExclude = workspaceYaml.minimumReleaseAgeExclude;
+    }
+
+    return workspaceFile;
   }
 
   public override addPackage(packagePath: string): void {

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

@@ -350,7 +350,7 @@ describe(PnpmWorkspaceFile.name, () => {
     });
   });
 
-  describe(PnpmWorkspaceFile.loadPatchedDependenciesAsync.name, () => {
+  describe(PnpmWorkspaceFile.loadAsync.name, () => {
     let mockReadFileAsync: jest.SpyInstance;
 
     beforeEach(() => {
@@ -375,7 +375,8 @@ describe(PnpmWorkspaceFile.name, () => {
       };
       await workspaceFile.saveAsync(workspaceFilePath, { onlyIfChanged: true });
 
-      await expect(PnpmWorkspaceFile.loadPatchedDependenciesAsync(workspaceFilePath)).resolves.toEqual({
+      const loadedWorkspaceFile: PnpmWorkspaceFile = await PnpmWorkspaceFile.loadAsync(workspaceFilePath);
+      expect(loadedWorkspaceFile.patchedDependencies).toEqual({
         'lodash@4.17.21': 'patches/lodash@4.17.21.patch'
       });
     });
@@ -385,9 +386,8 @@ describe(PnpmWorkspaceFile.name, () => {
       workspaceFile.addPackage(`${projectsDir}/app1`);
       await workspaceFile.saveAsync(workspaceFilePath, { onlyIfChanged: true });
 
-      await expect(
-        PnpmWorkspaceFile.loadPatchedDependenciesAsync(workspaceFilePath)
-      ).resolves.toBeUndefined();
+      const loadedWorkspaceFile: PnpmWorkspaceFile = await PnpmWorkspaceFile.loadAsync(workspaceFilePath);
+      expect(loadedWorkspaceFile.patchedDependencies).toBeUndefined();
     });
   });