Support pnpm v9 (#5009)

apps/lockfile-explorer/package.json

@@ -66,7 +66,7 @@
     "js-yaml": "~3.13.1",
     "open": "~8.4.0",
     "update-notifier": "~5.1.0",
-    "@pnpm/dependency-path": "~2.1.2",
+    "@pnpm/dependency-path-lockfile-pre-v9": "npm:@pnpm/dependency-path@~2.1.2",
     "semver": "~7.5.4",
     "@rushstack/rush-sdk": "workspace:*",
     "@rushstack/ts-command-line": "workspace:*"

apps/lockfile-explorer/src/utils/shrinkwrap.ts

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
 // See LICENSE in the project root for license information.
 
-import * as dp from '@pnpm/dependency-path';
+import * as dependencyPathLockfilePreV9 from '@pnpm/dependency-path-lockfile-pre-v9';
 
 interface IPackageInfo {
   name: string;
@@ -12,7 +12,7 @@ interface IPackageInfo {
 export function convertLockfileV6DepPathToV5DepPath(newDepPath: string): string {
   if (!newDepPath.includes('@', 2) || newDepPath.startsWith('file:')) return newDepPath;
   const index = newDepPath.indexOf('@', newDepPath.indexOf('/@') + 2);
-  if (newDepPath.includes('(') && index > dp.indexOfPeersSuffix(newDepPath)) return newDepPath;
+  if (newDepPath.includes('(') && index > dependencyPathLockfilePreV9.indexOfPeersSuffix(newDepPath)) return newDepPath;
   return `${newDepPath.substring(0, index)}/${newDepPath.substring(index + 1)}`;
 }
 
@@ -21,7 +21,7 @@ export function parseDependencyPath(shrinkwrapFileMajorVersion: number, newDepPa
   if (shrinkwrapFileMajorVersion === 6) {
     dependencyPath = convertLockfileV6DepPathToV5DepPath(newDepPath);
   }
-  const packageInfo = dp.parse(dependencyPath);
+  const packageInfo = dependencyPathLockfilePreV9.parse(dependencyPath);
   return {
     name: packageInfo.name as string,
     peersSuffix: packageInfo.peersSuffix,

common/changes/@microsoft/rush/feature-support_pnpmv9_2024-11-19-08-24.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@microsoft/rush",
+      "comment": "Support pnpm lockfile v9, which is used by default starting in pnpm v9.",
+      "type": "none"
+    }
+  ],
+  "packageName": "@microsoft/rush"
+}

common/changes/@rushstack/lockfile-explorer/feature-support_pnpmv9_2024-11-25-14-05.json

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

common/config/rush/nonbrowser-approved-packages.json

@@ -102,6 +102,10 @@
       "name": "@pnpm/logger",
       "allowedCategories": [ "libraries" ]
     },
+    {
+      "name": "@pnpm/lockfile.types",
+      "allowedCategories": [ "libraries" ]
+    },
     {
       "name": "@redis/client",
       "allowedCategories": [ "libraries" ]

common/config/subspaces/build-tests-subspace/repo-state.json

@@ -1,6 +1,6 @@
 // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush.
 {
-  "pnpmShrinkwrapHash": "a3198248beff4dfe8ef9d9c798b873ead75ef5cd",
+  "pnpmShrinkwrapHash": "bd75fc59a5df40deec1cf3db51e99ab1a7eb35f6",
   "preferredVersionsHash": "ce857ea0536b894ec8f346aaea08cfd85a5af648",
-  "packageJsonInjectedDependenciesHash": "35920c267d4a49b8de4b78d88cf91c7f46b83ebb"
+  "packageJsonInjectedDependenciesHash": "3f1f7f2e64fc15d64eef6c0311adc38dff344509"
 }

common/config/subspaces/default/repo-state.json

@@ -1,5 +1,5 @@
 // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush.
 {
-  "pnpmShrinkwrapHash": "387d2507a3b0dee1dd0ca694ced243f0edaa0dc1",
+  "pnpmShrinkwrapHash": "7b913e5ca364b30654436bba1a36ea570496f25c",
   "preferredVersionsHash": "ce857ea0536b894ec8f346aaea08cfd85a5af648"
 }

libraries/rush-lib/package.json

@@ -29,7 +29,8 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@pnpm/dependency-path": "~2.1.2",
+    "@pnpm/dependency-path-lockfile-pre-v9": "npm:@pnpm/dependency-path@~2.1.2",
+    "@pnpm/dependency-path": "~5.1.7",
     "@pnpm/link-bins": "~5.3.7",
     "@rushstack/heft-config-file": "workspace:*",
     "@rushstack/lookup-by-path": "workspace:*",
@@ -66,6 +67,7 @@
     "pnpm-sync-lib": "0.2.9"
   },
   "devDependencies": {
+    "@pnpm/lockfile.types": "~1.0.3",
     "@pnpm/logger": "4.0.0",
     "local-node-rig": "workspace:*",
     "@rushstack/heft-webpack5-plugin": "workspace:*",

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

@@ -229,7 +229,8 @@ export class PnpmLinkManager extends BaseLinkManager {
     const pathToLocalInstallation: string = await this._getPathToLocalInstallationAsync(
       tarballEntry,
       absolutePathToTgzFile,
-      folderNameSuffix
+      folderNameSuffix,
+      tempProjectDependencyKey
     );
 
     const parentShrinkwrapEntry: IPnpmShrinkwrapDependencyYaml | undefined =
@@ -289,7 +290,8 @@ export class PnpmLinkManager extends BaseLinkManager {
   private async _getPathToLocalInstallationAsync(
     tarballEntry: string,
     absolutePathToTgzFile: string,
-    folderSuffix: string
+    folderSuffix: string,
+    tempProjectDependencyKey: string
   ): Promise<string> {
     if (this._pnpmVersion.major === 6) {
       // PNPM 6 changed formatting to replace all ':' and '/' chars with '+'. Additionally, folder names > 120
@@ -319,8 +321,22 @@ export class PnpmLinkManager extends BaseLinkManager {
         folderName,
         RushConstants.nodeModulesFolderName
       );
-    } else if (this._pnpmVersion.major >= 8) {
+    } else if (this._pnpmVersion.major >= 9) {
       const { depPathToFilename } = await import('@pnpm/dependency-path');
+
+      // project@[email protected]
+      // The second parameter is max length of virtual store dir, default is 120 https://pnpm.io/next/npmrc#virtual-store-dir-max-length
+      // TODO Read virtual-store-dir-max-length from .npmrc
+      const folderName: string = depPathToFilename(tempProjectDependencyKey, 120);
+      return path.join(
+        this._rushConfiguration.commonTempFolder,
+        RushConstants.nodeModulesFolderName,
+        '.pnpm',
+        folderName,
+        RushConstants.nodeModulesFolderName
+      );
+    } else if (this._pnpmVersion.major >= 8) {
+      const { depPathToFilename } = await import('@pnpm/dependency-path-lockfile-pre-v9');
       // PNPM 8 changed the local path format again and the hashing algorithm, and
       // is now using the scoped '@pnpm/dependency-path' package
       // See https://github.com/pnpm/pnpm/releases/tag/v8.0.0