Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: don't write pnpm-lock.yaml if it has no changes #6260

Merged
merged 2 commits into from
Mar 23, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/early-dodos-wash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@pnpm/get-context": minor
---

Return `wantedLockfileIsModified`.
6 changes: 6 additions & 0 deletions .changeset/itchy-dancers-collect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
"@pnpm/core": patch
"pnpm": patch
---

Don't write the `pnpm-lock.yaml` file if it has no changes and `pnpm install --frozen-lockfile` was executed [#6158](https://github.com/pnpm/pnpm/issues/6158).
2 changes: 2 additions & 0 deletions pkg-manager/core/src/install/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -385,6 +385,7 @@ export async function mutateModules (
prunedAt: ctx.modulesFile?.prunedAt,
pruneVirtualStore,
wantedLockfile: maybeOpts.ignorePackageManifest ? undefined : ctx.wantedLockfile,
useLockfile: opts.useLockfile && ctx.wantedLockfileIsModified,
})
if (opts.useLockfile && opts.saveLockfile && opts.mergeGitBranchLockfiles) {
await writeLockfiles({
Expand Down Expand Up @@ -1257,6 +1258,7 @@ const installInContext: InstallFunction = async (projects, ctx, opts) => {
allProjects: ctx.projects,
prunedAt: ctx.modulesFile?.prunedAt,
wantedLockfile: result.newLockfile,
useLockfile: opts.useLockfile && ctx.wantedLockfileIsModified,
})
return result
}
Expand Down
16 changes: 16 additions & 0 deletions pkg-manager/core/test/lockfile.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1580,3 +1580,19 @@ test('update the lockfile when a new project is added to the workspace and lockf
const lockfile: Lockfile = await readYamlFile(WANTED_LOCKFILE)
expect(Object.keys(lockfile.importers)).toStrictEqual(['project-1', 'project-2'])
})

test('lockfile is not written when it has no changes', async () => {
prepareEmpty()

const manifest = await install({
dependencies: {
'@types/semver': '^5.3.31',
},
}, await testDefaults())

const stat = await fs.stat(WANTED_LOCKFILE)
const initialMtime = stat.mtimeMs

await install(manifest, await testDefaults())
expect(await fs.stat(WANTED_LOCKFILE)).toHaveProperty('mtimeMs', initialMtime)
})
2 changes: 2 additions & 0 deletions pkg-manager/get-context/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ export interface PnpmContext {
skipped: Set<string>
storeDir: string
wantedLockfile: Lockfile
wantedLockfileIsModified: boolean
registries: Registries
}

Expand Down Expand Up @@ -360,6 +361,7 @@ export interface PnpmSingleContext {
skipped: Set<string>
storeDir: string
wantedLockfile: Lockfile
wantedLockfileIsModified: boolean
}

export async function getContextForSingleImporter (
Expand Down
4 changes: 4 additions & 0 deletions pkg-manager/get-context/src/readLockfiles.ts
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ export async function readLockfiles (
existsCurrentLockfile: boolean
existsWantedLockfile: boolean
wantedLockfile: Lockfile
wantedLockfileIsModified: boolean
lockfileHadConflicts: boolean
}> {
const wantedLockfileVersion = LOCKFILE_VERSION_V6
Expand Down Expand Up @@ -115,8 +116,10 @@ export async function readLockfiles (
const wantedLockfile = files[0] ??
(currentLockfile && clone(currentLockfile)) ??
createLockfileObject(importerIds, sopts)
let wantedLockfileIsModified = false
for (const importerId of importerIds) {
if (!wantedLockfile.importers[importerId]) {
wantedLockfileIsModified = true
wantedLockfile.importers[importerId] = {
specifiers: {},
}
Expand All @@ -128,6 +131,7 @@ export async function readLockfiles (
existsCurrentLockfile: files[1] != null,
existsWantedLockfile: files[0] != null && !isEmptyLockfile(wantedLockfile),
wantedLockfile,
wantedLockfileIsModified,
lockfileHadConflicts,
}
}