Handle async Remix navigation properly #4839
Closed
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.
Problem:
I believe the Remix tests are flaky for 2 reasons:
the remix router navigate functions are async, and we just call them with
void
in theRemixNavigationContext.back/forward/home
functions. And these are the function which are called in the mouse event handlers of the remix navigation buttons.In the tests we wait for getDispatchFollowUpActionsFinished, but that doesn't really help, because remix navigation does not trigger a dispatch (but it still triggers a rerender, and we have to wait for that)
Fix:
Since it is really hard to expose the event of finishing of the navigation and the rendering, so I just decided to use the
waitFor
helper of react testing library, which can wait for a given timeout until an expectation is true.