X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fthread%2Ffixed.ts;h=8dd4e7e33e422b4467a76931b201c45c0ad80712;hb=7884d1837ee55026fe5204a56f4ebeca17e7e7dd;hp=7dda3f3090f72459a599128213364cb380a7356b;hpb=6e9d10db05ac2bbc85373195a5c885d2492fee61;p=poolifier.git diff --git a/src/pools/thread/fixed.ts b/src/pools/thread/fixed.ts index 7dda3f30..8dd4e7e3 100644 --- a/src/pools/thread/fixed.ts +++ b/src/pools/thread/fixed.ts @@ -1,99 +1,145 @@ -import { isMainThread, MessageChannel, SHARE_ENV, Worker } from 'worker_threads' -import type { Draft, MessageValue } from '../../utility-types' -import type { PoolOptions } from '../abstract-pool' +import { + type MessageChannel, + type MessagePort, + SHARE_ENV, + type TransferListItem, + Worker, + type WorkerOptions, + isMainThread +} from 'node:worker_threads' +import type { MessageValue } from '../../utility-types' import { AbstractPool } from '../abstract-pool' -import { PoolType } from '../pool-internal' +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. - * - * @template Data Type of data sent to the worker. This can only be serializable data. - * @template Response Type of response of execution. 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. * - * @param numberOfThreads Number of threads for this pool. - * @param filePath Path to an implementation of a `ThreadWorker` file, which can be relative or absolute. - * @param opts Options for this fixed thread pool. Default: `{}` + * @param numberOfThreads - Number of threads for this pool. + * @param filePath - Path to an implementation of a `ThreadWorker` file, which can be relative or absolute. + * @param opts - Options for this fixed thread pool. */ public constructor ( numberOfThreads: number, filePath: string, - opts: PoolOptions = {} + protected readonly opts: ThreadPoolOptions = {} ) { super(numberOfThreads, filePath, opts) } - /** @inheritdoc */ + /** @inheritDoc */ protected isMain (): boolean { return isMainThread } - /** @inheritdoc */ - public async destroyWorker ( - worker: ThreadWorkerWithMessageChannel - ): Promise { - this.sendToWorker(worker, { kill: 1 }) + /** @inheritDoc */ + protected async destroyWorkerNode (workerNodeKey: number): Promise { + 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.on('exit', () => { + resolve() + }) + }) + await this.sendKillMessageToWorker(workerNodeKey, worker.threadId) + workerNode.closeChannel() await worker.terminate() + await waitWorkerExit } - /** @inheritdoc */ + /** @inheritDoc */ protected sendToWorker ( - worker: ThreadWorkerWithMessageChannel, - message: MessageValue + workerNodeKey: number, + message: MessageValue, + transferList?: TransferListItem[] ): void { - worker.postMessage(message) + ( + this.workerNodes[workerNodeKey].messageChannel as MessageChannel + ).port1.postMessage(message, transferList) + } + + /** @inheritDoc */ + protected sendStartupMessageToWorker (workerNodeKey: number): void { + const worker = this.workerNodes[workerNodeKey].worker + const port2: MessagePort = ( + this.workerNodes[workerNodeKey].messageChannel as MessageChannel + ).port2 + worker.postMessage( + { + ready: false, + workerId: worker.threadId, + port: port2 + }, + [port2] + ) } - /** @inheritdoc */ - public registerWorkerMessageListener ( - messageChannel: ThreadWorkerWithMessageChannel, + /** @inheritDoc */ + protected registerWorkerMessageListener( + workerNodeKey: number, listener: (message: MessageValue) => void ): void { - messageChannel.port2?.on('message', listener) + ( + this.workerNodes[workerNodeKey].messageChannel as MessageChannel + ).port1.on('message', listener) } - /** @inheritdoc */ - protected createWorker (): ThreadWorkerWithMessageChannel { + /** @inheritDoc */ + protected createWorker (): Worker { return new Worker(this.filePath, { - env: SHARE_ENV + env: SHARE_ENV, + ...this.opts.workerOptions }) } - /** @inheritdoc */ - protected afterWorkerSetup (worker: ThreadWorkerWithMessageChannel): void { - const { port1, port2 } = new MessageChannel() - worker.postMessage({ parent: port1 }, [port1]) - worker.port1 = port1 - worker.port2 = port2 - // Listen worker messages. - this.registerWorkerMessageListener(worker, super.workerListener()) + /** @inheritDoc */ + protected get type (): PoolType { + return PoolTypes.fixed + } + + /** @inheritDoc */ + protected get worker (): WorkerType { + return WorkerTypes.thread + } + + /** @inheritDoc */ + protected get minSize (): number { + return this.numberOfWorkers } - /** @inheritdoc */ - public get type (): PoolType { - return PoolType.FIXED + /** @inheritDoc */ + protected get maxSize (): number { + return this.numberOfWorkers } - /** @inheritdoc */ - public get busy (): boolean { - return this.internalGetBusyStatus() + /** @inheritDoc */ + protected get busy (): boolean { + return this.internalBusy() } }