EditPostPreferencesModal: fix intermittently failing tests #53814
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
jsnajdr
added
[Type] Bug
jsnajdr
commented
Aug 18, 2023
| ).toMatchSnapshot(); | ||
| } ); | ||
| it( 'small viewports', async () => { | ||
| useSelect.mockImplementation( () => [ true, true, false ] ); | ||
| useViewportMatch.mockImplementation( () => false ); | ||
| render( <EditPostPreferencesModal /> ); | ||
| expect( | ||
| await screen.findByRole( 'dialog', { name: 'Preferences' } ) |
There was a problem hiding this comment.
For small viewports, the modal uses the Navigator* components instead of TabPanel. The UI is completely synchronous, and the test doesn't need to await.
|
Size Change: 0 B Total Size: 1.51 MB ℹ️ View Unchanged
|
|
I've noticed this test still appears to fail intermittently on PRs. To reproduce, if I run the following locally on 
Would it be worth us trying to add in a tiny delay to compensate for the |
|
Removing
This seems like a good option to me. Just looking at the component, do we really need a snapshot to check that the viewport rendering works? Seems like we could test for visibility on a few of the main elements. |
I've done that here just in case folks agree: |
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 unit tests that started failing randomly since #52133. See #52133 (comment) for details.
The fix makes sure that we wait until the default tab (General) is selected, before comparing rendered markup with the snapshot.
The selection is not done on initial render, but is delayed until some effects and rAFs are flushed. The symptoms is that
tabindexand sometimes alsodata-active-itemattributes on the<button role="tab">elements don't match.It can be tracked down to Ariakit's
useCompositeItemhook, where theisTabbablevalue takes some time to settle on the expected value.