Commit | Line | Data |
---|---|---|
c97c7edb | 1 | import { AsyncResource } from 'async_hooks' |
838898f1 S |
2 | import type { Worker } from 'cluster' |
3 | import type { MessagePort } from 'worker_threads' | |
1a81f8af | 4 | import type { MessageValue } from '../utility-types' |
6e9d10db | 5 | import { EMPTY_FUNCTION } from '../utils' |
1a81f8af S |
6 | import type { KillBehavior, WorkerOptions } from './worker-options' |
7 | import { KillBehaviors } from './worker-options' | |
4c35177b | 8 | |
978aad6f | 9 | const DEFAULT_MAX_INACTIVE_TIME = 60000 |
1a81f8af | 10 | const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT |
c97c7edb | 11 | |
729c563d | 12 | /** |
ea7a90d3 | 13 | * Base class that implements some shared logic for all poolifier workers. |
729c563d S |
14 | * |
15 | * @template MainWorker Type of main worker. | |
deb85c12 JB |
16 | * @template Data Type of data this worker receives from pool's execution. This can only be serializable data. |
17 | * @template Response Type of response the worker sends back to the main worker. This can only be serializable data. | |
729c563d | 18 | */ |
c97c7edb | 19 | export abstract class AbstractWorker< |
838898f1 | 20 | MainWorker extends Worker | MessagePort, |
d3c8a1a8 S |
21 | Data = unknown, |
22 | Response = unknown | |
c97c7edb | 23 | > extends AsyncResource { |
729c563d S |
24 | /** |
25 | * Timestamp of the last task processed by this worker. | |
26 | */ | |
e088a00c | 27 | protected lastTaskTimestamp: number |
729c563d | 28 | /** |
e088a00c | 29 | * Handler Id of the `aliveInterval` worker alive check. |
729c563d | 30 | */ |
e088a00c | 31 | protected readonly aliveInterval?: NodeJS.Timeout |
dc5d0cb3 JB |
32 | /** |
33 | * Options for the worker. | |
34 | */ | |
35 | public readonly opts: WorkerOptions | |
c97c7edb | 36 | /** |
729c563d | 37 | * Constructs a new poolifier worker. |
c97c7edb S |
38 | * |
39 | * @param type The type of async event. | |
729c563d S |
40 | * @param isMain Whether this is the main worker or not. |
41 | * @param fn Function processed by the worker when the pool's `execution` function is invoked. | |
838898f1 | 42 | * @param mainWorker Reference to main worker. |
729c563d | 43 | * @param opts Options for the worker. |
c97c7edb S |
44 | */ |
45 | public constructor ( | |
46 | type: string, | |
47 | isMain: boolean, | |
48 | fn: (data: Data) => Response, | |
7e0d447f | 49 | protected mainWorker: MainWorker | undefined | null, |
59a11fd2 | 50 | opts: WorkerOptions = { |
e088a00c JB |
51 | /** |
52 | * The kill behavior option on this Worker or its default value. | |
53 | */ | |
1a81f8af | 54 | killBehavior: DEFAULT_KILL_BEHAVIOR, |
e088a00c JB |
55 | /** |
56 | * The maximum time to keep this worker alive while idle. | |
57 | * The pool automatically checks and terminates this worker when the time expires. | |
58 | */ | |
1a81f8af | 59 | maxInactiveTime: DEFAULT_MAX_INACTIVE_TIME |
4c35177b | 60 | } |
c97c7edb S |
61 | ) { |
62 | super(type) | |
59a11fd2 | 63 | this.opts = opts |
c510fea7 | 64 | this.checkFunctionInput(fn) |
e088a00c JB |
65 | this.checkWorkerOptions(this.opts) |
66 | this.lastTaskTimestamp = Date.now() | |
838898f1 | 67 | // Keep the worker active |
78cea37e | 68 | if (!isMain) { |
e088a00c | 69 | this.aliveInterval = setInterval( |
c97c7edb | 70 | this.checkAlive.bind(this), |
e088a00c | 71 | (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2 |
c97c7edb S |
72 | ) |
73 | this.checkAlive.bind(this)() | |
74 | } | |
838898f1 S |
75 | |
76 | this.mainWorker?.on('message', (value: MessageValue<Data, MainWorker>) => { | |
cf597bc5 | 77 | this.messageListener(value, fn) |
838898f1 | 78 | }) |
c97c7edb S |
79 | } |
80 | ||
cf597bc5 JB |
81 | protected messageListener ( |
82 | value: MessageValue<Data, MainWorker>, | |
83 | fn: (data: Data) => Response | |
84 | ): void { | |
85 | if (value.data !== undefined && value.id !== undefined) { | |
86 | // Here you will receive messages | |
6bd72cd0 | 87 | if (this.opts.async === true) { |
cf597bc5 JB |
88 | this.runInAsyncScope(this.runAsync.bind(this), this, fn, value) |
89 | } else { | |
90 | this.runInAsyncScope(this.run.bind(this), this, fn, value) | |
91 | } | |
92 | } else if (value.parent !== undefined) { | |
93 | // Save a reference of the main worker to communicate with it | |
94 | // This will be received once | |
95 | this.mainWorker = value.parent | |
96 | } else if (value.kill !== undefined) { | |
97 | // Here is time to kill this worker, just clearing the interval | |
78cea37e | 98 | if (this.aliveInterval != null) clearInterval(this.aliveInterval) |
cf597bc5 JB |
99 | this.emitDestroy() |
100 | } | |
101 | } | |
102 | ||
78cea37e | 103 | private checkWorkerOptions (opts: WorkerOptions): void { |
e088a00c JB |
104 | this.opts.killBehavior = opts.killBehavior ?? DEFAULT_KILL_BEHAVIOR |
105 | this.opts.maxInactiveTime = | |
106 | opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME | |
78cea37e | 107 | this.opts.async = opts.async ?? false |
e088a00c JB |
108 | } |
109 | ||
c510fea7 | 110 | /** |
8accb8d5 | 111 | * Checks if the `fn` parameter is passed to the constructor. |
c510fea7 APA |
112 | * |
113 | * @param fn The function that should be defined. | |
114 | */ | |
a35560ba | 115 | private checkFunctionInput (fn: (data: Data) => Response): void { |
78cea37e JB |
116 | if (fn == null) throw new Error('fn parameter is mandatory') |
117 | if (typeof fn !== 'function') { throw new TypeError('fn parameter is not a function') } | |
c510fea7 APA |
118 | } |
119 | ||
729c563d S |
120 | /** |
121 | * Returns the main worker. | |
838898f1 S |
122 | * |
123 | * @returns Reference to the main worker. | |
729c563d | 124 | */ |
838898f1 | 125 | protected getMainWorker (): MainWorker { |
78cea37e | 126 | if (this.mainWorker == null) { |
838898f1 S |
127 | throw new Error('Main worker was not set') |
128 | } | |
129 | return this.mainWorker | |
130 | } | |
c97c7edb | 131 | |
729c563d | 132 | /** |
8accb8d5 | 133 | * Sends a message to the main worker. |
729c563d S |
134 | * |
135 | * @param message The response message. | |
136 | */ | |
c97c7edb S |
137 | protected abstract sendToMainWorker (message: MessageValue<Response>): void |
138 | ||
729c563d | 139 | /** |
a05c10de | 140 | * Checks if the worker should be terminated, because its living too long. |
729c563d | 141 | */ |
c97c7edb | 142 | protected checkAlive (): void { |
e088a00c JB |
143 | if ( |
144 | Date.now() - this.lastTaskTimestamp > | |
145 | (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) | |
146 | ) { | |
147 | this.sendToMainWorker({ kill: this.opts.killBehavior }) | |
c97c7edb S |
148 | } |
149 | } | |
150 | ||
729c563d | 151 | /** |
8accb8d5 | 152 | * Handles an error and convert it to a string so it can be sent back to the main worker. |
729c563d S |
153 | * |
154 | * @param e The error raised by the worker. | |
50eceb07 | 155 | * @returns Message of the error. |
729c563d | 156 | */ |
c97c7edb | 157 | protected handleError (e: Error | string): string { |
4a34343d | 158 | return e as string |
c97c7edb S |
159 | } |
160 | ||
729c563d | 161 | /** |
8accb8d5 | 162 | * Runs the given function synchronously. |
729c563d S |
163 | * |
164 | * @param fn Function that will be executed. | |
165 | * @param value Input data for the given function. | |
166 | */ | |
c97c7edb S |
167 | protected run ( |
168 | fn: (data?: Data) => Response, | |
169 | value: MessageValue<Data> | |
170 | ): void { | |
171 | try { | |
bf9549ae | 172 | const startTaskTimestamp = Date.now() |
c97c7edb | 173 | const res = fn(value.data) |
bf9549ae JB |
174 | const taskRunTime = Date.now() - startTaskTimestamp |
175 | this.sendToMainWorker({ data: res, id: value.id, taskRunTime }) | |
c97c7edb | 176 | } catch (e) { |
0a23f635 | 177 | const err = this.handleError(e as Error) |
c97c7edb | 178 | this.sendToMainWorker({ error: err, id: value.id }) |
6e9d10db | 179 | } finally { |
e088a00c | 180 | this.lastTaskTimestamp = Date.now() |
c97c7edb S |
181 | } |
182 | } | |
183 | ||
729c563d | 184 | /** |
8accb8d5 | 185 | * Runs the given function asynchronously. |
729c563d S |
186 | * |
187 | * @param fn Function that will be executed. | |
188 | * @param value Input data for the given function. | |
189 | */ | |
c97c7edb S |
190 | protected runAsync ( |
191 | fn: (data?: Data) => Promise<Response>, | |
192 | value: MessageValue<Data> | |
193 | ): void { | |
bf9549ae | 194 | const startTaskTimestamp = Date.now() |
c97c7edb S |
195 | fn(value.data) |
196 | .then(res => { | |
bf9549ae JB |
197 | const taskRunTime = Date.now() - startTaskTimestamp |
198 | this.sendToMainWorker({ data: res, id: value.id, taskRunTime }) | |
c97c7edb S |
199 | return null |
200 | }) | |
201 | .catch(e => { | |
f3636726 | 202 | const err = this.handleError(e as Error) |
c97c7edb | 203 | this.sendToMainWorker({ error: err, id: value.id }) |
6e9d10db JB |
204 | }) |
205 | .finally(() => { | |
e088a00c | 206 | this.lastTaskTimestamp = Date.now() |
c97c7edb | 207 | }) |
6e9d10db | 208 | .catch(EMPTY_FUNCTION) |
c97c7edb S |
209 | } |
210 | } |