X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fthread%2Ffixed.ts;h=28f8fceba679e5f9053820b8436583caf69f20af;hb=fa548cda5120ac0708d82f37cd0ce1260d7f96c1;hp=3dc10821e2cdb9198e3eea62e287a4fc4d8aa425;hpb=027063571693f211b35c8851566a063201adb9af;p=poolifier.git diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts index 3dc10821..28f8fceb 100644 --- a/src/pools/thread/fixed.ts +++ b/src/pools/thread/fixed.ts @@ -1,35 +1,41 @@ import { - isMainThread, - MessageChannel, + type MessageChannel, + type MessagePort, SHARE_ENV, - Worker + type TransferListItem, + Worker, + type WorkerOptions, + isMainThread } from 'node:worker_threads' -import type { Draft, MessageValue } from '../../utility-types' +import type { MessageValue } from '../../utility-types' import { AbstractPool } from '../abstract-pool' -import type { PoolOptions } from '../pool' -import { PoolType } from '../pool' +import { type PoolOptions, type PoolType, PoolTypes } from '../pool' +import { type WorkerType, WorkerTypes } from '../worker' /** - * A thread worker with message channels for communication between main thread and thread worker. + * Options for a poolifier thread pool. */ -export type ThreadWorkerWithMessageChannel = Worker & Draft +export interface ThreadPoolOptions extends PoolOptions { + /** + * Worker options. + * + * @see https://nodejs.org/api/worker_threads.html#new-workerfilename-options + */ + workerOptions?: WorkerOptions +} /** * A thread pool with a fixed number of threads. * - * It is possible to perform tasks in sync or asynchronous mode as you prefer. - * - * This pool selects the threads in a round robin fashion. - * - * @typeParam Data - Type of data sent to the worker. This can only be serializable data. - * @typeParam Response - Type of execution response. This can only be serializable data. + * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. + * @typeParam Response - Type of execution response. This can only be structured-cloneable data. * @author [Alessandro Pio Ardizio](https://github.com/pioardi) * @since 0.0.1 */ export class FixedThreadPool< Data = unknown, Response = unknown -> extends AbstractPool { +> extends AbstractPool { /** * Constructs a new poolifier fixed thread pool. * @@ -40,7 +46,7 @@ export class FixedThreadPool< public constructor ( numberOfThreads: number, filePath: string, - opts: PoolOptions = {} + protected readonly opts: ThreadPoolOptions = {} ) { super(numberOfThreads, filePath, opts) } @@ -51,54 +57,100 @@ export class FixedThreadPool< } /** @inheritDoc */ - protected async destroyWorker ( - worker: ThreadWorkerWithMessageChannel - ): Promise { - this.sendToWorker(worker, { kill: 1 }) + protected async destroyWorkerNode (workerNodeKey: number): Promise { + this.flagWorkerNodeAsNotReady(workerNodeKey) + this.flushTasksQueue(workerNodeKey) + // FIXME: wait for tasks to be finished + const workerNode = this.workerNodes[workerNodeKey] + const worker = workerNode.worker + const waitWorkerExit = new Promise(resolve => { + worker.once('exit', () => { + resolve() + }) + }) + await this.sendKillMessageToWorker(workerNodeKey) + workerNode.closeChannel() + workerNode.removeAllListeners() await worker.terminate() + await waitWorkerExit } /** @inheritDoc */ protected sendToWorker ( - worker: ThreadWorkerWithMessageChannel, - message: MessageValue + workerNodeKey: number, + message: MessageValue, + transferList?: TransferListItem[] ): void { - worker.postMessage(message) + this.workerNodes[workerNodeKey].messageChannel?.port1?.postMessage( + { ...message, workerId: this.getWorkerInfo(workerNodeKey).id }, + transferList + ) + } + + /** @inheritDoc */ + protected sendStartupMessageToWorker (workerNodeKey: number): void { + const workerNode = this.workerNodes[workerNodeKey] + const port2: MessagePort = (workerNode.messageChannel as MessageChannel) + .port2 + workerNode.worker.postMessage( + { + ready: false, + workerId: this.getWorkerInfo(workerNodeKey).id, + port: port2 + }, + [port2] + ) } /** @inheritDoc */ protected registerWorkerMessageListener( - messageChannel: ThreadWorkerWithMessageChannel, + workerNodeKey: number, listener: (message: MessageValue) => void ): void { - messageChannel.port2?.on('message', listener) + this.workerNodes[workerNodeKey].messageChannel?.port1?.on( + 'message', + listener + ) } /** @inheritDoc */ - protected createWorker (): ThreadWorkerWithMessageChannel { - return new Worker(this.filePath, { - env: SHARE_ENV - }) + protected registerOnceWorkerMessageListener( + workerNodeKey: number, + listener: (message: MessageValue) => void + ): void { + this.workerNodes[workerNodeKey].messageChannel?.port1?.once( + 'message', + listener + ) + } + + /** @inheritDoc */ + protected deregisterWorkerMessageListener( + workerNodeKey: number, + listener: (message: MessageValue) => void + ): void { + this.workerNodes[workerNodeKey].messageChannel?.port1?.off( + 'message', + listener + ) } /** @inheritDoc */ - protected afterWorkerSetup (worker: ThreadWorkerWithMessageChannel): void { - const { port1, port2 } = new MessageChannel() - worker.postMessage({ parent: port1 }, [port1]) - worker.port1 = port1 - worker.port2 = port2 - // Listen to worker messages. - this.registerWorkerMessageListener(worker, super.workerListener()) + protected createWorker (): Worker { + return new Worker(this.filePath, { + env: SHARE_ENV, + ...this.opts.workerOptions + }) } /** @inheritDoc */ - public get type (): PoolType { - return PoolType.FIXED + protected get type (): PoolType { + return PoolTypes.fixed } /** @inheritDoc */ - protected get full (): boolean { - return this.workerNodes.length === this.numberOfWorkers + protected get worker (): WorkerType { + return WorkerTypes.thread } /** @inheritDoc */