fix: configure dom-testing-library to flush Svelte changes #439
Conversation
This file contains hidden or 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
mcous force-pushed the fix/user-event-act branch 3 times, most recently from d8edb3b to 2230452 Compare 
mcous commented May 16, 2025
| 🎉 This PR is included in version 5.2.8 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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
While working on new examples for Svelte 5, I found a problem with this library's interop with
@testing-library/user-event- depending on project setup,await user.click()et. al. does not wait for Svelte to flush changes.We were missing a call to
configureto@testing-library/domto configure theeventWrapper(forfireEvent) andasyncWrapper(foruser-event) options. This fixes the issue foruser-event, and happily, removes the need for an async re-export offireEventonce we're able to drop Svelte 3/4, thanks to the newflushSyncexport fromsvelteRelated (old) issue: #250
Change log
setupfunction to complementcleanupfunction that calls@testing-library/dom::configurewithtickandflushSyncsetupintobeforeEachfor Jest and Vitest