X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=a00e8f8faadd4e912de558c5d4f8ca980db76036;hb=db746922cea3decbb34b5878d56a468d659d33f5;hp=950738b26f0a47f16f0f1eadd93be5f759a8024d;hpb=8f49716c05eb5a286c715089e5ec07f030c9cde8;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index 950738b2..a00e8f8f 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,15 +162,10 @@ 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') { - throw new TypeError('name parameter is not a string') - } - if (typeof name === 'string' && name.trim().length === 0) { - throw new TypeError('name parameter is an empty string') - } + this.checkTaskFunctionName(name) return this.taskFunctions.has(name) } @@ -188,7 +176,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. */ @@ -196,12 +184,7 @@ export abstract class AbstractWorker< name: string, fn: TaskFunction ): boolean { - if (typeof name !== 'string') { - throw new TypeError('name parameter is not a string') - } - if (typeof name === 'string' && name.trim().length === 0) { - throw new TypeError('name parameter is an empty string') - } + this.checkTaskFunctionName(name) if (name === DEFAULT_TASK_NAME) { throw new Error( 'Cannot add a task function with the default reserved name' @@ -231,17 +214,12 @@ 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. */ public removeTaskFunction (name: string): boolean { - if (typeof name !== 'string') { - throw new TypeError('name parameter is not a string') - } - if (typeof name === 'string' && name.trim().length === 0) { - throw new TypeError('name parameter is an empty string') - } + this.checkTaskFunctionName(name) if (name === DEFAULT_TASK_NAME) { throw new Error( 'Cannot remove the task function with the default reserved name' @@ -265,7 +243,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,17 +268,12 @@ 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. */ public setDefaultTaskFunction (name: string): boolean { - if (typeof name !== 'string') { - throw new TypeError('name parameter is not a string') - } - if (typeof name === 'string' && name.trim().length === 0) { - throw new TypeError('name parameter is an empty string') - } + this.checkTaskFunctionName(name) if (name === DEFAULT_TASK_NAME) { throw new Error( 'Cannot set the default task function reserved name as the default task function' @@ -305,6 +295,15 @@ export abstract class AbstractWorker< } } + private checkTaskFunctionName (name: string): void { + if (typeof name !== 'string') { + throw new TypeError('name parameter is not a string') + } + if (typeof name === 'string' && name.trim().length === 0) { + throw new TypeError('name parameter is an empty string') + } + } + /** * Handles the ready message sent by the main worker. * @@ -318,15 +317,7 @@ 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) { - 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}` - ) - } + this.checkMessageWorkerId(message) if (message.statistics != null) { // Statistics message received this.statistics = message.statistics @@ -375,6 +366,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. */ @@ -489,7 +496,7 @@ export abstract class AbstractWorker< const errorMessage = this.handleError(e as Error | string) this.sendToMainWorker({ taskError: { - name: name ?? DEFAULT_TASK_NAME, + name: name as string, message: errorMessage, data }, @@ -528,7 +535,7 @@ export abstract class AbstractWorker< const errorMessage = this.handleError(e as Error | string) this.sendToMainWorker({ taskError: { - name: name ?? DEFAULT_TASK_NAME, + name: name as string, message: errorMessage, data },