Fix infinite loop during unit testing #154
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
In unit testing measuring dimensions is impossible, so toast height evaluates to `0`, which causes Toaster to endlessly recompute the height and update the store. Instead we're being more specific and checking whether height is `undefined`, and memoizing the ref so that it isn't being called on every render. This also required other tweaks like properly memoizing handlers like `updateHeight` so that they can be used as hook dependencies. (We only needed `updateHeight` to be memoized, though.)
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/timo/react-hot-toast/EgN8uEsGqf7egSW79PcVxsV6fgZR |
silvenon
commented
Feb 14, 2022
| ) => { | ||
| const { reverseOrder = false, gutter = 8, defaultPosition } = | ||
| opts || {}; | ||
| const startPause = useCallback(() => { |
There was a problem hiding this comment.
I memoized all of these handlers individually because I needed updateHeight to be properly memoized instead of changing every time one of the other handlers change.
|
@timolins could you or whoever is maintaining the repo review this please? 🙏 |
|
Review 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.
Fixes #107.
During unit testing Toaster is being updated infinitely because it's waiting for height of toast messages to be truthy, which will never happen in
jsdombecause it's not possible to measure elements there, so it always returns0.react-hot-toast/src/components/toaster.tsx
Lines 84 to 88 in c5e5935
This part is now more specific, it checks whether the height is a number or not, which includes
0, and in addition with some memoizations it no longer causes an infinite loop. I added a test to verify this.The only remaining tricky part is that immediately dismissing the toast doesn't work because the store is yet to be updated with the toast height, which clears the toast message from the remove queue, so I worked around this by adding
aria-hiddento the close button until the height has been initialized, so that I have something to wait for before I dismiss the toast message.People testing
react-hot-toastwill also have to do something like this if they want to close immediately after opening.