X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=846994591b5b2049039c748b554aba84b1a13d97;hb=681fa0b0307b869ae70caf1cb6e53701b699f8af;hp=e97c03473c2dc04da13d6507b40fc750ca72d8a8;hpb=c8d883806c74b85db4f68d2df035bf0b49b75254;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index e97c0347..84699459 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -6,11 +6,11 @@ import { EMPTY_FUNCTION } from '../utils' import type { KillBehavior, 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. @@ -29,7 +29,10 @@ export abstract class AbstractWorker< * 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. * @@ -43,8 +46,8 @@ export abstract class AbstractWorker< type: string, isMain: boolean, fn: (data: Data) => Response, - protected mainWorker: MainWorker | null, - public readonly opts: WorkerOptions = { + protected mainWorker: MainWorker | undefined | null, + opts: WorkerOptions = { /** * The kill behavior option on this Worker or its default value. */ @@ -57,6 +60,7 @@ export abstract class AbstractWorker< } ) { super(type) + this.opts = opts this.checkFunctionInput(fn) this.checkWorkerOptions(this.opts) this.lastTaskTimestamp = Date.now() @@ -70,42 +74,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. */ 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') + } } /** @@ -114,21 +125,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. */ 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 ( @@ -140,17 +151,17 @@ 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. * @returns Message of the error. */ protected handleError (e: Error | string): string { - return e.toString() + 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. @@ -160,8 +171,10 @@ export abstract class AbstractWorker< 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 }) @@ -171,7 +184,7 @@ export abstract class AbstractWorker< } /** - * 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. @@ -180,13 +193,15 @@ 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 }) + 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 }) }) .finally(() => {