[React18] Migrate test suites to account for testing library upgrades security-entity-analytics #201178
+29
−33
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
eokoneyo
added
release_note:skip
|
/ci |
eokoneyo
force-pushed
the
chore/testing-library-migration-for-security-entity-analytics
branch
from
3aec23a to
ca64f75
Compare
|
/ci |
|
Pinging @elastic/security-entity-analytics (Team:Entity Analytics) |
|
@elasticmachine merge upstream |
1 similar comment
|
@elasticmachine merge upstream |
|
@elasticmachine merge upstream |
1 similar comment
|
@elasticmachine merge upstream |
hop-dev
approved these changes
Dec 9, 2024
|
@elasticmachine merge upstream |
4 similar comments
|
@elasticmachine merge upstream |
|
@elasticmachine merge upstream |
|
@elasticmachine merge upstream |
|
@elasticmachine merge upstream |
…ary owned by security-entity-analytics
eokoneyo
force-pushed
the
chore/testing-library-migration-for-security-entity-analytics
branch
from
8df8789 to
1d07dce
Compare
|
@elasticmachine merge upstream |
…-entity-analytics
|
@elasticmachine merge upstream |
…-entity-analytics
💚 Build Succeeded
Metrics [docs]
History
cc @eokoneyo |
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.
This PR migrates test suites that use
renderHookfrom the library@testing-library/react-hooksto adopt the equivalent and replacement ofrenderHookfrom the export that is now available from@testing-library/react. This work is required for the planned migration to react18.Context
In this PR, usages of
waitForNextUpdatethat previously could have been destructured fromrenderHookare now been replaced withwaitForexported from@testing-library/react, furthermorewaitForthat would also have been destructured from the same renderHook result is now been replaced with
waitForfrom the export of@testing-library/react.Why is
waitFora sufficient enough replacement forwaitForNextUpdate, and better for testing values subject to async computations?WaitFor will retry the provided callback if an error is returned, till the configured timeout elapses. By default the retry interval is
50mswith a timeout value of1000msthateffectively translates to at least 20 retries for assertions placed within waitFor. See https://testing-library.com/docs/dom-testing-library/api-async/#waitfor for more information.
This however means that for person's writing tests, said person has to be explicit about expectations that describe the internal state of the hook being tested.
This implies checking for instance when a react query hook is being rendered, there's an assertion that said hook isn't loading anymore.
In this PR you'd notice that this pattern has been adopted, with most existing assertions following an invocation of
waitForNextUpdatebeing placed within awaitForinvocation. In some cases the replacement is simply a
waitFor(() => new Promise((resolve) => resolve(null)))(many thanks to @kapral18, for point out exactly why this works),where this suffices the assertions that follow aren't placed within a waitFor so this PR doesn't get larger than it needs to be.
It's also worth pointing out this PR might also contain changes to test and application code to improve said existing test.
What to do next?
Any questions?
If you have any questions or need help with this PR, please leave comments in this PR.