Add timeouts to test.each implementations

[carusology]

🚀 Feature Proposal

As of right now, you can set the timeout for an individual test() invocation by setting the timeout parameter to the number of milliseconds you want a test to run. It is well documented here. However, that functionality is lacking for test.each(). I propose that test.each() is updated such that if you pass a timeout to its third argument, it sets a timeout for each iteration of the test as it does for the individual test().

Motivation

The consumer of Jest will have a more consistent API for test() and test.each() implementations, where the latter is merely a parameterized version of the former.

Example

I have an integration test that converts pdfs into images at various "chunk sizes", ensuring that only a specific number of pages are being converted at a time in order to prevent the conversion process from consuming too many resources. However, the end result should always be the same regardless of "chunk size." This particular test requires converting images and regularly takes more than 5 seconds. It should take less time than my failure cases which should return almost instantly.

test.each([ 1, 2, 3, 4, 5 ])
  ('resolves for chunk sizes of "%p"', async (chunkSize) => {

    // Arrange

    let converter = new ImageConverter(...);
    let expected = [ { ... pageOne ... }, { ... pageTwo ... } ];

    // Act

    let actual = converter.convert(options);

    // Assert

    expect.assertions(1);
    await expect(actual).resolves.toEqual(expected);
  }, 10000 /* The timeout is now 10s instead of 5s for each iteration of test.each */
);

Pitch

(Why does this feature belong in the Jest core platform?)

It already exists within the Jest core platform! :) I actually expected it to be there when I worked with the framework. Today, since there is no error if you set the timeout on a test.each implementation, Jest fails with a timeout of 5s as it does by default, and you have to look at the documentation to see that it actually isn't supported for parameterized tests as it is for individual ones. I think this is a clear cut situation where expectations and reality clash.

[SimenB]

We have an open PR for this 🙂 #6660

[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.