mirror of
https://github.com/pnpm/pnpm.git
synced 2026-07-28 16:37:47 -04:00
b7f0f21582
## Summary Replace individual `.mpk` (MessagePack) files under `$STORE/index/` with a single SQLite database at `$STORE/index.db` using Node.js 22's built-in `node:sqlite` module. This reduces filesystem syscall overhead and improves space efficiency for small metadata entries. Closes #10826 ## Design ### New package: `@pnpm/store.index` A new `StoreIndex` class wraps a SQLite database with a simple key-value API (`get`, `set`, `delete`, `has`, `entries`). Data is serialized with msgpackr and stored as BLOBs. The table uses `WITHOUT ROWID` for compact storage. Key design decisions: - **WAL mode** enables concurrent reads from workers while the main process writes. - **`busy_timeout=5000`** plus a retry loop with `Atomics.wait`-based `sleepSync` handles `SQLITE_BUSY` errors from concurrent access. - **Performance PRAGMAs**: `synchronous=NORMAL`, `mmap_size=512MB`, `cache_size=32MB`, `temp_store=MEMORY`, `wal_autocheckpoint=10000`. - **Write batching**: `queueWrites()` batches pre-packed entries from tarball extraction and flushes them in a single transaction on `process.nextTick`. `setRawMany()` writes immediate batches (e.g. from `addFilesFromDir`). - **Lifecycle**: `close()` auto-flushes pending writes, runs `PRAGMA optimize`, and closes the DB. A `process.on('exit')` handler ensures cleanup even on unexpected exits. - **`VACUUM` after `deleteMany`** (used by `pnpm store prune`) to reclaim disk space. ### Key format Keys are `integrity\tpkgId` (tab-separated). Git-hosted packages use `pkgId\tbuilt` or `pkgId\tnot-built`. ### Shared StoreIndex instance A single `StoreIndex` instance is threaded through the entire install lifecycle — from `createNewStoreController` through the fetcher chain, package requester, license scanner, SBOM collector, and dependencies hierarchy. This replaces the previous pattern of each component creating its own file-based index access. ### Worker architecture Index writes are performed in the main process, not in worker threads. Workers send pre-packed `{ key, buffer }` pairs back to the main process via `postMessage`, where they are batched and flushed to SQLite. This avoids SQLite write contention between threads. ### SQLite ExperimentalWarning suppression `node:sqlite` emits an `ExperimentalWarning` on first load. This is suppressed via a `process.emitWarning` override injected through esbuild's `banner` option, which runs on line 1 of both `dist/pnpm.mjs` and `dist/worker.js` — before any module that loads `node:sqlite`. ### No migration from `.mpk` files Old `.mpk` index files are not migrated. Packages missing from the new SQLite index are re-fetched on demand (the same behavior as a fresh store). ## Changed packages 121 files changed across these areas: - **`store/index/`** — New `@pnpm/store.index` package - **`worker/`** — Write batching moved from worker module into `StoreIndex` class; workers send pre-packed buffers to main process - **`store/package-store/`** — StoreIndex creation and lifecycle management - **`store/cafs/`** — Removed `getFilePathInCafs` index-file utilities (no longer needed) - **`store/pkg-finder/`** — Reads from StoreIndex instead of `.mpk` files - **`store/plugin-commands-store/`** — `store status` uses StoreIndex - **`store/plugin-commands-store-inspecting/`** — `cat-index` and `find-hash` use StoreIndex - **`fetching/tarball-fetcher/`** — Threads StoreIndex through fetchers; git-hosted fetcher flushes before reading - **`fetching/git-fetcher/`, `binary-fetcher/`, `pick-fetcher/`** — Accept StoreIndex parameter - **`pkg-manager/`** — `client`, `core`, `headless`, `package-requester` thread StoreIndex - **`reviewing/`** — `license-scanner`, `sbom`, `dependencies-hierarchy` accept StoreIndex - **`cache/api/`** — Cache view uses StoreIndex - **`pnpm/bundle.ts`** — esbuild banner for ExperimentalWarning suppression ## Test plan - [x] `pnpm --filter @pnpm/store.index test` — Unit tests for StoreIndex CRUD and batching - [x] `pnpm --filter @pnpm/package-store test` — Store controller lifecycle - [x] `pnpm --filter @pnpm/package-requester test` — Package requester reads from SQLite index - [x] `pnpm --filter @pnpm/tarball-fetcher test` — Tarball and git-hosted fetcher writes - [x] `pnpm --filter @pnpm/headless test` — Headless install - [x] `pnpm --filter @pnpm/core test` — Core install, side effects, patching - [x] `pnpm --filter @pnpm/plugin-commands-rebuild test` — Rebuild reads from index - [x] `pnpm --filter @pnpm/license-scanner test` — License scanning - [x] e2e tests pass 🤖 Generated with [Claude Code](https://claude.com/claude-code)
588 lines
19 KiB
TypeScript
588 lines
19 KiB
TypeScript
import fs from 'fs'
|
|
import path from 'path'
|
|
import { type PackageFilesIndex } from '@pnpm/store.cafs'
|
|
import { ENGINE_NAME } from '@pnpm/constants'
|
|
import { install } from '@pnpm/core'
|
|
import { type IgnoredScriptsLog } from '@pnpm/core-loggers'
|
|
import { createHexHashFromFile } from '@pnpm/crypto.hash'
|
|
import { prepareEmpty } from '@pnpm/prepare'
|
|
import { getIntegrity } from '@pnpm/registry-mock'
|
|
import { StoreIndex, storeIndexKey } from '@pnpm/store.index'
|
|
import { fixtures } from '@pnpm/test-fixtures'
|
|
import { jest } from '@jest/globals'
|
|
import { sync as rimraf } from '@zkochan/rimraf'
|
|
import { testDefaults } from '../utils/index.js'
|
|
|
|
const f = fixtures(import.meta.dirname)
|
|
|
|
const storeIndexes: StoreIndex[] = []
|
|
afterAll(() => {
|
|
for (const si of storeIndexes) si.close()
|
|
})
|
|
|
|
test('patch package with exact version', async () => {
|
|
const reporter = jest.fn()
|
|
const project = prepareEmpty()
|
|
const patchPath = path.join(f.find('patch-pkg'), 'is-positive@1.0.0.patch')
|
|
|
|
const patchedDependencies = {
|
|
'is-positive@1.0.0': patchPath,
|
|
}
|
|
const opts = testDefaults({
|
|
neverBuiltDependencies: undefined,
|
|
allowBuilds: {},
|
|
fastUnpack: false,
|
|
sideEffectsCacheRead: true,
|
|
sideEffectsCacheWrite: true,
|
|
patchedDependencies,
|
|
reporter,
|
|
}, {}, {}, { packageImportMethod: 'hardlink' })
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, opts)
|
|
|
|
expect(reporter).toHaveBeenCalledWith(expect.objectContaining({
|
|
packageNames: [],
|
|
level: 'debug',
|
|
name: 'pnpm:ignored-scripts',
|
|
} as IgnoredScriptsLog))
|
|
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// patched')
|
|
|
|
const patchFileHash = await createHexHashFromFile(patchPath)
|
|
const lockfile = project.readLockfile()
|
|
expect(lockfile.patchedDependencies).toStrictEqual({
|
|
'is-positive@1.0.0': {
|
|
path: path.relative(process.cwd(), patchedDependencies['is-positive@1.0.0']).replaceAll('\\', '/'),
|
|
hash: patchFileHash,
|
|
},
|
|
})
|
|
expect(lockfile.snapshots[`is-positive@1.0.0(patch_hash=${patchFileHash})`]).toBeTruthy()
|
|
|
|
const filesIndexKey = storeIndexKey(getIntegrity('is-positive', '1.0.0'), 'is-positive@1.0.0')
|
|
const storeIndex = new StoreIndex(opts.storeDir)
|
|
storeIndexes.push(storeIndex)
|
|
const filesIndex = storeIndex.get(filesIndexKey) as PackageFilesIndex
|
|
expect(filesIndex.sideEffects).toBeTruthy()
|
|
const sideEffectsKey = `${ENGINE_NAME};patch=${patchFileHash}`
|
|
expect(filesIndex.sideEffects!.has(sideEffectsKey)).toBeTruthy()
|
|
expect(filesIndex.sideEffects!.get(sideEffectsKey)!.added).toBeTruthy()
|
|
const patchedFileDigest = filesIndex.sideEffects!.get(sideEffectsKey)!.added!.get('index.js')?.digest
|
|
expect(patchedFileDigest).toBeTruthy()
|
|
const originalFileDigest = filesIndex.files.get('index.js')!.digest
|
|
expect(originalFileDigest).toBeTruthy()
|
|
// The digest of the original file differs from the digest of the patched file
|
|
expect(originalFileDigest).not.toEqual(patchedFileDigest)
|
|
|
|
// The same with frozen lockfile
|
|
rimraf('node_modules')
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, {
|
|
...opts,
|
|
frozenLockfile: true,
|
|
})
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// patched')
|
|
|
|
// The same with frozen lockfile and hoisted node_modules
|
|
rimraf('node_modules')
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, {
|
|
...opts,
|
|
frozenLockfile: true,
|
|
nodeLinker: 'hoisted',
|
|
})
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// patched')
|
|
|
|
process.chdir('..')
|
|
fs.mkdirSync('project2')
|
|
process.chdir('project2')
|
|
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, testDefaults({
|
|
fastUnpack: false,
|
|
sideEffectsCacheRead: true,
|
|
sideEffectsCacheWrite: true,
|
|
offline: true,
|
|
}, {}, {}, { packageImportMethod: 'hardlink' }))
|
|
|
|
// The original file did not break, when a patched version was created
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).not.toContain('// patched')
|
|
})
|
|
|
|
test('patch package with version range', async () => {
|
|
const reporter = jest.fn()
|
|
const project = prepareEmpty()
|
|
const patchPath = path.join(f.find('patch-pkg'), 'is-positive@1.0.0.patch')
|
|
|
|
const patchedDependencies = {
|
|
'is-positive@1': patchPath,
|
|
}
|
|
const opts = testDefaults({
|
|
neverBuiltDependencies: undefined,
|
|
allowBuilds: {},
|
|
fastUnpack: false,
|
|
sideEffectsCacheRead: true,
|
|
sideEffectsCacheWrite: true,
|
|
patchedDependencies,
|
|
reporter,
|
|
}, {}, {}, { packageImportMethod: 'hardlink' })
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, opts)
|
|
|
|
expect(reporter).toHaveBeenCalledWith(expect.objectContaining({
|
|
packageNames: [],
|
|
level: 'debug',
|
|
name: 'pnpm:ignored-scripts',
|
|
} as IgnoredScriptsLog))
|
|
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// patched')
|
|
|
|
const patchFileHash = await createHexHashFromFile(patchPath)
|
|
const lockfile = project.readLockfile()
|
|
expect(lockfile.patchedDependencies).toStrictEqual({
|
|
'is-positive@1': {
|
|
path: path.relative(process.cwd(), patchedDependencies['is-positive@1']).replaceAll('\\', '/'),
|
|
hash: patchFileHash,
|
|
},
|
|
})
|
|
expect(lockfile.snapshots[`is-positive@1.0.0(patch_hash=${patchFileHash})`]).toBeTruthy()
|
|
|
|
const filesIndexKey = storeIndexKey(getIntegrity('is-positive', '1.0.0'), 'is-positive@1.0.0')
|
|
const storeIndex = new StoreIndex(opts.storeDir)
|
|
storeIndexes.push(storeIndex)
|
|
const filesIndex = storeIndex.get(filesIndexKey) as PackageFilesIndex
|
|
expect(filesIndex.sideEffects).toBeTruthy()
|
|
const sideEffectsKey = `${ENGINE_NAME};patch=${patchFileHash}`
|
|
expect(filesIndex.sideEffects!.has(sideEffectsKey)).toBeTruthy()
|
|
expect(filesIndex.sideEffects!.get(sideEffectsKey)!.added).toBeTruthy()
|
|
const patchedFileDigest = filesIndex.sideEffects!.get(sideEffectsKey)!.added!.get('index.js')?.digest
|
|
expect(patchedFileDigest).toBeTruthy()
|
|
const originalFileDigest = filesIndex.files.get('index.js')!.digest
|
|
expect(originalFileDigest).toBeTruthy()
|
|
// The digest of the original file differs from the digest of the patched file
|
|
expect(originalFileDigest).not.toEqual(patchedFileDigest)
|
|
|
|
// The same with frozen lockfile
|
|
rimraf('node_modules')
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, {
|
|
...opts,
|
|
frozenLockfile: true,
|
|
})
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// patched')
|
|
|
|
// The same with frozen lockfile and hoisted node_modules
|
|
rimraf('node_modules')
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, {
|
|
...opts,
|
|
frozenLockfile: true,
|
|
nodeLinker: 'hoisted',
|
|
})
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// patched')
|
|
|
|
process.chdir('..')
|
|
fs.mkdirSync('project2')
|
|
process.chdir('project2')
|
|
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, testDefaults({
|
|
fastUnpack: false,
|
|
sideEffectsCacheRead: true,
|
|
sideEffectsCacheWrite: true,
|
|
offline: true,
|
|
}, {}, {}, { packageImportMethod: 'hardlink' }))
|
|
|
|
// The original file did not break, when a patched version was created
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).not.toContain('// patched')
|
|
})
|
|
|
|
test('patch package reports warning if not all patches are applied and allowUnusedPatches is set', async () => {
|
|
prepareEmpty()
|
|
const reporter = jest.fn()
|
|
const patchPath = path.join(f.find('patch-pkg'), 'is-positive@1.0.0.patch')
|
|
|
|
const patchedDependencies = {
|
|
'is-positive@1.0.0': patchPath,
|
|
'is-negative@1.0.0': patchPath,
|
|
}
|
|
const opts = testDefaults({
|
|
fastUnpack: false,
|
|
sideEffectsCacheRead: true,
|
|
sideEffectsCacheWrite: true,
|
|
patchedDependencies,
|
|
allowUnusedPatches: true,
|
|
reporter,
|
|
}, {}, {}, { packageImportMethod: 'hardlink' })
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, opts)
|
|
expect(reporter).toHaveBeenCalledWith(
|
|
expect.objectContaining({
|
|
level: 'warn',
|
|
message: 'The following patches were not used: is-negative@1.0.0',
|
|
})
|
|
)
|
|
})
|
|
|
|
test('patch package throws an exception if not all patches are applied', async () => {
|
|
prepareEmpty()
|
|
const patchPath = path.join(f.find('patch-pkg'), 'is-positive@1.0.0.patch')
|
|
|
|
const patchedDependencies = {
|
|
'is-positive@1.0.0': patchPath,
|
|
'is-negative@1.0.0': patchPath,
|
|
}
|
|
const opts = testDefaults({
|
|
fastUnpack: false,
|
|
sideEffectsCacheRead: true,
|
|
sideEffectsCacheWrite: true,
|
|
patchedDependencies,
|
|
}, {}, {}, { packageImportMethod: 'hardlink' })
|
|
await expect(
|
|
install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, opts)
|
|
).rejects.toThrow('The following patches were not used: is-negative@1.0.0')
|
|
})
|
|
|
|
test('the patched package is updated if the patch is modified', async () => {
|
|
prepareEmpty()
|
|
f.copy('patch-pkg', 'patches')
|
|
const patchPath = path.resolve('patches', 'is-positive@1.0.0.patch')
|
|
|
|
const patchedDependencies = {
|
|
'is-positive@1.0.0': patchPath,
|
|
}
|
|
const opts = testDefaults({
|
|
fastUnpack: false,
|
|
sideEffectsCacheRead: true,
|
|
sideEffectsCacheWrite: true,
|
|
patchedDependencies,
|
|
}, {}, {}, { packageImportMethod: 'hardlink' })
|
|
const manifest = {
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}
|
|
await install(manifest, opts)
|
|
|
|
const patchContent = fs.readFileSync(patchPath, 'utf8')
|
|
fs.writeFileSync(patchPath, patchContent.replace('// patched', '// edited patch'), 'utf8')
|
|
|
|
await install(manifest, opts)
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// edited patch')
|
|
})
|
|
|
|
test('patch package when scripts are ignored', async () => {
|
|
const project = prepareEmpty()
|
|
const patchPath = path.join(f.find('patch-pkg'), 'is-positive@1.0.0.patch')
|
|
|
|
const patchedDependencies = {
|
|
'is-positive@1.0.0': patchPath,
|
|
}
|
|
const opts = testDefaults({
|
|
fastUnpack: false,
|
|
ignoreScripts: true,
|
|
sideEffectsCacheRead: true,
|
|
sideEffectsCacheWrite: true,
|
|
patchedDependencies,
|
|
}, {}, {}, { packageImportMethod: 'hardlink' })
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, opts)
|
|
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// patched')
|
|
|
|
const patchFileHash = await createHexHashFromFile(patchPath)
|
|
const lockfile = project.readLockfile()
|
|
expect(lockfile.patchedDependencies).toStrictEqual({
|
|
'is-positive@1.0.0': {
|
|
path: path.relative(process.cwd(), patchedDependencies['is-positive@1.0.0']).replaceAll('\\', '/'),
|
|
hash: patchFileHash,
|
|
},
|
|
})
|
|
expect(lockfile.snapshots[`is-positive@1.0.0(patch_hash=${patchFileHash})`]).toBeTruthy()
|
|
|
|
const filesIndexKey = storeIndexKey(getIntegrity('is-positive', '1.0.0'), 'is-positive@1.0.0')
|
|
const storeIndex = new StoreIndex(opts.storeDir)
|
|
storeIndexes.push(storeIndex)
|
|
const filesIndex = storeIndex.get(filesIndexKey) as PackageFilesIndex
|
|
expect(filesIndex.sideEffects).toBeTruthy()
|
|
const sideEffectsKey = `${ENGINE_NAME};patch=${patchFileHash}`
|
|
expect(filesIndex.sideEffects!.has(sideEffectsKey)).toBeTruthy()
|
|
expect(filesIndex.sideEffects!.get(sideEffectsKey)!.added).toBeTruthy()
|
|
const patchedFileDigest = filesIndex.sideEffects!.get(sideEffectsKey)!.added!.get('index.js')?.digest
|
|
expect(patchedFileDigest).toBeTruthy()
|
|
const originalFileDigest = filesIndex.files.get('index.js')!.digest
|
|
expect(originalFileDigest).toBeTruthy()
|
|
// The digest of the original file differs from the digest of the patched file
|
|
expect(originalFileDigest).not.toEqual(patchedFileDigest)
|
|
|
|
// The same with frozen lockfile
|
|
rimraf('node_modules')
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, {
|
|
...opts,
|
|
frozenLockfile: true,
|
|
})
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// patched')
|
|
|
|
// The same with frozen lockfile and hoisted node_modules
|
|
rimraf('node_modules')
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, {
|
|
...opts,
|
|
frozenLockfile: true,
|
|
nodeLinker: 'hoisted',
|
|
})
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// patched')
|
|
|
|
process.chdir('..')
|
|
fs.mkdirSync('project2')
|
|
process.chdir('project2')
|
|
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, testDefaults({
|
|
fastUnpack: false,
|
|
ignoreScripts: true,
|
|
sideEffectsCacheRead: true,
|
|
sideEffectsCacheWrite: true,
|
|
offline: true,
|
|
}, {}, {}, { packageImportMethod: 'hardlink' }))
|
|
|
|
// The original file did not break, when a patched version was created
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).not.toContain('// patched')
|
|
})
|
|
|
|
test('patch package when the package is not in allowBuilds list', async () => {
|
|
const project = prepareEmpty()
|
|
const patchPath = path.join(f.find('patch-pkg'), 'is-positive@1.0.0.patch')
|
|
|
|
const patchedDependencies = {
|
|
'is-positive@1.0.0': patchPath,
|
|
}
|
|
const opts = testDefaults({
|
|
fastUnpack: false,
|
|
sideEffectsCacheRead: true,
|
|
sideEffectsCacheWrite: true,
|
|
patchedDependencies,
|
|
neverBuiltDependencies: undefined,
|
|
allowBuilds: {},
|
|
}, {}, {}, { packageImportMethod: 'hardlink' })
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, opts)
|
|
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// patched')
|
|
|
|
const patchFileHash = await createHexHashFromFile(patchPath)
|
|
const lockfile = project.readLockfile()
|
|
expect(lockfile.patchedDependencies).toStrictEqual({
|
|
'is-positive@1.0.0': {
|
|
path: path.relative(process.cwd(), patchedDependencies['is-positive@1.0.0']).replaceAll('\\', '/'),
|
|
hash: patchFileHash,
|
|
},
|
|
})
|
|
expect(lockfile.snapshots[`is-positive@1.0.0(patch_hash=${patchFileHash})`]).toBeTruthy()
|
|
|
|
const filesIndexKey = storeIndexKey(getIntegrity('is-positive', '1.0.0'), 'is-positive@1.0.0')
|
|
const storeIndex = new StoreIndex(opts.storeDir)
|
|
storeIndexes.push(storeIndex)
|
|
const filesIndex = storeIndex.get(filesIndexKey) as PackageFilesIndex
|
|
expect(filesIndex.sideEffects).toBeTruthy()
|
|
const sideEffectsKey = `${ENGINE_NAME};patch=${patchFileHash}`
|
|
expect(filesIndex.sideEffects!.has(sideEffectsKey)).toBeTruthy()
|
|
expect(filesIndex.sideEffects!.get(sideEffectsKey)!.added).toBeTruthy()
|
|
const patchedFileDigest = filesIndex.sideEffects!.get(sideEffectsKey)!.added!.get('index.js')?.digest
|
|
expect(patchedFileDigest).toBeTruthy()
|
|
const originalFileDigest = filesIndex.files.get('index.js')!.digest
|
|
expect(originalFileDigest).toBeTruthy()
|
|
// The digest of the original file differs from the digest of the patched file
|
|
expect(originalFileDigest).not.toEqual(patchedFileDigest)
|
|
|
|
// The same with frozen lockfile
|
|
rimraf('node_modules')
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, {
|
|
...opts,
|
|
frozenLockfile: true,
|
|
})
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// patched')
|
|
|
|
// The same with frozen lockfile and hoisted node_modules
|
|
rimraf('node_modules')
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, {
|
|
...opts,
|
|
frozenLockfile: true,
|
|
nodeLinker: 'hoisted',
|
|
})
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// patched')
|
|
|
|
process.chdir('..')
|
|
fs.mkdirSync('project2')
|
|
process.chdir('project2')
|
|
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, testDefaults({
|
|
fastUnpack: false,
|
|
sideEffectsCacheRead: true,
|
|
sideEffectsCacheWrite: true,
|
|
neverBuiltDependencies: undefined,
|
|
allowBuilds: {},
|
|
offline: true,
|
|
}, {}, {}, { packageImportMethod: 'hardlink' }))
|
|
|
|
// The original file did not break, when a patched version was created
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).not.toContain('// patched')
|
|
})
|
|
|
|
test('patch package when the patched package has no dependencies and appears multiple times', async () => {
|
|
const project = prepareEmpty()
|
|
const patchPath = path.join(f.find('patch-pkg'), 'is-positive@1.0.0.patch')
|
|
|
|
const patchedDependencies = {
|
|
'is-positive@1.0.0': patchPath,
|
|
}
|
|
const opts = testDefaults({
|
|
fastUnpack: false,
|
|
sideEffectsCacheRead: true,
|
|
sideEffectsCacheWrite: true,
|
|
patchedDependencies,
|
|
overrides: {
|
|
'is-positive': '1.0.0',
|
|
},
|
|
}, {}, {}, { packageImportMethod: 'hardlink' })
|
|
await install({
|
|
dependencies: {
|
|
'is-positive': '1.0.0',
|
|
'is-not-positive': '1.0.0',
|
|
},
|
|
}, opts)
|
|
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// patched')
|
|
|
|
const patchFileHash = await createHexHashFromFile(patchPath)
|
|
const lockfile = project.readLockfile()
|
|
expect(Object.keys(lockfile.snapshots).sort()).toStrictEqual([
|
|
'is-not-positive@1.0.0',
|
|
`is-positive@1.0.0(patch_hash=${patchFileHash})`,
|
|
].sort())
|
|
})
|
|
|
|
test('patch package should fail when the exact version patch fails to apply', async () => {
|
|
prepareEmpty()
|
|
const patchPath = path.join(f.find('patch-pkg'), 'is-positive@1.0.0.patch')
|
|
|
|
const patchedDependencies = {
|
|
'is-positive@3.1.0': patchPath,
|
|
}
|
|
const opts = testDefaults({
|
|
fastUnpack: false,
|
|
sideEffectsCacheRead: true,
|
|
sideEffectsCacheWrite: true,
|
|
patchedDependencies,
|
|
}, {}, {}, { packageImportMethod: 'hardlink' })
|
|
await expect(install({
|
|
dependencies: {
|
|
'is-positive': '3.1.0',
|
|
},
|
|
}, opts)).rejects.toThrow(/Could not apply patch/)
|
|
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).not.toContain('// patched')
|
|
})
|
|
|
|
test('patch package should fail when the version range patch fails to apply', async () => {
|
|
prepareEmpty()
|
|
const patchPath = path.join(f.find('patch-pkg'), 'is-positive@1.0.0.patch')
|
|
|
|
const patchedDependencies = {
|
|
'is-positive@>=3': patchPath,
|
|
}
|
|
const opts = testDefaults({
|
|
fastUnpack: false,
|
|
sideEffectsCacheRead: true,
|
|
sideEffectsCacheWrite: true,
|
|
patchedDependencies,
|
|
}, {}, {}, { packageImportMethod: 'hardlink' })
|
|
await expect(install({
|
|
dependencies: {
|
|
'is-positive': '3.1.0',
|
|
},
|
|
}, opts)).rejects.toThrow(/Could not apply patch/)
|
|
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).not.toContain('// patched')
|
|
})
|
|
|
|
test('patch package should fail when the name-only range patch fails to apply', async () => {
|
|
prepareEmpty()
|
|
const patchPath = path.join(f.find('patch-pkg'), 'is-positive@1.0.0.patch')
|
|
|
|
const patchedDependencies = {
|
|
'is-positive': patchPath,
|
|
}
|
|
const opts = testDefaults({
|
|
fastUnpack: false,
|
|
sideEffectsCacheRead: true,
|
|
sideEffectsCacheWrite: true,
|
|
patchedDependencies,
|
|
}, {}, {}, { packageImportMethod: 'hardlink' })
|
|
await expect(install({
|
|
dependencies: {
|
|
'is-positive': '3.1.0',
|
|
},
|
|
}, opts)).rejects.toThrow(/Could not apply patch/)
|
|
|
|
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).not.toContain('// patched')
|
|
})
|