[test] Use vitest's userEvent implementation in browser tests
#1314
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
✅ Deploy Preview for base-ui ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
michaldudak
commented
Jan 9, 2025
| @@ -65,15 +65,15 @@ describe('<Accordion.Root />', () => { | |||
| expect(trigger).to.have.attribute('aria-expanded', 'false'); | |||
| expect(queryByText(PANEL_CONTENT_1)).to.equal(null); | |||
|
|
|||
| await user.pointer({ keys: '[MouseLeft]', target: trigger }); | |||
| await user.click(trigger); | |||
There was a problem hiding this comment.
Vitest doesn't have the pointer method but clicks should work the same way in these cases
| <Dialog.Trigger>Trigger 1</Dialog.Trigger> | ||
| <Dialog.Portal> | ||
| <Dialog.Popup data-testid="popup1"> | ||
| <button onClick={() => setShowNested(!showNested)}>toggle</button> |
There was a problem hiding this comment.
Vitest functions are more strict about visibility and accessibility of the element to interact with.
| const result = await originalRender(element, options); | ||
| await flushMicrotasks(); | ||
| return result; | ||
| }); | ||
|
|
||
| if (!isJSDOM) { | ||
| const { userEvent: vitestUserEvent } = await import('@vitest/browser/context'); |
There was a problem hiding this comment.
This must be imported dynamically as the static import fails when executed outside of the browser environment.
michaldudak
commented
Jan 9, 2025
| } | ||
|
|
||
| return async (...args: unknown[]) => { | ||
| await act(async () => target[prop](...args)); |
There was a problem hiding this comment.
This isn't ideal. Perhaps we could change the implementation of act to no-op when running in the browser and get rid of this.
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.
Vitest docs don't recommend using React Testing Library's
userEventin browser tests (see the warning box in https://vitest.dev/guide/browser/#examples).This PR changes the imported library depending on the environment in which the tests run.