Commit | Line | Data |
---|---|---|
fc3e6586 | 1 | import EventEmitter from 'node:events' |
bdaf31cd JB |
2 | import type { |
3 | ErrorHandler, | |
4 | ExitHandler, | |
50e66724 | 5 | IWorker, |
bdaf31cd | 6 | MessageHandler, |
c4855468 JB |
7 | OnlineHandler, |
8 | WorkerNode | |
f06e48d8 | 9 | } from './worker' |
da309861 JB |
10 | import type { |
11 | WorkerChoiceStrategy, | |
12 | WorkerChoiceStrategyOptions | |
13 | } from './selection-strategies/selection-strategies-types' | |
bdaf31cd | 14 | |
c4855468 JB |
15 | /** |
16 | * Pool types. | |
17 | * | |
18 | * @enum | |
71ebe93b | 19 | * @internal |
c4855468 JB |
20 | */ |
21 | export enum PoolType { | |
22 | /** | |
23 | * Fixed pool type. | |
24 | */ | |
25 | FIXED = 'fixed', | |
26 | /** | |
27 | * Dynamic pool type. | |
28 | */ | |
29 | DYNAMIC = 'dynamic' | |
30 | } | |
31 | ||
b4904890 JB |
32 | /** |
33 | * Pool events emitter. | |
34 | */ | |
35 | export class PoolEmitter extends EventEmitter {} | |
36 | ||
aee46736 JB |
37 | /** |
38 | * Enumeration of pool events. | |
39 | */ | |
40 | export const PoolEvents = Object.freeze({ | |
41 | full: 'full', | |
42 | busy: 'busy' | |
43 | } as const) | |
44 | ||
45 | /** | |
46 | * Pool event. | |
47 | */ | |
48 | export type PoolEvent = keyof typeof PoolEvents | |
49 | ||
7171d33f JB |
50 | /** |
51 | * Worker tasks queue options. | |
52 | */ | |
53 | export interface TasksQueueOptions { | |
54 | /** | |
55 | * Maximum number of tasks that can be executed concurrently on a worker. | |
56 | * | |
57 | * @defaultValue 1 | |
58 | */ | |
59 | concurrency?: number | |
60 | } | |
61 | ||
bdaf31cd JB |
62 | /** |
63 | * Options for a poolifier pool. | |
c319c66b | 64 | * |
d480d708 | 65 | * @typeParam Worker - Type of worker. |
bdaf31cd | 66 | */ |
50e66724 | 67 | export interface PoolOptions<Worker extends IWorker> { |
bdaf31cd JB |
68 | /** |
69 | * A function that will listen for message event on each worker. | |
70 | */ | |
71 | messageHandler?: MessageHandler<Worker> | |
72 | /** | |
73 | * A function that will listen for error event on each worker. | |
74 | */ | |
75 | errorHandler?: ErrorHandler<Worker> | |
76 | /** | |
77 | * A function that will listen for online event on each worker. | |
78 | */ | |
79 | onlineHandler?: OnlineHandler<Worker> | |
80 | /** | |
81 | * A function that will listen for exit event on each worker. | |
82 | */ | |
83 | exitHandler?: ExitHandler<Worker> | |
84 | /** | |
46e857ca | 85 | * The worker choice strategy to use in this pool. |
bdaf31cd JB |
86 | */ |
87 | workerChoiceStrategy?: WorkerChoiceStrategy | |
da309861 JB |
88 | /** |
89 | * The worker choice strategy options. | |
90 | */ | |
91 | workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions | |
bdaf31cd JB |
92 | /** |
93 | * Pool events emission. | |
94 | * | |
38e795c1 | 95 | * @defaultValue true |
bdaf31cd JB |
96 | */ |
97 | enableEvents?: boolean | |
ff733df7 JB |
98 | /** |
99 | * Pool worker tasks queue. | |
100 | * | |
ff733df7 JB |
101 | * @defaultValue false |
102 | */ | |
103 | enableTasksQueue?: boolean | |
7171d33f JB |
104 | /** |
105 | * Pool worker tasks queue options. | |
7171d33f JB |
106 | */ |
107 | tasksQueueOptions?: TasksQueueOptions | |
bdaf31cd | 108 | } |
a35560ba | 109 | |
729c563d S |
110 | /** |
111 | * Contract definition for a poolifier pool. | |
112 | * | |
c4855468 | 113 | * @typeParam Worker - Type of worker which manages this pool. |
38e795c1 | 114 | * @typeParam Data - Type of data sent to the worker. This can only be serializable data. |
02706357 | 115 | * @typeParam Response - Type of execution response. This can only be serializable data. |
729c563d | 116 | */ |
c4855468 JB |
117 | export interface IPool< |
118 | Worker extends IWorker, | |
119 | Data = unknown, | |
120 | Response = unknown | |
121 | > { | |
122 | /** | |
123 | * Pool type. | |
124 | * | |
125 | * If it is `'dynamic'`, it provides the `max` property. | |
126 | */ | |
127 | readonly type: PoolType | |
128 | /** | |
129 | * Pool worker nodes. | |
130 | */ | |
131 | readonly workerNodes: Array<WorkerNode<Worker, Data>> | |
b4904890 JB |
132 | /** |
133 | * Emitter on which events can be listened to. | |
134 | * | |
135 | * Events that can currently be listened to: | |
136 | * | |
164d950a JB |
137 | * - `'full'`: Emitted when the pool is dynamic and full. |
138 | * - `'busy'`: Emitted when the pool is busy. | |
b4904890 JB |
139 | */ |
140 | readonly emitter?: PoolEmitter | |
c4855468 JB |
141 | /** |
142 | * Finds a free worker node key based on the number of tasks the worker has applied. | |
143 | * | |
144 | * If a worker is found with `0` running tasks, it is detected as free and its worker node key is returned. | |
145 | * | |
146 | * If no free worker is found, `-1` is returned. | |
147 | * | |
148 | * @returns A worker node key if there is one, `-1` otherwise. | |
149 | */ | |
150 | findFreeWorkerNodeKey: () => number | |
729c563d | 151 | /** |
48f97a95 | 152 | * Executes the function specified in the constructor with the task data input parameter. |
729c563d | 153 | * |
48f97a95 | 154 | * @param data - The task input data for the specified function. This can only be serializable data. |
729c563d S |
155 | * @returns Promise that will be resolved when the task is successfully completed. |
156 | */ | |
78cea37e | 157 | execute: (data: Data) => Promise<Response> |
280c2a77 | 158 | /** |
675bb809 | 159 | * Shutdowns every current worker in this pool. |
280c2a77 | 160 | */ |
78cea37e | 161 | destroy: () => Promise<void> |
a35560ba | 162 | /** |
bdede008 | 163 | * Sets the worker choice strategy in this pool. |
a35560ba | 164 | * |
38e795c1 | 165 | * @param workerChoiceStrategy - The worker choice strategy. |
59219cbb | 166 | * @param workerChoiceStrategyOptions - The worker choice strategy options. |
a35560ba | 167 | */ |
59219cbb JB |
168 | setWorkerChoiceStrategy: ( |
169 | workerChoiceStrategy: WorkerChoiceStrategy, | |
170 | workerChoiceStrategyOptions?: WorkerChoiceStrategyOptions | |
171 | ) => void | |
a20f0ba5 JB |
172 | /** |
173 | * Sets the worker choice strategy options in this pool. | |
174 | * | |
175 | * @param workerChoiceStrategyOptions - The worker choice strategy options. | |
176 | */ | |
177 | setWorkerChoiceStrategyOptions: ( | |
178 | workerChoiceStrategyOptions: WorkerChoiceStrategyOptions | |
179 | ) => void | |
180 | /** | |
181 | * Enables/disables the worker tasks queue in this pool. | |
182 | * | |
183 | * @param enable - Whether to enable or disable the worker tasks queue. | |
184 | * @param tasksQueueOptions - The worker tasks queue options. | |
185 | */ | |
8f52842f JB |
186 | enableTasksQueue: ( |
187 | enable: boolean, | |
188 | tasksQueueOptions?: TasksQueueOptions | |
189 | ) => void | |
a20f0ba5 JB |
190 | /** |
191 | * Sets the worker tasks queue options in this pool. | |
192 | * | |
193 | * @param tasksQueueOptions - The worker tasks queue options. | |
194 | */ | |
195 | setTasksQueueOptions: (tasksQueueOptions: TasksQueueOptions) => void | |
c97c7edb | 196 | } |