import fs from 'fs' import path from 'path' import { addDependenciesToPackage, install } from '@pnpm/core' import { hashObject } from '@pnpm/crypto.object-hasher' import { readMsgpackFileSync, writeMsgpackFileSync } from '@pnpm/fs.msgpack-file' import { getIndexFilePathInCafs, getFilePathByModeInCafs, type PackageFilesIndex } from '@pnpm/store.cafs' import { getIntegrity, REGISTRY_MOCK_PORT } from '@pnpm/registry-mock' import { prepareEmpty } from '@pnpm/prepare' import { ENGINE_NAME } from '@pnpm/constants' import { sync as rimraf } from '@zkochan/rimraf' import { testDefaults } from '../utils/index.js' const ENGINE_DIR = `${process.platform}-${process.arch}-node-${process.version.split('.')[0]}` test.skip('caching side effects of native package', async () => { prepareEmpty() const opts = testDefaults({ fastUnpack: false, sideEffectsCacheRead: true, sideEffectsCacheWrite: true, }) let { updatedManifest: manifest } = await addDependenciesToPackage({}, ['diskusage@1.1.3'], opts) const cacheBuildDir = path.join(opts.storeDir, `localhost+${REGISTRY_MOCK_PORT}/diskusage/1.1.3/side_effects/${ENGINE_DIR}/package/build`) const stat1 = fs.statSync(cacheBuildDir) expect(fs.existsSync('node_modules/diskusage/build')).toBeTruthy() expect(fs.existsSync(cacheBuildDir)).toBeTruthy() manifest = (await addDependenciesToPackage(manifest, ['diskusage@1.1.3'], opts)).updatedManifest const stat2 = fs.statSync(cacheBuildDir) expect(stat1.ino).toBe(stat2.ino) opts.force = true await addDependenciesToPackage(manifest, ['diskusage@1.1.3'], opts) const stat3 = fs.statSync(cacheBuildDir) // cache is overridden when force is true expect(stat1.ino).not.toBe(stat3.ino) }) test.skip('caching side effects of native package when hoisting is used', async () => { const project = prepareEmpty() const opts = testDefaults({ fastUnpack: false, hoistPattern: '*', sideEffectsCacheRead: true, sideEffectsCacheWrite: true, }) const { updatedManifest: manifest } = await addDependenciesToPackage({}, ['expire-fs@2.2.3'], opts) const cacheBuildDir = path.join(opts.storeDir, `localhost+${REGISTRY_MOCK_PORT}/diskusage/1.1.3/side_effects/${ENGINE_DIR}/package/build`) const stat1 = fs.statSync(cacheBuildDir) project.has('.pnpm/node_modules/diskusage/build') // build folder created expect(fs.existsSync(cacheBuildDir)).toBeTruthy() // build folder created in side effects cache project.has('.pnpm/node_modules/es6-promise') // verifying that a flat node_modules was created await addDependenciesToPackage(manifest, ['expire-fs@2.2.3'], opts) const stat2 = fs.statSync(cacheBuildDir) expect(stat1.ino).toBe(stat2.ino) // existing cache is not overridden project.has('.pnpm/node_modules/es6-promise') // verifying that a flat node_modules was created opts.force = true await addDependenciesToPackage(manifest, ['expire-fs@2.2.3'], opts) const stat3 = fs.statSync(cacheBuildDir) expect(stat1.ino).not.toBe(stat3.ino) // cache is overridden when force is true project.has('.pnpm/node_modules/es6-promise') // verifying that a flat node_modules was created }) test('using side effects cache', async () => { prepareEmpty() // Right now, hardlink does not work with side effects, so we specify copy as the packageImportMethod // We disable verifyStoreIntegrity because we are going to change the cache const opts = testDefaults({ fastUnpack: false, sideEffectsCacheRead: true, sideEffectsCacheWrite: true, verifyStoreIntegrity: false, allowBuilds: { '@pnpm.e2e/pre-and-postinstall-scripts-example': true }, }, {}, {}, { packageImportMethod: 'copy' }) const { updatedManifest: manifest } = await addDependenciesToPackage({}, ['@pnpm.e2e/pre-and-postinstall-scripts-example@1.0.0'], opts) const filesIndexFile = getIndexFilePathInCafs(opts.storeDir, getIntegrity('@pnpm.e2e/pre-and-postinstall-scripts-example', '1.0.0'), '@pnpm.e2e/pre-and-postinstall-scripts-example@1.0.0') const filesIndex = readMsgpackFileSync(filesIndexFile) expect(filesIndex.sideEffects).toBeTruthy() // files index has side effects const sideEffectsKey = `${ENGINE_NAME};deps=${hashObject({ id: `@pnpm.e2e/pre-and-postinstall-scripts-example@1.0.0:${getIntegrity('@pnpm.e2e/pre-and-postinstall-scripts-example', '1.0.0')}`, deps: { '@pnpm.e2e/hello-world-js-bin': hashObject({ id: `@pnpm.e2e/hello-world-js-bin@1.0.0:${getIntegrity('@pnpm.e2e/hello-world-js-bin', '1.0.0')}`, deps: {}, }), }, })}` expect(filesIndex.sideEffects).toBeTruthy() expect(filesIndex.sideEffects!.has(sideEffectsKey)).toBeTruthy() expect(filesIndex.sideEffects!.get(sideEffectsKey)!.added).toBeTruthy() const addedFiles = filesIndex.sideEffects!.get(sideEffectsKey)!.added! expect(addedFiles.has('generated-by-preinstall.js')).toBeTruthy() expect(addedFiles.has('generated-by-postinstall.js')).toBeTruthy() addedFiles.delete('generated-by-postinstall.js') writeMsgpackFileSync(filesIndexFile, filesIndex) rimraf('node_modules') rimraf('pnpm-lock.yaml') // to avoid headless install const opts2 = testDefaults({ fastUnpack: false, sideEffectsCacheRead: true, sideEffectsCacheWrite: true, storeDir: opts.storeDir, verifyStoreIntegrity: false, allowBuilds: { '@pnpm.e2e/pre-and-postinstall-scripts-example': true }, }, {}, {}, { packageImportMethod: 'copy' }) await addDependenciesToPackage(manifest, ['@pnpm.e2e/pre-and-postinstall-scripts-example@1.0.0'], opts2) expect(fs.existsSync(path.resolve('node_modules/@pnpm.e2e/pre-and-postinstall-scripts-example/generated-by-preinstall.js'))).toBeTruthy() // side effects cache correctly used expect(fs.existsSync(path.resolve('node_modules/@pnpm.e2e/pre-and-postinstall-scripts-example/generated-by-postinstall.js'))).toBeFalsy() // side effects cache correctly used }) test.skip('readonly side effects cache', async () => { prepareEmpty() const opts1 = testDefaults({ fastUnpack: false, sideEffectsCacheRead: true, sideEffectsCacheWrite: true, verifyStoreIntegrity: false, }) let { updatedManifest: manifest } = await addDependenciesToPackage({}, ['diskusage@1.1.3'], opts1) // Modify the side effects cache to make sure we are using it const cacheBuildDir = path.join(opts1.storeDir, `localhost+${REGISTRY_MOCK_PORT}/diskusage/1.1.3/side_effects/${ENGINE_DIR}/package/build`) fs.writeFileSync(path.join(cacheBuildDir, 'new-file.txt'), 'some new content') rimraf('node_modules') const opts2 = testDefaults({ fastUnpack: false, sideEffectsCacheRead: true, sideEffectsCacheWrite: false, verifyStoreIntegrity: false, }, {}, {}, { packageImportMethod: 'copy' }) manifest = (await addDependenciesToPackage(manifest, ['diskusage@1.1.3'], opts2)).updatedManifest expect(fs.existsSync('node_modules/diskusage/build/new-file.txt')).toBeTruthy() rimraf('node_modules') // changing version to make sure we don't create the cache await addDependenciesToPackage(manifest, ['diskusage@1.1.2'], opts2) expect(fs.existsSync('node_modules/diskusage/build')).toBeTruthy() expect(fs.existsSync(path.join(opts2.storeDir, `localhost+${REGISTRY_MOCK_PORT}/diskusage/1.1.2/side_effects/${ENGINE_DIR}/package/build`))).toBeFalsy() }) test('uploading errors do not interrupt installation', async () => { prepareEmpty() const opts = testDefaults({ fastUnpack: false, sideEffectsCacheRead: true, sideEffectsCacheWrite: true, allowBuilds: { '@pnpm.e2e/pre-and-postinstall-scripts-example': true }, }) opts.storeController.upload = async () => { throw new Error('an unexpected error') } await addDependenciesToPackage({}, ['@pnpm.e2e/pre-and-postinstall-scripts-example@1.0.0'], opts) expect(fs.existsSync('node_modules/@pnpm.e2e/pre-and-postinstall-scripts-example/generated-by-postinstall.js')).toBeTruthy() const filesIndexFile = getIndexFilePathInCafs(opts.storeDir, getIntegrity('@pnpm.e2e/pre-and-postinstall-scripts-example', '1.0.0'), '@pnpm.e2e/pre-and-postinstall-scripts-example@1.0.0') const filesIndex = readMsgpackFileSync(filesIndexFile) expect(filesIndex.sideEffects).toBeFalsy() }) test('a postinstall script does not modify the original sources added to the store', async () => { prepareEmpty() const opts = testDefaults({ fastUnpack: false, sideEffectsCacheRead: true, sideEffectsCacheWrite: true, allowBuilds: { '@pnpm/postinstall-modifies-source': true }, }, {}, {}, { packageImportMethod: 'hardlink' }) await addDependenciesToPackage({}, ['@pnpm/postinstall-modifies-source@1.0.0'], opts) expect(fs.readFileSync('node_modules/@pnpm/postinstall-modifies-source/empty-file.txt', 'utf8')).toContain('hello') const filesIndexFile = getIndexFilePathInCafs(opts.storeDir, getIntegrity('@pnpm/postinstall-modifies-source', '1.0.0'), '@pnpm/postinstall-modifies-source@1.0.0') const filesIndex = readMsgpackFileSync(filesIndexFile) expect(filesIndex.sideEffects).toBeTruthy() expect(filesIndex.sideEffects?.has(`${ENGINE_NAME};deps=${hashObject({ id: `@pnpm/postinstall-modifies-source@1.0.0:${getIntegrity('@pnpm/postinstall-modifies-source', '1.0.0')}`, deps: {}, })}`)).toBeTruthy() const sideEffectEntry = filesIndex.sideEffects!.get(`${ENGINE_NAME};deps=${hashObject({ id: `@pnpm/postinstall-modifies-source@1.0.0:${getIntegrity('@pnpm/postinstall-modifies-source', '1.0.0')}`, deps: {}, })}`)! const patchedFileDigest = sideEffectEntry.added!.get('empty-file.txt')?.digest expect(patchedFileDigest).toBeTruthy() const originalFileDigest = filesIndex.files.get('empty-file.txt')!.digest expect(originalFileDigest).toBeTruthy() // The digest of the original file differs from the digest of the patched file expect(originalFileDigest).not.toEqual(patchedFileDigest) expect(fs.readFileSync(getFilePathByModeInCafs(opts.storeDir, originalFileDigest, 420), 'utf8')).toBe('') }) test('a corrupted side-effects cache is ignored', async () => { prepareEmpty() const opts = testDefaults({ fastUnpack: false, sideEffectsCacheRead: true, sideEffectsCacheWrite: true, allowBuilds: { '@pnpm.e2e/pre-and-postinstall-scripts-example': true }, }) const { updatedManifest: manifest } = await addDependenciesToPackage({}, ['@pnpm.e2e/pre-and-postinstall-scripts-example@1.0.0'], opts) const filesIndexFile = getIndexFilePathInCafs(opts.storeDir, getIntegrity('@pnpm.e2e/pre-and-postinstall-scripts-example', '1.0.0'), '@pnpm.e2e/pre-and-postinstall-scripts-example@1.0.0') const filesIndex = readMsgpackFileSync(filesIndexFile) expect(filesIndex.sideEffects).toBeTruthy() // files index has side effects const sideEffectsKey = `${ENGINE_NAME};deps=${hashObject({ id: `@pnpm.e2e/pre-and-postinstall-scripts-example@1.0.0:${getIntegrity('@pnpm.e2e/pre-and-postinstall-scripts-example', '1.0.0')}`, deps: { '@pnpm.e2e/hello-world-js-bin': hashObject({ id: `@pnpm.e2e/hello-world-js-bin@1.0.0:${getIntegrity('@pnpm.e2e/hello-world-js-bin', '1.0.0')}`, deps: {}, }), }, })}` expect(filesIndex.sideEffects).toBeTruthy() expect(filesIndex.sideEffects!.has(sideEffectsKey)).toBeTruthy() expect(filesIndex.sideEffects!.get(sideEffectsKey)!.added).toBeTruthy() expect(filesIndex.sideEffects!.get(sideEffectsKey)!.added!.has('generated-by-preinstall.js')).toBeTruthy() const sideEffectFileStat = filesIndex.sideEffects!.get(sideEffectsKey)!.added!.get('generated-by-preinstall.js')! const sideEffectFile = getFilePathByModeInCafs(opts.storeDir, sideEffectFileStat.digest, sideEffectFileStat.mode) expect(fs.existsSync(sideEffectFile)).toBeTruthy() rimraf(sideEffectFile) // we remove the side effect file to break the store rimraf('node_modules') const opts2 = testDefaults({ fastUnpack: false, sideEffectsCacheRead: true, sideEffectsCacheWrite: true, storeDir: opts.storeDir, allowBuilds: { '@pnpm.e2e/pre-and-postinstall-scripts-example': true }, }) await install(manifest, opts2) expect(fs.existsSync(path.resolve('node_modules/@pnpm.e2e/pre-and-postinstall-scripts-example/generated-by-preinstall.js'))).toBeTruthy() // side effects cache correctly used })