-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 { 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.
- * @template Response Type of response the worker sends back to the main worker.
+ * @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,
Data = unknown,
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: KillBehavior
- /**
- * Whether the worker is working asynchronously or not.
- */
- protected readonly async: boolean
/**
* Timestamp of the last task processed by this worker.
*/
- protected lastTask: number
+ protected lastTaskTimestamp!: number
/**
- * Handler ID of the `interval` alive check.
+ * Handler id of the `aliveInterval` worker alive check.
*/
- protected readonly interval?: NodeJS.Timeout
-
+ protected readonly aliveInterval?: NodeJS.Timeout
/**
* 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 | null,
- public readonly opts: WorkerOptions = {
+ protected mainWorker: MainWorker | undefined | null,
+ protected readonly 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 ?? DEFAULT_KILL_BEHAVIOR
- this.maxInactiveTime =
- this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME
- this.async = !!this.opts.async
- this.lastTask = Date.now()
- if (!fn) throw new Error('fn parameter is mandatory')
- // Keep the worker active
- if (!isMain) {
- this.interval = setInterval(
+ this.checkFunctionInput(fn)
+ this.checkWorkerOptions(this.opts)
+ if (!this.isMain) {
+ this.lastTaskTimestamp = Date.now()
+ 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<Data, MainWorker>) => {
- 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.mainWorker?.on(
+ 'message',
+ (message: MessageValue<Data, MainWorker>) => {
+ 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 (
+ message: MessageValue<Data, MainWorker>,
+ fn: (data: Data) => Response
+ ): void {
+ if (message.data != null && message.id != null) {
+ // Task message received
+ if (this.opts.async === true) {
+ this.runInAsyncScope(this.runAsync.bind(this), this, fn, message)
+ } else {
+ this.runInAsyncScope(this.run.bind(this), this, fn, message)
}
- })
+ } 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()
+ }
+ }
+
+ private checkWorkerOptions (opts: WorkerOptions): void {
+ this.opts.killBehavior = opts.killBehavior ?? DEFAULT_KILL_BEHAVIOR
+ this.opts.maxInactiveTime =
+ opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME
+ this.opts.async = opts.async ?? false
+ }
+
+ /**
+ * 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 == null) throw new Error('fn parameter is mandatory')
+ if (typeof fn !== 'function') {
+ throw new TypeError('fn parameter is not a function')
+ }
}
/**
* @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<Response>): 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.
+ * @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.
+ * @param fn - Function that will be executed.
+ * @param message - Input data for the given function.
*/
protected run (
fn: (data?: Data) => Response,
- value: MessageValue<Data>
+ message: MessageValue<Data>
): void {
try {
- const res = fn(value.data)
- this.sendToMainWorker({ data: res, id: value.id })
- this.lastTask = Date.now()
+ 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)
- this.sendToMainWorker({ error: err, id: value.id })
- this.lastTask = Date.now()
+ const err = this.handleError(e as Error)
+ this.sendToMainWorker({ error: err, id: message.id })
+ } finally {
+ !this.isMain && (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 message - Input data for the given function.
*/
protected runAsync (
fn: (data?: Data) => Promise<Response>,
- value: MessageValue<Data>
+ message: MessageValue<Data>
): void {
- fn(value.data)
+ const startTimestamp = Date.now()
+ fn(message.data)
.then(res => {
- this.sendToMainWorker({ data: res, id: value.id })
- this.lastTask = Date.now()
+ const runTime = Date.now() - startTimestamp
+ this.sendToMainWorker({ data: res, id: message.id, runTime })
return null
})
.catch(e => {
- const err = this.handleError(e)
- this.sendToMainWorker({ error: err, id: value.id })
- this.lastTask = Date.now()
+ const err = this.handleError(e as Error)
+ this.sendToMainWorker({ error: err, id: message.id })
+ })
+ .finally(() => {
+ !this.isMain && (this.lastTaskTimestamp = Date.now())
})
+ .catch(EMPTY_FUNCTION)
}
}
repositories / poolifier.git / blobdiff