X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fpools%2Fworker-node.ts;h=bf2600d57782873bea28f50f413a7de945a35b35;hb=60aa9f2f82b880212aa9478e05f18490175fcab8;hp=ed6677027f810474aa9aa01e768fd5f483250679;hpb=a4846bb2399905e5529826605c20526c3bdd4333;p=poolifier.git diff --git a/src/pools/worker-node.ts b/src/pools/worker-node.ts index ed667702..bf2600d5 100644 --- a/src/pools/worker-node.ts +++ b/src/pools/worker-node.ts @@ -1,25 +1,24 @@ import { MessageChannel } from 'node:worker_threads' -import { CircularArray } from '../circular-array' -import type { Task } from '../utility-types' -import { - DEFAULT_TASK_NAME, - EMPTY_FUNCTION, - exponentialDelay, - getWorkerId, - getWorkerType, - sleep -} from '../utils' -import { Deque } from '../deque' +import { EventEmitter } from 'node:events' +import { CircularArray } from '../circular-array.js' +import type { Task } from '../utility-types.js' +import { DEFAULT_TASK_NAME, getWorkerId, getWorkerType } from '../utils.js' +import { Deque } from '../deque.js' import { + type ErrorHandler, + type ExitHandler, type IWorker, type IWorkerNode, + type MessageHandler, + type OnlineHandler, type StrategyData, type WorkerInfo, - type WorkerNodeEventCallback, + type WorkerNodeOptions, type WorkerType, WorkerTypes, type WorkerUsage -} from './worker' +} from './worker.js' +import { checkWorkerNodeArguments, createWorker } from './utils.js' /** * Worker node. @@ -28,7 +27,8 @@ import { * @typeParam Data - Type of data sent to the worker. This can only be structured-cloneable data. */ export class WorkerNode -implements IWorkerNode { + extends EventEmitter + implements IWorkerNode { /** @inheritdoc */ public readonly worker: Worker /** @inheritdoc */ @@ -41,33 +41,32 @@ implements IWorkerNode { public messageChannel?: MessageChannel /** @inheritdoc */ public tasksQueueBackPressureSize: number - /** @inheritdoc */ - public onBackPressure?: WorkerNodeEventCallback - /** @inheritdoc */ - public onEmptyQueue?: WorkerNodeEventCallback private readonly tasksQueue: Deque> private onBackPressureStarted: boolean - private onEmptyQueueCount: number private readonly taskFunctionsUsage: Map /** * Constructs a new worker node. * - * @param worker - The worker. - * @param tasksQueueBackPressureSize - The tasks queue back pressure size. + * @param type - The worker type. + * @param filePath - Path to the worker file. + * @param opts - The worker node options. */ - constructor (worker: Worker, tasksQueueBackPressureSize: number) { - this.checkWorkerNodeArguments(worker, tasksQueueBackPressureSize) - this.worker = worker - this.info = this.initWorkerInfo(worker) + constructor (type: WorkerType, filePath: string, opts: WorkerNodeOptions) { + super() + checkWorkerNodeArguments(type, filePath, opts) + this.worker = createWorker(type, filePath, { + env: opts.env, + workerOptions: opts.workerOptions + }) + this.info = this.initWorkerInfo(this.worker) this.usage = this.initWorkerUsage() if (this.info.type === WorkerTypes.thread) { this.messageChannel = new MessageChannel() } - this.tasksQueueBackPressureSize = tasksQueueBackPressureSize + this.tasksQueueBackPressureSize = opts.tasksQueueBackPressureSize this.tasksQueue = new Deque>() this.onBackPressureStarted = false - this.onEmptyQueueCount = 0 this.taskFunctionsUsage = new Map() } @@ -79,13 +78,9 @@ implements IWorkerNode { /** @inheritdoc */ public enqueueTask (task: Task): number { const tasksQueueSize = this.tasksQueue.push(task) - if ( - this.onBackPressure != null && - this.hasBackPressure() && - !this.onBackPressureStarted - ) { + if (this.hasBackPressure() && !this.onBackPressureStarted) { this.onBackPressureStarted = true - this.onBackPressure(this.info.id as number) + this.emit('backPressure', { workerId: this.info.id as number }) this.onBackPressureStarted = false } return tasksQueueSize @@ -94,13 +89,9 @@ implements IWorkerNode { /** @inheritdoc */ public unshiftTask (task: Task): number { const tasksQueueSize = this.tasksQueue.unshift(task) - if ( - this.onBackPressure != null && - this.hasBackPressure() && - !this.onBackPressureStarted - ) { + if (this.hasBackPressure() && !this.onBackPressureStarted) { this.onBackPressureStarted = true - this.onBackPressure(this.info.id as number) + this.emit('backPressure', { workerId: this.info.id as number }) this.onBackPressureStarted = false } return tasksQueueSize @@ -108,28 +99,12 @@ implements IWorkerNode { /** @inheritdoc */ public dequeueTask (): Task | undefined { - const task = this.tasksQueue.shift() - if ( - this.onEmptyQueue != null && - this.tasksQueue.size === 0 && - this.onEmptyQueueCount === 0 - ) { - this.startOnEmptyQueue().catch(EMPTY_FUNCTION) - } - return task + return this.tasksQueue.shift() } /** @inheritdoc */ public popTask (): Task | undefined { - const task = this.tasksQueue.pop() - if ( - this.onEmptyQueue != null && - this.tasksQueue.size === 0 && - this.onEmptyQueueCount === 0 - ) { - this.startOnEmptyQueue().catch(EMPTY_FUNCTION) - } - return task + return this.tasksQueue.pop() } /** @inheritdoc */ @@ -149,14 +124,50 @@ implements IWorkerNode { } /** @inheritdoc */ - public closeChannel (): void { - if (this.messageChannel != null) { - this.messageChannel?.port1.unref() - this.messageChannel?.port2.unref() - this.messageChannel?.port1.close() - this.messageChannel?.port2.close() - delete this.messageChannel + public async terminate (): Promise { + const waitWorkerExit = new Promise(resolve => { + this.registerOnceWorkerEventHandler('exit', () => { + resolve() + }) + }) + this.closeMessageChannel() + this.removeAllListeners() + switch (this.info.type) { + case WorkerTypes.thread: + await this.worker.terminate?.() + break + case WorkerTypes.cluster: + this.registerOnceWorkerEventHandler('disconnect', () => { + this.worker.kill?.() + }) + this.worker.disconnect?.() + break } + await waitWorkerExit + } + + /** @inheritdoc */ + public registerWorkerEventHandler ( + event: string, + handler: + | OnlineHandler + | MessageHandler + | ErrorHandler + | ExitHandler + ): void { + this.worker.on(event, handler) + } + + /** @inheritdoc */ + public registerOnceWorkerEventHandler ( + event: string, + handler: + | OnlineHandler + | MessageHandler + | ErrorHandler + | ExitHandler + ): void { + this.worker.once(event, handler) } /** @inheritdoc */ @@ -183,18 +194,19 @@ implements IWorkerNode { return this.taskFunctionsUsage.get(name) } - private async startOnEmptyQueue (): Promise { - if ( - this.onEmptyQueueCount > 0 && - (this.usage.tasks.executing > 0 || this.tasksQueue.size > 0) - ) { - this.onEmptyQueueCount = 0 - return + /** @inheritdoc */ + public deleteTaskFunctionWorkerUsage (name: string): boolean { + return this.taskFunctionsUsage.delete(name) + } + + private closeMessageChannel (): void { + if (this.messageChannel != null) { + this.messageChannel.port1.unref() + this.messageChannel.port2.unref() + this.messageChannel.port1.close() + this.messageChannel.port2.close() + delete this.messageChannel } - ++this.onEmptyQueueCount - this.onEmptyQueue?.(this.info.id as number) - await sleep(exponentialDelay(this.onEmptyQueueCount)) - await this.startOnEmptyQueue() } private initWorkerInfo (worker: Worker): WorkerInfo { @@ -202,7 +214,8 @@ implements IWorkerNode { id: getWorkerId(worker), type: getWorkerType(worker) as WorkerType, dynamic: false, - ready: false + ready: false, + stealing: false } } @@ -223,21 +236,22 @@ implements IWorkerNode { get maxQueued (): number { return getTasksQueueMaxSize() }, + sequentiallyStolen: 0, stolen: 0, failed: 0 }, runTime: { - history: new CircularArray() + history: new CircularArray() }, waitTime: { - history: new CircularArray() + history: new CircularArray() }, elu: { idle: { - history: new CircularArray() + history: new CircularArray() }, active: { - history: new CircularArray() + history: new CircularArray() } } } @@ -264,47 +278,24 @@ implements IWorkerNode { get queued (): number { return getTaskFunctionQueueSize() }, + sequentiallyStolen: 0, stolen: 0, failed: 0 }, runTime: { - history: new CircularArray() + history: new CircularArray() }, waitTime: { - history: new CircularArray() + history: new CircularArray() }, elu: { idle: { - history: new CircularArray() + history: new CircularArray() }, active: { - history: new CircularArray() + history: new CircularArray() } } } } - - private checkWorkerNodeArguments ( - worker: Worker, - tasksQueueBackPressureSize: number - ): void { - if (worker == null) { - throw new TypeError('Cannot construct a worker node without a worker') - } - if (tasksQueueBackPressureSize == null) { - throw new TypeError( - 'Cannot construct a worker node without a tasks queue back pressure size' - ) - } - if (!Number.isSafeInteger(tasksQueueBackPressureSize)) { - throw new TypeError( - 'Cannot construct a worker node with a tasks queue back pressure size that is not an integer' - ) - } - if (tasksQueueBackPressureSize <= 0) { - throw new RangeError( - 'Cannot construct a worker node with a tasks queue back pressure size that is not a positive integer' - ) - } - } }