mirror of
https://github.com/pnpm/pnpm.git
synced 2026-05-13 11:05:52 -04:00
832d898683
Closes #11488. `pnpm fetch` writes forced-empty `hoistPattern: []` and `publicHoistPattern: []` into `.modules.yaml` (because its `virtualStoreOnly` install path skips hoisting). In v10 the follow-up `pnpm install` ignored these unless the user had explicitly set a hoist-pattern in their config. v11's [#11199](https://github.com/pnpm/pnpm/pull/11199) removed that explicit-config gate, so `validateModules` now always sees the empty patterns as a hoist-pattern change and purges `node_modules` — slow on every CI run, and per the bug report sometimes leaves the modules dir in an `ERR_MODULE_NOT_FOUND` state on subsequent runs. The fix marks `.modules.yaml` with a new `virtualStoreOnly: true` field after a fetch. `validateModules` recognizes this flag as "incomplete install state" and skips the `PUBLIC_HOIST_PATTERN_DIFF` / `HOIST_PATTERN_DIFF` comparisons. The next install then completes the missing post-import linking in place rather than purging. The flag is dropped from `.modules.yaml` once a normal install runs. A genuine hoist-pattern change (without a fetch in between) still triggers the purge as before — verified manually with `publicHoistPattern` in `pnpm-workspace.yaml`.
332 lines
10 KiB
TypeScript
332 lines
10 KiB
TypeScript
import fs from 'node:fs'
|
|
import path from 'node:path'
|
|
|
|
import { expect, test } from '@jest/globals'
|
|
import { STORE_VERSION } from '@pnpm/constants'
|
|
import { fetch, install } from '@pnpm/installing.commands'
|
|
import { prepare } from '@pnpm/prepare'
|
|
import { REGISTRY_MOCK_PORT } from '@pnpm/registry-mock'
|
|
import { closeAllStoreIndexes } from '@pnpm/store.index'
|
|
import { fixtures } from '@pnpm/test-fixtures'
|
|
import { finishWorkers } from '@pnpm/worker'
|
|
import { rimrafSync } from '@zkochan/rimraf'
|
|
|
|
const REGISTRY_URL = `http://localhost:${REGISTRY_MOCK_PORT}`
|
|
|
|
const DEFAULT_OPTIONS = {
|
|
argv: {
|
|
original: [],
|
|
},
|
|
bail: false,
|
|
bin: 'node_modules/.bin',
|
|
cliOptions: {},
|
|
deployAllFiles: false,
|
|
excludeLinksFromLockfile: false,
|
|
extraEnv: {},
|
|
include: {
|
|
dependencies: true,
|
|
devDependencies: true,
|
|
optionalDependencies: true,
|
|
},
|
|
lock: true,
|
|
preferWorkspacePackages: true,
|
|
pnpmfile: ['.pnpmfile.cjs'],
|
|
pnpmHomeDir: '',
|
|
configByUri: {},
|
|
registries: {
|
|
default: REGISTRY_URL,
|
|
},
|
|
rootProjectManifestDir: '',
|
|
sort: true,
|
|
userConfig: {},
|
|
workspaceConcurrency: 1,
|
|
virtualStoreDirMaxLength: process.platform === 'win32' ? 60 : 120,
|
|
}
|
|
|
|
test('fetch dependencies', async () => {
|
|
const project = prepare({
|
|
dependencies: { 'is-positive': '1.0.0' },
|
|
devDependencies: { 'is-negative': '1.0.0' },
|
|
})
|
|
const storeDir = path.resolve('store')
|
|
|
|
await install.handler({
|
|
...DEFAULT_OPTIONS,
|
|
cacheDir: path.resolve('cache'),
|
|
dir: process.cwd(),
|
|
linkWorkspacePackages: true,
|
|
storeDir,
|
|
})
|
|
|
|
rimrafSync(path.resolve(project.dir(), 'node_modules'))
|
|
rimrafSync(path.resolve(project.dir(), './package.json'))
|
|
|
|
project.storeHasNot('is-negative')
|
|
project.storeHasNot('is-positive')
|
|
|
|
await fetch.handler({
|
|
...DEFAULT_OPTIONS,
|
|
cacheDir: path.resolve('cache'),
|
|
dir: process.cwd(),
|
|
storeDir,
|
|
})
|
|
|
|
project.storeHas('is-positive')
|
|
project.storeHas('is-negative')
|
|
})
|
|
|
|
test('fetch production dependencies', async () => {
|
|
const project = prepare({
|
|
dependencies: { 'is-positive': '1.0.0' },
|
|
devDependencies: { 'is-negative': '1.0.0' },
|
|
})
|
|
const storeDir = path.resolve('store')
|
|
await install.handler({
|
|
...DEFAULT_OPTIONS,
|
|
cacheDir: path.resolve('cache'),
|
|
dir: process.cwd(),
|
|
linkWorkspacePackages: true,
|
|
storeDir,
|
|
})
|
|
|
|
rimrafSync(path.resolve(project.dir(), 'node_modules'))
|
|
rimrafSync(path.resolve(project.dir(), './package.json'))
|
|
|
|
project.storeHasNot('is-negative')
|
|
project.storeHasNot('is-positive')
|
|
|
|
await fetch.handler({
|
|
...DEFAULT_OPTIONS,
|
|
cacheDir: path.resolve('cache'),
|
|
dev: true,
|
|
dir: process.cwd(),
|
|
storeDir,
|
|
})
|
|
|
|
project.storeHasNot('is-negative')
|
|
project.storeHas('is-positive')
|
|
})
|
|
|
|
test('fetch only dev dependencies', async () => {
|
|
const project = prepare({
|
|
dependencies: { 'is-positive': '1.0.0' },
|
|
devDependencies: { 'is-negative': '1.0.0' },
|
|
})
|
|
const storeDir = path.resolve('store')
|
|
await install.handler({
|
|
...DEFAULT_OPTIONS,
|
|
cacheDir: path.resolve('cache'),
|
|
dir: process.cwd(),
|
|
linkWorkspacePackages: true,
|
|
storeDir,
|
|
})
|
|
|
|
rimrafSync(path.resolve(project.dir(), 'node_modules'))
|
|
rimrafSync(path.resolve(project.dir(), './package.json'))
|
|
|
|
project.storeHasNot('is-negative')
|
|
project.storeHasNot('is-positive')
|
|
|
|
await fetch.handler({
|
|
...DEFAULT_OPTIONS,
|
|
cacheDir: path.resolve('cache'),
|
|
dev: true,
|
|
dir: process.cwd(),
|
|
storeDir,
|
|
})
|
|
|
|
project.storeHas('is-negative')
|
|
project.storeHasNot('is-positive')
|
|
})
|
|
|
|
// Regression test for https://github.com/pnpm/pnpm/issues/10460
|
|
// pnpm fetch should skip local file: protocol dependencies
|
|
// because they won't be available in Docker builds
|
|
test('fetch skips file: protocol dependencies that do not exist', async () => {
|
|
const project = prepare({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
'@local/pkg': 'file:./local-pkg',
|
|
},
|
|
})
|
|
const storeDir = path.resolve('store')
|
|
const localPkgDir = path.resolve(project.dir(), 'local-pkg')
|
|
|
|
// Create the local package for initial install to generate lockfile
|
|
fs.mkdirSync(localPkgDir, { recursive: true })
|
|
fs.writeFileSync(
|
|
path.join(localPkgDir, 'package.json'),
|
|
JSON.stringify({ name: '@local/pkg', version: '1.0.0' })
|
|
)
|
|
|
|
// Create a lockfile with the file: dependency
|
|
await install.handler({
|
|
...DEFAULT_OPTIONS,
|
|
cacheDir: path.resolve('cache'),
|
|
dir: process.cwd(),
|
|
linkWorkspacePackages: true,
|
|
storeDir,
|
|
})
|
|
|
|
rimrafSync(path.resolve(project.dir(), 'node_modules'))
|
|
rimrafSync(path.resolve(project.dir(), './package.json'))
|
|
// Remove the local package directory to simulate Docker build scenario
|
|
rimrafSync(localPkgDir)
|
|
|
|
project.storeHasNot('is-positive')
|
|
|
|
// This should not throw an error even though the file: dependency doesn't exist
|
|
await fetch.handler({
|
|
...DEFAULT_OPTIONS,
|
|
cacheDir: path.resolve('cache'),
|
|
dir: process.cwd(),
|
|
storeDir,
|
|
})
|
|
|
|
project.storeHas('is-positive')
|
|
})
|
|
|
|
test('fetch populates global virtual store links/', async () => {
|
|
prepare({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
devDependencies: {
|
|
'is-negative': '1.0.0',
|
|
},
|
|
})
|
|
const storeDir = path.resolve('store')
|
|
const globalVirtualStoreDir = path.join(storeDir, STORE_VERSION, 'links')
|
|
|
|
// Generate the lockfile only — no need for a full install
|
|
await install.handler({
|
|
...DEFAULT_OPTIONS,
|
|
cacheDir: path.resolve('cache'),
|
|
dir: process.cwd(),
|
|
linkWorkspacePackages: true,
|
|
lockfileOnly: true,
|
|
storeDir,
|
|
})
|
|
|
|
// Drain workers and close SQLite connections before removing the store (required on Windows)
|
|
await finishWorkers()
|
|
closeAllStoreIndexes()
|
|
|
|
// Remove the store — simulate a cold start with only the lockfile
|
|
rimrafSync(storeDir)
|
|
|
|
// Fetch with enableGlobalVirtualStore — should populate links/
|
|
await fetch.handler({
|
|
...DEFAULT_OPTIONS,
|
|
cacheDir: path.resolve('cache'),
|
|
dir: process.cwd(),
|
|
storeDir,
|
|
enableGlobalVirtualStore: true,
|
|
})
|
|
|
|
// The global virtual store links/ directory should exist and contain packages
|
|
expect(fs.existsSync(globalVirtualStoreDir)).toBeTruthy()
|
|
const entries = fs.readdirSync(globalVirtualStoreDir)
|
|
expect(entries.length).toBeGreaterThan(0)
|
|
})
|
|
|
|
// Regression test for https://github.com/pnpm/pnpm/issues/11488
|
|
// A subsequent install must not purge node_modules just because fetch
|
|
// recorded forced-empty hoist patterns in .modules.yaml. The follow-up
|
|
// install must also complete the post-import linking that fetch skipped:
|
|
// importer symlinks at the project root and hoisting under .pnpm/node_modules.
|
|
test('install after fetch completes linking without recreating node_modules', async () => {
|
|
const project = prepare({
|
|
dependencies: { '@pnpm.e2e/pkg-with-1-dep': '100.0.0' },
|
|
})
|
|
const storeDir = path.resolve('store')
|
|
|
|
// Generate the lockfile only — no need for a full install
|
|
await install.handler({
|
|
...DEFAULT_OPTIONS,
|
|
cacheDir: path.resolve('cache'),
|
|
dir: process.cwd(),
|
|
linkWorkspacePackages: true,
|
|
lockfileOnly: true,
|
|
storeDir,
|
|
})
|
|
|
|
await fetch.handler({
|
|
...DEFAULT_OPTIONS,
|
|
cacheDir: path.resolve('cache'),
|
|
dir: process.cwd(),
|
|
storeDir,
|
|
})
|
|
|
|
const modulesYamlPath = path.resolve(project.dir(), 'node_modules/.modules.yaml')
|
|
const virtualStoreDir = path.resolve(project.dir(), 'node_modules/.pnpm')
|
|
const virtualStoreInodeBefore = fs.statSync(virtualStoreDir).ino
|
|
// fetch only populates the virtual store — no importer symlink and no
|
|
// hoisting yet.
|
|
expect(fs.existsSync(path.resolve(project.dir(), 'node_modules/@pnpm.e2e/pkg-with-1-dep'))).toBeFalsy()
|
|
expect(fs.existsSync(path.resolve(virtualStoreDir, 'node_modules/@pnpm.e2e/dep-of-pkg-with-1-dep'))).toBeFalsy()
|
|
// fetch records the marker that opts the next install out of hoist-pattern checks.
|
|
expect(JSON.parse(fs.readFileSync(modulesYamlPath, 'utf8')).virtualStoreOnly).toBe(true)
|
|
|
|
await install.handler({
|
|
...DEFAULT_OPTIONS,
|
|
cacheDir: path.resolve('cache'),
|
|
dir: process.cwd(),
|
|
frozenLockfile: true,
|
|
hoistPattern: ['*'],
|
|
linkWorkspacePackages: true,
|
|
storeDir,
|
|
preferOffline: true,
|
|
})
|
|
|
|
// If the modules dir had been purged, the directory's inode would change
|
|
// (rimraf + remake creates a new directory).
|
|
expect(fs.statSync(virtualStoreDir).ino).toBe(virtualStoreInodeBefore)
|
|
// The direct dep must be symlinked at the project root.
|
|
expect(fs.existsSync(path.resolve(project.dir(), 'node_modules/@pnpm.e2e/pkg-with-1-dep'))).toBeTruthy()
|
|
// The transitive dep must be hoisted under the virtual store
|
|
// (default hoistPattern is ['*']).
|
|
expect(fs.existsSync(path.resolve(virtualStoreDir, 'node_modules/@pnpm.e2e/dep-of-pkg-with-1-dep'))).toBeTruthy()
|
|
// The marker must be cleared once the install completes the linking,
|
|
// otherwise a later install would keep skipping hoist-pattern checks.
|
|
expect(JSON.parse(fs.readFileSync(modulesYamlPath, 'utf8')).virtualStoreOnly).toBeUndefined()
|
|
})
|
|
|
|
test('fetch applies patches to dependencies when patchedDependencies key is bare package name', async () => {
|
|
const f = fixtures(import.meta.dirname)
|
|
const project = prepare({
|
|
dependencies: { '@pnpm.e2e/console-log': '1.0.0' },
|
|
})
|
|
fs.mkdirSync('patches', { recursive: true })
|
|
fs.copyFileSync(f.find('patchedDependencies/console-log-replace-1st-line.patch'), 'patches/console-log.patch')
|
|
|
|
const patchedDependencies = { '@pnpm.e2e/console-log': 'patches/console-log.patch' }
|
|
const cacheDir = path.resolve(project.dir(), 'cache')
|
|
const storeDir = path.resolve(project.dir(), 'store')
|
|
|
|
await install.handler({
|
|
...DEFAULT_OPTIONS,
|
|
cacheDir,
|
|
dir: project.dir(),
|
|
linkWorkspacePackages: false,
|
|
lockfileOnly: true,
|
|
storeDir,
|
|
patchedDependencies,
|
|
})
|
|
|
|
await fetch.handler({
|
|
...DEFAULT_OPTIONS,
|
|
cacheDir,
|
|
dir: project.dir(),
|
|
storeDir,
|
|
patchedDependencies,
|
|
})
|
|
|
|
const virtualStoreDir = path.resolve(project.dir(), 'node_modules', '.pnpm')
|
|
const consoleLogDirs = fs.readdirSync(virtualStoreDir).filter(d => d.startsWith('@pnpm.e2e+console-log@'))
|
|
expect(consoleLogDirs.length).toBeGreaterThan(0)
|
|
|
|
const patchedIndexJsAfterFetch = fs.readFileSync(path.join(virtualStoreDir, consoleLogDirs[0], 'node_modules/@pnpm.e2e/console-log/index.js'), 'utf8')
|
|
expect(patchedIndexJsAfterFetch).toContain('FIRST LINE')
|
|
})
|