X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=fcdd1bf283971955b8cdb9cc6482856b73516a48;hb=968a2e8ca7bfc81d61b5ffc820a6a76bf44b202f;hp=b8b442ecd2c0e2521a2c82b899620aa22197fbd7;hpb=75d3401a50550a9fc53e2e7d107bc2d776df83e3;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index b8b442ec..fcdd1bf2 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, isAsyncFunction, 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 @@ -114,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)) { @@ -125,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 } } @@ -139,33 +143,167 @@ 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 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 TypeError} If the `name` parameter is not a string. + * @throws {@link Error} If the `name` parameter is the default task function reserved name. + * @throws {@link 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 TypeError} If the `name` parameter is not a string. + * @throws {@link Error} If the `name` parameter is the default task function reserved name. + * @throws {@link 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 TypeError} If the `name` parameter is not a string. + * @throws {@link Error} If the `name` parameter is the default task function reserved name. + * @throws {@link 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.dynamic === true) { - // Worker dynamic message received - this.startCheckAlive() - } else if (message.statistics != null) { - // Statistics message received - this.statistics = message.statistics - } 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) + 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.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( @@ -175,6 +313,25 @@ export abstract class AbstractWorker< 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 }) + } + } + /** * Returns the main worker. * @@ -196,18 +353,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. * @@ -229,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({ @@ -242,10 +387,11 @@ export abstract class AbstractWorker< const errorMessage = this.handleError(e as Error | string) this.sendToMainWorker({ taskError: { - workerId: this.id, + name: message.name ?? DEFAULT_TASK_NAME, message: errorMessage, data: message.data }, + workerId: this.id, id: message.id }) } finally { @@ -265,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) @@ -281,10 +427,11 @@ export abstract class AbstractWorker< const errorMessage = this.handleError(e as Error | string) this.sendToMainWorker({ taskError: { - workerId: this.id, + name: message.name ?? DEFAULT_TASK_NAME, message: errorMessage, data: message.data }, + workerId: this.id, id: message.id }) }) @@ -299,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`) @@ -310,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() }) }