X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=54358ee64b58adfb1a4f9275f53a04185ea878e8;hb=b953022b2e57106ca7c52e641da5e03c2f9d5e07;hp=c50cfbb081599ed955561edea56a634c93d885ef;hpb=afd20c11f44e34385623a4b86834f69bcf660606;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index c50cfbb0..54358ee6 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -2,18 +2,19 @@ import { AsyncResource } from 'async_hooks' import type { Worker } from 'cluster' import type { MessagePort } from 'worker_threads' import type { MessageValue } from '../utility-types' -import type { WorkerOptions } from './worker-options' -import { killBehaviorEnumeration } from './worker-options' +import { EMPTY_FUNCTION } from '../utils' +import type { KillBehavior, WorkerOptions } from './worker-options' +import { KillBehaviors } from './worker-options' -const defaultMaxInactiveTime = 1000 * 60 -const defaultKillBehavior = killBehaviorEnumeration.SOFT +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. - * @template Response Type of response the worker sends back to the 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. */ export abstract class AbstractWorker< MainWorker extends Worker | MessagePort, @@ -21,26 +22,17 @@ export abstract class AbstractWorker< Response = unknown > extends AsyncResource { /** - * The maximum time to keep this worker alive while idle. The pool automatically checks and terminates this worker when the time expires. - */ - protected readonly maxInactiveTime: number - /** - * The kill behavior set as option on the Worker constructor or a default value. - */ - protected readonly killBehavior: string - /** - * Whether the worker is working asynchronously or not. + * Timestamp of the last task processed by this worker. */ - protected readonly async: boolean + protected lastTaskTimestamp: number /** - * Timestamp of the last task processed by this worker. + * Handler Id of the `aliveInterval` worker alive check. */ - protected lastTask: number + protected readonly aliveInterval?: NodeJS.Timeout /** - * Handler ID of the `interval` alive check. + * Options for the worker. */ - protected readonly interval?: NodeJS.Timeout - + public readonly opts: WorkerOptions /** * Constructs a new poolifier worker. * @@ -54,47 +46,76 @@ export abstract class AbstractWorker< type: string, isMain: boolean, fn: (data: Data) => Response, - protected mainWorker?: MainWorker | null, - public readonly opts: WorkerOptions = { - killBehavior: defaultKillBehavior, - maxInactiveTime: defaultMaxInactiveTime + protected mainWorker: MainWorker | undefined | null, + opts: WorkerOptions = { + /** + * The kill behavior option on this Worker or its default value. + */ + killBehavior: DEFAULT_KILL_BEHAVIOR, + /** + * The maximum time to keep this worker alive while idle. + * The pool automatically checks and terminates this worker when the time expires. + */ + maxInactiveTime: DEFAULT_MAX_INACTIVE_TIME } ) { super(type) - this.killBehavior = this.opts.killBehavior ?? defaultKillBehavior - this.maxInactiveTime = this.opts.maxInactiveTime ?? defaultMaxInactiveTime - this.async = !!this.opts.async - this.lastTask = Date.now() - if (!fn) throw new Error('fn parameter is mandatory') + this.opts = opts + this.checkFunctionInput(fn) + this.checkWorkerOptions(this.opts) + this.lastTaskTimestamp = Date.now() // Keep the worker active - if (!isMain) { - this.interval = setInterval( + if (isMain === false) { + this.aliveInterval = setInterval( this.checkAlive.bind(this), - this.maxInactiveTime / 2 + (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2 ) this.checkAlive.bind(this)() } this.mainWorker?.on('message', (value: MessageValue) => { - if (value?.data && value.id) { - // Here you will receive messages - if (this.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.interval) clearInterval(this.interval) - this.emitDestroy() - } + this.messageListener(value, fn) }) } + 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) clearInterval(this.aliveInterval) + this.emitDestroy() + } + } + + private checkWorkerOptions (opts: WorkerOptions) { + this.opts.killBehavior = opts.killBehavior ?? DEFAULT_KILL_BEHAVIOR + this.opts.maxInactiveTime = + opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME + this.opts.async = !!opts.async + } + + /** + * Checks if the `fn` parameter is passed to the constructor. + * + * @param fn The function that should be defined. + */ + private checkFunctionInput (fn: (data: Data) => Response): void { + if (!fn) throw new Error('fn parameter is mandatory') + } + /** * Returns the main worker. * @@ -108,33 +129,36 @@ export abstract class AbstractWorker< } /** - * Send a message to the main worker. + * Sends a message to the main worker. * * @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 (Date.now() - this.lastTask > this.maxInactiveTime) { - this.sendToMainWorker({ kill: this.killBehavior }) + if ( + Date.now() - this.lastTaskTimestamp > + (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) + ) { + this.sendToMainWorker({ kill: this.opts.killBehavior }) } } /** - * 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. * @returns Message of the error. */ protected handleError (e: Error | string): string { - return (e as unknown) as string + return e as string } /** - * 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. @@ -144,18 +168,20 @@ export abstract class AbstractWorker< value: MessageValue ): void { try { + const startTaskTimestamp = Date.now() const res = fn(value.data) - this.sendToMainWorker({ data: res, id: value.id }) - this.lastTask = Date.now() + const taskRunTime = Date.now() - startTaskTimestamp + this.sendToMainWorker({ data: res, id: value.id, taskRunTime }) } catch (e) { - const err = this.handleError(e) + const err = this.handleError(e as Error) this.sendToMainWorker({ error: err, id: value.id }) - this.lastTask = Date.now() + } finally { + 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. @@ -164,16 +190,20 @@ export abstract class AbstractWorker< fn: (data?: Data) => Promise, value: MessageValue ): void { + const startTaskTimestamp = Date.now() fn(value.data) .then(res => { - this.sendToMainWorker({ data: res, id: value.id }) - this.lastTask = Date.now() + const taskRunTime = Date.now() - startTaskTimestamp + this.sendToMainWorker({ data: res, id: value.id, taskRunTime }) return null }) .catch(e => { - const err = this.handleError(e) + const err = this.handleError(e as Error) this.sendToMainWorker({ error: err, id: value.id }) - this.lastTask = Date.now() }) + .finally(() => { + this.lastTaskTimestamp = Date.now() + }) + .catch(EMPTY_FUNCTION) } }