X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=5e7144877357806dacae29c1bf28993894616ca1;hb=ccd73e075194fac1cf6e1b736f1556b199c95bc5;hp=0646a9bfa0e423bd466ccc16efeba8b4782067c7;hpb=f65efa796405c785a1ab5e646e30fc27418a6151;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index 0646a9bf..5e714487 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -7,7 +7,12 @@ import type { TaskPerformance, WorkerStatistics } from '../utility-types' -import { EMPTY_FUNCTION, isPlainObject } from '../utils' +import { + DEFAULT_TASK_NAME, + EMPTY_FUNCTION, + isAsyncFunction, + isPlainObject +} from '../utils' import { type KillBehavior, KillBehaviors, @@ -20,7 +25,6 @@ import type { WorkerSyncFunction } from './worker-functions' -const DEFAULT_FUNCTION_NAME = 'default' const DEFAULT_MAX_INACTIVE_TIME = 60000 const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT @@ -55,7 +59,7 @@ export abstract class AbstractWorker< /** * Handler id of the `aliveInterval` worker alive check. */ - protected readonly aliveInterval?: NodeJS.Timeout + protected aliveInterval?: NodeJS.Timeout /** * Constructs a new poolifier worker. * @@ -88,12 +92,6 @@ export abstract class AbstractWorker< this.checkWorkerOptions(this.opts) this.checkTaskFunctions(taskFunctions) if (!this.isMain) { - this.lastTaskTimestamp = performance.now() - this.aliveInterval = setInterval( - this.checkAlive.bind(this), - (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2 - ) - this.checkAlive.bind(this)() this.mainWorker?.on('message', this.messageListener.bind(this)) } } @@ -120,7 +118,7 @@ export abstract class AbstractWorker< } this.taskFunctions = new Map>() if (typeof taskFunctions === 'function') { - this.taskFunctions.set(DEFAULT_FUNCTION_NAME, taskFunctions.bind(this)) + this.taskFunctions.set(DEFAULT_TASK_NAME, taskFunctions.bind(this)) } else if (isPlainObject(taskFunctions)) { let firstEntry = true for (const [name, fn] of Object.entries(taskFunctions)) { @@ -131,7 +129,7 @@ export abstract class AbstractWorker< } this.taskFunctions.set(name, fn.bind(this)) if (firstEntry) { - this.taskFunctions.set(DEFAULT_FUNCTION_NAME, fn.bind(this)) + this.taskFunctions.set(DEFAULT_TASK_NAME, fn.bind(this)) firstEntry = false } } @@ -145,27 +143,192 @@ export abstract class AbstractWorker< } } + /** + * Checks if the worker has a task function with the given name. + * + * @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. + */ + public hasTaskFunction (name: string): boolean { + if (typeof name !== 'string') { + throw new TypeError('name parameter is not a string') + } + return this.taskFunctions.has(name) + } + + /** + * Adds a task function to the worker. + * If a task function with the same name already exists, it is replaced. + * + * @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-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. + */ + public addTaskFunction ( + name: string, + fn: WorkerFunction + ): boolean { + if (typeof name !== 'string') { + throw new TypeError('name parameter is not a string') + } + if (name === DEFAULT_TASK_NAME) { + throw new Error( + 'Cannot add a task function with the default reserved name' + ) + } + if (typeof fn !== 'function') { + throw new TypeError('fn parameter is not a function') + } + try { + if ( + this.taskFunctions.get(name) === + this.taskFunctions.get(DEFAULT_TASK_NAME) + ) { + this.taskFunctions.set(DEFAULT_TASK_NAME, fn.bind(this)) + } + this.taskFunctions.set(name, fn.bind(this)) + return true + } catch { + return false + } + } + + /** + * Removes a task function from the worker. + * + * @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-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 (name === DEFAULT_TASK_NAME) { + throw new Error( + 'Cannot remove the task function with the default reserved name' + ) + } + if ( + this.taskFunctions.get(name) === this.taskFunctions.get(DEFAULT_TASK_NAME) + ) { + throw new Error( + 'Cannot remove the task function used as the default task function' + ) + } + return this.taskFunctions.delete(name) + } + + /** + * Sets the default task function to use when no task function name is specified. + * + * @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-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 (name === DEFAULT_TASK_NAME) { + throw new Error( + 'Cannot set the default task function reserved name as the default task function' + ) + } + if (!this.taskFunctions.has(name)) { + throw new Error( + 'Cannot set the default task function to a non-existing task function' + ) + } + try { + this.taskFunctions.set( + DEFAULT_TASK_NAME, + this.taskFunctions.get(name)?.bind(this) as WorkerFunction< + Data, + Response + > + ) + return true + } catch { + return false + } + } + /** * Worker message listener. * * @param message - Message received. */ protected messageListener (message: MessageValue): void { - if (message.id != null && message.data != null) { - // Task message received - const fn = this.getTaskFunction(message.name) - if (fn?.constructor.name === 'AsyncFunction') { - this.runInAsyncScope(this.runAsync.bind(this), this, fn, message) - } else { - this.runInAsyncScope(this.runSync.bind(this), this, fn, message) + if (message.workerId === this.id) { + if (message.ready != null) { + // Startup message received + this.workerReady() + } else if (message.statistics != null) { + // Statistics message received + this.statistics = message.statistics + } else if (message.checkAlive != null) { + // Check alive message received + message.checkAlive ? this.startCheckAlive() : this.stopCheckAlive() + } else if (message.id != null && message.data != null) { + // Task message received + const fn = this.getTaskFunction(message.name) + if (isAsyncFunction(fn)) { + this.runInAsyncScope(this.runAsync.bind(this), this, fn, message) + } else { + this.runInAsyncScope(this.runSync.bind(this), this, fn, message) + } + } else if (message.kill === true) { + // Kill message received + this.stopCheckAlive() + this.emitDestroy() } - } else if (message.statistics != null) { - // Statistics message received - this.statistics = message.statistics - } else if (message.kill != null) { - // Kill message received - this.aliveInterval != null && clearInterval(this.aliveInterval) - this.emitDestroy() + } + } + + /** + * Notifies the main worker that this worker is ready to process tasks. + */ + protected workerReady (): void { + !this.isMain && this.sendToMainWorker({ ready: true, workerId: this.id }) + } + + /** + * Starts the worker alive check interval. + */ + private startCheckAlive (): void { + this.lastTaskTimestamp = performance.now() + this.aliveInterval = setInterval( + this.checkAlive.bind(this), + (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2 + ) + this.checkAlive.bind(this)() + } + + /** + * Stops the worker alive check interval. + */ + private stopCheckAlive (): void { + this.aliveInterval != null && clearInterval(this.aliveInterval) + } + + /** + * Checks if the worker should be terminated, because its living too long. + */ + private checkAlive (): void { + if ( + performance.now() - this.lastTaskTimestamp > + (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) + ) { + this.sendToMainWorker({ kill: this.opts.killBehavior, workerId: this.id }) } } @@ -190,26 +353,14 @@ export abstract class AbstractWorker< message: MessageValue ): void - /** - * Checks if the worker should be terminated, because its living too long. - */ - protected checkAlive (): void { - if ( - performance.now() - this.lastTaskTimestamp > - (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) - ) { - this.sendToMainWorker({ kill: this.opts.killBehavior }) - } - } - /** * Handles an error and convert it to a string so it can be sent back to the main worker. * * @param e - The error raised by the worker. - * @returns Message of the error. + * @returns The error message. */ protected handleError (e: Error | string): string { - return e as string + return e instanceof Error ? e.message : e } /** @@ -223,7 +374,7 @@ export abstract class AbstractWorker< message: MessageValue ): void { try { - let taskPerformance = this.beginTaskPerformance() + let taskPerformance = this.beginTaskPerformance(message.name) const res = fn(message.data) taskPerformance = this.endTaskPerformance(taskPerformance) this.sendToMainWorker({ @@ -233,17 +384,20 @@ export abstract class AbstractWorker< id: message.id }) } catch (e) { - const err = this.handleError(e as Error) + const errorMessage = this.handleError(e as Error | string) this.sendToMainWorker({ taskError: { - message: err, + name: message.name ?? DEFAULT_TASK_NAME, + message: errorMessage, data: message.data }, workerId: this.id, id: message.id }) } finally { - !this.isMain && (this.lastTaskTimestamp = performance.now()) + if (!this.isMain && this.aliveInterval != null) { + this.lastTaskTimestamp = performance.now() + } } } @@ -257,7 +411,7 @@ export abstract class AbstractWorker< fn: WorkerAsyncFunction, message: MessageValue ): void { - let taskPerformance = this.beginTaskPerformance() + let taskPerformance = this.beginTaskPerformance(message.name) fn(message.data) .then(res => { taskPerformance = this.endTaskPerformance(taskPerformance) @@ -270,10 +424,11 @@ export abstract class AbstractWorker< return null }) .catch(e => { - const err = this.handleError(e as Error) + const errorMessage = this.handleError(e as Error | string) this.sendToMainWorker({ taskError: { - message: err, + name: message.name ?? DEFAULT_TASK_NAME, + message: errorMessage, data: message.data }, workerId: this.id, @@ -281,7 +436,9 @@ export abstract class AbstractWorker< }) }) .finally(() => { - !this.isMain && (this.lastTaskTimestamp = performance.now()) + if (!this.isMain && this.aliveInterval != null) { + this.lastTaskTimestamp = performance.now() + } }) .catch(EMPTY_FUNCTION) } @@ -289,10 +446,10 @@ export abstract class AbstractWorker< /** * Gets the task function in the given scope. * - * @param name - Name of the function that will be returned. + * @param name - Name of the task function that will be returned. */ private getTaskFunction (name?: string): WorkerFunction { - name = name ?? DEFAULT_FUNCTION_NAME + name = name ?? DEFAULT_TASK_NAME const fn = this.taskFunctions.get(name) if (fn == null) { throw new Error(`Task function '${name}' not found`) @@ -300,9 +457,10 @@ export abstract class AbstractWorker< return fn } - private beginTaskPerformance (): TaskPerformance { + private beginTaskPerformance (name?: string): TaskPerformance { this.checkStatistics() return { + name: name ?? DEFAULT_TASK_NAME, timestamp: performance.now(), ...(this.statistics.elu && { elu: performance.eventLoopUtilization() }) }