Async setupFiles

[grydstedt]

It would be useful to be able to wait for an asynchronous completion of a setupFiles module before starting tests. Is there a way to do that?

[cpojer]

This is not possible. Can you elaborate on why you'd like to do this?

[grydstedt]

I see, thanks. Just a an async function that preps the test environment that I can't make synchronous unfortunately.

[cpojer]

I don't think we'll support this as it makes everything dealing with the setup a bit more messy.

The way I would suggest to work around this is something like this in your setupFile:

global.it = function(description, fn) {
  pit(description, () => {
    // Assuming it is a promise
    return loadEnvironmentAsync().then(
      () => fn()
    )
  });
}

This will make everyone of your tests async. If you are not using pit you can use it instead (by doing const it = global.it; beforehand to save the jasmine function before). Then you have to use the done flag to work with async operations.

Let me know if this isn't a satisfying solution

[jasonkuhrt]

I just hit a use-case for this where I needed to do some async logic to determine which host the test suite should be running against. I will rework my solution to have the script expose data in an ENV variable for now. Would have been nice to have this though : )

[jasonkuhrt]

Oh amazing #3832 (comment).

Thanks @xfumihiro!!

[xfumihiro]

@jasonkuhrt happy coding! 😄

[spencerwilson]

See also: #11038

tl;dr Using ES modules, there's early support for awaiting async effects in setupFiles (and probably setupFilesAfterEnv, too). Might be a simpler option for some, compared to supplying a custom testEnvironment with an async setup method.

[github-actions]

This issue has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.
Please note this issue tracker is not a help forum. We recommend using StackOverflow or our discord channel for questions.