jest icon indicating copy to clipboard operation
jest copied to clipboard

[Possible regression] jest.setTimeout not honored

Open coodoo opened this issue 4 years ago • 25 comments

After updating to ^27.0.3 this morning, a bunch of previously working tests started to fail, with error messages below:

thrown: "Exceeded timeout of 5000 ms for a test.
    Use jest.setTimeout(newTimeout) to increase the timeout value, if this is a long-running test."

I did have jest.setTimeout(300000) in place and it was working fine before, hence I'm doubting there might be a regression issue here.

As a side note, after adding a global timeout in the jest config the problems went away, hence it's most likely a jest.setTimeout regression, might worth looking into.

coodoo avatar May 31 '21 22:05 coodoo

Hello!

I am currently having the same problem. I tried using jest.setTimeout, testTimeout or even set the timeout on the test but nothing is working...

I had to downgrade jest and babel-jest for now. I downgraded jest to 26.6.3 and babel-jest to 25.5.1. Any version after that broke my tests.

Thank you!

MEsteves22 avatar Jun 01 '21 09:06 MEsteves22

I believe setTimeout is not being mocked correctly in Jest 27. I'm finding that

it('mocks setTimeout correctly', () => {
  jest.useFakeTimers()
  setTimeout(() => {}, 1000)
  expect(setTimeout).toHaveBeenCalled()
})

gives

Error: expect(received).toHaveBeenCalled()

Matcher error: received value must be a mock or spy function

Received has type:  function
Received has value: [Function setTimeout]

s100 avatar Jun 01 '21 10:06 s100

I'm seeing the same thing with [email protected]

The new default "modern" timer mocking works as expected. However asserting expect(setTimeout).toHaveBeenCalled... reports the [Function setTimeout] as stated by @s100

Reverting to the legacy timer mocks works ok, e.g.

it('mocks setTimeout correctly', () => {
  jest.useFakeTimers('legacy')
  setTimeout(() => {}, 1000)
  expect(setTimeout).toHaveBeenCalled()
})

johnhunter avatar Jun 02 '21 17:06 johnhunter

I think its due to fact that modern timers use sinon fake timers and jest does not see it as proper mock where legacy timers were created by jest, but not sure if that is the case

Smrtnyk avatar Jun 02 '21 17:06 Smrtnyk

@Smrtnyk That fits with what I'm seeing.

If modern timers are not going to conform to the mock signature then the documentation should be updated to reflect it. The Timer Mocks documentation for v26 recommends using the failing approach. https://jestjs.io/docs/timer-mocks

johnhunter avatar Jun 03 '21 07:06 johnhunter

Since this issue is labeled "needs repro", I'm going to point to a related issue with a repro: https://github.com/facebook/jest/issues/11543

AlCalzone avatar Jun 24 '21 07:06 AlCalzone

We saw this as well with jest.setTimeout for our tests when migrating from 26 -> 27. We had only one particularly long running test and so we were calling that function within the test body to increase the timeout default. (As the CLI suggests!)

We have migrated to passing the timeout argument to the test directly as the trailing argument as well as the afterEach and it appears to have resolved the issue.

jackson-stone-ableto avatar Oct 29 '21 17:10 jackson-stone-ableto

Hello, everyone. I moved jest.setTimeout(600000) to top level and I have an timeout error 600ms. are there any solution for this issue? Thanks so much.

TimeoutError: Element .breadcrumb-container not found waiting for function failed: timeout 600ms exceeded

txeto90 avatar Nov 04 '21 10:11 txeto90

looks like if you use sinon-fake-timers directly, it somehow collides with jest.setTimeout and the tests are failing.

Niryo avatar Dec 28 '21 17:12 Niryo

I have the same issue, is there any plan to fix that?

ppamorim avatar Jan 19 '22 06:01 ppamorim

Just ran into this and it's now holding up an upgrade for us too.

jeffersoneagley avatar Jan 25 '22 21:01 jeffersoneagley

I'm having the same issue with jest.setTimeout not working. Jest version in package.json is ^27.4.5

ceoworks avatar Jan 27 '22 12:01 ceoworks

@ceoworks Migrate to the timeout at the it(...) definition.

ppamorim avatar Jan 27 '22 23:01 ppamorim

Hello!

I am currently having the same problem. I tried using jest.setTimeout, testTimeout or even set the timeout on the test but nothing is working...

I had to downgrade jest and babel-jest for now. I downgraded jest to 26.6.3 and babel-jest to 25.5.1. Any version after that broke my tests.

Thank you!

I'm having this issue currently. Have you been able to solve it without having to downgrade?

AmosSpark avatar May 17 '22 13:05 AmosSpark

Got the same issue updating from jest@26 to jest@^28.1.0. Sorry if I sound entitled, but how is this still an issue a year (and a major version) after the original report of this issue?

bertrand-caron avatar May 20 '22 22:05 bertrand-caron

Maybe try Sinon?

s100 avatar May 23 '22 09:05 s100

Maybe try Sinon?

So I'm following this tutorial (sinon implementation @11:00) and still got issues.

  1. clock = FakeTimers.install ();
  • gave me an error: cannot assign read only property 'performance' of object '#<object>'
  1. I changed to clock = FakeTimers.createClock ();
  • got the original errror: thrown: "Exceeded timeout of 5000 ms for a test. Use jest.setTimeout(newTimeout) to increase the timeout value, if this is a long-running test."

Although I'm testing a rest api endpoint that finds an item by id (findById).

Do you have any idea of how to go about it? Tried every supposed solution.

AmosSpark avatar May 23 '22 18:05 AmosSpark

Any solution for this? Im using jest at 29.0.2 version and facing the same issue. Even using jest.setTimeout or passing testTimeout in jest.config.js, nothing solves it.

matheustrres avatar Sep 14 '22 20:09 matheustrres

Any solution for this? Im using jest at 29.0.2 version and facing the same issue. Even using jest.setTimeout or passing testTimeout in jest.config.js, nothing solves it.

Are you using custom global error handlers?

For me, I had to do away with my global error handlers in the app.js file.

AmosSpark avatar Sep 15 '22 11:09 AmosSpark

Any solution for this? Im using jest at 29.0.2 version and facing the same issue. Even using jest.setTimeout or passing testTimeout in jest.config.js, nothing solves it.

Are you using custom global error handlers?

For me, I had to do away with my global error handlers in the app.js file.

Not really, im just creating it and receiving these error. By the way, instead of "Exceeded timeout of 5000 ms for a test." i receive "[...] for a hook".

matheustrres avatar Sep 15 '22 14:09 matheustrres

Any solution for this? Im using jest at 29.0.2 version and facing the same issue. Even using jest.setTimeout or passing testTimeout in jest.config.js, nothing solves it.

Are you using custom global error handlers? For me, I had to do away with my global error handlers in the app.js file.

Not really, im just creating it and receiving these error. By the way, instead of "Exceeded timeout of 5000 ms for a test." i receive "[...] for a hook".

Could you share the hosted link?

AmosSpark avatar Sep 16 '22 09:09 AmosSpark

As of jest 29 legacy timers no longer seem to work. Did I miss that in the release notes?

jest.useFakeTimers('legacy')
...
console.log(setTimeout.mock.calls); // -> undefined

johnhunter avatar Sep 16 '22 12:09 johnhunter

The API has changed since Jest 28. See Upgrade Guide: https://jestjs.io/docs/28.x/upgrading-to-jest28#fake-timers

mrazauskas avatar Sep 16 '22 12:09 mrazauskas

As of jest 29 legacy timers no longer seem to work. Did I miss that in the release notes?

So adding a separate spy to the non-legacy fake timer seems to work:

jest.useFakeTimers();
jest.spyOn(global, 'setTimeout');

johnhunter avatar Sep 16 '22 13:09 johnhunter

Yep. Just as documented here: https://jestjs.io/docs/timer-mocks

mrazauskas avatar Sep 16 '22 13:09 mrazauskas

This issue is stale because it has been open for 1 year with no activity. Remove stale label or comment or this will be closed in 30 days.

github-actions[bot] avatar Sep 16 '23 14:09 github-actions[bot]

This issue was closed because it has been stalled for 30 days with no activity. Please open a new issue if the issue is still relevant, linking to this one.

github-actions[bot] avatar Oct 16 '23 14:10 github-actions[bot]

Feels like a rather large bug which will negatively affect people who use Jest for testing UI where tests can easily exceed 5 seconds.

MattyBalaam avatar Oct 16 '23 14:10 MattyBalaam

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.

github-actions[bot] avatar Nov 16 '23 00:11 github-actions[bot]