jest: Defining test timeout as a config parameter

🚀 Feature Proposal

I’d like to propose introducing a new config parameter config called timeout, that would accept a number or a string.

Motivation

To set a global timeout different than Jest’s default, one must use a setupTestFrameworkScriptFile config and create a new file. This is a bit cumbersome, isn’t it?

It would also play nice with the API we have for already: jest.setTimeout(number).

Example

"jest": {
  "timeout": 60000
}

Pitch

Why does this feature belong in the Jest core platform?

It is a config change, duh.

About this issue

Original URL
State: closed
Created 6 years ago
Reactions: 93
Comments: 18 (8 by maintainers)

Most upvoted comments

Having a flag like ‘disable timeouts’ on the cli to help debugging makes more sense to me than being able to set a timeout

+35

SimenB on Jun 7, 2018

I can’t believe this doesn’t exist? How is it even possible to use a step debugger if every test times out after 5s?

+21

felixfbecker on Feb 17, 2019

Anyone working on this issue? If no, I pick up.

+12

ert78gb on May 12, 2019

@SimenB @krzkaczor so we could have a single --timeout flag that would take a number or Infinity for no-timeout at all, what do you think?

thymikee on Mar 15, 2019

Yes and it is landed in 24.9.0

ert78gb on Sep 23, 2019

I think that users should be able to:

make timeout part of the config. Can be useful when all tests are expected to be slow (imagine using jest to drive e2e tests)
provide timeout as CLI parameter / disable timeouts - mostly useful when working with the debugger.

@thymikee what do you think about it? I can try implementing these.

krzkaczor on Mar 15, 2019

@ert78gb Is this issue covered by your PR?

MajorBreakfast on Sep 23, 2019

@thymikee I think 0 is more obvious (mocha does it as well).

krzkaczor on Mar 15, 2019

@bluedusk you can always just drop somewhere jest.setTimeout(2137*1000); or something similar.

krzkaczor on Mar 15, 2019

Could this parameter be added to the CLI as well? Reason for this is that when I use a debugger to step through code, I would like to set it to infinite (or very high). But I don’t want to change this setting in our config, because then this change might be committed by accident…

Or is it possible to point to a different config via another cli parameter?

restfulhead on Jun 6, 2018

Makes sense. Should the name be testTimeout or something to be clear this is not a global test suite timeout, but per test?

SimenB on May 21, 2018