X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=6bf84b875622ebaece3d8b4b8dae3c637593ed68;hb=ee9f0ad39b47fe80bb08d159024dad0fae81f6c5;hp=0f1d442a6f242ef2a25068f8e212f2fbff686a37;hpb=984dc9c8adc66d4ed982e76391db751dd685f0b2;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index 0f1d442a..6bf84b87 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. */ @@ -74,9 +74,7 @@ export abstract class AbstractWorker< type: string, protected readonly isMain: boolean, private readonly mainWorker: MainWorker, - taskFunctions: - | WorkerFunction - | TaskFunctions, + taskFunctions: TaskFunction | TaskFunctions, protected readonly opts: WorkerOptions = { /** * The kill behavior option on this worker or its default value. @@ -86,7 +84,11 @@ export abstract class AbstractWorker< * The maximum time to keep this worker active while idle. * The pool automatically checks and terminates this worker when the time expires. */ - maxInactiveTime: DEFAULT_MAX_INACTIVE_TIME + maxInactiveTime: DEFAULT_MAX_INACTIVE_TIME, + /** + * The function to call when the worker is killed. + */ + killHandler: EMPTY_FUNCTION } ) { super(type) @@ -102,6 +104,7 @@ export abstract class AbstractWorker< this.opts.maxInactiveTime = opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME delete this.opts.async + this.opts.killHandler = opts.killHandler ?? EMPTY_FUNCTION } /** @@ -110,20 +113,18 @@ 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) this.taskFunctions.set( typeof taskFunctions.name === 'string' && - taskFunctions.name.trim().length > 0 + taskFunctions.name.trim().length > 0 ? taskFunctions.name : 'fn1', boundFn @@ -185,7 +186,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') @@ -247,7 +248,7 @@ export abstract class AbstractWorker< * @returns The names of the worker's task functions. */ public listTaskFunctions (): string[] { - return Array.from(this.taskFunctions.keys()) + return [...this.taskFunctions.keys()] } /** @@ -276,7 +277,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 { @@ -297,16 +298,20 @@ export abstract class AbstractWorker< * @param message - The received message. */ protected messageListener (message: MessageValue): void { - if (message.workerId === this.id) { + if (this.isMain) { + throw new Error('Cannot handle message to worker in main worker') + } else if (message.workerId != null && message.workerId !== this.id) { + throw new Error( + `Message worker id ${message.workerId} does not match the worker id ${this.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 - !this.isMain && message.checkActive - ? this.startCheckActive() - : this.stopCheckActive() - } else if (message.id != null && message.data != null) { + 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) { @@ -322,8 +327,31 @@ export abstract class AbstractWorker< * @param message - The kill message. */ protected handleKillMessage (message: MessageValue): void { - !this.isMain && this.stopCheckActive() - this.emitDestroy() + this.stopCheckActive() + if (isAsyncFunction(this.opts.killHandler)) { + (this.opts.killHandler?.() as Promise) + .then(() => { + this.sendToMainWorker({ kill: 'success', workerId: this.id }) + return null + }) + .catch(() => { + this.sendToMainWorker({ kill: 'failure', workerId: this.id }) + }) + .finally(() => { + this.emitDestroy() + }) + .catch(EMPTY_FUNCTION) + } else { + try { + // eslint-disable-next-line @typescript-eslint/no-invalid-void-type + this.opts.killHandler?.() as void + this.sendToMainWorker({ kill: 'success', workerId: this.id }) + } catch { + this.sendToMainWorker({ kill: 'failure', workerId: this.id }) + } finally { + this.emitDestroy() + } + } } /** @@ -335,7 +363,6 @@ export abstract class AbstractWorker< this.checkActive.bind(this), (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2 ) - this.activeInterval.unref() } /** @@ -373,7 +400,7 @@ export abstract class AbstractWorker< } /** - * Sends a message to the main worker. + * Sends a message to main worker. * * @param message - The response message. */ @@ -398,9 +425,6 @@ 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) @@ -416,7 +440,7 @@ export abstract class AbstractWorker< * @param task - Input data for the task function. */ protected runSync ( - fn: WorkerSyncFunction, + fn: TaskSyncFunction, task: Task ): void { try { @@ -427,7 +451,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) @@ -438,7 +462,7 @@ export abstract class AbstractWorker< data: task.data }, workerId: this.id, - id: task.id + taskId: task.taskId }) } finally { this.updateLastTaskTimestamp() @@ -452,22 +476,22 @@ 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) fn(task.data) - .then(res => { + .then((res) => { taskPerformance = this.endTaskPerformance(taskPerformance) this.sendToMainWorker({ data: res, taskPerformance, workerId: this.id, - id: task.id + taskId: task.taskId }) return null }) - .catch(e => { + .catch((e) => { const errorMessage = this.handleError(e as Error | string) this.sendToMainWorker({ taskError: { @@ -476,7 +500,7 @@ export abstract class AbstractWorker< data: task.data }, workerId: this.id, - id: task.id + taskId: task.taskId }) }) .finally(() => { @@ -492,7 +516,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) { @@ -532,7 +556,7 @@ export abstract class AbstractWorker< } private updateLastTaskTimestamp (): void { - if (!this.isMain && this.activeInterval != null) { + if (this.activeInterval != null) { this.lastTaskTimestamp = performance.now() } }