✅ DOP-4302 handles test with lazy loading a component

[caesarbell]

Stories/Links:

DOP-4302

Current Behavior:

Flaky test

Staging Links:

Passing test

Notes:

It seems according to Jest's test method documentation, there is a way of making a test wait for the promise to resolve before letting the test complete.

In our case, the solution is to return the promise from the waitFor async function from RTL. Since this test now waits for the promise to resolve, we can remove the optional timeout.

[caesarbell]

I re-ran the jobs about three times, each one passing, assuming that would be equivalent to pushing up multiple commits to trigger the builds. Each time, the test passes.

To be extra sure, I even pushed up an empty commit, to trigger the builds to see if tests contniue to pass.

[mmeigs]

TIL about returning waitFor would be the magic bullet. But wondering if that means we still need the timeout or no?

[mmeigs]

^ btw, I'm totally fine with it!! Just wondering if it's necessary.

[caesarbell]

@mmeigs good point. I know we don't need the test method's option timeout param, however, the timeout option is still needed for the waitFor method. waitFor runs the callback a number of times until the timeout is reached, and the default value is 1000ms. In our use case we need 8000ms, but we won't need to set the timeout in the test method.