X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fworker%2Fabstract-worker.ts;h=bf81a9f2432ff81606f7c10536c6ce338f16f066;hb=79aafe9fe0d0c4c40da43337b0a8c358f5f834ce;hp=3090b6f534f29597e7dca3dabddee8935f46ddbe;hpb=6bd72cd09232827a710b41952254cab597664247;p=poolifier.git diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts index 3090b6f5..bf81a9f2 100644 --- a/src/worker/abstract-worker.ts +++ b/src/worker/abstract-worker.ts @@ -1,9 +1,9 @@ -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 { type KillBehavior, type WorkerOptions } from './worker-options' import { KillBehaviors } from './worker-options' const DEFAULT_MAX_INACTIVE_TIME = 60000 @@ -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,7 +24,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. */ @@ -36,15 +36,15 @@ export abstract class AbstractWorker< /** * 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 = { @@ -63,9 +63,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 === false) { + if (!this.isMain) { + this.lastTaskTimestamp = Date.now() this.aliveInterval = setInterval( this.checkAlive.bind(this), (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2 @@ -95,28 +94,28 @@ export abstract class AbstractWorker< 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.aliveInterval != null && clearInterval(this.aliveInterval) this.emitDestroy() } } - private checkWorkerOptions (opts: WorkerOptions) { + 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 } /** * 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') + } } /** @@ -125,7 +124,7 @@ 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 @@ -134,12 +133,12 @@ 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 /** - * 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 ( @@ -153,7 +152,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 { @@ -163,8 +162,8 @@ 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 value - Input data for the given function. */ protected run ( fn: (data?: Data) => Response, @@ -179,15 +178,15 @@ export abstract class AbstractWorker< const err = this.handleError(e as Error) this.sendToMainWorker({ error: err, id: value.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 value - Input data for the given function. */ protected runAsync ( fn: (data?: Data) => Promise, @@ -205,7 +204,7 @@ export abstract class AbstractWorker< this.sendToMainWorker({ error: err, id: value.id }) }) .finally(() => { - this.lastTaskTimestamp = Date.now() + !this.isMain && (this.lastTaskTimestamp = Date.now()) }) .catch(EMPTY_FUNCTION) }