From 8bbb2cb154e82ea059c7af5cb6e0f5c97744859a Mon Sep 17 00:00:00 2001 From: Sam Zhou Date: Fri, 20 Nov 2026 12:11:06 -0800 Subject: [PATCH] Type jest test and hook callbacks as `@types/jest` does Summary: The jest callbacks were typed `(done) => ?Promise`. With Flow's `experimental.ts_void`, a callback that returns `void`, such as `afterEach(() => cleanup())`, no longer fits that type. The callbacks are now typed as in TypeScript's `types/jest`: - tests: `ProvidesCallback`, i.e. `((done) => void) | (() => PromiseLike)`; - hooks: `ProvidesHookCallback`, i.e. `(() => any) | ProvidesCallback`; - `each` callbacks: `(...args) => any`. The `done` parameter of the `afterEach` callback in `dev-middleware`'s `ServerUtils` test is now annotated. Flow 0.340 can't infer its type from the union. Changelog: [Internal] Differential Revision: D133411234 --- flow-typed/environment/jest.js | 46 ++++++++----------- .../src/__tests__/ServerUtils.js | 2 +- 2 files changed, 19 insertions(+), 29 deletions(-) diff --git a/flow-typed/environment/jest.js b/flow-typed/environment/jest.js index e94a4e2c382c..d3cc6126ebb0 100644 --- a/flow-typed/environment/jest.js +++ b/flow-typed/environment/jest.js @@ -1003,24 +1003,26 @@ type JestDoneFn = { fail: (error: Error) => void, }; +type JestProvidesCallback = + ((done: JestDoneFn) => void) | (() => PromiseLike); + +type JestProvidesHookCallback = (() => any) | JestProvidesCallback; + /** Runs this function after every test inside this context */ declare function afterEach( - fn: (done: JestDoneFn) => ?Promise, + fn: JestProvidesHookCallback, timeout?: number, ): void; /** Runs this function before every test inside this context */ declare function beforeEach( - fn: (done: JestDoneFn) => ?Promise, + fn: JestProvidesHookCallback, timeout?: number, ): void; /** Runs this function after all tests have finished inside this context */ -declare function afterAll( - fn: (done: JestDoneFn) => ?Promise, - timeout?: number, -): void; +declare function afterAll(fn: JestProvidesHookCallback, timeout?: number): void; /** Runs this function before any tests have started inside this context */ declare function beforeAll( - fn: (done: JestDoneFn) => ?Promise, + fn: JestProvidesHookCallback, timeout?: number, ): void; @@ -1049,7 +1051,7 @@ declare var describe: { | [ReadonlyArray, string] ): ( name: JestTestName, - fn?: (...args: ReadonlyArray) => ?Promise, + fn?: (...args: ReadonlyArray) => any, timeout?: number, ) => void, ... @@ -1064,11 +1066,7 @@ declare var it: { * @param {Function} Test * @param {number} Timeout for the test, in milliseconds. */ - ( - name: JestTestName, - fn?: (done: JestDoneFn) => ?Promise, - timeout?: number, - ): void, + (name: JestTestName, fn?: JestProvidesCallback, timeout?: number): void, /** * Only run this test * @@ -1077,16 +1075,12 @@ declare var it: { * @param {number} Timeout for the test, in milliseconds. */ only: { - ( - name: JestTestName, - fn?: (done: JestDoneFn) => ?Promise, - timeout?: number, - ): void, + (name: JestTestName, fn?: JestProvidesCallback, timeout?: number): void, each( ...table: Array | unknown> | [Array, string] ): ( name: JestTestName, - fn?: (...args: Array) => ?Promise, + fn?: (...args: Array) => any, timeout?: number, ) => void, }, @@ -1098,16 +1092,12 @@ declare var it: { * @param {number} Timeout for the test, in milliseconds. */ skip: { - ( - name: JestTestName, - fn?: (done: JestDoneFn) => ?Promise, - timeout?: number, - ): void, + (name: JestTestName, fn?: JestProvidesCallback, timeout?: number): void, each( ...table: Array | unknown> | [Array, string] ): ( name: JestTestName, - fn?: (...args: Array) => ?Promise, + fn?: (...args: Array) => any, timeout?: number, ) => void, }, @@ -1126,7 +1116,7 @@ declare var it: { */ concurrent( name: JestTestName, - fn?: (done: JestDoneFn) => ?Promise, + fn?: JestProvidesCallback, timeout?: number, ): void, /** @@ -1140,7 +1130,7 @@ declare var it: { | [ReadonlyArray, string] ): ( name: JestTestName, - fn?: (...args: Array) => ?Promise, + fn?: (...args: Array) => any, timeout?: number, ) => void, ... @@ -1148,7 +1138,7 @@ declare var it: { declare function fit( name: JestTestName, - fn: (done: JestDoneFn) => ?Promise, + fn: JestProvidesCallback, timeout?: number, ): void; /** An individual test unit */ diff --git a/packages/dev-middleware/src/__tests__/ServerUtils.js b/packages/dev-middleware/src/__tests__/ServerUtils.js index 6a7b9c1bacd1..1352bbdea10d 100644 --- a/packages/dev-middleware/src/__tests__/ServerUtils.js +++ b/packages/dev-middleware/src/__tests__/ServerUtils.js @@ -74,7 +74,7 @@ export function withServerForEachTest(options: CreateServerOptions): Readonly<{ Object.defineProperty(ref, 'app', {value: app}); Object.defineProperty(ref, 'port', {value: server.address().port}); }); - afterEach(done => { + afterEach((done: JestDoneFn) => { server.close(() => done()); }); return ref;