Add support for async function in setupFilesAfterEnv

CHANGELOG.md

@@ -648,6 +648,7 @@
 - `[jest-worker]` [**BREAKING**] Allow only absolute `workerPath` ([#12343](https://github.com/facebook/jest/pull/12343))
 - `[jest-worker]` [**BREAKING**] Default to advanced serialization when using child process workers ([#10983](https://github.com/facebook/jest/pull/10983))
 - `[pretty-format]` New `maxWidth` parameter ([#12402](https://github.com/facebook/jest/pull/12402))
+- `[jest-circus, jest-jasmine2]` Allow `setupFilesAfterEnv` to export an async function ([#10962](https://github.com/jestjs/jest/issues/10962))
 
 ### Fixes
 

e2e/__tests__/setupFilesAfterEnvConfig.test.ts

@@ -64,4 +64,48 @@ describe('setupFilesAfterEnv', () => {
     expect(result.json.testResults).toHaveLength(1);
     expect(result.exitCode).toBe(0);
   });
+
+  it('awaits async function returned from the setup file (jest-circus)', () => {
+    const pkgJson = {
+      jest: {
+        setupFilesAfterEnv: ['./setupAsyncFunction.js'],
+        testRunner: 'jest-circus',
+      },
+    };
+
+    writeFiles(DIR, {
+      'package.json': JSON.stringify(pkgJson, null, 2),
+    });
+
+    const result = runWithJson('setup-files-after-env-config', [
+      'setupAsyncFunction.test.js',
+    ]);
+
+    expect(result.json.numTotalTests).toBe(1);
+    expect(result.json.numPassedTests).toBe(1);
+    expect(result.json.testResults).toHaveLength(1);
+    expect(result.exitCode).toBe(0);
+  });
+
+  it('awaits async function returned from the setup file (jest-jasmine2)', () => {
+    const pkgJson = {
+      jest: {
+        setupFilesAfterEnv: ['./setupAsyncFunction.js'],
+        testRunner: 'jest-jasmine2',
+      },
+    };
+
+    writeFiles(DIR, {
+      'package.json': JSON.stringify(pkgJson, null, 2),
+    });
+
+    const result = runWithJson('setup-files-after-env-config', [
+      'setupAsyncFunction.test.js',
+    ]);
+
+    expect(result.json.numTotalTests).toBe(1);
+    expect(result.json.numPassedTests).toBe(1);
+    expect(result.json.testResults).toHaveLength(1);
+    expect(result.exitCode).toBe(0);
+  });
 });

e2e/setup-files-after-env-config/__tests__/setupAsyncFunction.test.js

@@ -0,0 +1,13 @@
+/**
+ * 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.
+ */
+'use strict';
+
+describe('setupFilesAfterEnv', () => {
+  it('has waited for async function', () => {
+    expect(globalThis.afterEnvAsyncFunctionFinished).toBe(true);
+  });
+});

e2e/setup-files-after-env-config/setupAsyncFunction.js

@@ -0,0 +1,10 @@
+globalThis.afterEnvAsyncFunctionFinished = false;
+
+module.exports = async () => {
+  await new Promise(resolve =>
+    setTimeout(() => {
+      globalThis.afterEnvAsyncFunctionFinished = true;
+      resolve();
+    }, 2000),
+  );
+};

packages/jest-circus/src/legacy-code-todo-rewrite/jestAdapter.ts

@@ -81,7 +81,10 @@ const jestAdapter = async (
     if (esm) {
       await runtime.unstable_importModule(path);
     } else {
-      runtime.requireModule(path);
+      const setupFile = runtime.requireModule(path);
+      if (typeof setupFile === 'function') {
+        await setupFile();
+      }
     }
   }
   const setupAfterEnvEnd = Date.now();

packages/jest-jasmine2/src/index.ts

@@ -180,7 +180,10 @@ export default async function jasmine2(
     if (esm) {
       await runtime.unstable_importModule(path);
     } else {
-      runtime.requireModule(path);
+      const setupFile = runtime.requireModule(path);
+      if (typeof setupFile === 'function') {
+        await setupFile();
+      }
     }
   }