fix: throw a meaningful error message on broken lockfile (#4387)

When `node-linker` is set to `hoisted`, a meaningful error message
should be thrown if the lockfile is broken and `pnpm install` is
executed.

.changeset/rich-books-build.md

@@ -0,0 +1,5 @@
+---
+"@pnpm/filter-lockfile": patch
+---
+
+Update `@pnpm/error`.

.changeset/serious-jars-provide.md

@@ -0,0 +1,6 @@
+---
+"@pnpm/real-hoist": patch
+"pnpm": patch
+---
+
+Throw a meaningful error message on `pnpm install` when the lockfile is broken and `node-linker` is set to `hoisted`.

.changeset/stupid-dryers-wave.md

@@ -0,0 +1,5 @@
+---
+"@pnpm/error": minor
+---
+
+Add new error object: LockfileMissingDependencyError.

packages/error/package.json

@@ -31,5 +31,8 @@
   "funding": "https://opencollective.com/pnpm",
   "devDependencies": {
     "@pnpm/error": "workspace:2.0.0"
+  },
+  "dependencies": {
+    "@pnpm/constants": "workspace:5.0.0"
   }
 }

packages/error/src/index.ts

@@ -1,3 +1,5 @@
+import { WANTED_LOCKFILE } from '@pnpm/constants'
+
 export default class PnpmError extends Error {
   public readonly code: string
   public readonly hint?: string
@@ -55,3 +57,13 @@ function hideAuthInformation (authHeaderValue: string) {
   const [authType, token] = authHeaderValue.split(' ')
   return `${authType} ${token.substring(0, 4)}[hidden]`
 }
+
+export class LockfileMissingDependencyError extends PnpmError {
+  constructor (depPath: string) {
+    const message = `Broken lockfile: no entry for '${depPath}' in ${WANTED_LOCKFILE}`
+    super('LOCKFILE_MISSING_DEPENDENCY', message, {
+      hint: 'This issue is probably caused by a badly resolved merge conflict.\n' +
+        'To fix the lockfile, run \'pnpm install --no-frozen-lockfile\'.',
+    })
+  }
+}

packages/error/tsconfig.json

@@ -8,5 +8,9 @@
     "src/**/*.ts",
     "../../typings/**/*.d.ts"
   ],
-  "references": []
+  "references": [
+    {
+      "path": "../constants"
+    }
+  ]
 }

packages/filter-lockfile/src/filterLockfileByImporters.ts

@@ -1,4 +1,5 @@
 import { WANTED_LOCKFILE } from '@pnpm/constants'
+import { LockfileMissingDependencyError } from '@pnpm/error'
 import {
   Lockfile,
   PackageSnapshots,
@@ -7,7 +8,6 @@ import lockfileWalker, { LockfileWalkerStep } from '@pnpm/lockfile-walker'
 import pnpmLogger from '@pnpm/logger'
 import { DependenciesField } from '@pnpm/types'
 import filterImporter from './filterImporter'
-import LockfileMissingDependencyError from './LockfileMissingDependencyError'
 
 const logger = pnpmLogger('lockfile')
 

packages/filter-lockfile/src/filterLockfileByImportersAndEngine.ts

@@ -1,4 +1,5 @@
 import { WANTED_LOCKFILE } from '@pnpm/constants'
+import { LockfileMissingDependencyError } from '@pnpm/error'
 import {
   Lockfile,
   PackageSnapshots,
@@ -10,7 +11,6 @@ import { DependenciesField } from '@pnpm/types'
 import * as dp from 'dependency-path'
 import unnest from 'ramda/src/unnest'
 import filterImporter from './filterImporter'
-import LockfileMissingDependencyError from './LockfileMissingDependencyError'
 
 const logger = pnpmLogger('lockfile')
 

packages/real-hoist/package.json

@@ -30,6 +30,7 @@
     "compile": "tsc --build && pnpm run lint --fix"
   },
   "dependencies": {
+    "@pnpm/error": "workspace:2.0.0",
     "@pnpm/lockfile-utils": "workspace:3.2.1",
     "@yarnpkg/nm": "3.0.1",
     "dependency-path": "workspace:8.0.11"

packages/real-hoist/src/index.ts

@@ -1,3 +1,4 @@
+import { LockfileMissingDependencyError } from '@pnpm/error'
 import {
   Lockfile,
   nameVerFromPkgSnapshot,
@@ -70,8 +71,10 @@ function toTree (nodes: Map<string, HoisterTree>, lockfile: Lockfile, deps: Reco
     const key = `${alias}:${depPath}`
     let node = nodes.get(key)
     if (!node) {
-      // const { name, version, peersSuffix } = nameVerFromPkgSnapshot(depPath, lockfile.packages![depPath])
       const pkgSnapshot = lockfile.packages![depPath]
+      if (!pkgSnapshot) {
+        throw new LockfileMissingDependencyError(depPath)
+      }
       const pkgName = nameVerFromPkgSnapshot(depPath, pkgSnapshot).name
       node = {
         name: alias,

packages/real-hoist/test/index.ts

@@ -6,3 +6,20 @@ test('hoist', async () => {
   const lockfile = await readWantedLockfile(path.join(__dirname, '../../..'), { ignoreIncompatible: true })
   expect(hoist(lockfile!)).toBeTruthy()
 })
+
+test('hoist throws an error if the lockfile is broken', () => {
+  expect(() => hoist({
+    lockfileVersion: 5,
+    importers: {
+      '.': {
+        dependencies: {
+          foo: '1.0.0',
+        },
+        specifiers: {
+          foo: '1.0.0',
+        },
+      },
+    },
+    packages: {},
+  })).toThrow(/Broken lockfile/)
+})

packages/real-hoist/tsconfig.json

@@ -12,6 +12,9 @@
     {
       "path": "../dependency-path"
     },
+    {
+      "path": "../error"
+    },
     {
       "path": "../lockfile-file"
     },