-import { isMainThread, MessageChannel, SHARE_ENV, Worker } from 'worker_threads'
-import type { Draft, MessageValue } from '../../utility-types'
+import {
+ isMainThread,
+ type TransferListItem,
+ type Worker,
+} from 'node:worker_threads'
-export type WorkerWithMessageChannel = Worker & Draft<MessageChannel>
+import type { MessageValue } from '../../utility-types.js'
+import { AbstractPool } from '../abstract-pool.js'
+import { type PoolOptions, type PoolType, PoolTypes } from '../pool.js'
+import { type WorkerType, WorkerTypes } from '../worker.js'
-export interface FixedThreadPoolOptions {
- /**
- * A function that will listen for error event on each worker thread.
- */
- errorHandler?: (this: Worker, e: Error) => void
- /**
- * A function that will listen for online event on each worker thread.
- */
- onlineHandler?: (this: Worker) => void
- /**
- * A function that will listen for exit event on each worker thread.
- */
- exitHandler?: (this: Worker, code: number) => void
- /**
- * This is just to avoid not useful warnings message, is used to set `maxListeners` on event emitters (workers are event emitters).
- *
- * @default 1000
- */
- maxTasks?: number
-}
+/**
+ * Options for a poolifier thread pool.
+ */
+export type ThreadPoolOptions = PoolOptions<Worker>
/**
- * A thread pool with a static number of threads, is possible to execute tasks in sync or async mode as you prefer.
- *
- * This pool will select the worker thread in a round robin fashion.
- *
+ * A thread pool with a fixed number of threads.
+ * @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
*/
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export class FixedThreadPool<Data = any, Response = any> {
- public readonly workers: WorkerWithMessageChannel[] = []
- public nextWorker: number = 0
-
- // threadId as key and an integer value
- public readonly tasks: Map<WorkerWithMessageChannel, number> = new Map<
- WorkerWithMessageChannel,
- number
- >()
-
- protected id: number = 0
-
+export class FixedThreadPool<
+ Data = unknown,
+ Response = unknown
+> extends AbstractPool<Worker, Data, Response> {
/**
- * @param numThreads Num of threads for this worker pool.
- * @param filePath A file path with implementation of `ThreadWorker` class, relative path is fine.
- * @param opts An object with possible options for example `errorHandler`, `onlineHandler`. Default: `{ maxTasks: 1000 }`
+ * 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.
+ * @param maximumNumberOfThreads - The maximum number of threads for this pool.
*/
public constructor (
- public readonly numThreads: number,
- public readonly filePath: string,
- public readonly opts: FixedThreadPoolOptions = { maxTasks: 1000 }
+ numberOfThreads: number,
+ filePath: string,
+ opts: ThreadPoolOptions = {},
+ maximumNumberOfThreads?: number
) {
- if (!isMainThread) {
- throw new Error('Cannot start a thread pool from a worker thread !!!')
- }
- // TODO christopher 2021-02-07: Improve this check e.g. with a pattern or blank check
- if (!this.filePath) {
- throw new Error('Please specify a file with a worker implementation')
- }
+ super(numberOfThreads, filePath, opts, maximumNumberOfThreads)
+ }
- for (let i = 1; i <= this.numThreads; i++) {
- this.newWorker()
- }
+ /** @inheritDoc */
+ protected isMain (): boolean {
+ return isMainThread
}
- public async destroy (): Promise<void> {
- for (const worker of this.workers) {
- await worker.terminate()
- }
+ /** @inheritDoc */
+ protected sendToWorker (
+ workerNodeKey: number,
+ message: MessageValue<Data>,
+ transferList?: readonly TransferListItem[]
+ ): void {
+ this.workerNodes[workerNodeKey]?.messageChannel?.port1.postMessage(
+ {
+ ...message,
+ workerId: this.getWorkerInfo(workerNodeKey)?.id,
+ } satisfies MessageValue<Data>,
+ transferList
+ )
}
- /**
- * Execute the task specified into the constructor with the data parameter.
- *
- * @param data The input for the task specified.
- * @returns Promise that is resolved when the task is done.
- */
- public execute (data: Data): Promise<Response> {
- // configure worker to handle message with the specified task
- const worker = this.chooseWorker()
- const previousWorkerIndex = this.tasks.get(worker)
- if (previousWorkerIndex !== undefined) {
- this.tasks.set(worker, previousWorkerIndex + 1)
- } else {
- throw Error('Worker could not be found in tasks map')
- }
- const id = ++this.id
- const res = this.internalExecute(worker, id)
- worker.postMessage({ data: data || {}, id: id })
- return res
+ /** @inheritDoc */
+ protected sendStartupMessageToWorker (workerNodeKey: number): void {
+ const workerNode = this.workerNodes[workerNodeKey]
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ const port2 = workerNode.messageChannel!.port2
+ workerNode.worker.postMessage(
+ {
+ ready: false,
+ workerId: this.getWorkerInfo(workerNodeKey)?.id,
+ port: port2,
+ } satisfies MessageValue<Data>,
+ [port2]
+ )
+ }
+
+ /** @inheritDoc */
+ protected registerWorkerMessageListener<Message extends Data | Response>(
+ workerNodeKey: number,
+ listener: (message: MessageValue<Message>) => void
+ ): void {
+ this.workerNodes[workerNodeKey].messageChannel?.port1.on(
+ 'message',
+ listener
+ )
+ }
+
+ /** @inheritDoc */
+ protected registerOnceWorkerMessageListener<Message extends Data | Response>(
+ workerNodeKey: number,
+ listener: (message: MessageValue<Message>) => void
+ ): void {
+ this.workerNodes[workerNodeKey].messageChannel?.port1.once(
+ 'message',
+ listener
+ )
+ }
+
+ /** @inheritDoc */
+ protected deregisterWorkerMessageListener<Message extends Data | Response>(
+ workerNodeKey: number,
+ listener: (message: MessageValue<Message>) => void
+ ): void {
+ this.workerNodes[workerNodeKey].messageChannel?.port1.off(
+ 'message',
+ listener
+ )
+ }
+
+ /** @inheritDoc */
+ protected shallCreateDynamicWorker (): boolean {
+ return false
+ }
+
+ /** @inheritDoc */
+ protected checkAndEmitDynamicWorkerCreationEvents (): void {
+ /* noop */
}
- protected internalExecute (
- worker: WorkerWithMessageChannel,
- id: number
- ): Promise<Response> {
- return new Promise((resolve, reject) => {
- const listener: (message: MessageValue<Response>) => void = message => {
- if (message.id === id) {
- worker.port2?.removeListener('message', listener)
- const previousWorkerIndex = this.tasks.get(worker)
- if (previousWorkerIndex !== undefined) {
- this.tasks.set(worker, previousWorkerIndex + 1)
- } else {
- throw Error('Worker could not be found in tasks map')
- }
- if (message.error) reject(message.error)
- else resolve(message.data as Response)
- }
- }
- worker.port2?.on('message', listener)
- })
+ /** @inheritDoc */
+ protected get type (): PoolType {
+ return PoolTypes.fixed
}
- protected chooseWorker (): WorkerWithMessageChannel {
- if (this.workers.length - 1 === this.nextWorker) {
- this.nextWorker = 0
- return this.workers[this.nextWorker]
- } else {
- this.nextWorker++
- return this.workers[this.nextWorker]
- }
+ /** @inheritDoc */
+ protected get worker (): WorkerType {
+ return WorkerTypes.thread
}
- protected newWorker (): WorkerWithMessageChannel {
- const worker: WorkerWithMessageChannel = new Worker(this.filePath, {
- env: SHARE_ENV
- })
- worker.on('error', this.opts.errorHandler ?? (() => {}))
- worker.on('online', this.opts.onlineHandler ?? (() => {}))
- // TODO handle properly when a thread exit
- worker.on('exit', this.opts.exitHandler ?? (() => {}))
- this.workers.push(worker)
- const { port1, port2 } = new MessageChannel()
- worker.postMessage({ parent: port1 }, [port1])
- worker.port1 = port1
- worker.port2 = port2
- // we will attach a listener for every task,
- // when task is completed the listener will be removed but to avoid warnings we are increasing the max listeners size
- worker.port2.setMaxListeners(this.opts.maxTasks ?? 1000)
- // init tasks map
- this.tasks.set(worker, 0)
- return worker
+ /** @inheritDoc */
+ protected get busy (): boolean {
+ return this.internalBusy()
}
}