fix(snapshot): fix "obsolete" message on snapshot update re-run (#7129)

hi-ogawa · web-flow · commit c2beb8ca93a6 · 2024-12-27T10:05:03.000+01:00
diff --git a/packages/vitest/src/node/core.ts b/packages/vitest/src/node/core.ts
@@ -937,13 +937,15 @@ export class Vitest {
       // environment is resolved inside a worker thread
       snapshotEnvironment: null as any,
     }
+    this.snapshot.options.updateSnapshot = 'all'
   }
 
   /**
    * Disable the mode that allows updating snapshots when running tests.
    */
   public resetSnapshotUpdate(): void {
     delete this.configOverride.snapshotOptions
+    this.snapshot.options.updateSnapshot = this.config.snapshotOptions.updateSnapshot
   }
 
   /**
diff --git a/test/snapshots/test/fixtures/summary-removed/.gitignore b/test/snapshots/test/fixtures/summary-removed/.gitignore
@@ -0,0 +1 @@
+__snapshots__
diff --git a/test/snapshots/test/fixtures/summary-removed/basic.test.ts b/test/snapshots/test/fixtures/summary-removed/basic.test.ts
@@ -0,0 +1,11 @@
+import { expect, test } from 'vitest'
+
+test('x', () => {
+  expect(0).toMatchSnapshot()
+})
+
+// REMOVE-START
+test('y', () => {
+  expect(0).toMatchSnapshot()
+})
+// REMOVE-END
diff --git a/test/snapshots/test/summary.test.ts b/test/snapshots/test/summary.test.ts
@@ -1,7 +1,7 @@
 import fs from 'node:fs'
 import { join } from 'node:path'
-import { expect, test } from 'vitest'
-import { runVitest } from '../../test-utils'
+import { assert, expect, onTestFailed, onTestFinished, test } from 'vitest'
+import { editFile, runVitest } from '../../test-utils'
 
 function fsUpdate(file: string, updateFn: (data: string) => string) {
   fs.writeFileSync(file, updateFn(fs.readFileSync(file, 'utf-8')))
@@ -40,3 +40,54 @@ test('summary', async () => {
   })
   expect(vitest.stdout).toContain('Snapshots  2 updated')
 })
+
+test('first obsolete then remove', async () => {
+  const root = join(import.meta.dirname, 'fixtures/summary-removed')
+  const testFile = join(root, 'basic.test.ts')
+  const snapshotFile = join(root, '__snapshots__/basic.test.ts.snap')
+
+  // reset snapshot
+  fs.rmSync(snapshotFile, { recursive: true, force: true })
+  await runVitest({
+    root,
+    update: true,
+  })
+  expect(fs.readFileSync(snapshotFile, 'utf-8')).toMatchInlineSnapshot(`
+    "// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+    exports[\`x 1\`] = \`0\`;
+
+    exports[\`y 1\`] = \`0\`;
+    "
+  `)
+
+  // watch run
+  const { ctx, ...result } = await runVitest(
+    {
+      watch: true,
+      root,
+    },
+  )
+  assert(ctx)
+  onTestFinished(() => {
+    ctx.close()
+  })
+  onTestFailed(() => {
+    console.error(result.vitest.stdout)
+    console.error(result.vitest.stderr)
+  })
+
+  // remove `toMatchSnapshot()` and rerun -> obsolete snapshot
+  editFile(testFile, s => s.replace(/REMOVE-START.*REMOVE-END/s, ''))
+  await result.vitest.waitForStdout('1 obsolete')
+
+  // rerun with update -> remove snapshot
+  await ctx.updateSnapshot()
+  await result.vitest.waitForStdout('1 removed')
+  expect(fs.readFileSync(snapshotFile, 'utf-8')).toMatchInlineSnapshot(`
+    "// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+    exports[\`x 1\`] = \`0\`;
+    "
+  `)
+})

Original file line number	Diff line number	Diff line change
`@@ -937,13 +937,15 @@ export class Vitest {`
`937`	`937`	`// environment is resolved inside a worker thread`
`938`	`938`	`snapshotEnvironment: null as any,`
`939`	`939`	`}`
	`940`	`+ this.snapshot.options.updateSnapshot = 'all'`
`940`	`941`	`}`
`941`	`942`
`942`	`943`	`/**`
`943`	`944`	`* Disable the mode that allows updating snapshots when running tests.`
`944`	`945`	`*/`
`945`	`946`	`public resetSnapshotUpdate(): void {`
`946`	`947`	`delete this.configOverride.snapshotOptions`
	`948`	`+ this.snapshot.options.updateSnapshot = this.config.snapshotOptions.updateSnapshot`
`947`	`949`	`}`
`948`	`950`
`949`	`951`	`/**`