[React18] Migrate test suites to account for testing library upgrades security-detection-engine #201149
Conversation
eokoneyo
added
release_note:skip
|
/ci |
…ary owned by security-detection-engine
eokoneyo
force-pushed
the
chore/testing-library-migration-for-security-detection-engine
branch
from
9b0f81d
to
861764d
Compare
|
/ci |
|
Pinging @elastic/security-detection-engine (Team:Detection Engine) |
|
@elasticmachine merge upstream |
…-detection-engine
botelastic
bot
added
the
Team:Fleet
|
Pinging @elastic/fleet (Team:Fleet) |
| } | ||
|
|
||
| try { | ||
| abortCtrl = new AbortController(); |
There was a problem hiding this comment.
won't every new call of saveExceptionItem create a new instance of AbortController?
That would lead to replacing value in abortCtrl and older requests might not be cancelled when component gets unmounted.
There was a problem hiding this comment.
I tried to test this, but turned out this hook is not used anymore in code.
@eokoneyo, would you mind to delete it and associated test? Thanks
There was a problem hiding this comment.
won't every new call of
saveExceptionItemcreate a new instance ofAbortController? That would lead to replacing value inabortCtrland older requests might not be cancelled when component gets unmounted.
Yes every request has it's own AbortController especially that if the component gets unmounted we call abort on the signal passed, in fact this approach is quite similar to the previous implementation with the only difference being that the controller is only initialised when we know that an actual request will be made.
|
@elasticmachine merge upstream |
…-detection-engine
|
@elasticmachine merge upstream |
…-detection-engine
💚 Build Succeeded
Metrics [docs]
History
cc @eokoneyo |
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.