X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=64627efb8823198c6cb09c81fbdded3bef046f01;hb=3d76750ac8dacd95003ca89cf9542c3b2a014b8c;hp=1b8a673c2a78d461288bc6c4f30fa8eb5a942285;hpb=2a69b8c50a10229de607013f867d685ee594dba9;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index 1b8a673c..64627efb 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -20,11 +20,11 @@ import { type WorkerOptions } from './worker-options' import type { + TaskAsyncFunction, + TaskFunction, TaskFunctions, - WorkerAsyncFunction, - WorkerFunction, - WorkerSyncFunction -} from './worker-functions' + TaskSyncFunction +} from './task-functions' const DEFAULT_MAX_INACTIVE_TIME = 60000 const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT @@ -48,7 +48,7 @@ export abstract class AbstractWorker< /** * Task function(s) processed by the worker when the pool's `execution` function is invoked. */ - protected taskFunctions!: Map> + protected taskFunctions!: Map> /** * Timestamp of the last task processed by this worker. */ @@ -66,17 +66,15 @@ export abstract class AbstractWorker< * * @param type - The type of async event. * @param isMain - Whether this is the main worker or not. - * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked. The first function is the default function. * @param mainWorker - Reference to main worker. + * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked. The first function is the default function. * @param opts - Options for the worker. */ public constructor ( type: string, protected readonly isMain: boolean, - taskFunctions: - | WorkerFunction - | TaskFunctions, - protected readonly mainWorker: MainWorker, + private readonly mainWorker: MainWorker, + taskFunctions: TaskFunction | TaskFunctions, protected readonly opts: WorkerOptions = { /** * The kill behavior option on this worker or its default value. @@ -93,7 +91,7 @@ export abstract class AbstractWorker< this.checkWorkerOptions(this.opts) this.checkTaskFunctions(taskFunctions) if (!this.isMain) { - this.mainWorker?.on('message', this.messageListener.bind(this)) + this.getMainWorker()?.on('message', this.handleReadyMessage.bind(this)) } } @@ -110,14 +108,12 @@ export abstract class AbstractWorker< * @param taskFunctions - The task function(s) parameter that should be checked. */ private checkTaskFunctions ( - taskFunctions: - | WorkerFunction - | TaskFunctions + taskFunctions: TaskFunction | TaskFunctions ): void { if (taskFunctions == null) { throw new Error('taskFunctions parameter is mandatory') } - this.taskFunctions = new Map>() + this.taskFunctions = new Map>() if (typeof taskFunctions === 'function') { const boundFn = taskFunctions.bind(this) this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn) @@ -142,11 +138,11 @@ export abstract class AbstractWorker< ) } const boundFn = fn.bind(this) - this.taskFunctions.set(name, boundFn) if (firstEntry) { this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn) firstEntry = false } + this.taskFunctions.set(name, boundFn) } if (firstEntry) { throw new Error('taskFunctions parameter object is empty') @@ -185,7 +181,7 @@ export abstract class AbstractWorker< */ public addTaskFunction ( name: string, - fn: WorkerFunction + fn: TaskFunction ): boolean { if (typeof name !== 'string') { throw new TypeError('name parameter is not a string') @@ -198,8 +194,8 @@ export abstract class AbstractWorker< if (typeof fn !== 'function') { throw new TypeError('fn parameter is not a function') } - const boundFn = fn.bind(this) try { + const boundFn = fn.bind(this) if ( this.taskFunctions.get(name) === this.taskFunctions.get(DEFAULT_TASK_NAME) @@ -242,7 +238,16 @@ export abstract class AbstractWorker< } /** - * Sets the default task function to use when no task function name is specified. + * Lists the names of the worker's task functions. + * + * @returns The names of the worker's task functions. + */ + public listTaskFunctions (): string[] { + return [...this.taskFunctions.keys()] + } + + /** + * Sets the default task function to use in the worker. * * @param name - The name of the task function to use as default task function. * @returns Whether the default task function was set or not. @@ -267,7 +272,7 @@ export abstract class AbstractWorker< try { this.taskFunctions.set( DEFAULT_TASK_NAME, - this.taskFunctions.get(name) as WorkerFunction + this.taskFunctions.get(name) as TaskFunction ) return true } catch { @@ -275,38 +280,48 @@ export abstract class AbstractWorker< } } + /** + * Handles the ready message sent by the main worker. + * + * @param message - The ready message. + */ + protected abstract handleReadyMessage (message: MessageValue): void + /** * Worker message listener. * * @param message - The received message. */ - protected messageListener (message: MessageValue): void { - if (message.workerId === this.id) { - if (message.ready != null) { - // Startup message received - this.sendReadyResponse() - } else if (message.statistics != null) { + protected messageListener (message: MessageValue): void { + if (message.workerId != null && message.workerId !== this.id) { + throw new Error('Message worker id does not match worker id') + } else if (message.workerId === this.id) { + if (message.statistics != null) { // Statistics message received this.statistics = message.statistics } else if (message.checkActive != null) { // Check active message received - message.checkActive ? this.startCheckActive() : this.stopCheckActive() - } else if (message.id != null && message.data != null) { + !this.isMain && message.checkActive + ? this.startCheckActive() + : this.stopCheckActive() + } else if (message.taskId != null && message.data != null) { // Task message received this.run(message) } else if (message.kill === true) { // Kill message received - this.stopCheckActive() - this.emitDestroy() + this.handleKillMessage(message) } } } /** - * Sends the ready response to the main worker. + * Handles a kill message sent by the main worker. + * + * @param message - The kill message. */ - protected sendReadyResponse (): void { - !this.isMain && this.sendToMainWorker({ ready: true, workerId: this.id }) + protected handleKillMessage (message: MessageValue): void { + !this.isMain && this.stopCheckActive() + this.emitDestroy() } /** @@ -324,7 +339,10 @@ export abstract class AbstractWorker< * Stops the worker check active interval. */ private stopCheckActive (): void { - this.activeInterval != null && clearInterval(this.activeInterval) + if (this.activeInterval != null) { + clearInterval(this.activeInterval) + delete this.activeInterval + } } /** @@ -352,7 +370,7 @@ export abstract class AbstractWorker< } /** - * Sends a message to the main worker. + * Sends a message to main worker. * * @param message - The response message. */ @@ -377,6 +395,9 @@ export abstract class AbstractWorker< * @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found. */ protected run (task: Task): void { + if (this.isMain) { + throw new Error('Cannot run a task in the main worker') + } const fn = this.getTaskFunction(task.name) if (isAsyncFunction(fn)) { this.runInAsyncScope(this.runAsync.bind(this), this, fn, task) @@ -392,7 +413,7 @@ export abstract class AbstractWorker< * @param task - Input data for the task function. */ protected runSync ( - fn: WorkerSyncFunction, + fn: TaskSyncFunction, task: Task ): void { try { @@ -403,7 +424,7 @@ export abstract class AbstractWorker< data: res, taskPerformance, workerId: this.id, - id: task.id + taskId: task.taskId }) } catch (e) { const errorMessage = this.handleError(e as Error | string) @@ -414,12 +435,10 @@ export abstract class AbstractWorker< data: task.data }, workerId: this.id, - id: task.id + taskId: task.taskId }) } finally { - if (!this.isMain && this.activeInterval != null) { - this.lastTaskTimestamp = performance.now() - } + this.updateLastTaskTimestamp() } } @@ -430,7 +449,7 @@ export abstract class AbstractWorker< * @param task - Input data for the task function. */ protected runAsync ( - fn: WorkerAsyncFunction, + fn: TaskAsyncFunction, task: Task ): void { let taskPerformance = this.beginTaskPerformance(task.name) @@ -441,7 +460,7 @@ export abstract class AbstractWorker< data: res, taskPerformance, workerId: this.id, - id: task.id + taskId: task.taskId }) return null }) @@ -454,13 +473,11 @@ export abstract class AbstractWorker< data: task.data }, workerId: this.id, - id: task.id + taskId: task.taskId }) }) .finally(() => { - if (!this.isMain && this.activeInterval != null) { - this.lastTaskTimestamp = performance.now() - } + this.updateLastTaskTimestamp() }) .catch(EMPTY_FUNCTION) } @@ -472,7 +489,7 @@ export abstract class AbstractWorker< * @returns The task function. * @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found. */ - private getTaskFunction (name?: string): WorkerFunction { + private getTaskFunction (name?: string): TaskFunction { name = name ?? DEFAULT_TASK_NAME const fn = this.taskFunctions.get(name) if (fn == null) { @@ -510,4 +527,10 @@ export abstract class AbstractWorker< throw new Error('Performance statistics computation requirements not set') } } + + private updateLastTaskTimestamp (): void { + if (!this.isMain && this.activeInterval != null) { + this.lastTaskTimestamp = performance.now() + } + } }