X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=10a0c82d0565de18529343f163b295688c22bc70;hb=aee467366d8c393b79e7af82c6a7ab12338ee64e;hp=ab56a5e9bb2f8c16c8b774eb2bdd6789de882ee5;hpb=78cea37e264d5ca527bc42eb056f3b9579a2b2c4;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index ab56a5e9..10a0c82d 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -1,6 +1,6 @@ -import { AsyncResource } from 'async_hooks' -import type { Worker } from 'cluster' -import type { MessagePort } from 'worker_threads' +import { AsyncResource } from 'node:async_hooks' +import type { Worker } from 'node:cluster' +import type { MessagePort } from 'node:worker_threads' import type { MessageValue } from '../utility-types' import { EMPTY_FUNCTION } from '../utils' import type { KillBehavior, WorkerOptions } from './worker-options' @@ -12,9 +12,9 @@ const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT /** * Base class that implements some shared logic for all poolifier workers. * - * @template MainWorker Type of main worker. - * @template Data Type of data this worker receives from pool's execution. This can only be serializable data. - * @template Response Type of response the worker sends back to the main worker. This can only be serializable data. + * @typeParam MainWorker - Type of main worker. + * @typeParam Data - Type of data this worker receives from pool's execution. This can only be serializable data. + * @typeParam Response - Type of response the worker sends back to the main worker. This can only be serializable data. */ export abstract class AbstractWorker< MainWorker extends Worker | MessagePort, @@ -24,32 +24,28 @@ export abstract class AbstractWorker< /** * Timestamp of the last task processed by this worker. */ - protected lastTaskTimestamp: number + protected lastTaskTimestamp!: number /** - * Handler Id of the `aliveInterval` worker alive check. + * Handler id of the `aliveInterval` worker alive check. */ protected readonly aliveInterval?: NodeJS.Timeout - /** - * Options for the worker. - */ - public readonly opts: WorkerOptions /** * Constructs a new poolifier worker. * - * @param type The type of async event. - * @param isMain Whether this is the main worker or not. - * @param fn Function processed by the worker when the pool's `execution` function is invoked. - * @param mainWorker Reference to main worker. - * @param opts Options for the worker. + * @param type - The type of async event. + * @param isMain - Whether this is the main worker or not. + * @param fn - Function processed by the worker when the pool's `execution` function is invoked. + * @param mainWorker - Reference to main worker. + * @param opts - Options for the worker. */ public constructor ( type: string, - isMain: boolean, + protected readonly isMain: boolean, fn: (data: Data) => Response, protected mainWorker: MainWorker | undefined | null, - opts: WorkerOptions = { + protected readonly opts: WorkerOptions = { /** - * The kill behavior option on this Worker or its default value. + * The kill behavior option on this worker or its default value. */ killBehavior: DEFAULT_KILL_BEHAVIOR, /** @@ -60,12 +56,10 @@ export abstract class AbstractWorker< } ) { super(type) - this.opts = opts this.checkFunctionInput(fn) this.checkWorkerOptions(this.opts) - this.lastTaskTimestamp = Date.now() - // Keep the worker active - if (!isMain) { + if (!this.isMain) { + this.lastTaskTimestamp = Date.now() this.aliveInterval = setInterval( this.checkAlive.bind(this), (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2 @@ -73,29 +67,37 @@ export abstract class AbstractWorker< this.checkAlive.bind(this)() } - this.mainWorker?.on('message', (value: MessageValue) => { - this.messageListener(value, fn) - }) + this.mainWorker?.on( + 'message', + (message: MessageValue) => { + this.messageListener(message, fn) + } + ) } + /** + * Worker message listener. + * + * @param message - Message received. + * @param fn - Function processed by the worker when the pool's `execution` function is invoked. + */ protected messageListener ( - value: MessageValue, + message: MessageValue, fn: (data: Data) => Response ): void { - if (value.data !== undefined && value.id !== undefined) { - // Here you will receive messages + if (message.data != null && message.id != null) { + // Task message received if (this.opts.async === true) { - this.runInAsyncScope(this.runAsync.bind(this), this, fn, value) + this.runInAsyncScope(this.runAsync.bind(this), this, fn, message) } else { - this.runInAsyncScope(this.run.bind(this), this, fn, value) + this.runInAsyncScope(this.run.bind(this), this, fn, message) } - } else if (value.parent !== undefined) { - // Save a reference of the main worker to communicate with it - // This will be received once - this.mainWorker = value.parent - } else if (value.kill !== undefined) { - // Here is time to kill this worker, just clearing the interval - if (this.aliveInterval != null) clearInterval(this.aliveInterval) + } else if (message.parent != null) { + // Main worker reference message received + this.mainWorker = message.parent + } else if (message.kill != null) { + // Kill message received + this.aliveInterval != null && clearInterval(this.aliveInterval) this.emitDestroy() } } @@ -110,11 +112,13 @@ export abstract class AbstractWorker< /** * Checks if the `fn` parameter is passed to the constructor. * - * @param fn The function that should be defined. + * @param fn - The function that should be defined. */ private checkFunctionInput (fn: (data: Data) => Response): void { if (fn == null) throw new Error('fn parameter is mandatory') - if (typeof fn !== 'function') { throw new TypeError('fn parameter is not a function') } + if (typeof fn !== 'function') { + throw new TypeError('fn parameter is not a function') + } } /** @@ -132,7 +136,7 @@ export abstract class AbstractWorker< /** * Sends a message to the main worker. * - * @param message The response message. + * @param message - The response message. */ protected abstract sendToMainWorker (message: MessageValue): void @@ -151,7 +155,7 @@ export abstract class AbstractWorker< /** * 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. + * @param e - The error raised by the worker. * @returns Message of the error. */ protected handleError (e: Error | string): string { @@ -161,49 +165,49 @@ export abstract class AbstractWorker< /** * Runs the given function synchronously. * - * @param fn Function that will be executed. - * @param value Input data for the given function. + * @param fn - Function that will be executed. + * @param message - Input data for the given function. */ protected run ( fn: (data?: Data) => Response, - value: MessageValue + message: MessageValue ): void { try { - const startTaskTimestamp = Date.now() - const res = fn(value.data) - const taskRunTime = Date.now() - startTaskTimestamp - this.sendToMainWorker({ data: res, id: value.id, taskRunTime }) + const startTimestamp = Date.now() + const res = fn(message.data) + const runTime = Date.now() - startTimestamp + this.sendToMainWorker({ data: res, id: message.id, runTime }) } catch (e) { const err = this.handleError(e as Error) - this.sendToMainWorker({ error: err, id: value.id }) + this.sendToMainWorker({ error: err, id: message.id }) } finally { - this.lastTaskTimestamp = Date.now() + !this.isMain && (this.lastTaskTimestamp = Date.now()) } } /** * Runs the given function asynchronously. * - * @param fn Function that will be executed. - * @param value Input data for the given function. + * @param fn - Function that will be executed. + * @param message - Input data for the given function. */ protected runAsync ( fn: (data?: Data) => Promise, - value: MessageValue + message: MessageValue ): void { - const startTaskTimestamp = Date.now() - fn(value.data) + const startTimestamp = Date.now() + fn(message.data) .then(res => { - const taskRunTime = Date.now() - startTaskTimestamp - this.sendToMainWorker({ data: res, id: value.id, taskRunTime }) + const runTime = Date.now() - startTimestamp + this.sendToMainWorker({ data: res, id: message.id, runTime }) return null }) .catch(e => { const err = this.handleError(e as Error) - this.sendToMainWorker({ error: err, id: value.id }) + this.sendToMainWorker({ error: err, id: message.id }) }) .finally(() => { - this.lastTaskTimestamp = Date.now() + !this.isMain && (this.lastTaskTimestamp = Date.now()) }) .catch(EMPTY_FUNCTION) }