X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=12307f47c07ba019ca2da01f9547b633cfc64e03;hb=c3024c5998f1aa6c228c5db083e160b6fd967d7c;hp=5fcc3419b2c1acc8d9ea39ca556c199a9ff44ea9;hpb=69b70a7e1d5238ebb186171275941ec4bcffc882;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index 5fcc3419..12307f47 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -1,31 +1,32 @@ import type { Worker } from 'node:cluster' -import type { MessagePort } from 'node:worker_threads' import { performance } from 'node:perf_hooks' +import type { MessagePort } from 'node:worker_threads' + import type { MessageValue, Task, TaskPerformance, WorkerStatistics -} from '../utility-types' +} from '../utility-types.js' import { DEFAULT_TASK_NAME, EMPTY_FUNCTION, isAsyncFunction, isPlainObject -} from '../utils' -import { KillBehaviors, type WorkerOptions } from './worker-options' +} from '../utils.js' import type { TaskAsyncFunction, TaskFunction, TaskFunctionOperationResult, TaskFunctions, TaskSyncFunction -} from './task-functions' +} from './task-functions.js' import { checkTaskFunctionName, checkValidTaskFunctionEntry, checkValidWorkerOptions -} from './utils' +} from './utils.js' +import { KillBehaviors, type WorkerOptions } from './worker-options.js' const DEFAULT_MAX_INACTIVE_TIME = 60000 const DEFAULT_WORKER_OPTIONS: WorkerOptions = { @@ -71,28 +72,26 @@ export abstract class AbstractWorker< /** * Performance statistics computation requirements. */ - protected statistics!: WorkerStatistics + protected statistics?: WorkerStatistics /** * Handler id of the `activeInterval` worker activity check. */ protected activeInterval?: NodeJS.Timeout + /** * Constructs a new poolifier worker. * - * @param type - The type of async event. * @param isMain - Whether this is the main worker or not. * @param mainWorker - Reference to main worker. * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked. The first function is the default function. * @param opts - Options for the worker. */ public constructor ( - type: string, - protected readonly isMain: boolean, - private readonly mainWorker: MainWorker, + protected readonly isMain: boolean | undefined, + private readonly mainWorker: MainWorker | undefined | null, taskFunctions: TaskFunction | TaskFunctions, protected opts: WorkerOptions = DEFAULT_WORKER_OPTIONS ) { - // super(type) if (this.isMain == null) { throw new Error('isMain parameter is mandatory') } @@ -115,7 +114,10 @@ export abstract class AbstractWorker< * @param taskFunctions - The task function(s) parameter that should be checked. */ private checkTaskFunctions ( - taskFunctions: TaskFunction | TaskFunctions + taskFunctions: + | TaskFunction + | TaskFunctions + | undefined ): void { if (taskFunctions == null) { throw new Error('taskFunctions parameter is mandatory') @@ -126,7 +128,7 @@ export abstract class AbstractWorker< this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn) this.taskFunctions.set( typeof taskFunctions.name === 'string' && - taskFunctions.name.trim().length > 0 + taskFunctions.name.trim().length > 0 ? taskFunctions.name : 'fn1', boundFn @@ -240,8 +242,8 @@ export abstract class AbstractWorker< * @returns The names of the worker's task functions. */ public listTaskFunctionNames (): string[] { - const names: string[] = [...this.taskFunctions.keys()] - let defaultTaskFunctionName: string = DEFAULT_TASK_NAME + const names = [...this.taskFunctions.keys()] + let defaultTaskFunctionName = DEFAULT_TASK_NAME for (const [name, fn] of this.taskFunctions) { if ( name !== DEFAULT_TASK_NAME && @@ -279,10 +281,8 @@ export abstract class AbstractWorker< 'Cannot set the default task function to a non-existing task function' ) } - this.taskFunctions.set( - DEFAULT_TASK_NAME, - this.taskFunctions.get(name) as TaskFunction - ) + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + this.taskFunctions.set(DEFAULT_TASK_NAME, this.taskFunctions.get(name)!) this.sendTaskFunctionNamesToMainWorker() return { status: true } } catch (error) { @@ -326,23 +326,28 @@ export abstract class AbstractWorker< message: MessageValue ): void { const { taskFunctionOperation, taskFunctionName, taskFunction } = message - let response!: TaskFunctionOperationResult + if (taskFunctionName == null) { + throw new Error( + 'Cannot handle task function operation message without a task function name' + ) + } + let response: TaskFunctionOperationResult switch (taskFunctionOperation) { case 'add': response = this.addTaskFunction( - taskFunctionName as string, + taskFunctionName, // eslint-disable-next-line @typescript-eslint/no-implied-eval, no-new-func - new Function(`return ${taskFunction as string}`)() as TaskFunction< + new Function(`return ${taskFunction}`)() as TaskFunction< Data, Response > ) break case 'remove': - response = this.removeTaskFunction(taskFunctionName as string) + response = this.removeTaskFunction(taskFunctionName) break case 'default': - response = this.setDefaultTaskFunction(taskFunctionName as string) + response = this.setDefaultTaskFunction(taskFunctionName) break default: response = { status: false, error: new Error('Unknown task operation') } @@ -353,9 +358,9 @@ export abstract class AbstractWorker< taskFunctionOperationStatus: response.status, taskFunctionName, ...(!response.status && - response?.error != null && { + response.error != null && { workerError: { - name: taskFunctionName as string, + name: taskFunctionName, message: this.handleError(response.error as Error | string) } }) @@ -370,7 +375,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' }) return undefined @@ -484,14 +489,15 @@ export abstract class AbstractWorker< * * @param task - The task to execute. */ - protected run (task: Task): void { + protected readonly run = (task: Task): void => { const { name, taskId, data } = task const taskFunctionName = name ?? DEFAULT_TASK_NAME if (!this.taskFunctions.has(taskFunctionName)) { this.sendToMainWorker({ workerError: { - name: name as string, - message: `Task function '${name as string}' not found`, + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + name: name!, + message: `Task function '${name}' not found`, data }, taskId @@ -512,10 +518,10 @@ export abstract class AbstractWorker< * @param fn - Task function that will be executed. * @param task - Input data for the task function. */ - protected runSync ( + protected readonly runSync = ( fn: TaskSyncFunction, task: Task - ): void { + ): void => { const { name, taskId, data } = task try { let taskPerformance = this.beginTaskPerformance(name) @@ -529,7 +535,8 @@ export abstract class AbstractWorker< } catch (error) { this.sendToMainWorker({ workerError: { - name: name as string, + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + name: name!, message: this.handleError(error as Error | string), data }, @@ -546,10 +553,10 @@ export abstract class AbstractWorker< * @param fn - Task function that will be executed. * @param task - Input data for the task function. */ - protected runAsync ( + protected readonly runAsync = ( fn: TaskAsyncFunction, task: Task - ): void { + ): void => { const { name, taskId, data } = task let taskPerformance = this.beginTaskPerformance(name) fn(data) @@ -562,10 +569,11 @@ export abstract class AbstractWorker< }) return undefined }) - .catch(error => { + .catch((error: unknown) => { this.sendToMainWorker({ workerError: { - name: name as string, + // eslint-disable-next-line @typescript-eslint/no-non-null-assertion + name: name!, message: this.handleError(error as Error | string), data }, @@ -579,18 +587,24 @@ export abstract class AbstractWorker< } private beginTaskPerformance (name?: string): TaskPerformance { - this.checkStatistics() + if (this.statistics == null) { + throw new Error('Performance statistics computation requirements not set') + } return { name: name ?? DEFAULT_TASK_NAME, timestamp: performance.now(), - ...(this.statistics.elu && { elu: performance.eventLoopUtilization() }) + ...(this.statistics.elu && { + elu: performance.eventLoopUtilization() + }) } } private endTaskPerformance ( taskPerformance: TaskPerformance ): TaskPerformance { - this.checkStatistics() + if (this.statistics == null) { + throw new Error('Performance statistics computation requirements not set') + } return { ...taskPerformance, ...(this.statistics.runTime && { @@ -602,12 +616,6 @@ export abstract class AbstractWorker< } } - private checkStatistics (): void { - if (this.statistics == null) { - throw new Error('Performance statistics computation requirements not set') - } - } - private updateLastTaskTimestamp (): void { if (this.activeInterval != null) { this.lastTaskTimestamp = performance.now()