X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=a0d78dbd08f2023e38cd37dbff6dbc74064168fb;hb=facb41d7d33bd6c11970da5e946c51347824fd54;hp=98b32fe4cb9525efba1ab151b8d7b7f3efb2310b;hpb=1c132fec1844432e7bfea1bd5d384a9880b91dbb;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index 98b32fe4..a0d78dbd 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,38 +85,45 @@ 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) + if (this.isMain == null) { + throw new Error('isMain parameter is mandatory') + } this.checkTaskFunctions(taskFunctions) + this.checkWorkerOptions(this.opts) if (!this.isMain) { - this.getMainWorker()?.on('message', this.handleReadyMessage.bind(this)) + this.getMainWorker().on('message', this.handleReadyMessage.bind(this)) } } 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 } + private checkValidTaskFunction ( + name: string, + fn: TaskFunction + ): void { + if (typeof name !== 'string') { + throw new TypeError( + 'A taskFunctions parameter object key is not a string' + ) + } + if (typeof name === 'string' && name.trim().length === 0) { + throw new TypeError( + 'A taskFunctions parameter object key is an empty string' + ) + } + if (typeof fn !== 'function') { + throw new TypeError( + 'A taskFunctions parameter object value is not a function' + ) + } + } + /** * Checks if the `taskFunctions` parameter is passed to the constructor. * @@ -132,21 +149,7 @@ export abstract class AbstractWorker< } else if (isPlainObject(taskFunctions)) { let firstEntry = true for (const [name, fn] of Object.entries(taskFunctions)) { - if (typeof name !== 'string') { - throw new TypeError( - 'A taskFunctions parameter object key is not a string' - ) - } - if (typeof name === 'string' && name.trim().length === 0) { - throw new TypeError( - 'A taskFunctions parameter object key an empty string' - ) - } - if (typeof fn !== 'function') { - throw new TypeError( - 'A taskFunctions parameter object value is not a function' - ) - } + this.checkValidTaskFunction(name, fn) const boundFn = fn.bind(this) if (firstEntry) { this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn) @@ -172,12 +175,7 @@ export abstract class AbstractWorker< * @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) } @@ -196,12 +194,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' @@ -236,12 +229,7 @@ export abstract class AbstractWorker< * @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 +253,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 + ) + ] } /** @@ -278,12 +283,7 @@ export abstract class AbstractWorker< * @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 +305,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. * @@ -342,7 +351,7 @@ export abstract class AbstractWorker< protected handleKillMessage (message: MessageValue): void { this.stopCheckActive() if (isAsyncFunction(this.opts.killHandler)) { - (this.opts.killHandler?.() as Promise) + ;(this.opts.killHandler?.() as Promise) .then(() => { this.sendToMainWorker({ kill: 'success', workerId: this.id }) return null @@ -420,6 +429,7 @@ export abstract class AbstractWorker< * Returns the main worker. * * @returns Reference to the main worker. + * @throws {@link https://nodejs.org/api/errors.html#class-error} If the main worker is not set. */ protected getMainWorker (): MainWorker { if (this.mainWorker == null) { @@ -464,7 +474,20 @@ 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 { - const fn = this.getTaskFunction(task.name) + const { name, taskId, data } = task + const fn = this.taskFunctions.get(name ?? DEFAULT_TASK_NAME) + if (fn == null) { + this.sendToMainWorker({ + taskError: { + name: name as string, + message: `Task function '${name as string}' not found`, + data + }, + workerId: this.id, + taskId + }) + return + } if (isAsyncFunction(fn)) { this.runInAsyncScope(this.runAsync.bind(this), this, fn, task) } else { @@ -497,7 +520,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 }, @@ -536,7 +559,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 }, @@ -550,22 +573,6 @@ export abstract class AbstractWorker< .catch(EMPTY_FUNCTION) } - /** - * Gets the task function with the given name. - * - * @param name - Name of the task function that will be returned. - * @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): TaskFunction { - name = name ?? DEFAULT_TASK_NAME - const fn = this.taskFunctions.get(name) - if (fn == null) { - throw new Error(`Task function '${name}' not found`) - } - return fn - } - private beginTaskPerformance (name?: string): TaskPerformance { this.checkStatistics() return {