-import { isMainThread, MessageChannel, SHARE_ENV, Worker } from 'worker_threads'
-import type { Draft, MessageValue } from '../../utility-types'
-import type { PoolOptions } from '../abstract-pool'
-import { AbstractPool } from '../abstract-pool'
+import {
+ isMainThread,
+ type TransferListItem,
+ type Worker
+} from 'node:worker_threads'
-export type ThreadWorkerWithMessageChannel = 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'
/**
- * 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.
+ * Options for a poolifier thread pool.
+ */
+export type ThreadPoolOptions = PoolOptions<Worker>
+
+/**
+ * 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> extends AbstractPool<
- ThreadWorkerWithMessageChannel,
- Data,
- Response
-> {
+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.
*/
public constructor (
- numThreads: number,
+ numberOfThreads: number,
filePath: string,
- opts: PoolOptions<ThreadWorkerWithMessageChannel> = { maxTasks: 1000 }
+ opts: ThreadPoolOptions = {},
+ maximumNumberOfThreads?: number
) {
- super(numThreads, filePath, opts)
+ super(numberOfThreads, filePath, opts, maximumNumberOfThreads)
}
+ /** @inheritDoc */
protected isMain (): boolean {
return isMainThread
}
- protected async destroyWorker (
- worker: ThreadWorkerWithMessageChannel
- ): Promise<void> {
- 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
+ )
}
- protected sendToWorker (
- worker: ThreadWorkerWithMessageChannel,
- message: MessageValue<Data>
+ /** @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 {
- worker.postMessage(message)
+ this.workerNodes[workerNodeKey].messageChannel?.port1.on(
+ 'message',
+ listener
+ )
}
- protected registerWorkerMessageListener (
- port: ThreadWorkerWithMessageChannel,
- listener: (message: MessageValue<Response>) => void
+ /** @inheritDoc */
+ protected registerOnceWorkerMessageListener<Message extends Data | Response>(
+ workerNodeKey: number,
+ listener: (message: MessageValue<Message>) => void
): void {
- port.port2?.on('message', listener)
+ this.workerNodes[workerNodeKey].messageChannel?.port1.once(
+ 'message',
+ listener
+ )
}
- protected unregisterWorkerMessageListener (
- port: ThreadWorkerWithMessageChannel,
- listener: (message: MessageValue<Response>) => void
+ /** @inheritDoc */
+ protected deregisterWorkerMessageListener<Message extends Data | Response>(
+ workerNodeKey: number,
+ listener: (message: MessageValue<Message>) => void
): void {
- port.port2?.removeListener('message', listener)
+ this.workerNodes[workerNodeKey].messageChannel?.port1.off(
+ 'message',
+ listener
+ )
}
- protected newWorker (): ThreadWorkerWithMessageChannel {
- return new Worker(this.filePath, {
- env: SHARE_ENV
- })
+ /** @inheritDoc */
+ protected shallCreateDynamicWorker (): boolean {
+ return false
}
- protected afterNewWorkerPushed (
- worker: ThreadWorkerWithMessageChannel
- ): void {
- 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)
+ /** @inheritDoc */
+ protected checkAndEmitDynamicWorkerCreationEvents (): void {
+ /* noop */
+ }
+
+ /** @inheritDoc */
+ protected get type (): PoolType {
+ return PoolTypes.fixed
+ }
+
+ /** @inheritDoc */
+ protected get worker (): WorkerType {
+ return WorkerTypes.thread
+ }
+
+ /** @inheritDoc */
+ protected get busy (): boolean {
+ return this.internalBusy()
}
}
repositories / poolifier.git / blobdiff