Support pnpm v9

Author: gavinxgu

package.json

@@ -0,0 +1,3 @@
+{
+  "packageManager": "pnpm@8.15.9+sha512.499434c9d8fdd1a2794ebf4552b3b25c0a633abcee5bb15e7b5de90f32f47b513aca98cd5cfd001c31f0db454bc3804edccd578501e4ca293a6816166bbd9f81"
+}

packages/pnpm-sync-lib/package.json

@@ -7,17 +7,18 @@
     "url": "https://github.com/tiktok/pnpm-sync.git",
     "directory": "packages/pnpm-sync-lib"
   },
+  "license": "MIT",
   "main": "lib/index.js",
   "types": "dist/pnpm-sync-lib.d.ts",
-  "license": "MIT",
   "scripts": {
     "build": "heft build --clean",
-    "test": "heft test --clean",
     "lint": "eslint src/**",
-    "prepublishOnly": "heft build --clean"
+    "prepublishOnly": "heft build --clean",
+    "test": "heft test --clean"
   },
   "dependencies": {
-    "@pnpm/dependency-path": "2.1.8",
+    "@pnpm/dependency-path-2": "npm:@pnpm/dependency-path@^2.1.8",
+    "@pnpm/dependency-path-5": "npm:@pnpm/dependency-path@^5.1.7",
     "yaml": "2.4.1"
   },
   "devDependencies": {
@@ -27,7 +28,7 @@
     "@rushstack/heft-node-rig": "^2.4.5",
     "@types/heft-jest": "1.0.6",
     "@types/node": "18.17.15",
-    "typescript": "~5.3.3",
-    "eslint": "~8.7.0"
+    "eslint": "~8.7.0",
+    "typescript": "~5.3.3"
   }
 }

packages/pnpm-sync-lib/src/pnpmSyncPrepare.ts

@@ -2,7 +2,8 @@ import path from 'path';
 import fs from 'fs';
 import YAML from 'yaml';
 import process from 'node:process';
-import { depPathToFilename } from '@pnpm/dependency-path';
+import { depPathToFilename as depPathToFilename2 } from '@pnpm/dependency-path-2';
+import { depPathToFilename as depPathToFilename5 } from '@pnpm/dependency-path-5';
 
 import {
   ILockfile,
@@ -11,7 +12,6 @@ import {
   LogMessageIdentifier,
   IPnpmSyncJson,
   IVersionSpecifier,
-  ILockfilePackage,
   ITargetFolder
 } from './interfaces';
 import { pnpmSyncGetJsonVersion } from './utilities';
@@ -220,9 +220,9 @@ export async function pnpmSyncPrepareAsync(options: IPnpmSyncPrepareOptions): Pr
   const pnpmVersion: string | undefined = pnpmModulesYaml?.packageManager?.split('@')[1];
 
   // currently, only support pnpm v8
-  if (!pnpmVersion || !pnpmVersion.startsWith('8')) {
+  if (!pnpmVersion || !pnpmVersion.startsWith('8') || !pnpmVersion.startsWith('9')) {
     logMessageCallback({
-      message: `The pnpm version is not supported; pnpm-sync requires pnpm version 8.x`,
+      message: `The pnpm version is not supported; pnpm-sync requires pnpm version 8.x, 9.x`,
       messageKind: LogMessageKind.ERROR,
       details: {
         messageIdentifier: LogMessageIdentifier.PREPARE_ERROR_UNSUPPORTED_PNPM_VERSION,
@@ -240,9 +240,9 @@ export async function pnpmSyncPrepareAsync(options: IPnpmSyncPrepareOptions): Pr
 
   // currently, only support lockfileVersion 6.x, which is pnpm v8
   const lockfileVersion: string | undefined = pnpmLockfile?.lockfileVersion.toString();
-  if (!lockfileVersion || !lockfileVersion.startsWith('6')) {
+  if (!lockfileVersion || !lockfileVersion.startsWith('6') || !lockfileVersion.startsWith('9')) {
     logMessageCallback({
-      message: `The pnpm-lock.yaml format is not supported; pnpm-sync requires lockfile version 6`,
+      message: `The pnpm-lock.yaml format is not supported; pnpm-sync requires lockfile version 6, 9`,
       messageKind: LogMessageKind.ERROR,
       details: {
         messageIdentifier: LogMessageIdentifier.PREPARE_ERROR_UNSUPPORTED_FORMAT,
@@ -282,12 +282,17 @@ export async function pnpmSyncPrepareAsync(options: IPnpmSyncPrepareOptions): Pr
         injectedDependencyToFilePathSet.set(injectedDependencyPath, []);
       }
 
-      const fullPackagePath = path.join(
-        dotPnpmFolder,
-        depPathToFilename(injectedDependencyVersion),
-        'node_modules',
-        injectedDependency
-      );
+      const packageDirname = (() => {
+        if (pnpmVersion.startsWith('8')) {
+          return depPathToFilename2(injectedDependencyVersion);
+        }
+        if (pnpmVersion.startsWith('9')) {
+          return depPathToFilename5(injectedDependency + '@' + injectedDependencyVersion, 120);
+        }
+        return '';
+      })();
+
+      const fullPackagePath = path.join(dotPnpmFolder, packageDirname, 'node_modules', injectedDependency);
 
       injectedDependencyToFilePathSet.get(injectedDependencyPath)?.push(fullPackagePath);
     }
@@ -376,47 +381,65 @@ function processTransitiveInjectedDependency(
   pnpmLockfile: ILockfile | undefined,
   injectedDependencyToVersion: Map<string, Set<string>>
 ): void {
+  if (!pnpmLockfile) {
+    return;
+  }
+
+  const { lockfileVersion } = pnpmLockfile;
+
   const potentialTransitiveInjectedDependencyVersionQueue: Array<string> = [];
-  for (const injectedDependencyVersion of [...injectedDependencyToVersion.values()]) {
-    potentialTransitiveInjectedDependencyVersionQueue.push(...injectedDependencyVersion);
+  for (const [packageName, injectedDependencyVersion] of [...injectedDependencyToVersion.entries()]) {
+    if (lockfileVersion.toString().startsWith('6')) {
+      potentialTransitiveInjectedDependencyVersionQueue.push(...injectedDependencyVersion);
+    } else if (lockfileVersion.toString().startsWith('9')) {
+      potentialTransitiveInjectedDependencyVersionQueue.push(
+        ...[...injectedDependencyVersion].map((version) => packageName + '@' + version)
+      );
+    }
   }
 
-  const lockfilePackages: Record<string, ILockfilePackage> | undefined = pnpmLockfile?.packages;
-
-  if (lockfilePackages) {
-    while (potentialTransitiveInjectedDependencyVersionQueue.length > 0) {
-      const transitiveInjectedDependencyVersion: string | undefined =
-        potentialTransitiveInjectedDependencyVersionQueue.shift();
-      if (transitiveInjectedDependencyVersion) {
-        const { dependencies, optionalDependencies } = lockfilePackages[transitiveInjectedDependencyVersion];
-        processInjectedDependencies(
-          dependencies,
-          injectedDependencyToVersion,
-          potentialTransitiveInjectedDependencyVersionQueue
-        );
-        processInjectedDependencies(
-          optionalDependencies,
-          injectedDependencyToVersion,
-          potentialTransitiveInjectedDependencyVersionQueue
-        );
-      }
+  const { packages: lockfilePackages } = pnpmLockfile;
+
+  while (potentialTransitiveInjectedDependencyVersionQueue.length > 0) {
+    const transitiveInjectedDependencyVersion: string | undefined =
+      potentialTransitiveInjectedDependencyVersionQueue.shift();
+    if (transitiveInjectedDependencyVersion) {
+      const { dependencies, optionalDependencies } = lockfilePackages[transitiveInjectedDependencyVersion];
+      processInjectedDependencies(
+        dependencies,
+        injectedDependencyToVersion,
+        potentialTransitiveInjectedDependencyVersionQueue,
+        pnpmLockfile
+      );
+      processInjectedDependencies(
+        optionalDependencies,
+        injectedDependencyToVersion,
+        potentialTransitiveInjectedDependencyVersionQueue,
+        pnpmLockfile
+      );
     }
   }
 }
 function processInjectedDependencies(
   dependencies: Record<string, string> | undefined,
   injectedDependencyToVersion: Map<string, Set<string>>,
-  potentialTransitiveInjectedDependencyVersionQueue: Array<string>
+  potentialTransitiveInjectedDependencyVersionQueue: Array<string>,
+  pnpmLockfile: ILockfile
 ): void {
   if (dependencies) {
+    const { lockfileVersion } = pnpmLockfile;
     for (const [dependency, version] of Object.entries(dependencies)) {
       // if the version is set with file: protocol, then it is a transitive injected dependency
       if (version.startsWith('file:')) {
         if (!injectedDependencyToVersion.has(dependency)) {
           injectedDependencyToVersion.set(dependency, new Set());
         }
         injectedDependencyToVersion.get(dependency)?.add(version);
-        potentialTransitiveInjectedDependencyVersionQueue.push(version);
+        if (lockfileVersion.toString().startsWith('6')) {
+          potentialTransitiveInjectedDependencyVersionQueue.push(version);
+        } else if (lockfileVersion.toString().startsWith('9')) {
+          potentialTransitiveInjectedDependencyVersionQueue.push(dependency + '@' + version);
+        }
       }
     }
   }