Skip to content

Commit 9075c45

Browse files
authored
Type jest test and hook callbacks as @types/jest does
Summary: The jest callbacks were typed `(done) => ?Promise<unknown>`. 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<unknown>)`; - 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 Pull Request resolved: #60192
1 parent 5c062e6 commit 9075c45

2 files changed

Lines changed: 19 additions & 29 deletions

File tree

‎flow-typed/environment/jest.js‎

Lines changed: 18 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1003,24 +1003,26 @@ type JestDoneFn = {
10031003
fail: (error: Error) => void,
10041004
};
10051005

1006+
type JestProvidesCallback =
1007+
((done: JestDoneFn) => void) | (() => PromiseLike<unknown>);
1008+
1009+
type JestProvidesHookCallback = (() => any) | JestProvidesCallback;
1010+
10061011
/** Runs this function after every test inside this context */
10071012
declare function afterEach(
1008-
fn: (done: JestDoneFn) => ?Promise<unknown>,
1013+
fn: JestProvidesHookCallback,
10091014
timeout?: number,
10101015
): void;
10111016
/** Runs this function before every test inside this context */
10121017
declare function beforeEach(
1013-
fn: (done: JestDoneFn) => ?Promise<unknown>,
1018+
fn: JestProvidesHookCallback,
10141019
timeout?: number,
10151020
): void;
10161021
/** Runs this function after all tests have finished inside this context */
1017-
declare function afterAll(
1018-
fn: (done: JestDoneFn) => ?Promise<unknown>,
1019-
timeout?: number,
1020-
): void;
1022+
declare function afterAll(fn: JestProvidesHookCallback, timeout?: number): void;
10211023
/** Runs this function before any tests have started inside this context */
10221024
declare function beforeAll(
1023-
fn: (done: JestDoneFn) => ?Promise<unknown>,
1025+
fn: JestProvidesHookCallback,
10241026
timeout?: number,
10251027
): void;
10261028

@@ -1049,7 +1051,7 @@ declare var describe: {
10491051
| [ReadonlyArray<string>, string]
10501052
): (
10511053
name: JestTestName,
1052-
fn?: (...args: ReadonlyArray<any>) => ?Promise<unknown>,
1054+
fn?: (...args: ReadonlyArray<any>) => any,
10531055
timeout?: number,
10541056
) => void,
10551057
...
@@ -1064,11 +1066,7 @@ declare var it: {
10641066
* @param {Function} Test
10651067
* @param {number} Timeout for the test, in milliseconds.
10661068
*/
1067-
(
1068-
name: JestTestName,
1069-
fn?: (done: JestDoneFn) => ?Promise<unknown>,
1070-
timeout?: number,
1071-
): void,
1069+
(name: JestTestName, fn?: JestProvidesCallback, timeout?: number): void,
10721070
/**
10731071
* Only run this test
10741072
*
@@ -1077,16 +1075,12 @@ declare var it: {
10771075
* @param {number} Timeout for the test, in milliseconds.
10781076
*/
10791077
only: {
1080-
(
1081-
name: JestTestName,
1082-
fn?: (done: JestDoneFn) => ?Promise<unknown>,
1083-
timeout?: number,
1084-
): void,
1078+
(name: JestTestName, fn?: JestProvidesCallback, timeout?: number): void,
10851079
each(
10861080
...table: Array<Array<unknown> | unknown> | [Array<string>, string]
10871081
): (
10881082
name: JestTestName,
1089-
fn?: (...args: Array<any>) => ?Promise<unknown>,
1083+
fn?: (...args: Array<any>) => any,
10901084
timeout?: number,
10911085
) => void,
10921086
},
@@ -1098,16 +1092,12 @@ declare var it: {
10981092
* @param {number} Timeout for the test, in milliseconds.
10991093
*/
11001094
skip: {
1101-
(
1102-
name: JestTestName,
1103-
fn?: (done: JestDoneFn) => ?Promise<unknown>,
1104-
timeout?: number,
1105-
): void,
1095+
(name: JestTestName, fn?: JestProvidesCallback, timeout?: number): void,
11061096
each(
11071097
...table: Array<Array<unknown> | unknown> | [Array<string>, string]
11081098
): (
11091099
name: JestTestName,
1110-
fn?: (...args: Array<any>) => ?Promise<unknown>,
1100+
fn?: (...args: Array<any>) => any,
11111101
timeout?: number,
11121102
) => void,
11131103
},
@@ -1126,7 +1116,7 @@ declare var it: {
11261116
*/
11271117
concurrent(
11281118
name: JestTestName,
1129-
fn?: (done: JestDoneFn) => ?Promise<unknown>,
1119+
fn?: JestProvidesCallback,
11301120
timeout?: number,
11311121
): void,
11321122
/**
@@ -1140,15 +1130,15 @@ declare var it: {
11401130
| [ReadonlyArray<string>, string]
11411131
): (
11421132
name: JestTestName,
1143-
fn?: (...args: Array<any>) => ?Promise<unknown>,
1133+
fn?: (...args: Array<any>) => any,
11441134
timeout?: number,
11451135
) => void,
11461136
...
11471137
};
11481138

11491139
declare function fit(
11501140
name: JestTestName,
1151-
fn: (done: JestDoneFn) => ?Promise<unknown>,
1141+
fn: JestProvidesCallback,
11521142
timeout?: number,
11531143
): void;
11541144
/** An individual test unit */

‎packages/dev-middleware/src/__tests__/ServerUtils.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ export function withServerForEachTest(options: CreateServerOptions): Readonly<{
7474
Object.defineProperty(ref, 'app', {value: app});
7575
Object.defineProperty(ref, 'port', {value: server.address().port});
7676
});
77-
afterEach(done => {
77+
afterEach((done: JestDoneFn) => {
7878
server.close(() => done());
7979
});
8080
return ref;

0 commit comments

Comments
 (0)