Will/lockfile pnpm8 support

apps/lockfile-explorer-web/package.json

@@ -6,7 +6,7 @@
   "license": "MIT",
   "scripts": {
     "build": "heft test --clean",
-    "start": "heft build-watch",
+    "start": "heft start",
     "test": "heft test",
     "_phase:build": "heft run --only build -- --clean",
     "_phase:test": "heft run --only test -- --clean"

apps/lockfile-explorer-web/src/parsing/readLockfile.ts

@@ -7,6 +7,11 @@ import { Path } from '@lifaon/path';
 
 const serviceUrl: string = window.appContext.serviceUrl;
 
+export enum PnpmLockfileVersion {
+  V6,
+  V5
+}
+
 export interface IPackageJsonType {
   name: string;
   dependencies: {
@@ -16,22 +21,36 @@ export interface IPackageJsonType {
     [key in string]: string;
   };
 }
-
-export interface ILockfilePackageType {
-  lockfileVersion: number;
-  importers?: {
+export interface ILockfileImporterV6 {
+  dependencies?: {
     [key in string]: {
-      specifiers?: {
-        [key in string]: string;
-      };
-      dependencies?: {
-        [key in string]: string;
-      };
-      devDependencies?: {
-        [key in string]: string;
-      };
+      specifier: string;
+      version: string;
+    };
+  };
+  devDependencies?: {
+    [key in string]: {
+      specifier: string;
+      version: string;
     };
   };
+}
+export interface ILockfileImporterV5 {
+  specifiers?: {
+    [key in string]: string;
+  };
+  dependencies?: {
+    [key in string]: string;
+  };
+  devDependencies?: {
+    [key in string]: string;
+  };
+}
+export interface ILockfilePackageType {
+  lockfileVersion: number | string;
+  importers?: {
+    [key in string]: ILockfileImporterV5 | ILockfileImporterV6;
+  };
   packages?: {
     [key in string]: {
       resolution: {
@@ -48,13 +67,48 @@ export interface ILockfilePackageType {
   };
 }
 
+/**
+ * Transform any newer lockfile formats to the following format:
+ * [packageName]:
+ *     specifier: ...
+ *     version: ...
+ */
+function getImporterValue(
+  importerValue: ILockfileImporterV5 | ILockfileImporterV6,
+  pnpmLockfileVersion: PnpmLockfileVersion
+): ILockfileImporterV5 {
+  if (pnpmLockfileVersion === PnpmLockfileVersion.V6) {
+    const v6ImporterValue = importerValue as ILockfileImporterV6;
+    const v5ImporterValue: ILockfileImporterV5 = {
+      specifiers: {},
+      dependencies: {},
+      devDependencies: {}
+    };
+    for (const [depName, depDetails] of Object.entries(v6ImporterValue.dependencies || {})) {
+      v5ImporterValue.specifiers![depName] = depDetails.specifier;
+      v5ImporterValue.dependencies![depName] = depDetails.version;
+    }
+    for (const [depName, depDetails] of Object.entries(v6ImporterValue.devDependencies || {})) {
+      v5ImporterValue.specifiers![depName] = depDetails.specifier;
+      v5ImporterValue.devDependencies![depName] = depDetails.version;
+    }
+    return v5ImporterValue;
+  } else {
+    return importerValue as ILockfileImporterV5;
+  }
+}
+
 /**
  * Parse through the lockfile and create all the corresponding LockfileEntries and LockfileDependencies
  * to construct the lockfile graph.
  *
  * @returns A list of all the LockfileEntries in the lockfile.
  */
 export function generateLockfileGraph(lockfile: ILockfilePackageType): LockfileEntry[] {
+  let pnpmLockfileVersion: PnpmLockfileVersion = PnpmLockfileVersion.V5;
+  if (`${lockfile.lockfileVersion}`.startsWith('6')) {
+    pnpmLockfileVersion = PnpmLockfileVersion.V6;
+  }
   const allEntries: LockfileEntry[] = [];
   const allEntriesById: { [key in string]: LockfileEntry } = {};
 
@@ -81,7 +135,7 @@ export function generateLockfileGraph(lockfile: ILockfilePackageType): LockfileE
         // entryId: normalizedPath,
         rawEntryId: importerKey,
         kind: LockfileEntryFilter.Project,
-        rawYamlData: importerValue,
+        rawYamlData: getImporterValue(importerValue, pnpmLockfileVersion),
         duplicates
       });
       allImporters.push(importer);
@@ -95,16 +149,21 @@ export function generateLockfileGraph(lockfile: ILockfilePackageType): LockfileE
     for (const [dependencyKey, dependencyValue] of Object.entries(lockfile.packages)) {
       // const normalizedPath = new Path(dependencyKey).makeAbsolute('/').toString();
 
+      let packageDepKey = dependencyKey;
+      if (pnpmLockfileVersion === PnpmLockfileVersion.V6) {
+        packageDepKey = dependencyKey.replace('@', '/');
+      }
+
       const currEntry = new LockfileEntry({
         // entryId: normalizedPath,
-        rawEntryId: dependencyKey,
+        rawEntryId: packageDepKey,
         kind: LockfileEntryFilter.Package,
         rawYamlData: dependencyValue
       });
 
       allPackages.push(currEntry);
       allEntries.push(currEntry);
-      allEntriesById[dependencyKey] = currEntry;
+      allEntriesById[packageDepKey] = currEntry;
     }
   }
 
@@ -123,7 +182,7 @@ export function generateLockfileGraph(lockfile: ILockfilePackageType): LockfileE
         matchedEntry.referrers.push(entry);
       } else {
         // Local package
-        console.error('Could not resolve dependency entryId: ', dependency.entryId);
+        console.error('Could not resolve dependency entryId: ', dependency.entryId, dependency);
       }
     }
   }

common/changes/@rushstack/lockfile-explorer/will-lockfile-pnpm8-support_2023-08-31-23-03.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/lockfile-explorer",
+      "comment": "Add support for the V6 lockfile used by PNPM 8.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/lockfile-explorer"
+}