-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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.
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
feat(snapshot): ability to skip snapshot from custom serializer + attest
example
#6852
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hi-ogawa
changed the title
feat(snapshot): ability to skip snapshot from custom serializer
feat(snapshot): ability to skip snapshot from custom serializer + attest example
Nov 5, 2024
✅ Deploy Preview for vitest-dev ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site configuration. |
hi-ogawa
changed the title
feat(snapshot): ability to skip snapshot from custom serializer + attest example
feat(snapshot): ability to skip snapshot from custom serializer + Nov 5, 2024
attest
example
This comment was marked as resolved.
This comment was marked as resolved.
Closing in favor of |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
From my quick research, there are currently two blockers for attest to be able to make use of Vitest snapshot system.
One is that, Vitest snapshot workflow normally expects a watch re-run, for example, for new inline snapshot or when updating failed snapshots. Attest relies on
globalSetup
to trigger analyze once, so this was the issue, but should be solved by #6803 and it looks good now.Secondly, to support
skipType
mode (which is essential to allow running only normal tests without heavy typescript analysis), we'll probably need a concept of "skipped" snapshot check so that Vitest gracefully let invalid attest snapshots pass. This is what PR implements.This approach assumes that attest is kept as 3rd party integration. If it'll end up as core feature, then there might be a way to special case attest usage like
expectAttest().toMatchTypeSnapshot()
, which then implement "skip mode" behavior there instead of doing the magic in serializer level, but I haven't investigate this direction yet.tbd
expectAttest
?attest
in browser mode where fs is not available? (can we send precache result ahead and access it synchronously?)todo
Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
pnpm-lock.yaml
unless you introduce a new test example.Tests
pnpm test:ci
.Documentation
pnpm run docs
command.Changesets
feat:
,fix:
,perf:
,docs:
, orchore:
.