Prevent false test failures caused by promise rejections handled asynchronously

CHANGELOG.md

@@ -13,6 +13,7 @@
 ### Fixes
 
 - `[babel-plugin-jest-hoist]` Use `denylist` instead of the deprecated `blacklist` for Babel 8 support ([#14109](https://github.com/jestjs/jest/pull/14109))
+- `[jest-circus]` [**BREAKING**] Prevent false test failures caused by promise rejections handled asynchronously ([#14315](https://github.com/jestjs/jest/pull/14315))
 - `[@jest/expect-utils]` Fix comparison of `DataView` ([#14408](https://github.com/jestjs/jest/pull/14408))
 - `[jest-leak-detector]` Make leak-detector more aggressive when running GC ([#14526](https://github.com/jestjs/jest/pull/14526))
 - `[jest-util]` Make sure `isInteractive` works in a browser ([#14552](https://github.com/jestjs/jest/pull/14552))

e2e/__tests__/__snapshots__/environmentAfterTeardown.test.ts.snap

@@ -1,7 +1,7 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`prints useful error for environment methods after test is done 1`] = `
-"ReferenceError: You are trying to access a property or method of the Jest environment after it has been torn down. From __tests__/afterTeardown.test.js.
+"    ReferenceError: You are trying to access a property or method of the Jest environment outside of the scope of the test code.
 
        9 | test('access environment methods after done', () => {
       10 |   setTimeout(() => {

e2e/__tests__/__snapshots__/environmentAfterTeardownJasmine.test.ts.snap

@@ -0,0 +1,13 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`prints useful error for environment methods after test is done 1`] = `
+"ReferenceError: You are trying to access a property or method of the Jest environment after it has been torn down. From __tests__/afterTeardown.test.js.
+
+       9 | test('access environment methods after done', () => {
+      10 |   setTimeout(() => {
+    > 11 |     jest.clearAllTimers();
+         |          ^
+      12 |   }, 0);
+      13 | });
+      14 |"
+`;

e2e/__tests__/__snapshots__/promiseAsyncHandling.test.ts.snap

@@ -0,0 +1,236 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`fails because of unhandled promise rejection in afterAll hook 1`] = `
+Object {
+  "rest": "FAIL __tests__/unhandledRejectionAfterAll.test.js
+
+
+  ● Test suite failed to run
+
+    REJECTED
+
+      11 |
+      12 | afterAll(async () => {
+    > 13 |   Promise.reject(new Error('REJECTED'));
+         |                  ^
+      14 |
+      15 |   await promisify(setTimeout)(0);
+      16 | });
+
+      at Object.<anonymous> (__tests__/unhandledRejectionAfterAll.test.js:13:18)",
+  "summary": "Test Suites: 1 failed, 1 total
+Tests:       1 passed, 1 total
+Snapshots:   0 total
+Time:        <<REPLACED>>
+Ran all test suites matching /unhandledRejectionAfterAll.test.js/i.",
+}
+`;
+
+exports[`fails because of unhandled promise rejection in afterEach hook 1`] = `
+Object {
+  "rest": "FAIL __tests__/unhandledRejectionAfterEach.test.js
+  ✕ foo #1
+  ✕ foo #2
+
+  ● foo #1
+
+    REJECTED
+
+      11 |
+      12 | afterEach(async () => {
+    > 13 |   Promise.reject(new Error('REJECTED'));
+         |                  ^
+      14 |
+      15 |   await promisify(setTimeout)(0);
+      16 | });
+
+      at Object.<anonymous> (__tests__/unhandledRejectionAfterEach.test.js:13:18)
+
+  ● foo #2
+
+    REJECTED
+
+      11 |
+      12 | afterEach(async () => {
+    > 13 |   Promise.reject(new Error('REJECTED'));
+         |                  ^
+      14 |
+      15 |   await promisify(setTimeout)(0);
+      16 | });
+
+      at Object.<anonymous> (__tests__/unhandledRejectionAfterEach.test.js:13:18)",
+  "summary": "Test Suites: 1 failed, 1 total
+Tests:       2 failed, 2 total
+Snapshots:   0 total
+Time:        <<REPLACED>>
+Ran all test suites matching /unhandledRejectionAfterEach.test.js/i.",
+}
+`;
+
+exports[`fails because of unhandled promise rejection in beforeAll hook 1`] = `
+Object {
+  "rest": "FAIL __tests__/unhandledRejectionBeforeAll.test.js
+  ✕ foo
+
+  ● foo
+
+    REJECTED
+
+      11 |
+      12 | beforeAll(async () => {
+    > 13 |   Promise.reject(new Error('REJECTED'));
+         |                  ^
+      14 |
+      15 |   await promisify(setTimeout)(0);
+      16 | });
+
+      at Object.<anonymous> (__tests__/unhandledRejectionBeforeAll.test.js:13:18)",
+  "summary": "Test Suites: 1 failed, 1 total
+Tests:       1 failed, 1 total
+Snapshots:   0 total
+Time:        <<REPLACED>>
+Ran all test suites matching /unhandledRejectionBeforeAll.test.js/i.",
+}
+`;
+
+exports[`fails because of unhandled promise rejection in beforeEach hook 1`] = `
+Object {
+  "rest": "FAIL __tests__/unhandledRejectionBeforeEach.test.js
+  ✕ foo #1
+  ✕ foo #2
+
+  ● foo #1
+
+    REJECTED
+
+      11 |
+      12 | beforeEach(async () => {
+    > 13 |   Promise.reject(new Error('REJECTED'));
+         |                  ^
+      14 |
+      15 |   await promisify(setTimeout)(0);
+      16 | });
+
+      at Object.<anonymous> (__tests__/unhandledRejectionBeforeEach.test.js:13:18)
+
+  ● foo #2
+
+    REJECTED
+
+      11 |
+      12 | beforeEach(async () => {
+    > 13 |   Promise.reject(new Error('REJECTED'));
+         |                  ^
+      14 |
+      15 |   await promisify(setTimeout)(0);
+      16 | });
+
+      at Object.<anonymous> (__tests__/unhandledRejectionBeforeEach.test.js:13:18)",
+  "summary": "Test Suites: 1 failed, 1 total
+Tests:       2 failed, 2 total
+Snapshots:   0 total
+Time:        <<REPLACED>>
+Ran all test suites matching /unhandledRejectionBeforeEach.test.js/i.",
+}
+`;
+
+exports[`fails because of unhandled promise rejection in test 1`] = `
+Object {
+  "rest": "FAIL __tests__/unhandledRejectionTest.test.js
+  ✕ w/o event loop turn after rejection
+  ✕ w/ event loop turn after rejection in async function
+  ✕ w/ event loop turn after rejection in sync function
+  ✕ combined w/ another failure _after_ promise rejection
+
+  ● w/o event loop turn after rejection
+
+    REJECTED
+
+      11 |
+      12 | test('w/o event loop turn after rejection', () => {
+    > 13 |   Promise.reject(new Error('REJECTED'));
+         |                  ^
+      14 | });
+      15 |
+      16 | test('w/ event loop turn after rejection in async function', async () => {
+
+      at Object.<anonymous> (__tests__/unhandledRejectionTest.test.js:13:18)
+
+  ● w/ event loop turn after rejection in async function
+
+    REJECTED
+
+      15 |
+      16 | test('w/ event loop turn after rejection in async function', async () => {
+    > 17 |   Promise.reject(new Error('REJECTED'));
+         |                  ^
+      18 |
+      19 |   await promisify(setTimeout)(0);
+      20 | });
+
+      at Object.<anonymous> (__tests__/unhandledRejectionTest.test.js:17:18)
+
+  ● w/ event loop turn after rejection in sync function
+
+    REJECTED
+
+      21 |
+      22 | test('w/ event loop turn after rejection in sync function', done => {
+    > 23 |   Promise.reject(new Error('REJECTED'));
+         |                  ^
+      24 |
+      25 |   setTimeout(done, 0);
+      26 | });
+
+      at Object.<anonymous> (__tests__/unhandledRejectionTest.test.js:23:18)
+
+  ● combined w/ another failure _after_ promise rejection
+
+    expect(received).toBe(expected) // Object.is equality
+
+    Expected: false
+    Received: true
+
+      31 |   await promisify(setTimeout)(0);
+      32 |
+    > 33 |   expect(true).toBe(false);
+         |                ^
+      34 | });
+      35 |
+
+      at Object.toBe (__tests__/unhandledRejectionTest.test.js:33:16)
+
+  ● combined w/ another failure _after_ promise rejection
+
+    REJECTED
+
+      27 |
+      28 | test('combined w/ another failure _after_ promise rejection', async () => {
+    > 29 |   Promise.reject(new Error('REJECTED'));
+         |                  ^
+      30 |
+      31 |   await promisify(setTimeout)(0);
+      32 |
+
+      at Object.<anonymous> (__tests__/unhandledRejectionTest.test.js:29:18)",
+  "summary": "Test Suites: 1 failed, 1 total
+Tests:       4 failed, 4 total
+Snapshots:   0 total
+Time:        <<REPLACED>>
+Ran all test suites matching /unhandledRejectionTest.test.js/i.",
+}
+`;
+
+exports[`succeeds for async handled promise rejections 1`] = `
+Object {
+  "rest": "PASS __tests__/rejectionHandled.test.js
+  ✓ async function succeeds because the promise is eventually awaited by assertion
+  ✓ async function succeeds because the promise is eventually directly awaited
+  ✓ sync function succeeds because the promise is eventually handled by \`.catch\` handler",
+  "summary": "Test Suites: 1 passed, 1 total
+Tests:       3 passed, 3 total
+Snapshots:   0 total
+Time:        <<REPLACED>>
+Ran all test suites matching /rejectionHandled.test.js/i.",
+}
+`;

e2e/__tests__/__snapshots__/requireAfterTeardown.test.ts.snap

@@ -1,7 +1,7 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
 exports[`prints useful error for requires after test is done 1`] = `
-"ReferenceError: You are trying to \`import\` a file after the Jest environment has been torn down. From __tests__/lateRequire.test.js.
+"    ReferenceError: You are trying to \`import\` a file outside of the scope of the test code.
 
        9 | test('require after done', () => {
       10 |   setTimeout(() => {

e2e/__tests__/__snapshots__/requireAfterTeardownJasmine.test.ts.snap

@@ -0,0 +1,13 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`prints useful error for requires after test is done 1`] = `
+"ReferenceError: You are trying to \`import\` a file after the Jest environment has been torn down. From __tests__/lateRequire.test.js.
+
+       9 | test('require after done', () => {
+      10 |   setTimeout(() => {
+    > 11 |     const double = require('../');
+         |                    ^
+      12 |
+      13 |     expect(double(5)).toBe(10);
+      14 |   }, 0);"
+`;

e2e/__tests__/environmentAfterTeardown.test.ts

@@ -5,14 +5,17 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+import {skipSuiteOnJasmine} from '@jest/test-utils';
 import runJest from '../runJest';
 
+skipSuiteOnJasmine();
+
 test('prints useful error for environment methods after test is done', () => {
   const {stderr} = runJest('environment-after-teardown');
-  const interestingLines = stderr.split('\n').slice(9, 18).join('\n');
+  const interestingLines = stderr.split('\n').slice(5, 14).join('\n');
 
   expect(interestingLines).toMatchSnapshot();
-  expect(stderr.split('\n')[9]).toBe(
-    'ReferenceError: You are trying to access a property or method of the Jest environment after it has been torn down. From __tests__/afterTeardown.test.js.',
+  expect(stderr.split('\n')[5]).toMatch(
+    'ReferenceError: You are trying to access a property or method of the Jest environment outside of the scope of the test code.',
   );
 });

e2e/__tests__/environmentAfterTeardownJasmine.test.ts

@@ -0,0 +1,21 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import {skipSuiteOnJestCircus} from '@jest/test-utils';
+import runJest from '../runJest';
+
+skipSuiteOnJestCircus();
+
+test('prints useful error for environment methods after test is done', () => {
+  const {stderr} = runJest('environment-after-teardown');
+  const interestingLines = stderr.split('\n').slice(9, 18).join('\n');
+
+  expect(interestingLines).toMatchSnapshot();
+  expect(stderr.split('\n')[9]).toBe(
+    'ReferenceError: You are trying to access a property or method of the Jest environment after it has been torn down. From __tests__/afterTeardown.test.js.',
+  );
+});

e2e/__tests__/fakeTimersLegacy.test.ts

@@ -5,6 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+import {isJestJasmineRun} from '@jest/test-utils';
 import runJest from '../runJest';
 
 describe('enableGlobally', () => {
@@ -39,10 +40,13 @@ describe('requestAnimationFrame', () => {
 
 describe('setImmediate', () => {
   test('fakes setImmediate', () => {
+    // Jasmine runner does not handle unhandled promise rejections that are causing the test to fail in Jest circus
+    const expectedExitCode = isJestJasmineRun() ? 0 : 1;
+
     const result = runJest('fake-timers-legacy/set-immediate');
 
     expect(result.stderr).toMatch('setImmediate test');
-    expect(result.exitCode).toBe(0);
+    expect(result.exitCode).toBe(expectedExitCode);
   });
 });