fix(snapshot)!: reset snapshot state for retry and repeats

[hi-ogawa]

Description

• closes Test after retry should check the same snapshot, not create a new one #5312
• closes --retry=2 gives wrong error: toMatchInlineSnapshot cannot be called multiple times at the same location #6589

todo

• inline
• file
• multiple tests with same title
• added/updated stats
• tests
• should we make @vitest/snapshot non breaking?
  • I changed SnapshotClient interface a lot to simplify the concept, but it's probably possible to make it non-breaking by keeping testId optional.
• review @vitest/snapshot usage in the wild to see if new API is not bad.

I have an attempt to support different snapshot files per test in #6827, but I need to think a bit more to validate the idea and we should separate it from this fix.

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

• It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
• Ideally, include a test that fails without this PR but passes with it.
• Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

• Run the tests with pnpm test:ci.

Documentation

• If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

• Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

[netlify]

✅ Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	eae4ed7
🔍 Latest deploy log	https://app.netlify.com/sites/vitest-dev/deploys/67286f50949dd30008bc6ca8
😎 Deploy Preview	https://deploy-preview-6817--vitest-dev.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[sheremet-va]

Looks very good! But we would have to release it as a breaking change (@vitest/snapshot is a public API and SnapshotState is exposed on expect.getState() - there are jest's custom matchers that rely on the jest interface)

[sheremet-va]

Can we maybe make it more presentable here, too? Since snapshot manager is a public API (even used in webdriverio, I think). Something like The snapshot state for ${file} was not initialised. Did you call manager.setup()?

[hi-ogawa]

Only 7 users on public 😃 https://www.npmjs.com/package/@vitest/snapshot?activeTab=dependents I'll check what webdriverio does and see if new API fits them.

[hi-ogawa]

I briefly reviewed expect-webdriverio's usage and new API should look okay.

• SnapshotClient.startCurrentRun, SnapshotClient.finishCurrentRun https://github.com/webdriverio/expect-webdriverio/blob/fc4624d6484af5eeabcdd87c38ca3aea0c9e7ff5/src/snapshot.ts#L79-L91
• SnapshotClient.assert https://github.com/webdriverio/expect-webdriverio/blob/fc4624d6484af5eeabcdd87c38ca3aea0c9e7ff5/src/matchers/snapshot.ts#L49-L53

Webdriverio doesn't seem to have testId, but they can reuse the test name for this like SnapshotClient.assert({ ..., name: testName, testId: testName}). One consideration for us is that maybe we can make testId optional on our side with name fallback automatically since this is only used for SnapshotClient.clearTest(file, testId).

[ffMathy]

This is awesome. Could solve: #7011

Anything I can do to help get this out somehow? What's missing?

[hi-ogawa]

This is a breaking change, so unfortunately we have to wait until next major v3.

[ffMathy]

Oh okay. How often do major releases like this release? Are we talking years, or is there a chance we'll see this in H1 of 2025?

[sheremet-va]

Oh okay. How often do major releases like this release? Are we talking years, or is there a chance we'll see this in H1 of 2025?

You won't believe it. Vitest 3 comes out in January.

[ffMathy]

Hahahaha ❤️
That's awesome!