forked from jestjs/jest
/
types.ts
181 lines (150 loc) Β· 4.42 KB
/
types.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
/**
* Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/
import type {EventEmitter} from 'events';
import type {ForkOptions} from 'child_process';
import type {ResourceLimits} from 'worker_threads';
// Because of the dynamic nature of a worker communication process, all messages
// coming from any of the other processes cannot be typed. Thus, many types
// include "unknown" as a TS type, which is (unfortunately) correct here.
export const CHILD_MESSAGE_INITIALIZE: 0 = 0;
export const CHILD_MESSAGE_CALL: 1 = 1;
export const CHILD_MESSAGE_END: 2 = 2;
export const PARENT_MESSAGE_OK: 0 = 0;
export const PARENT_MESSAGE_CLIENT_ERROR: 1 = 1;
export const PARENT_MESSAGE_SETUP_ERROR: 2 = 2;
export const PARENT_MESSAGE_CUSTOM: 3 = 3;
export type PARENT_MESSAGE_ERROR =
| typeof PARENT_MESSAGE_CLIENT_ERROR
| typeof PARENT_MESSAGE_SETUP_ERROR;
export interface WorkerPoolInterface {
getStderr(): NodeJS.ReadableStream;
getStdout(): NodeJS.ReadableStream;
getWorkers(): Array<WorkerInterface>;
createWorker(options: WorkerOptions): WorkerInterface;
send(
workerId: number,
request: ChildMessage,
onStart: OnStart,
onEnd: OnEnd,
onCustomMessage: OnCustomMessage,
): void;
end(): Promise<PoolExitResult>;
}
export interface WorkerInterface {
send(
request: ChildMessage,
onProcessStart: OnStart,
onProcessEnd: OnEnd,
onCustomMessage: OnCustomMessage,
): void;
waitForExit(): Promise<void>;
forceExit(): void;
getWorkerId(): number;
getStderr(): NodeJS.ReadableStream | null;
getStdout(): NodeJS.ReadableStream | null;
}
export type PoolExitResult = {
forceExited: boolean;
};
export interface PromiseWithCustomMessage<T> extends Promise<T> {
UNSTABLE_onCustomMessage?: (listener: OnCustomMessage) => () => void;
}
// Option objects.
export type {ForkOptions, ResourceLimits};
export type FarmOptions = {
computeWorkerKey?: (method: string, ...args: Array<unknown>) => string | null;
exposedMethods?: ReadonlyArray<string>;
forkOptions?: ForkOptions;
resourceLimits?: ResourceLimits;
setupArgs?: Array<unknown>;
maxRetries?: number;
numWorkers?: number;
WorkerPool?: (
workerPath: string,
options?: WorkerPoolOptions,
) => WorkerPoolInterface;
enableWorkerThreads?: boolean;
};
export type WorkerPoolOptions = {
setupArgs: Array<unknown>;
forkOptions: ForkOptions;
resourceLimits: ResourceLimits;
maxRetries: number;
numWorkers: number;
enableWorkerThreads: boolean;
};
export type WorkerOptions = {
forkOptions: ForkOptions;
resourceLimits: ResourceLimits;
setupArgs: Array<unknown>;
maxRetries: number;
workerId: number;
workerPath: string;
};
// Messages passed from the parent to the children.
export type MessagePort = typeof EventEmitter & {
postMessage(message: unknown): void;
};
export type MessageChannel = {
port1: MessagePort;
port2: MessagePort;
};
export type ChildMessageInitialize = [
typeof CHILD_MESSAGE_INITIALIZE, // type
boolean, // processed
string, // file
Array<unknown> | undefined, // setupArgs
MessagePort | undefined, // MessagePort
];
export type ChildMessageCall = [
typeof CHILD_MESSAGE_CALL, // type
boolean, // processed
string, // method
Array<unknown>, // args
];
export type ChildMessageEnd = [
typeof CHILD_MESSAGE_END, // type
boolean, // processed
];
export type ChildMessage =
| ChildMessageInitialize
| ChildMessageCall
| ChildMessageEnd;
// Messages passed from the children to the parent.
export type ParentMessageCustom = [
typeof PARENT_MESSAGE_CUSTOM, // type
unknown, // result
];
export type ParentMessageOk = [
typeof PARENT_MESSAGE_OK, // type
unknown, // result
];
export type ParentMessageError = [
PARENT_MESSAGE_ERROR, // type
string, // constructor
string, // message
string, // stack
unknown, // extra
];
export type ParentMessage =
| ParentMessageOk
| ParentMessageError
| ParentMessageCustom;
// Queue types.
export type OnStart = (worker: WorkerInterface) => void;
export type OnEnd = (err: Error | null, result: unknown) => void;
export type OnCustomMessage = (message: unknown) => void;
export type QueueChildMessage = {
request: ChildMessage;
onStart: OnStart;
onEnd: OnEnd;
onCustomMessage: OnCustomMessage;
};
export type QueueItem = {
task: QueueChildMessage;
next: QueueItem | null;
};