Files

1416 lines
51 KiB
TypeScript

import fs from 'fs'
import os from 'os'
import path from 'path'
import { prepare, preparePackages, tempDir } from '@pnpm/prepare'
import { install } from '@pnpm/plugin-commands-installation'
import { filterPackagesFromDir } from '@pnpm/workspace.filter-packages-from-dir'
import { sync as writeYamlFile } from 'write-yaml-file'
import { readWorkspaceManifest } from '@pnpm/workspace.read-manifest'
import tempy from 'tempy'
import { patch, patchCommit, patchRemove } from '@pnpm/plugin-commands-patching'
import { readProjectManifest } from '@pnpm/read-project-manifest'
import { REGISTRY_MOCK_PORT } from '@pnpm/registry-mock'
import { DEFAULT_OPTS } from './utils/index.js'
import { fixtures } from '@pnpm/test-fixtures'
import { jest } from '@jest/globals'
import * as enquirer from 'enquirer'
jest.mock('enquirer', () => ({ prompt: jest.fn() }))
// eslint-disable-next-line
const prompt = enquirer.prompt as any
const f = fixtures(__dirname)
const basePatchOption = {
pnpmHomeDir: '',
rawConfig: {
registry: `http://localhost:${REGISTRY_MOCK_PORT}/`,
},
registries: { default: `http://localhost:${REGISTRY_MOCK_PORT}/` },
userConfig: {},
virtualStoreDir: 'node_modules/.pnpm',
virtualStoreDirMaxLength: process.platform === 'win32' ? 60 : 120,
}
describe('patch and commit', () => {
let defaultPatchOption: patch.PatchCommandOptions
let cacheDir: string
let storeDir: string
beforeEach(async () => {
prepare({
dependencies: {
'is-positive': '1.0.0',
},
})
cacheDir = path.resolve('cache')
storeDir = path.resolve('store')
defaultPatchOption = {
...basePatchOption,
cacheDir,
dir: process.cwd(),
storeDir,
}
await install.handler({
...DEFAULT_OPTS,
cacheDir,
storeDir,
dir: process.cwd(),
saveLockfile: true,
})
})
test('patch throws an error when edit dir is not empty', async () => {
fs.mkdirSync('node_modules/.pnpm_patches/is-positive@1.0.0', { recursive: true })
fs.writeFileSync('node_modules/.pnpm_patches/is-positive@1.0.0/package.json', '{}')
await expect(patch.handler(defaultPatchOption, ['is-positive@1.0.0'])).rejects.toMatchObject({
code: 'ERR_PNPM_EDIT_DIR_NOT_EMPTY',
})
})
test('patch and commit with exact version', async () => {
const output = await patch.handler(defaultPatchOption, ['is-positive@1.0.0'])
const patchDir = getPatchDirFromPatchOutput(output)
// store patch files in a directory inside modules dir when not given editDir option
expect(patchDir).toContain(path.join('node_modules', '.pnpm_patches', 'is-positive@1.0.0'))
expect(path.basename(patchDir)).toBe('is-positive@1.0.0')
expect(fs.existsSync(patchDir)).toBe(true)
// sanity check to ensure that the license file contains the expected string
expect(fs.readFileSync(path.join(patchDir, 'license'), 'utf8')).toContain('The MIT License (MIT)')
fs.appendFileSync(path.join(patchDir, 'index.js'), '// test patching', 'utf8')
fs.unlinkSync(path.join(patchDir, 'license'))
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [patchDir])
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'is-positive@1.0.0': 'patches/is-positive@1.0.0.patch',
})
const patchContent = fs.readFileSync('patches/is-positive@1.0.0.patch', 'utf8')
expect(patchContent).toContain('diff --git')
expect(patchContent).toContain('// test patching')
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// test patching')
expect(patchContent).not.toContain('The MIT License (MIT)')
expect(fs.existsSync('node_modules/is-positive/license')).toBe(false)
})
test('patch and commit without exact version', async () => {
const output = await patch.handler(defaultPatchOption, ['is-positive'])
const patchDir = getPatchDirFromPatchOutput(output)
expect(patchDir).toContain(path.join('node_modules', '.pnpm_patches', 'is-positive@'))
expect(path.basename(patchDir)).toMatch(/^is-positive@\d+\.\d+\.\d+$/)
expect(fs.existsSync(patchDir)).toBe(true)
// sanity check to ensure that the license file contains the expected string
expect(fs.readFileSync(path.join(patchDir, 'license'), 'utf8')).toContain('The MIT License (MIT)')
fs.appendFileSync(path.join(patchDir, 'index.js'), '// test patching', 'utf8')
fs.unlinkSync(path.join(patchDir, 'license'))
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [patchDir])
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'is-positive': 'patches/is-positive.patch',
})
const patchContent = fs.readFileSync('patches/is-positive.patch', 'utf8')
expect(patchContent).toContain('diff --git')
expect(patchContent).toContain('// test patching')
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// test patching')
expect(patchContent).not.toContain('The MIT License (MIT)')
expect(fs.existsSync('node_modules/is-positive/license')).toBe(false)
})
test('patch-commit multiple times', async () => {
const output = await patch.handler(defaultPatchOption, ['is-positive@1.0.0'])
const patchDir = getPatchDirFromPatchOutput(output)
// store patch files in a directory inside modules dir when not given editDir option
expect(patchDir).toContain(path.join('node_modules', '.pnpm_patches', 'is-positive@1.0.0'))
expect(path.basename(patchDir)).toBe('is-positive@1.0.0')
expect(fs.existsSync(patchDir)).toBe(true)
// sanity check to ensure that the license file contains the expected string
expect(fs.readFileSync(path.join(patchDir, 'license'), 'utf8')).toContain('The MIT License (MIT)')
{
// First edit
fs.appendFileSync(path.join(patchDir, 'index.js'), '// first edit\n', 'utf8')
fs.unlinkSync(path.join(patchDir, 'license'))
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [patchDir])
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'is-positive@1.0.0': 'patches/is-positive@1.0.0.patch',
})
const patchContent = fs.readFileSync('patches/is-positive@1.0.0.patch', 'utf8')
expect(patchContent).toContain('diff --git')
expect(patchContent).toContain('// first edit')
expect(patchContent).not.toContain('// second edit')
expect(patchContent).not.toContain('// third edit')
const indexFileContent = fs.readFileSync('node_modules/is-positive/index.js', 'utf8')
expect(indexFileContent).toContain('// first edit')
expect(indexFileContent).not.toContain('// second edit')
expect(indexFileContent).not.toContain('// third edit')
expect(patchContent).not.toContain('The MIT License (MIT)')
expect(fs.existsSync('node_modules/is-positive/license')).toBe(false)
}
{
// Second edit
fs.appendFileSync(path.join(patchDir, 'index.js'), '// second edit\n', 'utf8')
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [patchDir])
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'is-positive@1.0.0': 'patches/is-positive@1.0.0.patch',
})
const patchContent = fs.readFileSync('patches/is-positive@1.0.0.patch', 'utf8')
expect(patchContent).toContain('diff --git')
expect(patchContent).toContain('// first edit')
expect(patchContent).toContain('// second edit')
expect(patchContent).not.toContain('// third edit')
const indexFileContent = fs.readFileSync('node_modules/is-positive/index.js', 'utf8')
expect(indexFileContent).toContain('// first edit')
expect(indexFileContent).toContain('// second edit')
expect(indexFileContent).not.toContain('// third edit')
expect(patchContent).not.toContain('The MIT License (MIT)')
expect(fs.existsSync('node_modules/is-positive/license')).toBe(false)
}
{
// Third edit
fs.appendFileSync(path.join(patchDir, 'index.js'), '// third edit\n', 'utf8')
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [patchDir])
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'is-positive@1.0.0': 'patches/is-positive@1.0.0.patch',
})
const patchContent = fs.readFileSync('patches/is-positive@1.0.0.patch', 'utf8')
expect(patchContent).toContain('diff --git')
expect(patchContent).toContain('// first edit')
expect(patchContent).toContain('// second edit')
expect(patchContent).toContain('// third edit')
const indexFileContent = fs.readFileSync('node_modules/is-positive/index.js', 'utf8')
expect(indexFileContent).toContain('// first edit')
expect(indexFileContent).toContain('// second edit')
expect(indexFileContent).toContain('// third edit')
expect(patchContent).not.toContain('The MIT License (MIT)')
expect(fs.existsSync('node_modules/is-positive/license')).toBe(false)
}
})
test('patch-commit with relative path', async () => {
const output = await patch.handler(defaultPatchOption, ['is-positive@1.0.0'])
const patchDir = getPatchDirFromPatchOutput(output)
// store patch files in a directory inside modules dir when not given editDir option
expect(patchDir).toContain(path.join('node_modules', '.pnpm_patches', 'is-positive@1.0.0'))
expect(path.basename(patchDir)).toBe('is-positive@1.0.0')
expect(fs.existsSync(patchDir)).toBe(true)
// sanity check to ensure that the license file contains the expected string
expect(fs.readFileSync(path.join(patchDir, 'license'), 'utf8')).toContain('The MIT License (MIT)')
fs.appendFileSync(path.join(patchDir, 'index.js'), '// test patching', 'utf8')
fs.unlinkSync(path.join(patchDir, 'license'))
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [path.relative(process.cwd(), patchDir)])
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'is-positive@1.0.0': 'patches/is-positive@1.0.0.patch',
})
const patchContent = fs.readFileSync('patches/is-positive@1.0.0.patch', 'utf8')
expect(patchContent).toContain('diff --git')
expect(patchContent).toContain('// test patching')
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// test patching')
expect(patchContent).not.toContain('The MIT License (MIT)')
expect(fs.existsSync('node_modules/is-positive/license')).toBe(false)
})
test('patch and commit with filtered files', async () => {
const output = await patch.handler(defaultPatchOption, ['is-positive@1.0.0'])
const patchDir = getPatchDirFromPatchOutput(output)
// store patch files in a directory inside modules dir when not given editDir option
expect(patchDir).toContain(path.join('node_modules', '.pnpm_patches', 'is-positive@1.0.0'))
expect(path.basename(patchDir)).toBe('is-positive@1.0.0')
expect(fs.existsSync(patchDir)).toBe(true)
// sanity check to ensure that the license file contains the expected string
expect(fs.readFileSync(path.join(patchDir, 'license'), 'utf8')).toContain('The MIT License (MIT)')
fs.writeFileSync(path.join(patchDir, 'ignore.txt'), '', 'utf8')
const { manifest } = await readProjectManifest(patchDir)
expect(manifest?.files).toStrictEqual(['index.js'])
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [patchDir])
expect(fs.existsSync('node_modules/is-positive/ignore.txt')).toBe(false)
})
test('patch and commit with a custom edit dir', async () => {
const editDir = path.join(tempy.directory())
const output = await patch.handler({ ...defaultPatchOption, editDir }, ['is-positive@1.0.0'])
const patchDir = getPatchDirFromPatchOutput(output)
expect(patchDir).toBe(editDir)
expect(fs.existsSync(patchDir)).toBe(true)
fs.appendFileSync(path.join(patchDir, 'index.js'), '// test patching', 'utf8')
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [patchDir])
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// test patching')
})
test('patch with relative path to custom edit dir and commit with absolute path', async () => {
const editDir = 'custom-edit-dir'
const output = await patch.handler({ ...defaultPatchOption, editDir }, ['is-positive@1.0.0'])
const patchDir = getPatchDirFromPatchOutput(output)
const editDirAbsolute = path.resolve(defaultPatchOption.dir, editDir)
expect(patchDir).toBe(editDirAbsolute)
expect(fs.existsSync(editDirAbsolute)).toBe(true)
fs.appendFileSync(path.join(patchDir, 'index.js'), '// test patching', 'utf8')
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [path.resolve(editDir)])
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// test patching')
})
test('patch and commit with custom patches dir', async () => {
const patchesDir = 'ts/src/../custom-patches'
const output = await patch.handler({ ...defaultPatchOption }, ['is-positive@1.0.0'])
const patchDir = getPatchDirFromPatchOutput(output)
expect(fs.existsSync(path.normalize(patchesDir))).toBe(false)
fs.appendFileSync(path.join(patchDir, 'index.js'), '// test patching', 'utf8')
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
patchesDir,
storeDir,
}, [patchDir])
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'is-positive@1.0.0': 'ts/custom-patches/is-positive@1.0.0.patch',
})
expect(fs.existsSync(path.normalize(patchesDir))).toBe(true)
expect(fs.readFileSync(path.join(patchesDir, 'is-positive@1.0.0.patch'), 'utf8')).toContain('// test patching')
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// test patching')
})
test('patch throws an error if the edit-dir already exists and is not empty', async () => {
const editDir = tempy.directory()
fs.writeFileSync(path.join(editDir, 'test.txt'), '', 'utf8')
await expect(() => patch.handler({ ...defaultPatchOption, editDir }, ['is-positive@1.0.0']))
.rejects.toThrow(`The target directory already exists: '${editDir}'`)
})
test('patch and commit should work when the patch directory is specified with a trailing slash', async () => {
const editDir = path.join(tempy.directory()) + (os.platform() === 'win32' ? '\\' : '/')
const output = await patch.handler({ ...defaultPatchOption, editDir }, ['is-positive@1.0.0'])
const patchDir = getPatchDirFromPatchOutput(output)
expect(fs.existsSync(patchDir)).toBe(true)
fs.appendFileSync(path.join(patchDir, 'index.js'), '// test patching', 'utf8')
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [patchDir])
expect(fs.readFileSync('node_modules/is-positive/index.js', 'utf8')).toContain('// test patching')
})
test('should reuse existing patch file by default (with version suffix)', async () => {
let output = await patch.handler(defaultPatchOption, ['is-positive@1.0.0'])
let patchDir = getPatchDirFromPatchOutput(output)
fs.appendFileSync(path.join(patchDir, 'index.js'), '// test patching', 'utf8')
fs.unlinkSync(path.join(patchDir, 'license'))
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [patchDir])
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'is-positive@1.0.0': 'patches/is-positive@1.0.0.patch',
})
const { manifest } = await readProjectManifest(process.cwd())
expect(fs.existsSync('patches/is-positive@1.0.0.patch')).toBe(true)
// re-patch
fs.rmSync(patchDir, { recursive: true })
output = await patch.handler({ ...defaultPatchOption, rootProjectManifest: manifest, patchedDependencies: workspaceManifest?.patchedDependencies }, ['is-positive@1.0.0'])
patchDir = getPatchDirFromPatchOutput(output)
expect(fs.existsSync(patchDir)).toBe(true)
expect(fs.existsSync(path.join(patchDir, 'license'))).toBe(false)
expect(fs.readFileSync(path.join(patchDir, 'index.js'), 'utf8')).toContain('// test patching')
})
test('should reuse existing patch file by default (without version suffix)', async () => {
let output = await patch.handler(defaultPatchOption, ['is-positive'])
let patchDir = getPatchDirFromPatchOutput(output)
fs.appendFileSync(path.join(patchDir, 'index.js'), '// test patching', 'utf8')
fs.unlinkSync(path.join(patchDir, 'license'))
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [patchDir])
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'is-positive': 'patches/is-positive.patch',
})
expect(fs.existsSync('patches/is-positive.patch')).toBe(true)
// re-patch
fs.rmSync(patchDir, { recursive: true })
const { manifest } = await readProjectManifest(process.cwd())
output = await patch.handler({ ...defaultPatchOption, rootProjectManifest: manifest, patchedDependencies: workspaceManifest?.patchedDependencies }, ['is-positive'])
patchDir = getPatchDirFromPatchOutput(output)
expect(fs.existsSync(patchDir)).toBe(true)
expect(fs.existsSync(path.join(patchDir, 'license'))).toBe(false)
expect(fs.readFileSync(path.join(patchDir, 'index.js'), 'utf8')).toContain('// test patching')
})
test('if the patch file is not existed when patching, should throw an error', async () => {
const { writeProjectManifest, manifest } = await readProjectManifest(process.cwd())
await writeProjectManifest({
...manifest,
pnpm: {
patchedDependencies: {
'is-positive@1.0.0': 'patches/not-found.patch',
},
},
})
try {
await patch.handler(defaultPatchOption, ['is-positive@1.0.0'])
} catch (err: any) { // eslint-disable-line
expect(err.code).toBe('ERR_PNPM_PATCH_FILE_NOT_FOUND')
}
})
test('should ignore patch files with --ignore-patches', async () => {
let output = await patch.handler(defaultPatchOption, ['is-positive@1.0.0'])
let patchDir = getPatchDirFromPatchOutput(output)
fs.appendFileSync(path.join(patchDir, 'index.js'), '// test patching', 'utf8')
fs.unlinkSync(path.join(patchDir, 'license'))
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [patchDir])
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'is-positive@1.0.0': 'patches/is-positive@1.0.0.patch',
})
expect(fs.existsSync('patches/is-positive@1.0.0.patch')).toBe(true)
// re-patch with --ignore-patches
fs.rmSync(patchDir, { recursive: true })
output = await patch.handler({ ...defaultPatchOption, ignoreExisting: true }, ['is-positive@1.0.0'])
patchDir = getPatchDirFromPatchOutput(output)
expect(fs.existsSync(patchDir)).toBe(true)
expect(fs.existsSync(path.join(patchDir, 'license'))).toBe(true)
expect(fs.readFileSync(path.join(patchDir, 'index.js'), 'utf8')).not.toContain('// test patching')
})
test('patch throw an error if no package specified', async () => {
await expect(() => patch.handler({ ...defaultPatchOption }, []))
.rejects.toThrow('`pnpm patch` requires the package name')
})
test('should throw an error if no installed versions found for patched package', async () => {
await expect(() => patch.handler(defaultPatchOption, ['chalk']))
.rejects.toThrow(`Can not find chalk in project ${process.cwd()}, did you forget to install chalk?`)
})
test('should throw an error if no preferred versions found for patched package', async () => {
await expect(() => patch.handler(defaultPatchOption, ['is-positive@2.0.0']))
.rejects.toThrow(`Can not find is-positive@2.0.0 in project ${process.cwd()}, you can specify currently installed version: 1.0.0.`)
})
test('patch package with installed version', async () => {
const output = await patch.handler(defaultPatchOption, ['is-positive@1'])
const patchDir = getPatchDirFromPatchOutput(output)
expect(patchDir).toContain(path.join('node_modules', '.pnpm_patches', 'is-positive@1'))
expect(path.basename(patchDir)).toMatch(/^is-positive@1\.\d+\.\d+$/)
expect(fs.existsSync(patchDir)).toBe(true)
expect(JSON.parse(fs.readFileSync(path.join(patchDir, 'package.json'), 'utf8')).version).toBe('1.0.0')
})
test('should skip empty patch content and not create patches dir', async () => {
const output = await patch.handler(defaultPatchOption, ['is-positive@1.0.0'])
const patchDir = getPatchDirFromPatchOutput(output)
const result = await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [patchDir])
expect(result).toBe(`No changes were found to the following directory: ${patchDir}`)
expect(fs.existsSync('patches/is-positive@1.0.0.patch')).toBe(false)
expect(fs.existsSync('patches')).toBe(false)
})
test('should exclude .DS_Store files from the patch', async () => {
const output = await patch.handler(defaultPatchOption, ['is-positive@1.0.0'])
const patchDir = getPatchDirFromPatchOutput(output)
fs.appendFileSync(path.join(patchDir, 'index.js'), '// test patching', 'utf8')
fs.appendFileSync(path.join(patchDir, '.DS_Store'), '// dummy content', 'utf8') // The diff is added in the middle of the patch file.
fs.mkdirSync(path.join(patchDir, 'subdir'))
fs.appendFileSync(path.join(patchDir, 'subdir', '.DS_Store'), '// dummy content', 'utf8') // The diff is added to the end of the patch file
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [patchDir])
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'is-positive@1.0.0': 'patches/is-positive@1.0.0.patch',
})
const patchContent = fs.readFileSync('patches/is-positive@1.0.0.patch', 'utf8')
expect(patchContent).toContain('diff --git a/index.js b/index.js')
expect(patchContent).toContain('// test patching')
expect(patchContent).not.toContain('diff --git a/.DS_Store b/.DS_Store')
expect(patchContent).not.toContain('diff --git a/subdir/.DS_Store b/subdir/.DS_Store')
expect(patchContent).not.toContain('// dummy content')
})
})
describe('multiple versions', () => {
let defaultPatchOption: patch.PatchCommandOptions
let cacheDir: string
let storeDir: string
beforeEach(() => {
prepare({
dependencies: {
'@pnpm.e2e/depends-on-console-log': '1.0.0',
},
})
cacheDir = path.resolve('cache')
storeDir = path.resolve('store')
defaultPatchOption = {
...basePatchOption,
cacheDir,
dir: process.cwd(),
storeDir,
}
})
test('choosing apply to all should apply the patch to all applicable versions', async () => {
await install.handler({
...DEFAULT_OPTS,
cacheDir,
storeDir,
dir: process.cwd(),
saveLockfile: true,
})
prompt.mockResolvedValue({
version: '1.0.0',
applyToAll: true,
})
prompt.mockClear()
const output = await patch.handler(defaultPatchOption, ['@pnpm.e2e/console-log'])
expect(prompt.mock.calls).toMatchObject([[[
{
type: 'select',
name: 'version',
choices: ['1.0.0', '2.0.0', '3.0.0'].map(x => ({ name: x, message: x, value: x })),
},
{
type: 'confirm',
name: 'applyToAll',
},
]]])
const patchDir = getPatchDirFromPatchOutput(output)
const fileToPatch = path.join(patchDir, 'index.js')
const originalContent = fs.readFileSync(fileToPatch, 'utf-8')
const patchedContent = originalContent.replace('first line', 'FIRST LINE')
fs.writeFileSync(fileToPatch, patchedContent)
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [patchDir])
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'@pnpm.e2e/console-log': 'patches/@pnpm.e2e__console-log.patch',
})
const patchFileContent = fs.readFileSync('patches/@pnpm.e2e__console-log.patch', 'utf-8')
expect(patchFileContent).toContain('diff --git')
expect(patchFileContent).toContain("\n+console.log('FIRST LINE')")
expect(patchFileContent).toContain("\n-console.log('first line')")
expect(
fs.readFileSync(
'node_modules/.pnpm/@pnpm.e2e+depends-on-console-log@1.0.0/node_modules/console-log-1/index.js',
'utf-8'
)
).toContain('FIRST LINE')
expect(
fs.readFileSync(
'node_modules/.pnpm/@pnpm.e2e+depends-on-console-log@1.0.0/node_modules/console-log-2/index.js',
'utf-8'
)
).toContain('FIRST LINE')
expect(
fs.readFileSync(
'node_modules/.pnpm/@pnpm.e2e+depends-on-console-log@1.0.0/node_modules/console-log-3/index.js',
'utf-8'
)
).toContain('FIRST LINE')
})
})
describe('prompt to choose version', () => {
let defaultPatchOption: patch.PatchCommandOptions
let cacheDir: string
let storeDir: string
beforeEach(() => {
prepare({
dependencies: {
'@pnpm.e2e/requires-chalk-530': '1.0.0',
chalk: '4.1.2',
},
})
cacheDir = path.resolve('cache')
storeDir = path.resolve('store')
defaultPatchOption = {
...basePatchOption,
cacheDir,
dir: process.cwd(),
storeDir,
}
})
test('prompt to choose version if multiple versions found for patched package, no apply to all', async () => {
await install.handler({
...DEFAULT_OPTS,
cacheDir,
storeDir,
dir: process.cwd(),
saveLockfile: true,
})
prompt.mockResolvedValue({
version: '5.3.0',
applyToAll: false,
})
prompt.mockClear()
const output = await patch.handler(defaultPatchOption, ['chalk'])
expect(prompt.mock.calls).toMatchObject([[[
{
type: 'select',
name: 'version',
choices: [
{
name: '4.1.2',
message: '4.1.2',
value: '4.1.2',
},
{
name: '5.3.0',
message: '5.3.0',
value: '5.3.0',
},
],
},
{
type: 'confirm',
name: 'applyToAll',
},
]]])
const patchDir = getPatchDirFromPatchOutput(output)
expect(patchDir).toContain(path.join('node_modules', '.pnpm_patches', 'chalk@'))
expect(path.basename(patchDir)).toMatch(/^chalk@\d+\.\d+\.\d+$/)
expect(fs.existsSync(patchDir)).toBe(true)
expect(JSON.parse(fs.readFileSync(path.join(patchDir, 'package.json'), 'utf8')).version).toBe('5.3.0')
expect(fs.existsSync(path.join(patchDir, 'source/index.js'))).toBe(true)
fs.appendFileSync(path.join(patchDir, 'source/index.js'), '// test patching', 'utf8')
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [patchDir])
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'chalk@5.3.0': 'patches/chalk@5.3.0.patch',
})
const patchContent = fs.readFileSync('patches/chalk@5.3.0.patch', 'utf8')
expect(patchContent).toContain('diff --git')
expect(patchContent).toContain('// test patching')
expect(fs.readFileSync('node_modules/.pnpm/@pnpm.e2e+requires-chalk-530@1.0.0/node_modules/chalk/source/index.js', 'utf8')).toContain('// test patching')
})
test('prompt to choose version if multiple versions found for patched package, apply to all', async () => {
await install.handler({
...DEFAULT_OPTS,
cacheDir,
storeDir,
dir: process.cwd(),
saveLockfile: true,
})
prompt.mockResolvedValue({
version: '5.3.0',
applyToAll: true,
})
prompt.mockClear()
const output = await patch.handler(defaultPatchOption, ['chalk'])
expect(prompt.mock.calls).toMatchObject([[[
{
type: 'select',
name: 'version',
choices: [
{
name: '4.1.2',
message: '4.1.2',
value: '4.1.2',
},
{
name: '5.3.0',
message: '5.3.0',
value: '5.3.0',
},
],
},
{
type: 'confirm',
name: 'applyToAll',
},
]]])
const patchDir = getPatchDirFromPatchOutput(output)
expect(patchDir).toContain(path.join('node_modules', '.pnpm_patches', 'chalk@'))
expect(path.basename(patchDir)).toMatch(/^chalk@\d+\.\d+\.\d+$/)
expect(fs.existsSync(patchDir)).toBe(true)
expect(JSON.parse(fs.readFileSync(path.join(patchDir, 'package.json'), 'utf8')).version).toBe('5.3.0')
expect(fs.existsSync(path.join(patchDir, 'source/index.js'))).toBe(true)
fs.appendFileSync(path.join(patchDir, 'source/index.js'), '// test patching', 'utf8')
await patchCommit.handler({
...DEFAULT_OPTS,
cacheDir,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
storeDir,
}, [patchDir])
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
chalk: 'patches/chalk.patch',
})
const patchContent = fs.readFileSync('patches/chalk.patch', 'utf8')
expect(patchContent).toContain('diff --git')
expect(patchContent).toContain('// test patching')
expect(fs.readFileSync('node_modules/.pnpm/@pnpm.e2e+requires-chalk-530@1.0.0/node_modules/chalk/source/index.js', 'utf8')).toContain('// test patching')
})
})
describe('patching should work when there is a no EOL in the patched file', () => {
let defaultPatchOption: patch.PatchCommandOptions
beforeEach(async () => {
prepare({
dependencies: {
'safe-execa': '0.1.2',
},
})
const cacheDir = path.resolve('cache')
const storeDir = path.resolve('store')
defaultPatchOption = {
...basePatchOption,
cacheDir,
dir: process.cwd(),
storeDir,
}
await install.handler({
...DEFAULT_OPTS,
cacheDir,
storeDir,
dir: process.cwd(),
saveLockfile: true,
})
})
it('should work when adding content on a newline', async () => {
const output = await patch.handler(defaultPatchOption, ['safe-execa@0.1.2'])
const userPatchDir = getPatchDirFromPatchOutput(output)
expect(userPatchDir).toContain(path.join('node_modules', '.pnpm_patches', 'safe-execa@0.1.2'))
expect(path.basename(userPatchDir)).toBe('safe-execa@0.1.2')
expect(fs.existsSync(userPatchDir)).toBe(true)
expect(fs.existsSync(path.join(userPatchDir, 'lib/index.js'))).toBe(true)
fs.appendFileSync(path.join(userPatchDir, 'lib/index.js'), '\n// test patching', 'utf8')
await patchCommit.handler({
...DEFAULT_OPTS,
...defaultPatchOption,
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
}, [userPatchDir])
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'safe-execa@0.1.2': 'patches/safe-execa@0.1.2.patch',
})
const patchContent = fs.readFileSync('patches/safe-execa@0.1.2.patch', 'utf8')
expect(patchContent).toContain('diff --git')
expect(patchContent).toContain('// test patching')
expect(patchContent).not.toContain('No newline at end of file')
expect(fs.readFileSync('node_modules/safe-execa/lib/index.js', 'utf8')).toContain('// test patching')
})
it('should work fine when new content is appended', async () => {
const output = await patch.handler(defaultPatchOption, ['safe-execa@0.1.2'])
const userPatchDir = getPatchDirFromPatchOutput(output)
expect(userPatchDir).toContain(path.join('node_modules', '.pnpm_patches', 'safe-execa@0.1.2'))
expect(path.basename(userPatchDir)).toBe('safe-execa@0.1.2')
expect(fs.existsSync(userPatchDir)).toBe(true)
expect(fs.existsSync(path.join(userPatchDir, 'lib/index.js'))).toBe(true)
fs.appendFileSync(path.join(userPatchDir, 'lib/index.js'), '// patch without newline', 'utf8')
await patchCommit.handler({
...DEFAULT_OPTS,
...defaultPatchOption,
rootProjectManifestDir: process.cwd(),
frozenLockfile: false,
fixLockfile: true,
}, [userPatchDir])
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'safe-execa@0.1.2': 'patches/safe-execa@0.1.2.patch',
})
const patchContent = fs.readFileSync('patches/safe-execa@0.1.2.patch', 'utf8')
expect(patchContent).toContain('No newline at end of file')
expect(fs.readFileSync('node_modules/safe-execa/lib/index.js', 'utf8')).toContain('//# sourceMappingURL=index.js.map// patch without newline')
})
})
describe('patch and commit in workspaces', () => {
let defaultPatchOption: patch.PatchCommandOptions
let cacheDir: string
let storeDir: string
beforeEach(async () => {
preparePackages([
{
location: '.',
package: {
name: 'patch-commit-workspaces',
},
},
{
name: 'project-1',
version: '1.0.0',
dependencies: {
'is-positive': '1.0.0',
hi: '0.0.0',
},
},
{
name: 'project-2',
version: '1.0.0',
dependencies: {
'is-positive': '1.0.0',
'project-1': '1',
hi: 'github:zkochan/hi#4cdebec76b7b9d1f6e219e06c42d92a6b8ea60cd',
},
},
])
cacheDir = path.resolve('cache')
storeDir = path.resolve('store')
defaultPatchOption = {
...basePatchOption,
cacheDir,
dir: process.cwd(),
storeDir,
}
writeYamlFile('pnpm-workspace.yaml', { packages: ['project-1', 'project-2'] })
})
test('patch commit should work in workspaces', async () => {
const { allProjects, allProjectsGraph, selectedProjectsGraph } = await filterPackagesFromDir(process.cwd(), [])
await install.handler({
...DEFAULT_OPTS,
cacheDir,
storeDir,
allProjects,
allProjectsGraph,
dir: process.cwd(),
lockfileDir: process.cwd(),
selectedProjectsGraph,
workspaceDir: process.cwd(),
saveLockfile: true,
})
const output = await patch.handler(defaultPatchOption, ['is-positive@1.0.0'])
const patchDir = getPatchDirFromPatchOutput(output)
expect(patchDir).toContain(path.join('node_modules', '.pnpm_patches', 'is-positive@1.0.0'))
expect(path.basename(patchDir)).toBe('is-positive@1.0.0')
expect(fs.existsSync(patchDir)).toBe(true)
expect(fs.readFileSync(path.join(patchDir, 'license'), 'utf8')).toContain('The MIT License (MIT)')
fs.appendFileSync(path.join(patchDir, 'index.js'), '// test patching', 'utf8')
fs.unlinkSync(path.join(patchDir, 'license'))
await patchCommit.handler({
...DEFAULT_OPTS,
allProjects,
allProjectsGraph,
selectedProjectsGraph,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
cacheDir,
storeDir,
lockfileDir: process.cwd(),
workspaceDir: process.cwd(),
saveLockfile: true,
frozenLockfile: false,
}, [patchDir])
const { manifest } = await readProjectManifest(process.cwd())
expect(manifest.pnpm?.patchedDependencies).toStrictEqual(undefined)
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'is-positive@1.0.0': 'patches/is-positive@1.0.0.patch',
})
const patchContent = fs.readFileSync('patches/is-positive@1.0.0.patch', 'utf8')
expect(patchContent).toContain('diff --git')
expect(patchContent).toContain('// test patching')
expect(fs.readFileSync('project-1/node_modules/is-positive/index.js', 'utf8')).toContain('// test patching')
expect(fs.existsSync('project-1/node_modules/is-positive/license')).toBe(false)
expect(fs.readFileSync('project-2/node_modules/is-positive/index.js', 'utf8')).toContain('// test patching')
expect(fs.existsSync('project-2/node_modules/is-positive/license')).toBe(false)
})
test('patch and patch-commit should work with shared-workspace-lockfile=false', async () => {
const { allProjects, allProjectsGraph, selectedProjectsGraph } = await filterPackagesFromDir(process.cwd(), [])
await install.handler({
...DEFAULT_OPTS,
cacheDir,
storeDir,
allProjects,
allProjectsGraph,
dir: process.cwd(),
lockfileDir: undefined,
selectedProjectsGraph,
workspaceDir: process.cwd(),
saveLockfile: true,
sharedWorkspaceLockfile: false,
})
if (path.basename(process.cwd()) !== 'project-1') {
process.chdir('./project-1')
}
const output = await patch.handler({
...defaultPatchOption,
dir: process.cwd(),
}, ['is-positive@1.0.0'])
const patchDir = getPatchDirFromPatchOutput(output)
expect(patchDir).toContain(path.join('node_modules', '.pnpm_patches', 'is-positive@1.0.0'))
expect(path.basename(patchDir)).toBe('is-positive@1.0.0')
expect(fs.existsSync(patchDir)).toBe(true)
expect(fs.readFileSync(path.join(patchDir, 'license'), 'utf8')).toContain('The MIT License (MIT)')
fs.appendFileSync(path.join(patchDir, 'index.js'), '// test patching', 'utf8')
fs.unlinkSync(path.join(patchDir, 'license'))
await patchCommit.handler({
...DEFAULT_OPTS,
allProjects,
allProjectsGraph,
selectedProjectsGraph,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
cacheDir,
storeDir,
lockfileDir: process.cwd(),
workspaceDir: process.cwd(),
saveLockfile: true,
frozenLockfile: false,
fixLockfile: true,
sharedWorkspaceLockfile: false,
}, [patchDir])
const { manifest } = await readProjectManifest(process.cwd())
expect(manifest.pnpm?.patchedDependencies).toStrictEqual(undefined)
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'is-positive@1.0.0': 'patches/is-positive@1.0.0.patch',
})
const patchContent = fs.readFileSync('patches/is-positive@1.0.0.patch', 'utf8')
expect(patchContent).toContain('diff --git')
expect(patchContent).toContain('// test patching')
expect(fs.readFileSync('./node_modules/is-positive/index.js', 'utf8')).toContain('// test patching')
expect(fs.existsSync('./node_modules/is-positive/license')).toBe(false)
expect(fs.readFileSync('../project-2/node_modules/is-positive/index.js', 'utf8')).not.toContain('// test patching')
expect(fs.existsSync('../project-2/node_modules/is-positive/license')).toBe(true)
})
test('reusing existing patch file should work with shared-workspace-lockfile=false', async () => {
const { allProjects, allProjectsGraph, selectedProjectsGraph } = await filterPackagesFromDir(process.cwd(), [])
await install.handler({
...DEFAULT_OPTS,
cacheDir,
storeDir,
allProjects,
allProjectsGraph,
dir: process.cwd(),
lockfileDir: undefined,
selectedProjectsGraph,
workspaceDir: process.cwd(),
saveLockfile: true,
sharedWorkspaceLockfile: false,
})
// patch project-1
process.chdir('./project-1')
let output = await patch.handler({
...defaultPatchOption,
dir: process.cwd(),
}, ['is-positive@1.0.0'])
let patchDir = getPatchDirFromPatchOutput(output)
// modify index.js and remove license
fs.appendFileSync(path.join(patchDir, 'index.js'), '// test patching', 'utf8')
fs.unlinkSync(path.join(patchDir, 'license'))
// patch-commit
let workspaceManifest = await readWorkspaceManifest(process.cwd())
await patchCommit.handler({
...DEFAULT_OPTS,
allProjects,
allProjectsGraph,
selectedProjectsGraph,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
patchedDependencies: workspaceManifest?.patchedDependencies,
cacheDir,
storeDir,
lockfileDir: process.cwd(),
workspaceDir: process.cwd(),
saveLockfile: true,
frozenLockfile: false,
fixLockfile: true,
sharedWorkspaceLockfile: false,
}, [patchDir])
// verify committed patch
expect(fs.readFileSync('./node_modules/is-positive/index.js', 'utf8')).toContain('// test patching')
expect(fs.existsSync('./node_modules/is-positive/license')).toBe(false)
// re-patch project-1
fs.rmSync(patchDir, { recursive: true })
workspaceManifest = await readWorkspaceManifest(process.cwd())
output = await patch.handler({
...defaultPatchOption,
dir: process.cwd(),
patchedDependencies: workspaceManifest?.patchedDependencies,
}, ['is-positive@1.0.0'])
patchDir = getPatchDirFromPatchOutput(output)
expect(fs.existsSync(patchDir)).toBe(true)
// verify temporary patch is reusing last committed patch
expect(fs.readFileSync(path.join(patchDir, 'index.js'), 'utf8')).toContain('// test patching')
expect(fs.existsSync(path.join(patchDir, 'license'))).toBe(false)
})
test('patch and patch-commit for git hosted dependency', async () => {
const { allProjects, allProjectsGraph, selectedProjectsGraph } = await filterPackagesFromDir(process.cwd(), [])
await install.handler({
...DEFAULT_OPTS,
cacheDir,
storeDir,
allProjects,
allProjectsGraph,
dir: process.cwd(),
lockfileDir: process.cwd(),
selectedProjectsGraph,
workspaceDir: process.cwd(),
saveLockfile: true,
})
prompt.mockResolvedValue({
version: 'https://codeload.github.com/zkochan/hi/tar.gz/4cdebec76b7b9d1f6e219e06c42d92a6b8ea60cd',
applyToAll: false,
})
prompt.mockClear()
const output = await patch.handler(defaultPatchOption, ['hi'])
expect(prompt.mock.calls).toMatchObject([[[
{
type: 'select',
name: 'version',
choices: [
{
name: '0.0.0',
message: '0.0.0',
value: '0.0.0',
},
{
name: '1.0.0',
message: '1.0.0',
value: 'https://codeload.github.com/zkochan/hi/tar.gz/4cdebec76b7b9d1f6e219e06c42d92a6b8ea60cd',
hint: 'Git Hosted',
},
],
},
{
type: 'confirm',
name: 'applyToAll',
},
]]])
const patchDir = getPatchDirFromPatchOutput(output)
expect(fs.existsSync(patchDir)).toBe(true)
expect(fs.readFileSync(path.join(patchDir, 'index.js'), 'utf8')).toContain('module.exports = \'Hi\'')
fs.appendFileSync(path.join(patchDir, 'index.js'), '// test patching', 'utf8')
await patchCommit.handler({
...DEFAULT_OPTS,
allProjects,
allProjectsGraph,
selectedProjectsGraph,
dir: process.cwd(),
rootProjectManifestDir: process.cwd(),
cacheDir,
storeDir,
lockfileDir: process.cwd(),
workspaceDir: process.cwd(),
saveLockfile: true,
frozenLockfile: false,
}, [patchDir])
const { manifest } = await readProjectManifest(process.cwd())
expect(manifest.pnpm?.patchedDependencies).toStrictEqual(undefined)
const workspaceManifest = await readWorkspaceManifest(process.cwd())
expect(workspaceManifest!.patchedDependencies).toStrictEqual({
'hi@1.0.0': 'patches/hi@1.0.0.patch',
})
const patchContent = fs.readFileSync('patches/hi@1.0.0.patch', 'utf8')
expect(patchContent).toContain('diff --git')
expect(patchContent).toContain('// test patching')
expect(fs.readFileSync('./project-2/node_modules/hi/index.js', 'utf8')).toContain('// test patching')
})
})
describe('patch with custom modules-dir and virtual-store-dir', () => {
let defaultPatchOption: patch.PatchCommandOptions
let customModulesDirFixture: string
let cacheDir: string
let storeDir: string
beforeAll(() => {
customModulesDirFixture = tempDir()
f.copy('custom-modules-dir', customModulesDirFixture)
cacheDir = path.resolve(customModulesDirFixture, 'cache')
storeDir = path.resolve(customModulesDirFixture, 'store')
defaultPatchOption = {
...basePatchOption,
cacheDir,
dir: customModulesDirFixture,
storeDir,
modulesDir: 'fake_modules',
virtualStoreDir: 'fake_modules/.fake_store',
}
})
test('should work with custom modules-dir and virtual-store-dir', async () => {
const { allProjects, allProjectsGraph, selectedProjectsGraph } = await filterPackagesFromDir(customModulesDirFixture, [])
await install.handler({
...DEFAULT_OPTS,
...defaultPatchOption,
lockfileDir: customModulesDirFixture,
allProjects,
allProjectsGraph,
selectedProjectsGraph,
workspaceDir: customModulesDirFixture,
saveLockfile: true,
confirmModulesPurge: false,
})
const output = await patch.handler(defaultPatchOption, ['is-positive@1'])
const patchDir = getPatchDirFromPatchOutput(output)
expect(patchDir).toContain(path.join('fake_modules', '.pnpm_patches', 'is-positive@1'))
expect(path.basename(patchDir)).toMatch(/^is-positive@1\.\d+\.\d+$/)
expect(fs.existsSync(patchDir)).toBe(true)
expect(JSON.parse(fs.readFileSync(path.join(patchDir, 'package.json'), 'utf8')).version).toBe('1.0.0')
fs.appendFileSync(path.join(patchDir, 'index.js'), '// test patching', 'utf8')
await patchCommit.handler({
...DEFAULT_OPTS,
...defaultPatchOption,
rootProjectManifestDir: customModulesDirFixture,
saveLockfile: true,
frozenLockfile: false,
fixLockfile: true,
allProjects,
allProjectsGraph,
selectedProjectsGraph,
lockfileDir: customModulesDirFixture,
workspaceDir: customModulesDirFixture,
confirmModulesPurge: false,
}, [patchDir])
expect(fs.readFileSync(path.join(customModulesDirFixture, 'packages/bar/fake_modules/is-positive/index.js'), 'utf8')).toContain('// test patching')
})
})
describe('patch-remove', () => {
let defaultPatchRemoveOption: patchRemove.PatchRemoveCommandOptions
let cacheDir: string
let storeDir: string
beforeEach(async () => {
prompt.mockClear()
prepare({
dependencies: {
'is-positive': '1.0.0',
},
})
cacheDir = path.resolve('cache')
storeDir = path.resolve('store')
defaultPatchRemoveOption = {
...DEFAULT_OPTS,
dir: process.cwd(),
cacheDir,
storeDir,
}
await install.handler({
...defaultPatchRemoveOption,
dir: process.cwd(),
saveLockfile: true,
})
})
test('patch-remove should work as expected', async () => {
const { manifest, writeProjectManifest } = await readProjectManifest(process.cwd())
manifest.pnpm = {
patchedDependencies: {
'is-positive@1.0.0': 'patches/is-positive@1.0.0.patch',
},
}
await writeProjectManifest(manifest)
fs.mkdirSync(path.join(process.cwd(), 'patches'))
fs.writeFileSync(path.join(process.cwd(), 'patches/is-positive@1.0.0.patch'), 'test patch content', 'utf8')
await patchRemove.handler({
...defaultPatchRemoveOption,
rootProjectManifest: manifest,
patchedDependencies: manifest.pnpm.patchedDependencies,
}, ['is-positive@1.0.0'])
const { manifest: newManifest } = await readProjectManifest(process.cwd())
expect(newManifest!.pnpm!).toBeUndefined()
expect(fs.existsSync(path.join(process.cwd(), 'patches/is-positive@1.0.0.patch'))).toBe(false)
expect(fs.existsSync(path.join(process.cwd(), 'patches'))).toBe(false)
})
test('prompt to select patches that to be removed', async () => {
const { manifest, writeProjectManifest } = await readProjectManifest(process.cwd())
manifest.pnpm = {
patchedDependencies: {
'is-positive@1.0.0': 'patches/is-positive@1.0.0.patch',
'chalk@4.1.2': 'patches/chalk@4.1.2.patch',
},
}
await writeProjectManifest(manifest)
prompt.mockResolvedValue({
patches: ['is-positive@1.0.0', 'chalk@4.1.2'],
})
await patchRemove.handler({
...defaultPatchRemoveOption,
rootProjectManifest: manifest,
patchedDependencies: manifest.pnpm.patchedDependencies,
}, [])
expect(prompt.mock.calls[0][0].choices).toEqual(expect.arrayContaining(['is-positive@1.0.0', 'chalk@4.1.2']))
prompt.mockClear()
const { manifest: newManifest } = await readProjectManifest(process.cwd())
expect(newManifest!.pnpm!).toBeUndefined()
})
test('should throw error when there is no patch to remove', async () => {
await expect(() => patchRemove.handler({ ...defaultPatchRemoveOption, patchedDependencies: {} }, []))
.rejects.toThrow('There are no patches that need to be removed')
})
})
function getPatchDirFromPatchOutput (output: string): string {
const match = output.match(/['"]([^'"]+)['"]/)
if (match?.[1] == null) throw new Error('No path in output')
return match[1]
}