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

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

@@ -2,18 +2,35 @@
 
 exports[`\`done()\` should not be called more than once 1`] = `
 FAIL __tests__/index.test.js
-  ✕ \`done()\` should not be called more than once
+  \`done()\` called more than once
+    ✕ should fail
+    ✕ should fail inside a promise
 
-  ● \`done()\` should not be called more than once
+  ● \`done()\` called more than once › should fail
 
     Expected done to be called once, but it was called multiple times.
 
-       7 | test('\`done()\` should not be called more than once', done => {
-       8 |   done();
-    >  9 |   done();
-         |   ^
-      10 | });
-      11 | 
+       8 |   it('should fail', done => {
+       9 |     done();
+    > 10 |     done();
+         |     ^
+      11 |   });
+      12 | 
+      13 |   it('should fail inside a promise', done => {
 
-      at Object.done (__tests__/index.test.js:9:3)
+      at Object.done (__tests__/index.test.js:10:5)
+
+  ● \`done()\` called more than once › should fail inside a promise
+
+    Expected done to be called once, but it was called multiple times.
+
+      15 |       .then(() => {
+      16 |         done();
+    > 17 |         done();
+         |         ^
+      18 |       })
+      19 |       .catch(err => err);
+      20 |   });
+
+      at done (__tests__/index.test.js:17:9)
 `;

packages/jest-circus/src/eventHandler.ts

@@ -31,6 +31,7 @@ const eventHandler: Circus.EventHandler = (
       break;
     }
     case 'hook_start': {
+      event.hook.seenDone = false;
       break;
     }
     case 'start_describe_definition': {
@@ -195,6 +196,10 @@ const eventHandler: Circus.EventHandler = (
       event.test.invocations += 1;
       break;
     }
+    case 'test_fn_start': {
+      event.test.seenDone = false;
+      break;
+    }
     case 'test_fn_failure': {
       const {
         error,

packages/jest-circus/src/run.ts

@@ -149,7 +149,6 @@ const _callCircusHook = async ({
   testContext?: Circus.TestContext;
 }): Promise<void> => {
   await dispatch({hook, name: 'hook_start'});
-  hook.seenDone = false;
   const timeout = hook.timeout || getState().testTimeout;
 
   try {
@@ -168,7 +167,6 @@ const _callCircusTest = async (
   testContext: Circus.TestContext,
 ): Promise<void> => {
   await dispatch({name: 'test_fn_start', test});
-  test.seenDone = false;
   const timeout = test.timeout || getState().testTimeout;
   invariant(test.fn, `Tests with no 'fn' should have 'mode' set to 'skipped'`);
 

packages/jest-circus/src/utils.ts

@@ -192,20 +192,22 @@ export const callAsyncCircusFn = (
       let returnedValue: unknown = undefined;
 
       const done = (reason?: Error | string): void => {
+        // We need to keep a stack here before the promise tick
+        const errorAtDone = new ErrorWithStack(undefined, done);
+
         if (!completed && testOrHook.seenDone) {
-          let message =
+          errorAtDone.message =
             'Expected done to be called once, but it was called multiple times.';
 
           if (reason) {
-            message += ' Reason: ' + prettyFormat(reason, {maxDepth: 3});
+            errorAtDone.message +=
+              ' Reason: ' + prettyFormat(reason, {maxDepth: 3});
           }
-
-          throw new ErrorWithStack(message, done);
+          reject(errorAtDone);
+          throw errorAtDone;
         } else {
           testOrHook.seenDone = true;
         }
-        // We need to keep a stack here before the promise tick
-        const errorAtDone = new ErrorWithStack(undefined, done);
 
         // Use `Promise.resolve` to allow the event loop to go a single tick in case `done` is called synchronously
         Promise.resolve().then(() => {