X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=93a36bad382fe5781f35d73b71a8169510b818ac;hb=8e5ca0401467b0a5c40b20a40ef08db6c05b9561;hp=7d81a88ccc816803bcdcdae4f89cb9dd56486f51;hpb=49d1b48ce81c9f195830a1a886657de6f2de4ca4;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index 7d81a88c..93a36bad 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -4,10 +4,16 @@ import type { MessagePort } from 'node:worker_threads' import { performance } from 'node:perf_hooks' import type { MessageValue, + Task, TaskPerformance, WorkerStatistics } from '../utility-types' -import { EMPTY_FUNCTION, isAsyncFunction, isPlainObject } from '../utils' +import { + DEFAULT_TASK_NAME, + EMPTY_FUNCTION, + isAsyncFunction, + isPlainObject +} from '../utils' import { type KillBehavior, KillBehaviors, @@ -20,7 +26,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 +60,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 +93,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,10 +119,15 @@ 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)) { + if (typeof name !== 'string') { + throw new TypeError( + 'A taskFunctions parameter object key is not a string' + ) + } if (typeof fn !== 'function') { throw new TypeError( 'A taskFunctions parameter object value is not a function' @@ -131,7 +135,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 +149,187 @@ 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. + * @param message - The received message. */ protected messageListener (message: MessageValue): void { - 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) + 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 + this.run(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 aliveness 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 aliveness 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,18 +354,6 @@ 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. * @@ -213,59 +365,77 @@ export abstract class AbstractWorker< } /** - * Runs the given function synchronously. + * Runs the given task. * - * @param fn - Function that will be executed. - * @param message - Input data for the given function. + * @param task - The task to execute. + * @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) + if (isAsyncFunction(fn)) { + this.runInAsyncScope(this.runAsync.bind(this), this, fn, task) + } else { + this.runInAsyncScope(this.runSync.bind(this), this, fn, task) + } + } + + /** + * Runs the given task function synchronously. + * + * @param fn - Task function that will be executed. + * @param task - Input data for the task function. */ protected runSync ( fn: WorkerSyncFunction, - message: MessageValue + task: Task ): void { try { - let taskPerformance = this.beginTaskPerformance() - const res = fn(message.data) + let taskPerformance = this.beginTaskPerformance(task.name) + const res = fn(task.data) taskPerformance = this.endTaskPerformance(taskPerformance) this.sendToMainWorker({ data: res, taskPerformance, workerId: this.id, - id: message.id + id: task.id }) } catch (e) { const errorMessage = this.handleError(e as Error | string) this.sendToMainWorker({ taskError: { - workerId: this.id, + name: task.name ?? DEFAULT_TASK_NAME, message: errorMessage, - data: message.data + data: task.data }, - id: message.id + workerId: this.id, + id: task.id }) } finally { - !this.isMain && (this.lastTaskTimestamp = performance.now()) + if (!this.isMain && this.aliveInterval != null) { + this.lastTaskTimestamp = performance.now() + } } } /** - * Runs the given function asynchronously. + * Runs the given task function asynchronously. * - * @param fn - Function that will be executed. - * @param message - Input data for the given function. + * @param fn - Task function that will be executed. + * @param task - Input data for the task function. */ protected runAsync ( fn: WorkerAsyncFunction, - message: MessageValue + task: Task ): void { - let taskPerformance = this.beginTaskPerformance() - fn(message.data) + let taskPerformance = this.beginTaskPerformance(task.name) + fn(task.data) .then(res => { taskPerformance = this.endTaskPerformance(taskPerformance) this.sendToMainWorker({ data: res, taskPerformance, workerId: this.id, - id: message.id + id: task.id }) return null }) @@ -273,26 +443,31 @@ export abstract class AbstractWorker< const errorMessage = this.handleError(e as Error | string) this.sendToMainWorker({ taskError: { - workerId: this.id, + name: task.name ?? DEFAULT_TASK_NAME, message: errorMessage, - data: message.data + data: task.data }, - id: message.id + workerId: this.id, + id: task.id }) }) .finally(() => { - !this.isMain && (this.lastTaskTimestamp = performance.now()) + if (!this.isMain && this.aliveInterval != null) { + this.lastTaskTimestamp = performance.now() + } }) .catch(EMPTY_FUNCTION) } /** - * Gets the task function in the given scope. + * Gets the task function with the given name. * - * @param name - Name of the function that will be returned. + * @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): 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 +475,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() }) }