Jest 27: incorrect `afterEach` order with `jest-circus`

[mrtnzlml]

💥 Regression Report

In Jest 26, it was possible to set up afterEach callback in a setupFilesAfterEnv script which was correctly called after the tests specific afterEach callbacks. It makes sense to behave like this because it allows us to set up callbacks that are executed after any test was completed (including their specific afterEach callbacks).

It seems that Jest 27 calls the "global" afterEach before the test-specific afterEach which breaks our codebase. It's because some of the tests are calling jest.restoreAllMocks in afterEach and later we are checking (in the global afterEach) whether all console mocks were actually restored or not.

Use case: we are capturing unexpected console logs in a similar way like React, see:

• https://github.com/facebook/react/blob/bb1c8215569f59b70276e8939bd8a59aa7f28f53/scripts/jest/setupTests.js#L159-L160
• our code: https://github.com/adeira/universe/blob/adc8bdf25d253b8bb883a040b6bf0d4bd1b66404/scripts/jest/setupTests.js#L63-L92

Test file:

afterEach(() => {
  jest.restoreAllMocks();
});

Setup file:

afterEach(() => {
  // here we check whether `restoreAllMocks` (or any equivalent which restores console mocks) was called
  // HOWEVER, if this global callback is called first then the test-specific mocks are not restored yet breaking the logic
});

Last working version

Worked up to version: 26.6.3

Stopped working in version: 27.0.1

To Reproduce

Steps to reproduce the behavior:

• setup afterEach callback in setupFilesAfterEnv script
• setup afterEach callback in some test
• check the order of execution of these callbacks (the test specific one should be run before the one from setupFilesAfterEnv)

Expected behavior

The order of afterEach callbacks is not changed from version 26 so it's still possible to register custom global afterEach callback.

Link to repl or repo (highly encouraged)

https://replit.com/@mrtnzlml/jest-afterEach-bug (try to change the Jest versions in package.json and check the difference in the order)

Run npx envinfo --preset jest

Paste the results here:

  System:
    OS: macOS 11.2.3
    CPU: (8) x64 Intel(R) Core(TM) i5-1038NG7 CPU @ 2.00GHz
  Binaries:
    Node: 16.2.0 - /usr/local/bin/node
    Yarn: 1.22.10 - /usr/local/bin/yarn
    npm: 7.14.0 - /usr/local/bin/npm
  npmPackages:
    jest: ^27.0.1 => 27.0.1 

[SimenB]

I'm not sure what makes the most sense. @jeysal?

[mrtnzlml]

@SimenB In case this issue gets dismissed, is there any other way how to have a global afterEach callback so we can achieve the same thing?

[jeysal]

Tbh I would say the previous behavior is rather unexpected (and I certainly didn't know it used to behave that way), because in any other case afterEachs would be executed in the order they are declared.
There is no drop in replacement that comes to my mind to get the previous behavior, only things that require more changes like calling something explicitly at the end of each test file, or monkey patching things. But I suppose the same is true with the old behavior if you wanted your afterEach to be run before the test afterEachs. So maybe this issue should be about giving users a way to control that easily. Or maybe there is already a good enough way? Not sure