X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=f42fae1751e0381cd4cf8505a6a689cf7adf3e19;hb=refs%2Ftags%2Fv2.6.29;hp=ff31fc7cb1879e19435c7942ca34c80b1a5a2051;hpb=3c5dc3fbade52c4f8e707279cd3089c57210e241;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index ff31fc7c..f42fae17 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -14,11 +14,7 @@ import { isAsyncFunction, isPlainObject } from '../utils' -import { - type KillBehavior, - KillBehaviors, - type WorkerOptions -} from './worker-options' +import { KillBehaviors, type WorkerOptions } from './worker-options' import type { TaskAsyncFunction, TaskFunction, @@ -27,7 +23,21 @@ import type { } from './task-functions' const DEFAULT_MAX_INACTIVE_TIME = 60000 -const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT +const DEFAULT_WORKER_OPTIONS: WorkerOptions = { + /** + * The kill behavior option on this worker or its default value. + */ + killBehavior: KillBehaviors.SOFT, + /** + * 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, + /** + * The function to call when the worker is killed. + */ + killHandler: EMPTY_FUNCTION +} /** * Base class that implements some shared logic for all poolifier workers. @@ -75,21 +85,7 @@ export abstract class AbstractWorker< protected readonly isMain: boolean, private readonly mainWorker: MainWorker, taskFunctions: TaskFunction | TaskFunctions, - protected readonly opts: WorkerOptions = { - /** - * The kill behavior option on this worker or its default value. - */ - killBehavior: DEFAULT_KILL_BEHAVIOR, - /** - * 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, - /** - * The function to call when the worker is killed. - */ - killHandler: EMPTY_FUNCTION - } + protected opts: WorkerOptions = DEFAULT_WORKER_OPTIONS ) { super(type) this.checkWorkerOptions(this.opts) @@ -100,10 +96,7 @@ export abstract class AbstractWorker< } private checkWorkerOptions (opts: WorkerOptions): void { - this.opts.killBehavior = opts.killBehavior ?? DEFAULT_KILL_BEHAVIOR - this.opts.maxInactiveTime = - opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME - this.opts.killHandler = opts.killHandler ?? EMPTY_FUNCTION + this.opts = { ...DEFAULT_WORKER_OPTIONS, ...opts } delete this.opts.async } @@ -169,7 +162,7 @@ export abstract class AbstractWorker< * * @param name - The name of the task function to check. * @returns Whether the worker has a task function with the given name or not. - * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string. + * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string. */ public hasTaskFunction (name: string): boolean { if (typeof name !== 'string') { @@ -188,7 +181,7 @@ export abstract class AbstractWorker< * @param name - The name of the task function to add. * @param fn - The task function to add. * @returns Whether the task function was added or not. - * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string. + * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string. * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the default task function reserved name. * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `fn` parameter is not a function. */ @@ -231,7 +224,7 @@ export abstract class AbstractWorker< * * @param name - The name of the task function to remove. * @returns Whether the task function existed and was removed or not. - * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string. + * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string. * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the default task function reserved name. * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the task function used as default task function. */ @@ -265,7 +258,24 @@ export abstract class AbstractWorker< * @returns The names of the worker's task functions. */ public listTaskFunctions (): string[] { - return [...this.taskFunctions.keys()] + const names: string[] = [...this.taskFunctions.keys()] + let defaultTaskFunctionName: string = DEFAULT_TASK_NAME + for (const [name, fn] of this.taskFunctions) { + if ( + name !== DEFAULT_TASK_NAME && + fn === this.taskFunctions.get(DEFAULT_TASK_NAME) + ) { + defaultTaskFunctionName = name + break + } + } + return [ + names[names.indexOf(DEFAULT_TASK_NAME)], + defaultTaskFunctionName, + ...names.filter( + (name) => name !== DEFAULT_TASK_NAME && name !== defaultTaskFunctionName + ) + ] } /** @@ -273,7 +283,7 @@ export abstract class AbstractWorker< * * @param name - The name of the task function to use as default task function. * @returns Whether the default task function was set or not. - * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string. + * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string. * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the default task function reserved name. * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is a non-existing task function. */ @@ -318,26 +328,19 @@ export abstract class AbstractWorker< * @param message - The received message. */ protected messageListener (message: MessageValue): void { - 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 - 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.handleKillMessage(message) - } + this.checkMessageWorkerId(message) + 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.taskId != null && message.data != null) { + // Task message received + this.run(message) + } else if (message.kill === true) { + // Kill message received + this.handleKillMessage(message) } } @@ -374,6 +377,22 @@ export abstract class AbstractWorker< } } + /** + * Check if the message worker id is set and matches the worker id. + * + * @param message - The message to check. + * @throws {@link https://nodejs.org/api/errors.html#class-error} If the message worker id is not set or does not match the worker id. + */ + private checkMessageWorkerId (message: MessageValue): void { + if (message.workerId == null) { + throw new Error('Message worker id is not set') + } 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}` + ) + } + } + /** * Starts the worker check active interval. */ @@ -473,26 +492,27 @@ export abstract class AbstractWorker< fn: TaskSyncFunction, task: Task ): void { + const { name, taskId, data } = task try { - let taskPerformance = this.beginTaskPerformance(task.name) - const res = fn(task.data) + let taskPerformance = this.beginTaskPerformance(name) + const res = fn(data) taskPerformance = this.endTaskPerformance(taskPerformance) this.sendToMainWorker({ data: res, taskPerformance, workerId: this.id, - taskId: task.taskId + taskId }) } catch (e) { const errorMessage = this.handleError(e as Error | string) this.sendToMainWorker({ taskError: { - name: task.name ?? DEFAULT_TASK_NAME, + name: name ?? DEFAULT_TASK_NAME, message: errorMessage, - data: task.data + data }, workerId: this.id, - taskId: task.taskId + taskId }) } finally { this.updateLastTaskTimestamp() @@ -509,15 +529,16 @@ export abstract class AbstractWorker< fn: TaskAsyncFunction, task: Task ): void { - let taskPerformance = this.beginTaskPerformance(task.name) - fn(task.data) + const { name, taskId, data } = task + let taskPerformance = this.beginTaskPerformance(name) + fn(data) .then((res) => { taskPerformance = this.endTaskPerformance(taskPerformance) this.sendToMainWorker({ data: res, taskPerformance, workerId: this.id, - taskId: task.taskId + taskId }) return null }) @@ -525,12 +546,12 @@ export abstract class AbstractWorker< const errorMessage = this.handleError(e as Error | string) this.sendToMainWorker({ taskError: { - name: task.name ?? DEFAULT_TASK_NAME, + name: name ?? DEFAULT_TASK_NAME, message: errorMessage, - data: task.data + data }, workerId: this.id, - taskId: task.taskId + taskId }) }) .finally(() => {