1 // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
3 import { Worker
} from
'worker_threads';
5 import WorkerAbstract from
'./WorkerAbstract';
6 import { WorkerUtils
} from
'./WorkerUtils';
12 type WorkerSetElement
,
13 } from
'../types/Worker';
14 import Utils from
'../utils/Utils';
16 export default class WorkerSet
extends WorkerAbstract
<WorkerData
> {
17 private readonly workerSet
: Set
<WorkerSetElement
>;
20 * Create a new `WorkerSet`.
22 * @param workerScript -
23 * @param workerOptions -
25 constructor(workerScript
: string, workerOptions
?: WorkerOptions
) {
26 super(workerScript
, workerOptions
);
27 this.workerSet
= new Set
<WorkerSetElement
>();
31 return this.workerSet
.size
;
34 get
maxElementsPerWorker(): number | null {
35 return this.workerOptions
.elementsPerWorker
;
40 * @param elementData -
44 public async addElement(elementData
: WorkerData
): Promise
<void> {
45 if (!this.workerSet
) {
46 throw new Error("Cannot add a WorkerSet element: workers' set does not exist");
49 this.workerSet
.size
=== 0 ||
50 this.getLastWorkerSetElement().numberOfWorkerElements
>= this.workerOptions
.elementsPerWorker
52 await this.startWorker();
54 this.getLastWorker().postMessage({
55 id
: WorkerMessageEvents
.START_WORKER_ELEMENT
,
58 this.getLastWorkerSetElement().numberOfWorkerElements
++;
59 // Start element sequentially to optimize memory at startup
60 if (this.workerOptions
.elementStartDelay
> 0) {
61 await Utils
.sleep(this.workerOptions
.elementStartDelay
);
70 public async start(): Promise
<void> {
71 await this.startWorker();
79 public async stop(): Promise
<void> {
80 for (const workerSetElement
of this.workerSet
) {
81 await workerSetElement
.worker
.terminate();
83 this.workerSet
.clear();
87 * Start a new `Worker`.
89 private async startWorker(): Promise
<void> {
90 const worker
= new Worker(this.workerScript
);
94 this.workerOptions
?.messageHandler
??
96 /* This is intentional */
98 ).bind(this) as MessageHandler
<Worker
>
100 worker
.on('error', WorkerUtils
.defaultErrorHandler
.bind(this) as (err
: Error) => void);
101 worker
.on('exit', code
=> {
102 WorkerUtils
.defaultExitHandler(code
);
103 this.workerSet
.delete(this.getWorkerSetElementByWorker(worker
));
105 this.workerSet
.add({ worker
, numberOfWorkerElements
: 0 });
106 // Start worker sequentially to optimize memory at startup
107 this.workerOptions
.workerStartDelay
> 0 &&
108 (await Utils
.sleep(this.workerOptions
.workerStartDelay
));
111 private getLastWorkerSetElement(): WorkerSetElement
{
112 let workerSetElement
: WorkerSetElement
;
113 for (workerSetElement
of this.workerSet
) {
114 /* This is intentional */
116 return workerSetElement
;
119 private getLastWorker(): Worker
{
120 return this.getLastWorkerSetElement().worker
;
123 private getWorkerSetElementByWorker(worker
: Worker
): WorkerSetElement
{
124 let workerSetElt
: WorkerSetElement
;
125 for (const workerSetElement
of this.workerSet
) {
126 if (workerSetElement
.worker
.threadId
=== worker
.threadId
) {
127 workerSetElt
= workerSetElement
;