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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 2 commits into from
Mar 23, 2023
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8243836
fix: don't writ pnpm-lock.yaml if it has no changes
zkochan Mar 23, 2023
b86b243
fix: don't write pnpm-lock.yaml if it wasn't modified
zkochan Mar 23, 2023
File filter

Filter by extension

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

Return a copy of the wantedLockfile (wantedLockfileUnmodified) for checking later on if the lockfile was modified.
6 changes: 6 additions & 0 deletions .changeset/itchy-dancers-collect.md
View file
Open in desktop
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).
5 changes: 5 additions & 0 deletions .changeset/nasty-walls-sell.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@pnpm/headless": minor
---

A new option is accepted: wantedLockfileUnmodified. It is used to check if the wanted lockfile was changed and whether it needs to be written.
2 changes: 2 additions & 0 deletions pkg-manager/core/src/install/index.ts
View file
Open in desktop
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,
wantedLockfileUnmodified: ctx.wantedLockfileUnmodified,
})
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,
wantedLockfileUnmodified: ctx.wantedLockfileUnmodified,
})
return result
}
Expand Down
16 changes: 16 additions & 0 deletions pkg-manager/core/test/lockfile.ts
View file
Open in desktop
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
View file
Open in desktop
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
wantedLockfileUnmodified: Lockfile
registries: Registries
}

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

export async function getContextForSingleImporter (
Expand Down
2 changes: 2 additions & 0 deletions pkg-manager/get-context/src/readLockfiles.ts
View file
Open in desktop
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
wantedLockfileUnmodified: Lockfile
lockfileHadConflicts: boolean
}> {
const wantedLockfileVersion = LOCKFILE_VERSION_V6
Expand Down Expand Up @@ -128,6 +129,7 @@ export async function readLockfiles (
existsCurrentLockfile: files[1] != null,
existsWantedLockfile: files[0] != null && !isEmptyLockfile(wantedLockfile),
wantedLockfile,
wantedLockfileUnmodified: JSON.parse(JSON.stringify(wantedLockfile)),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: It might be worth a comment that we have to recreate this object since the consumer is expected to mutate wantedLockfile. But maybe that's fairly obvious and isn't worth commenting.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was also considering just to save the hash of the object and then comparing hashes. That would use less memory but probably would do more processing

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have changed it. There was actually no need in the copy.

lockfileHadConflicts,
}
}
3 changes: 2 additions & 1 deletion pkg-manager/headless/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,7 @@ export interface HeadlessOptions {
pruneStore: boolean
pruneVirtualStore?: boolean
wantedLockfile?: Lockfile
wantedLockfileUnmodified?: Lockfile
ownLifecycleHooksStdio?: 'inherit' | 'pipe'
pendingBuilds: string[]
resolveSymlinksInInjectedDirs?: boolean
Expand Down Expand Up @@ -545,7 +546,7 @@ export async function headlessInstall (opts: HeadlessOptions) {
storeDir: opts.storeDir,
virtualStoreDir,
})
if (opts.useLockfile) {
if (opts.useLockfile && JSON.stringify(wantedLockfile) !== JSON.stringify(opts.wantedLockfileUnmodified)) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: It might be worth following up with a deepEqual(...) function that early exits as soon as it sees the lockfiles are different for performance. I've seen pnpm-lock.yaml files grow to be 4MB, and serializing 2 * 4MB could add a few seconds to each pnpm install.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have changed it. There was actually no need in the copy.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

// We need to write the wanted lockfile as well.
// Even though it will only be changed if the workspace will have new projects with no dependencies.
await writeLockfiles({
Expand Down