feat(test-utils): work with either jest or vitest
#5692
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
Follow-up to #5690. Changes `@votingworks/test-utils` to look for either a `jest` global or import from `vitest`, mostly for creating mock functions (i.e. `fn`). For simplicity, keeps the `jest` API for mock functions because they're so similar (but not actually TS-compatible). The possibility of `import`ing whenever we call `fn` within `test-utils` means that anything that creates a momck function now needs to be async. This isn't awesome and it caused a bunch of changes in other packages, but I think it's worth it to allow the `jest` → `vitest` migration to occur in pieces.
eventualbuddha
commented
Dec 5, 2024
| console[method]('test'); | ||
| expect(console[method]).toHaveBeenNthCalledWith(1, 'test'); | ||
| }); | ||
| expect('mock' in console[method]).toEqual(false); |
There was a problem hiding this comment.
This may still be true with vitest, but felt like testing an implementation detail. Replaced it with what we actually care about.
eventualbuddha
commented
Dec 5, 2024
| expect('mock' in console.log).toEqual(false); | ||
| }); | ||
|
|
||
| test('suppressingConsoleOutput throws the error thrown by the callback', () => { |
There was a problem hiding this comment.
Now that suppressingConsoleOutput always returns a Promise, this test is redundant.
eventualbuddha
commented
Dec 5, 2024
Comment on lines
-141
to
+147
| jest.spyOn(console, 'log').mockRestore(); | ||
| jest.spyOn(console, 'warn').mockRestore(); | ||
| jest.spyOn(console, 'error').mockRestore(); | ||
| logSpy.mockRestore(); | ||
| warnSpy.mockRestore(); | ||
| errorSpy.mockRestore(); |
There was a problem hiding this comment.
Seeming behavior difference: jest uses the original spy with this second spyOn call, then restores it. vitest seems to replace the first spy with a second spy, then immediately restores back to the first spy.
None of the tests actually require a DOM, so this simplifies the test setup.
For some reason this causes `vitest` to fail and report almost all coverage as 0.
|
Closing in favor of #5703. |
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.
Overview
Follow-up to #5690.
Changes
@votingworks/test-utilsto look for either ajestglobal or import fromvitest, mostly for creating mock functions (i.e.fn). For simplicity, keeps thejestAPI for mock functions because they're so similar (but not actually TS-compatible). The possibility ofimporting whenever we callfnwithintest-utilsmeans that anything that creates a mock function now needs to be async. This isn't awesome and it caused a bunch of changes in other packages, but I think it's worth it to allow thejest→vitestmigration to occur in pieces.Demo Video or Screenshot
n/a
Testing Plan
Automated tests.