feat: fail tests when multiple done() calls are made

[flozender]

Summary

Aims to close #7052.

When done() is called more than once, the test is reported as a failure.

Changes made only to jest-circus as of now.

Test plan

e2e tests added to emulate the issue.

[SimenB]

Changes made only to jest-circus as of now.

@flozender just noticed this in the OP - it's perfectly fine to just change jest-circus - jest-jasmine is more or less in maintenance mode at this point

[SimenB]

why do it down here?

[flozender]

We want to first check if done was passed with a reason for failure, if so, return the reason. Or else, we can check if done was called more than once and return that as an error. We have some tests that checked if reason was being sent out properly, and they were failing because we returned our Expected done to be called once, but it was called multiple times. error before the reason was checked.

[SimenB]

Which tests are those? If they call done multiple times that's wrong. I can take a look if there are cases it does make sense though - could you point me to the tests that failed?

[flozender]

Here's one such test that calls done more than once. EDIT: let me just check if my latest commit is causing the CI to fail and I'm just confused.

[flozender]

Ok, I was confused about something else, please ignore this. I'll revert the position-change commit. However, this doesn't work as expected: https://github.com/facebook/jest/blob/3641e3cc7309caf4c755add40bebcb77fc18b786/e2e/failures/__tests__/errorAfterTestComplete.test.js#L10-L13
Expects: Error: Caught error after test environment was torn down
Receives: Expected done to be called once, but it was called multiple times.
(Same error as in the CI)

UPD: So turns out I was trying to fix this issue by moving the seenDone check to after checking if the environment was torn down, hence the movement of the check. But clearly, that didn't work.

[SimenB]

Thanks! I'll merge this when we're ready to land breaking changes 🙂

[SimenB]

@flozender CI is unhappy here - would you be able to take a look?

[flozender]

Sure, I'll try to fix it.

[flozender]

@SimenB I get an error here: https://github.com/facebook/jest/blob/a028bc13b8cb7d9f10933da67a41e7f52db277dd/packages/jest-jasmine2/src/jasmine/Env.ts#L56
56:31 error '@typescript-eslint/no-unused-vars' rule is disabled but never reported eslint-comments/no-unused-disable

Looks like it's a new change, what should I do here?

[SimenB]

@flozender have you run yarn? It came from a recent dependency upgrade

[flozender]

That didn't seem to work. I ran yarn in both the root directory and in jest-jasmine2.

[SimenB]

Very odd. You can try to delete .eslintcache in root? CI is not failing with that lint warning

[flozender]

Perfect, that worked!

[SimenB]

Also please add a test like

test('something', done => {
  Promise.resolve().then(() => {
    done();
    done();
  });
});

[SimenB]

Thanks for a great contribution @flozender!

[github-actions]

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.