#8708 Add global setup/teardown per-worker configuration options (that do nothing at the moment)

eyalroth · eyalroth · commit 9869d991c669 · 2025-06-28T17:52:27.000+03:00
diff --git a/packages/create-jest/src/__tests__/__snapshots__/init.test.ts.snap b/packages/create-jest/src/__tests__/__snapshots__/init.test.ts.snap
@@ -190,9 +190,15 @@ const config: Config = {
   // A path to a module which exports an async function that is triggered once before all test suites
   // globalSetup: undefined,
 
+  // A path to a module which exports an async function that is triggered once before all test suites in a worker
+  // globalSetupPerWorker: undefined,
+
   // A path to a module which exports an async function that is triggered once after all test suites
   // globalTeardown: undefined,
 
+  // A path to a module which exports an async function that is triggered once after all test suites in a worker
+  // globalTeardownPerWorker: undefined,
+
   // A set of global variables that need to be available in all test environments
   // globals: {},
 
@@ -394,9 +400,15 @@ const config = {
   // A path to a module which exports an async function that is triggered once before all test suites
   // globalSetup: undefined,
 
+  // A path to a module which exports an async function that is triggered once before all test suites in a worker
+  // globalSetupPerWorker: undefined,
+
   // A path to a module which exports an async function that is triggered once after all test suites
   // globalTeardown: undefined,
 
+  // A path to a module which exports an async function that is triggered once after all test suites in a worker
+  // globalTeardownPerWorker: undefined,
+
   // A set of global variables that need to be available in all test environments
   // globals: {},
 
@@ -598,9 +610,15 @@ const config = {
   // A path to a module which exports an async function that is triggered once before all test suites
   // globalSetup: undefined,
 
+  // A path to a module which exports an async function that is triggered once before all test suites in a worker
+  // globalSetupPerWorker: undefined,
+
   // A path to a module which exports an async function that is triggered once after all test suites
   // globalTeardown: undefined,
 
+  // A path to a module which exports an async function that is triggered once after all test suites in a worker
+  // globalTeardownPerWorker: undefined,
+
   // A set of global variables that need to be available in all test environments
   // globals: {},
 
diff --git a/packages/jest-cli/src/args.ts b/packages/jest-cli/src/args.ts
@@ -286,11 +286,21 @@ export const options: {[key: string]: Options} = {
     requiresArg: true,
     type: 'string',
   },
+  globalSetupPerWorker: {
+    description: 'The path to a module that runs before All Tests in a worker',
+    requiresArg: true,
+    type: 'string',
+  },
   globalTeardown: {
     description: 'The path to a module that runs after All Tests.',
     requiresArg: true,
     type: 'string',
   },
+  globalTeardownPerWorker: {
+    description: 'The path to a module that runs after All Tests in a worker',
+    requiresArg: true,
+    type: 'string',
+  },
   globals: {
     description:
       'A JSON string with map of global variables that need ' +
diff --git a/packages/jest-config/src/Descriptions.ts b/packages/jest-config/src/Descriptions.ts
@@ -36,8 +36,12 @@ const descriptions: {[key in keyof Config.InitialOptions]: string} = {
     'Force coverage collection from ignored files using an array of glob patterns',
   globalSetup:
     'A path to a module which exports an async function that is triggered once before all test suites',
+  globalSetupPerWorker:
+    'A path to a module which exports an async function that is triggered once before all test suites in a worker',
   globalTeardown:
     'A path to a module which exports an async function that is triggered once after all test suites',
+  globalTeardownPerWorker:
+    'A path to a module which exports an async function that is triggered once after all test suites in a worker',
   globals:
     'A set of global variables that need to be available in all test environments',
   maxWorkers:
diff --git a/packages/jest-config/src/ValidConfig.ts b/packages/jest-config/src/ValidConfig.ts
@@ -74,7 +74,9 @@ export const initialOptions: Config.InitialOptions = {
   forceCoverageMatch: ['**/*.t.js'],
   forceExit: false,
   globalSetup: 'setup.js',
+  globalSetupPerWorker: 'setup-per-worker.js',
   globalTeardown: 'teardown.js',
+  globalTeardownPerWorker: 'teardown-per-worker.js',
   globals: {__DEV__: true},
   haste: {
     computeSha1: true,
@@ -245,7 +247,9 @@ export const initialProjectOptions: Config.InitialProjectOptions = {
   filter: '<rootDir>/filter.js',
   forceCoverageMatch: ['**/*.t.js'],
   globalSetup: 'setup.js',
+  globalSetupPerWorker: 'setup-per-worker.js',
   globalTeardown: 'teardown.js',
+  globalTeardownPerWorker: 'teardown-per-worker.js',
   globals: {__DEV__: true},
   haste: {
     computeSha1: true,
diff --git a/packages/jest-config/src/index.ts b/packages/jest-config/src/index.ts
@@ -99,7 +99,9 @@ const groupOptions = (
     findRelatedTests: options.findRelatedTests,
     forceExit: options.forceExit,
     globalSetup: options.globalSetup,
+    globalSetupPerWorker: options.globalSetupPerWorker,
     globalTeardown: options.globalTeardown,
+    globalTeardownPerWorker: options.globalTeardownPerWorker,
     json: options.json,
     lastCommit: options.lastCommit,
     listTests: options.listTests,
@@ -166,7 +168,9 @@ const groupOptions = (
     filter: options.filter,
     forceCoverageMatch: options.forceCoverageMatch,
     globalSetup: options.globalSetup,
+    globalSetupPerWorker: options.globalSetupPerWorker,
     globalTeardown: options.globalTeardown,
+    globalTeardownPerWorker: options.globalTeardownPerWorker,
     globals: options.globals,
     haste: options.haste,
     id: options.id,
diff --git a/packages/jest-config/src/normalize.ts b/packages/jest-config/src/normalize.ts
@@ -637,7 +637,9 @@ export default async function normalize(
         break;
       case 'dependencyExtractor':
       case 'globalSetup':
+      case 'globalSetupPerWorker':
       case 'globalTeardown':
+      case 'globalTeardownPerWorker':
       case 'runtime':
       case 'snapshotResolver':
       case 'testResultsProcessor':
diff --git a/packages/jest-core/src/__tests__/watch.test.js b/packages/jest-core/src/__tests__/watch.test.js
@@ -651,7 +651,9 @@ describe('Watch mode flows', () => {
     ${'✔︎'} | ${'findRelatedTests'}
     ${'✖︎'} | ${'forceExit'}
     ${'✖︎'} | ${'globalSetup'}
+    ${'✖︎'} | ${'globalSetupPerWorker'}
     ${'✖︎'} | ${'globalTeardown'}
+    ${'✖︎'} | ${'globalTeardownPerWorker'}
     ${'✖︎'} | ${'json'}
     ${'✖︎'} | ${'lastCommit'}
     ${'✖︎'} | ${'listTests'}
diff --git a/packages/jest-schemas/src/raw-types.ts b/packages/jest-schemas/src/raw-types.ts
@@ -256,7 +256,9 @@ export const InitialOptions = Type.Partial(
     json: Type.Boolean(),
     globals: Type.Record(Type.String(), Type.Unknown()),
     globalSetup: Type.Union([Type.String(), Type.Null()]),
+    globalSetupPerWorker: Type.Union([Type.String(), Type.Null()]),
     globalTeardown: Type.Union([Type.String(), Type.Null()]),
+    globalTeardownPerWorker: Type.Union([Type.String(), Type.Null()]),
     haste: HasteConfig,
     id: Type.String(),
     injectGlobals: Type.Boolean(),
diff --git a/packages/jest-transform/src/__tests__/__snapshots__/ScriptTransformer.test.ts.snap b/packages/jest-transform/src/__tests__/__snapshots__/ScriptTransformer.test.ts.snap
@@ -45,7 +45,9 @@ exports[`ScriptTransformer in async mode, passes expected transform options to g
           "filter": undefined,
           "forceCoverageMatch": Array [],
           "globalSetup": undefined,
+          "globalSetupPerWorker": undefined,
           "globalTeardown": undefined,
+          "globalTeardownPerWorker": undefined,
           "globals": Object {},
           "haste": Object {},
           "id": "test",
@@ -196,7 +198,9 @@ exports[`ScriptTransformer passes expected transform options to getCacheKey 1`]
           "filter": undefined,
           "forceCoverageMatch": Array [],
           "globalSetup": undefined,
+          "globalSetupPerWorker": undefined,
           "globalTeardown": undefined,
+          "globalTeardownPerWorker": undefined,
           "globals": Object {},
           "haste": Object {},
           "id": "test",
@@ -321,7 +325,9 @@ exports[`ScriptTransformer passes expected transform options to getCacheKeyAsync
           "filter": undefined,
           "forceCoverageMatch": Array [],
           "globalSetup": undefined,
+          "globalSetupPerWorker": undefined,
           "globalTeardown": undefined,
+          "globalTeardownPerWorker": undefined,
           "globals": Object {},
           "haste": Object {},
           "id": "test",
diff --git a/packages/jest-transform/src/__tests__/shouldInstrument.test.ts b/packages/jest-transform/src/__tests__/shouldInstrument.test.ts
@@ -216,12 +216,24 @@ describe('shouldInstrument', () => {
       });
     });
 
+    it('if file is a globalSetupPerWorker file', () => {
+      testShouldInstrument('globalSetupPerWorker.js', defaultOptions, {
+        globalSetupPerWorker: 'globalSetupPerWorker.js',
+      });
+    });
+
     it('if file is globalTeardown file', () => {
       testShouldInstrument('globalTeardown.js', defaultOptions, {
         globalTeardown: 'globalTeardown.js',
       });
     });
 
+    it('if file is globalTeardownPerWorker file', () => {
+      testShouldInstrument('globalTeardownPerWorker.js', defaultOptions, {
+        globalTeardownPerWorker: 'globalTeardownPerWorker.js',
+      });
+    });
+
     it('if file is in setupFiles', () => {
       testShouldInstrument('setupTest.js', defaultOptions, {
         setupFiles: ['setupTest.js'],
diff --git a/packages/jest-transform/src/shouldInstrument.ts b/packages/jest-transform/src/shouldInstrument.ts
@@ -91,10 +91,18 @@ export default function shouldInstrument(
     return false;
   }
 
+  if (config.globalSetupPerWorker === filename) {
+    return false;
+  }
+
   if (config.globalTeardown === filename) {
     return false;
   }
 
+  if (config.globalTeardownPerWorker === filename) {
+    return false;
+  }
+
   if (config.setupFiles.includes(filename)) {
     return false;
   }
diff --git a/packages/jest-types/src/Config.ts b/packages/jest-types/src/Config.ts
@@ -274,7 +274,9 @@ export type GlobalConfig = {
   forceExit: boolean;
   json: boolean;
   globalSetup?: string;
+  globalSetupPerWorker?: string;
   globalTeardown?: string;
+  globalTeardownPerWorker?: string;
   lastCommit: boolean;
   logHeapUsage: boolean;
   listTests: boolean;
@@ -346,7 +348,9 @@ export type ProjectConfig = {
   filter?: string;
   forceCoverageMatch: Array<string>;
   globalSetup?: string;
+  globalSetupPerWorker?: string;
   globalTeardown?: string;
+  globalTeardownPerWorker?: string;
   globals: ConfigGlobals;
   haste: HasteConfig;
   id: string;
@@ -427,7 +431,9 @@ export type Argv = Arguments<
     forceExit: boolean;
     globals: string;
     globalSetup: string | null | undefined;
+    globalSetupPerWorker: string | null | undefined;
     globalTeardown: string | null | undefined;
+    globalTeardownPerWorker: string | null | undefined;
     haste: string;
     ignoreProjects: Array<string>;
     injectGlobals: boolean;
diff --git a/packages/test-utils/src/config.ts b/packages/test-utils/src/config.ts
@@ -27,7 +27,9 @@ const DEFAULT_GLOBAL_CONFIG: Config.GlobalConfig = {
   findRelatedTests: false,
   forceExit: false,
   globalSetup: undefined,
+  globalSetupPerWorker: undefined,
   globalTeardown: undefined,
+  globalTeardownPerWorker: undefined,
   json: false,
   lastCommit: false,
   listTests: false,
@@ -89,7 +91,9 @@ const DEFAULT_PROJECT_CONFIG: Config.ProjectConfig = {
   filter: undefined,
   forceCoverageMatch: [],
   globalSetup: undefined,
+  globalSetupPerWorker: undefined,
   globalTeardown: undefined,
+  globalTeardownPerWorker: undefined,
   globals: {},
   haste: {},
   id: 'test_name',
