-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'
/**
* Timestamp of the last task processed by this worker.
*/
- protected lastTaskTimestamp: number
+ protected lastTaskTimestamp!: number
/**
- * Handler Id of the `aliveInterval` worker alive check.
+ * 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.
*
*/
public constructor (
type: string,
- isMain: boolean,
- fn: (data: Data) => Response,
+ protected readonly isMain: boolean,
+ fn: (data: Data) => Response | Promise<Response>,
protected mainWorker: MainWorker | undefined | null,
- opts: WorkerOptions = {
+ protected readonly opts: WorkerOptions = {
/**
- * The kill behavior option on this Worker or its default value.
+ * The kill behavior option on this worker or its default value.
*/
killBehavior: DEFAULT_KILL_BEHAVIOR,
/**
}
) {
super(type)
- this.opts = opts
- this.checkFunctionInput(fn)
this.checkWorkerOptions(this.opts)
- this.lastTaskTimestamp = Date.now()
- // Keep the worker active
- if (!isMain) {
+ this.checkFunctionInput(fn)
+ if (!this.isMain) {
+ this.lastTaskTimestamp = performance.now()
this.aliveInterval = setInterval(
this.checkAlive.bind(this),
(this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2
this.checkAlive.bind(this)()
}
- this.mainWorker?.on('message', (value: MessageValue<Data, MainWorker>) => {
- this.messageListener(value, fn)
- })
+ 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 (
- value: MessageValue<Data, MainWorker>,
- fn: (data: Data) => Response
+ message: MessageValue<Data, MainWorker>,
+ fn: (data: Data) => Response | Promise<Response>
): void {
- if (value.data !== undefined && value.id !== undefined) {
- // Here you will receive messages
+ if (message.id != null && message.data != null) {
+ // Task message received
if (this.opts.async === true) {
- this.runInAsyncScope(this.runAsync.bind(this), this, fn, value)
+ this.runInAsyncScope(this.runAsync.bind(this), this, fn, message)
} else {
- this.runInAsyncScope(this.run.bind(this), this, fn, value)
+ this.runInAsyncScope(this.run.bind(this), this, fn, message)
}
- } 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)
+ } 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()
}
}
*
* @param fn - The function that should be defined.
*/
- private checkFunctionInput (fn: (data: Data) => Response): void {
+ private checkFunctionInput (
+ fn: (data: Data) => Response | Promise<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')
}
+ if (fn.constructor.name === 'AsyncFunction' && this.opts.async === false) {
+ throw new Error(
+ 'fn parameter is an async function, please set the async option to true'
+ )
+ }
}
/**
*/
protected checkAlive (): void {
if (
- Date.now() - this.lastTaskTimestamp >
+ performance.now() - this.lastTaskTimestamp >
(this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME)
) {
this.sendToMainWorker({ kill: this.opts.killBehavior })
* Runs the given function synchronously.
*
* @param fn - Function that will be executed.
- * @param value - Input data for the given function.
+ * @param message - Input data for the given function.
*/
protected run (
fn: (data?: Data) => Response,
- value: MessageValue<Data>
+ message: MessageValue<Data>
): void {
try {
- const startTaskTimestamp = Date.now()
- const res = fn(value.data)
- const taskRunTime = Date.now() - startTaskTimestamp
- this.sendToMainWorker({ data: res, id: value.id, taskRunTime })
+ const startTimestamp = performance.now()
+ const res = fn(message.data)
+ const runTime = performance.now() - startTimestamp
+ this.sendToMainWorker({
+ data: res,
+ id: message.id,
+ runTime
+ })
} catch (e) {
const err = this.handleError(e as Error)
- this.sendToMainWorker({ error: err, id: value.id })
+ this.sendToMainWorker({ error: err, id: message.id })
} finally {
- this.lastTaskTimestamp = Date.now()
+ !this.isMain && (this.lastTaskTimestamp = performance.now())
}
}
* Runs the given function asynchronously.
*
* @param fn - Function that will be executed.
- * @param value - Input data for the given function.
+ * @param message - Input data for the given function.
*/
protected runAsync (
fn: (data?: Data) => Promise<Response>,
- value: MessageValue<Data>
+ message: MessageValue<Data>
): void {
- const startTaskTimestamp = Date.now()
- fn(value.data)
+ const startTimestamp = performance.now()
+ fn(message.data)
.then(res => {
- const taskRunTime = Date.now() - startTaskTimestamp
- this.sendToMainWorker({ data: res, id: value.id, taskRunTime })
+ const runTime = performance.now() - startTimestamp
+ this.sendToMainWorker({
+ data: res,
+ id: message.id,
+ runTime
+ })
return null
})
.catch(e => {
const err = this.handleError(e as Error)
- this.sendToMainWorker({ error: err, id: value.id })
+ this.sendToMainWorker({ error: err, id: message.id })
})
.finally(() => {
- this.lastTaskTimestamp = Date.now()
+ !this.isMain && (this.lastTaskTimestamp = performance.now())
})
.catch(EMPTY_FUNCTION)
}