[Feature]: Explicitly mention that test is failing because done() is not being called

[daanklijn]

🚀 Feature Proposal

Currently, when using the done callback the test will fail with a timeout if done is never called. I believe that this test failure is not explicit enough. We should instead also mention that this timeout occurred because the done callback was never called.

Motivation

I believe it should be obvious why a test is failing. I therefore believe there is added value in letting the user know that a test is failing because the done callback was never called.

Example

Current behaviour:

test("1+1 equals 2", (done) => {
  expect(1 + 1).toBe(2);
});

>>>

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

Proposed behaviour:

test("1+1 equals 2", (done) => {
  expect(1 + 1).toBe(2);
});

>>>

Exceeded timeout of 5000 ms while waiting for done to be called. 
Use jest.setTimeout(newTimeout) to increase the timeout value, if this is a long-running test

Pitch

See motivation.

[daanklijn]

This is great! Thanks @lpizzinidev!

[SimenB]

https://github.com/facebook/jest/releases/tag/v29.4.2

[DercilioFontes]

Hi guys,

I am getting an error that is very common to happen in the CI pipeline with the message:

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

It took a while to understand what "testfalse" meant. The test was negative (passed), but it timed out!? Googling gives nothing. 😅

I searched in the jest code and found that:

// node_modules/jest-circus/build/utils.js
// line 208
const _makeTimeoutMessage = (timeout, isHook, takesDoneCallback) =>
  `Exceeded timeout of ${(0, _jestUtil.formatTime)(timeout)} for a ${
    isHook ? 'hook' : 'test'
  }${
    takesDoneCallback && ' while waiting for `done()` to be called'
  }.\nUse jest.setTimeout(newTimeout) to increase the timeout value, if this is a long-running test.`;

So, the change from this issue creates the word "testfalse" when the takesDoneCallback is false.

It was very confusing for me. Maybe it could be good to change it to avoid creating this testfalse.

[SimenB]

yep! wanna send a PR? Just changing takesDoneCallback && ' while waiting for `done()` to be called' to takesDoneCallback ? ' while waiting for `done()` to be called' : '' should do it

[DercilioFontes]

@SimenB, sure! I can do it. I'll send it. Thanks for your feedback.

[DercilioFontes]

Hi @SimenB,

I sent the PR (#13954)

[SimenB]

https://github.com/facebook/jest/releases/tag/v29.5.0

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