X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=1f42a90bcf073e514a0acf2eec4fa4f04fdb0aea;hb=e65c6cd9a3d6ed2e5b8af95120a5aa070101e945;hp=8f86fb485cd26f30efcc51a1546eb1752579ba24;hpb=df422579fde9c2638e5802e94daa4f6eda698b2b;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index 8f86fb48..1f42a90b 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -1,20 +1,24 @@ -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' +import { + isKillBehavior, + type KillBehavior, + type WorkerOptions +} from './worker-options' import { KillBehaviors } from './worker-options' -const DEFAULT_MAX_INACTIVE_TIME = 1000 * 60 +const DEFAULT_MAX_INACTIVE_TIME = 60000 const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT /** - * Base class containing some shared logic for all poolifier workers. + * 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,7 +28,7 @@ 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. */ @@ -33,15 +37,14 @@ export abstract class AbstractWorker< * 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, @@ -64,9 +67,8 @@ export abstract class AbstractWorker< this.opts = opts this.checkFunctionInput(fn) this.checkWorkerOptions(this.opts) - this.lastTaskTimestamp = Date.now() - // Keep the worker active - if (!isMain) { + if (!isMain && isKillBehavior(KillBehaviors.HARD, this.opts.killBehavior)) { + this.lastTaskTimestamp = Date.now() this.aliveInterval = setInterval( this.checkAlive.bind(this), (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2 @@ -75,42 +77,49 @@ export abstract class AbstractWorker< } this.mainWorker?.on('message', (value: MessageValue) => { - if (value?.data && value.id) { - // Here you will receive messages - if (this.opts.async) { - this.runInAsyncScope(this.runAsync.bind(this), this, fn, value) - } else { - this.runInAsyncScope(this.run.bind(this), this, fn, value) - } - } else if (value.parent) { - // Save a reference of the main worker to communicate with it - // This will be received once - this.mainWorker = value.parent - } else if (value.kill) { - // Here is time to kill this worker, just clearing the interval - if (this.aliveInterval) clearInterval(this.aliveInterval) - this.emitDestroy() - } + this.messageListener(value, fn) }) } - private checkWorkerOptions (opts: WorkerOptions) { + protected messageListener ( + value: MessageValue, + fn: (data: Data) => Response + ): void { + if (value.data !== undefined && value.id !== undefined) { + // Here you will receive messages + if (this.opts.async === true) { + this.runInAsyncScope(this.runAsync.bind(this), this, fn, value) + } else { + this.runInAsyncScope(this.run.bind(this), this, fn, value) + } + } 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) + this.emitDestroy() + } + } + + private checkWorkerOptions (opts: WorkerOptions): void { this.opts.killBehavior = opts.killBehavior ?? DEFAULT_KILL_BEHAVIOR this.opts.maxInactiveTime = opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME - /** - * Whether the worker is working asynchronously or not. - */ - this.opts.async = !!opts.async + this.opts.async = opts.async ?? false } /** - * Check if the `fn` parameter is passed to the constructor. + * 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) throw new Error('fn parameter is mandatory') + if (fn == null) throw new Error('fn parameter is mandatory') + if (typeof fn !== 'function') { + throw new TypeError('fn parameter is not a function') + } } /** @@ -119,21 +128,21 @@ export abstract class AbstractWorker< * @returns Reference to the main worker. */ protected getMainWorker (): MainWorker { - if (!this.mainWorker) { + if (this.mainWorker == null) { throw new Error('Main worker was not set') } return this.mainWorker } /** - * Send a message to the main worker. + * Sends a message to the main worker. * - * @param message The response message. + * @param message - The response message. */ protected abstract sendToMainWorker (message: MessageValue): void /** - * Check to see if the worker should be terminated, because its living too long. + * Checks if the worker should be terminated, because its living too long. */ protected checkAlive (): void { if ( @@ -145,9 +154,9 @@ export abstract class AbstractWorker< } /** - * Handle an error and convert it to a string so it can be sent back to the main worker. + * 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 { @@ -155,39 +164,44 @@ export abstract class AbstractWorker< } /** - * Run the given function synchronously. + * 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 value - Input data for the given function. */ protected run ( fn: (data?: Data) => Response, value: MessageValue ): void { try { + const startTaskTimestamp = Date.now() const res = fn(value.data) - this.sendToMainWorker({ data: res, id: value.id }) + const taskRunTime = Date.now() - startTaskTimestamp + this.sendToMainWorker({ data: res, id: value.id, taskRunTime }) } catch (e) { const err = this.handleError(e as Error) this.sendToMainWorker({ error: err, id: value.id }) } finally { - this.lastTaskTimestamp = Date.now() + isKillBehavior(KillBehaviors.HARD, this.opts.killBehavior) && + (this.lastTaskTimestamp = Date.now()) } } /** - * Run the given function asynchronously. + * 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 value - Input data for the given function. */ protected runAsync ( fn: (data?: Data) => Promise, value: MessageValue ): void { + const startTaskTimestamp = Date.now() fn(value.data) .then(res => { - this.sendToMainWorker({ data: res, id: value.id }) + const taskRunTime = Date.now() - startTaskTimestamp + this.sendToMainWorker({ data: res, id: value.id, taskRunTime }) return null }) .catch(e => { @@ -195,7 +209,8 @@ export abstract class AbstractWorker< this.sendToMainWorker({ error: err, id: value.id }) }) .finally(() => { - this.lastTaskTimestamp = Date.now() + isKillBehavior(KillBehaviors.HARD, this.opts.killBehavior) && + (this.lastTaskTimestamp = Date.now()) }) .catch(EMPTY_FUNCTION) }