fix(vitest): initialize snapshot state only once for each file suite (#4796)

Author: hi-ogawa

packages/vitest/src/runtime/runners/test.ts

@@ -27,15 +27,15 @@ export class VitestTestRunner implements VitestRunner {
     this.snapshotClient.clear()
   }
 
-  async onAfterRunFiles() {
-    const result = await this.snapshotClient.finishCurrentRun()
-    if (result)
-      await rpc().snapshotSaved(result)
-  }
-
-  onAfterRunSuite(suite: Suite) {
+  async onAfterRunSuite(suite: Suite) {
     if (this.config.logHeapUsage && typeof process !== 'undefined')
       suite.result!.heap = process.memoryUsage().heapUsed
+
+    if (suite.mode !== 'skip' && typeof suite.filepath !== 'undefined') {
+      const result = await this.snapshotClient.finishCurrentRun()
+      if (result)
+        await rpc().snapshotSaved(result)
+    }
   }
 
   onAfterRunTask(test: Test) {
@@ -63,14 +63,20 @@ export class VitestTestRunner implements VitestRunner {
     }
 
     clearModuleMocks(this.config)
-    await this.snapshotClient.startCurrentRun(test.file!.filepath, name, this.workerState.config.snapshotOptions)
 
     this.workerState.current = test
   }
 
-  onBeforeRunSuite(suite: Suite) {
+  async onBeforeRunSuite(suite: Suite) {
     if (this.cancelRun)
       suite.mode = 'skip'
+
+    // initialize snapshot state before running file suite
+    if (suite.mode !== 'skip' && typeof suite.filepath !== 'undefined') {
+      // default "name" is irrelevant for Vitest since each snapshot assertion
+      // (e.g. `toMatchSnapshot`) specifies "filepath" / "name" pair explicitly
+      await this.snapshotClient.startCurrentRun(suite.filepath, '__default_name_', this.workerState.config.snapshotOptions)
+    }
   }
 
   onBeforeTryTask(test: Test) {

test/snapshots/test-update/inline-test-template-concurrent.test.js

@@ -0,0 +1,13 @@
+import { it } from 'vitest'
+
+it.concurrent('1st', ({ expect }) => {
+  expect('hi1').toMatchInlineSnapshot(`"hi1"`)
+})
+
+it.concurrent('2nd', ({ expect }) => {
+  expect('hi2').toMatchInlineSnapshot(`"hi2"`)
+})
+
+it.concurrent('3rd', ({ expect }) => {
+  expect('hi3').toMatchInlineSnapshot(`"hi3"`)
+})

test/snapshots/test/__snapshots__/shapshots-concurrent-sync.test.ts.snap

@@ -0,0 +1,7 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`concurrent suite > snapshot 1`] = `
+Object {
+  "foo": "bar",
+}
+`;

test/snapshots/test/__snapshots__/shapshots.test.ts.snap

@@ -1,5 +1,22 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
+exports[`concurrent snapshot update 1`] = `
+"import { it } from 'vitest'
+
+it.concurrent('1st', ({ expect }) => {
+  expect('hi1').toMatchInlineSnapshot(\`"hi1"\`)
+})
+
+it.concurrent('2nd', ({ expect }) => {
+  expect('hi2').toMatchInlineSnapshot(\`"hi2"\`)
+})
+
+it.concurrent('3rd', ({ expect }) => {
+  expect('hi3').toMatchInlineSnapshot(\`"hi3"\`)
+})
+"
+`;
+
 exports[`js snapshots generated correctly 1`] = `
 "import { describe, expect, test } from 'vitest'
 

test/snapshots/test/shapshots-concurrent-sync.test.ts

@@ -0,0 +1,10 @@
+import { describe, it } from 'vitest'
+
+// from https://github.com/vitest-dev/vitest/issues/3361
+describe.concurrent('concurrent suite', () => {
+  it('snapshot', ({ expect }) => {
+    expect({ foo: 'bar' }).toMatchSnapshot()
+  })
+
+  it('empty test')
+})

test/snapshots/test/shapshots.test.ts

@@ -44,3 +44,9 @@ test('js snapshots generated correctly', async () => {
   const content = await fs.readFile(path, 'utf8')
   expect(content).toMatchSnapshot()
 })
+
+test('concurrent snapshot update', async () => {
+  const path = pathe.resolve(__dirname, '../test-update/inline-test-template-concurrent.test.js')
+  const content = await fs.readFile(path, 'utf8')
+  expect(content).toMatchSnapshot()
+})

test/snapshots/tools/generate-inline-test.mjs

@@ -15,4 +15,8 @@ const template = resolve(dir, './inline-test-template.js');
 
 (async () => {
   await generateInlineTest(template, filepath)
+  await generateInlineTest(
+    resolve(dir, './inline-test-template-concurrent.js'),
+    resolve(dir, '../test-update/inline-test-template-concurrent.test.js'),
+  )
 })()

test/snapshots/tools/inline-test-template-concurrent.js

@@ -0,0 +1,13 @@
+import { it } from 'vitest'
+
+it.concurrent('1st', ({ expect }) => {
+  expect('hi1').toMatchInlineSnapshot()
+})
+
+it.concurrent('2nd', ({ expect }) => {
+  expect('hi2').toMatchInlineSnapshot()
+})
+
+it.concurrent('3rd', ({ expect }) => {
+  expect('hi3').toMatchInlineSnapshot()
+})