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

close #6158
pnpm · Mar 23, 2023 · e6fb46e · e6fb46e
1 parent b8bafe8
commit e6fb46e
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 0 deletions.
diff --git a/.changeset/early-dodos-wash.md b/.changeset/early-dodos-wash.md
@@ -0,0 +1,5 @@
+---
+"@pnpm/get-context": minor
+---
+
+Return `wantedLockfileIsModified`.
diff --git a/.changeset/itchy-dancers-collect.md b/.changeset/itchy-dancers-collect.md
@@ -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).
diff --git a/pkg-manager/core/src/install/index.ts b/pkg-manager/core/src/install/index.ts
@@ -388,6 +388,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({
@@ -1266,6 +1267,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
     }

diff --git a/pkg-manager/core/test/lockfile.ts b/pkg-manager/core/test/lockfile.ts
@@ -1559,3 +1559,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)
+})
diff --git a/pkg-manager/get-context/src/index.ts b/pkg-manager/get-context/src/index.ts
@@ -52,6 +52,7 @@ export interface PnpmContext {
   skipped: Set<string>
   storeDir: string
   wantedLockfile: Lockfile
+  wantedLockfileIsModified: boolean
   registries: Registries
 }
 
@@ -363,6 +364,7 @@ export interface PnpmSingleContext {
   skipped: Set<string>
   storeDir: string
   wantedLockfile: Lockfile
+  wantedLockfileIsModified: boolean
 }
 
 export async function getContextForSingleImporter (

diff --git a/pkg-manager/get-context/src/readLockfiles.ts b/pkg-manager/get-context/src/readLockfiles.ts
@@ -46,6 +46,7 @@ export async function readLockfiles (
     existsCurrentLockfile: boolean
     existsWantedLockfile: boolean
     wantedLockfile: Lockfile
+    wantedLockfileIsModified: boolean
     lockfileHadConflicts: boolean
   }> {
   const wantedLockfileVersion = opts.useLockfileV6 ? LOCKFILE_VERSION_V6 : LOCKFILE_VERSION
@@ -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: {},
       }
@@ -128,6 +131,7 @@ export async function readLockfiles (
     existsCurrentLockfile: files[1] != null,
     existsWantedLockfile: files[0] != null,
     wantedLockfile,
+    wantedLockfileIsModified,
     lockfileHadConflicts,
   }
 }