feat: set global timeout in command line argument #8456

ert78gb · 2019-05-12T15:19:34Z

Summary

My motivation is. When I debug the unit tests in IntelliJ and I got a timeout error.
Other's motivation: #6216

I would like to set the timeout to Infinity when jest runner in debug mode if this PR is approved. I like the step by step development

Test plan

I extended the timeout e2e tests with use cases

facebook-github-bot · 2019-05-12T15:19:47Z

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file. In order for us to review and merge your code, please sign up at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need the corporate CLA signed.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

facebook-github-bot · 2019-05-12T15:30:29Z

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

jeysal · 2019-05-12T15:54:49Z

Hey @ert78gb, thanks a lot for tackling one of the most +1ed issues :)
As you'll notice test-jest-circus is failing. We'll need this functionality in jest-circus in addition to jest-jasmine2 - kind of annoying I know but hopefully just as simple as in jasmine2 :)
This should help explain what that's all about.

ert78gb · 2019-05-12T16:01:05Z

Hi @jeysal I will check soon what is in the "circus" :)

ert78gb · 2019-05-12T18:54:09Z

I solved the jest-circus timeout issue, but I don't like the solution.

Maybe would be better if I create an initState function but currently, I recognized only the timeout parameter to pass and the modified file is in the todo-rewrite folder, so when you will rewrite this part of the code I think you will find a better place to initialize the global timeout.

codecov-io · 2019-05-12T19:01:13Z

Codecov Report

Merging #8456 into master will increase coverage by <.01%.
The diff coverage is 57.14%.

@@            Coverage Diff             @@
##           master    #8456      +/-   ##
==========================================
+ Coverage   60.56%   60.56%   +<.01%     
==========================================
  Files         269      269              
  Lines       11045    11051       +6     
  Branches     2690     2694       +4     
==========================================
+ Hits         6689     6693       +4     
- Misses       3770     3772       +2     
  Partials      586      586

Impacted Files	Coverage Δ
packages/jest-jasmine2/src/index.ts	`0% <ø> (ø)`	⬆️
packages/jest-config/src/index.ts	`11.94% <ø> (ø)`	⬆️
packages/jest-config/src/ValidConfig.ts	`100% <ø> (ø)`	⬆️
...us/src/legacy-code-todo-rewrite/jestAdapterInit.ts	`0% <0%> (ø)`	⬆️
packages/jest-jasmine2/src/jasmine/jasmineLight.ts	`0% <0%> (ø)`	⬆️
packages/jest-config/src/normalize.ts	`78.2% <100%> (+0.28%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 44a13e7...bf40692. Read the comment docs.

SimenB · 2019-05-13T09:21:22Z

packages/jest-config/src/normalize.ts

@@ -789,6 +790,11 @@ export default function normalize(
        value = oldOptions[key];
        break;
      }
+      case 'timeout': {
+        value =
+          oldOptions[key] === 0 ? MAX_32_BIT_SIGNED_INTEGER : oldOptions[key];


can we throw if it's 0? I bet 99.99% of the time, that's not what the user wanted.

Should throw if it's <= 0

Maybe even throw if it's more than, say, an hour. I don't see there being any use case for more than an hour, and again, I'd guess it was some calculation gone wrong for the user

I would like to use 0 to represent the infinity timeout. Similar to other test frameworks. I want an infinity timeout when I debugging. I agree most of the time 10 min is more than enough, but there is a few edge case when need an hour.

jasmine always need a DEFAULT_TIMEOUT_INTERVAL value this is the reason why I set it. I use the max possible 32 bit signed value because I would like to avoid the next issue about pls increase the value x+1.

I can implement the <0 error throwing.

@SimenB What is the final statement about the setTimeout = 0 and max value? I would like to implement them in 1 comment

What I'm afraid of is somebody messing up their math or something and having ci use a bajillion years timing out.

I'd rather have -1 mean infinity, 0 seems like a math error to me. I might be alone in that though :)

Why not just require a positive sign number or Infinity.
You can check on infinity and return MAX_32_BIT_SIGNED_INTEGER for jasmine.

Meaning 0 would be instant timeout?

This might be weird for users if other test frameworks default on the 0 = no timeout behaviour.

Is there intentional precedence or just what I'd consider buggy code if (timeout) {setSomeTimeout()} since 0 is falsy? Seems more natural to be explicit using the Infinity global. That doesn't really translate to json or CLI config, though...

I don't feel too strongly here if making 0 mean infinity is something mocha, jasmine, tap, ava or someone else already does

mocha, tap use 0 to represent infinity timeout

jasmine need a positive integer. max 2^32-1 the possible value. Infinity is not option for jasmine

ava has not got default timeout

I am using mocha near 6 years and I never make mistake when I switch off the timeout.

All modern CI listen to /read from the standard output and if no message - mostly in 10 min - it stop the build process.

If everyone search for the option to switch off the timeout then he/she will read the documentation and if 0 is the no timeout option will use it.

I think the current solution 0 = no timeout is match with the industry standard. Jasmine need an exact value so we need to translate the 0 to a big value. The biggest value 2^32-1.

It's up to you what will the final solution, but pls don't overthink a simple problem :)

TestUtils.ts

docs/CLI.md

Removed-5an · 2019-05-22T20:01:40Z

Hello, any chance of getting this PR merged, seems like the requested changes are minor?

ert78gb · 2019-05-22T20:04:24Z

I will do the changes asap if we agree in the final solution. But I have not receive any answer 9 days

SimenB · 2019-05-22T20:07:36Z

@jeysal @thymikee thoughts?

jeysal · 2019-05-23T21:22:55Z

I have all but strong feelings about the meaning of 0 here, which is why I didn't comment on this earlier. Do we have to treat it in a special way at all? What happens if we don't? In my mental model, the config option works by running the test this way:

setTimeout(() => cancelTestIfStillRunning(), config.timeout);
await runTestToCompletionOrCancellation();

So if the test is synchronous or only uses microticks, it's fine.

And a timeout of 1ms seems no less absurd than 0 to me, so why forbid one but not the other.

ert78gb · 2019-06-02T10:20:15Z

I renamed the timeout => testTimeout as you wish.
Please provide an exact requirement for the "no timeout" value (0, -1 or else).
After it, I can implement validation rule(s).

ert78gb · 2019-06-02T10:36:49Z

@jeysal You are right in synchronous tests but, this problem is not related to this issue cli timeout parameter. It is a totally new problem about how to measure the timeouts correctly.

jeysal · 2019-06-03T22:13:21Z

I'd just not treat any numbers in a special way for reasons described in my latest comment and because it's what jest.setTimeout does.

Please provide an exact requirement for the "no timeout" value (0, -1 or else).

Do we absolutely need one? I'm with @SimenB on this, just use --testTimeout 99999999 and you should be fine.

ert78gb · 2019-06-04T05:43:08Z

Ok, then I will remove the special meaning of the 0 and I will add testTimeout < 0 validation

ert78gb · 2019-06-04T20:20:10Z

I removed the 0 special meaning.

jeysal

LGTM, thanks for your patience :)

SimenB

Just some nitpicks, then I think this is good to go. Thanks!

packages/jest-circus/src/legacy-code-todo-rewrite/jestAdapterInit.ts

packages/jest-cli/src/cli/args.ts

docs/CLI.md

packages/jest-jasmine2/src/index.ts

ert78gb · 2019-06-05T19:43:09Z

I think I finished.

roydekleijn · 2019-06-11T21:04:52Z

when will this be released to NPM?

SimenB · 2019-06-11T21:43:28Z

When we make a release (no timeline). We try to prioritize bug fixes, but features are bound to whenever a release happens. However, we'll probably have one last 24 release soonish (again, no timeline)

bergos · 2019-08-02T11:04:23Z

You should fix syncing the docs on the website with the npm releases. When I go to Jest CLI Options it lists the --testTimeout option, also big on the top left version 24.8 is shown but it's not part of that minor version. That can be very confusing.

jeysal · 2019-08-11T17:39:11Z

@bergos thanks for reporting this. Looks like there is nothing wrong on the technical side, just the 24.8 version of the CLI docs being created from the wrong commit. I fixed this particular instance in #8811, hope there's not much else wrong.

github-actions · 2021-05-11T16:08:00Z

This pull request 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.

ert78gb force-pushed the feat-timeout-in-command-line-arg branch from 335d649 to d36815c Compare May 12, 2019 15:22

facebook-github-bot added the cla signed label May 12, 2019

jeysal requested review from SimenB and thymikee May 12, 2019 15:55

SimenB requested changes May 13, 2019

View reviewed changes

SimenB requested a review from scotthovestadt May 13, 2019 09:24

ert78gb added 3 commits June 2, 2019 12:11

feat: set global timeout in command line argument

650c278

feat: set testTimeout of jest-circus state in command line argument

8a7ac7b

refactor: rename timeout to testTimeout

2ea81b9

ert78gb force-pushed the feat-timeout-in-command-line-arg branch from 4488cb9 to 2ea81b9 Compare June 2, 2019 10:12

doc: fix changelog entry

635ddc0

feat: remove 0 special meaning and trow error when timeout is negative

76f120a

ert78gb added 2 commits June 4, 2019 23:01

test: remove invalid e2e test

ef4026a

test: remove invalid e2e test

9bd646d

jeysal approved these changes Jun 4, 2019

View reviewed changes

SimenB approved these changes Jun 4, 2019

View reviewed changes

SimenB requested changes Jun 4, 2019

View reviewed changes

fix: polishes

bf40692

SimenB approved these changes Jun 5, 2019

View reviewed changes

SimenB merged commit 46f9a97 into jestjs:master Jun 5, 2019

ert78gb deleted the feat-timeout-in-command-line-arg branch June 5, 2019 21:08

jeysal mentioned this pull request Aug 11, 2019

remove unreleased --testTimeout feature from versioned_docs #8811

Merged

snyk-bot mentioned this pull request Sep 2, 2019

[Snyk] Upgrade jest from 24.8.0 to 24.9.0 iliutastoica/30-seconds-of-angular#3

Open

Kocal mentioned this pull request Sep 11, 2019

Jest: passing jasmine Timeout in all tests #5247

Closed

snyk-bot mentioned this pull request Dec 15, 2019

[Snyk] Upgrade babel-jest from 24.0.0 to 24.9.0 jakeherp/burger-builder#14

Open

This was referenced Dec 31, 2019

Update jest to the latest version Leko/hothouse#515

Open

Update babel-jest to the latest version Leko/hothouse#529

Open

This was referenced Jan 7, 2020

Update jest to the latest version Leko/hothouse#542

Open

Update babel-jest to the latest version Leko/hothouse#552

Open

Update jest to the latest version Leko/hothouse#560

Open

Update babel-jest to the latest version Leko/hothouse#579

Open

This was referenced Jan 21, 2020

Update jest to the latest version Leko/hothouse#596

Open

Update babel-jest to the latest version Leko/hothouse#606

Open

This was referenced Mar 21, 2020

[Snyk] Upgrade: jest, jest-cli lwojcik/sc2pte-panel-frontend#88

Closed

[Snyk] Upgrade jest from 24.0.0 to 24.9.0 DavidKindler/burger-builder#47

Merged

snyk-bot mentioned this pull request Apr 30, 2020

[Snyk] Upgrade: jest, jest-cli lwojcik/sc2pte-panel-frontend#118

Closed

github-actions bot locked as resolved and limited conversation to collaborators May 11, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: set global timeout in command line argument #8456

feat: set global timeout in command line argument #8456

ert78gb commented May 12, 2019

facebook-github-bot commented May 12, 2019

facebook-github-bot commented May 12, 2019

jeysal commented May 12, 2019

ert78gb commented May 12, 2019

ert78gb commented May 12, 2019

codecov-io commented May 12, 2019 •

edited

Loading

SimenB May 13, 2019

SimenB May 13, 2019

ert78gb May 13, 2019

ert78gb May 16, 2019

SimenB May 22, 2019

Removed-5an May 22, 2019

SimenB May 22, 2019

ert78gb May 22, 2019

Removed-5an commented May 22, 2019

ert78gb commented May 22, 2019

SimenB commented May 22, 2019

jeysal commented May 23, 2019 •

edited

Loading

ert78gb commented Jun 2, 2019

ert78gb commented Jun 2, 2019

jeysal commented Jun 3, 2019

ert78gb commented Jun 4, 2019

ert78gb commented Jun 4, 2019

jeysal left a comment

SimenB left a comment

ert78gb commented Jun 5, 2019

roydekleijn commented Jun 11, 2019

SimenB commented Jun 11, 2019 •

edited

Loading

bergos commented Aug 2, 2019

jeysal commented Aug 11, 2019

github-actions bot commented May 11, 2021

feat: set global timeout in command line argument #8456

feat: set global timeout in command line argument #8456

Conversation

ert78gb commented May 12, 2019

Summary

Test plan

facebook-github-bot commented May 12, 2019

facebook-github-bot commented May 12, 2019

jeysal commented May 12, 2019

ert78gb commented May 12, 2019

ert78gb commented May 12, 2019

codecov-io commented May 12, 2019 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Removed-5an commented May 22, 2019

ert78gb commented May 22, 2019

SimenB commented May 22, 2019

jeysal commented May 23, 2019 • edited Loading

ert78gb commented Jun 2, 2019

ert78gb commented Jun 2, 2019

jeysal commented Jun 3, 2019

ert78gb commented Jun 4, 2019

ert78gb commented Jun 4, 2019

jeysal left a comment

Choose a reason for hiding this comment

SimenB left a comment

Choose a reason for hiding this comment

ert78gb commented Jun 5, 2019

roydekleijn commented Jun 11, 2019

SimenB commented Jun 11, 2019 • edited Loading

bergos commented Aug 2, 2019

jeysal commented Aug 11, 2019

github-actions bot commented May 11, 2021

codecov-io commented May 12, 2019 •

edited

Loading

jeysal commented May 23, 2019 •

edited

Loading

SimenB commented Jun 11, 2019 •

edited

Loading