-import { AsyncResource } from 'node:async_hooks'
import type { Worker } from 'node:cluster'
-import type { MessagePort } from 'node:worker_threads'
import { performance } from 'node:perf_hooks'
+import type { MessagePort } from 'node:worker_threads'
+
import type {
MessageValue,
Task,
TaskPerformance,
WorkerStatistics
-} from '../utility-types'
+} from '../utility-types.js'
import {
DEFAULT_TASK_NAME,
EMPTY_FUNCTION,
isAsyncFunction,
isPlainObject
-} from '../utils'
-import { KillBehaviors, type WorkerOptions } from './worker-options'
+} from '../utils.js'
import type {
TaskAsyncFunction,
TaskFunction,
+ TaskFunctionOperationResult,
TaskFunctions,
TaskSyncFunction
-} from './task-functions'
+} from './task-functions.js'
+import {
+ checkTaskFunctionName,
+ checkValidTaskFunctionEntry,
+ checkValidWorkerOptions
+} from './utils.js'
+import { KillBehaviors, type WorkerOptions } from './worker-options.js'
const DEFAULT_MAX_INACTIVE_TIME = 60000
const DEFAULT_WORKER_OPTIONS: WorkerOptions = {
MainWorker extends Worker | MessagePort,
Data = unknown,
Response = unknown
-> extends AsyncResource {
+> {
/**
* Worker id.
*/
/**
* Performance statistics computation requirements.
*/
- protected statistics!: WorkerStatistics
+ protected statistics?: WorkerStatistics
/**
* Handler id of the `activeInterval` worker activity check.
*/
protected activeInterval?: 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 mainWorker - Reference to main worker.
* @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked. The first function is the default function.
* @param opts - Options for the worker.
*/
public constructor (
- type: string,
- protected readonly isMain: boolean,
- private readonly mainWorker: MainWorker,
+ protected readonly isMain: boolean | undefined,
+ private readonly mainWorker: MainWorker | undefined | null,
taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>,
protected opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
) {
- super(type)
if (this.isMain == null) {
throw new Error('isMain parameter is mandatory')
}
this.checkTaskFunctions(taskFunctions)
this.checkWorkerOptions(this.opts)
if (!this.isMain) {
+ // Should be once() but Node.js on windows has a bug that prevents it from working
this.getMainWorker().on('message', this.handleReadyMessage.bind(this))
}
}
private checkWorkerOptions (opts: WorkerOptions): void {
+ checkValidWorkerOptions(opts)
this.opts = { ...DEFAULT_WORKER_OPTIONS, ...opts }
- delete this.opts.async
- }
-
- private checkValidTaskFunction (
- name: string,
- fn: TaskFunction<Data, Response>
- ): void {
- if (typeof name !== 'string') {
- throw new TypeError(
- 'A taskFunctions parameter object key is not a string'
- )
- }
- if (typeof name === 'string' && name.trim().length === 0) {
- throw new TypeError(
- 'A taskFunctions parameter object key is an empty string'
- )
- }
- if (typeof fn !== 'function') {
- throw new TypeError(
- 'A taskFunctions parameter object value is not a function'
- )
- }
}
/**
- * Checks if the `taskFunctions` parameter is passed to the constructor.
+ * Checks if the `taskFunctions` parameter is passed to the constructor and valid.
*
* @param taskFunctions - The task function(s) parameter that should be checked.
*/
private checkTaskFunctions (
- taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>
+ taskFunctions:
+ | TaskFunction<Data, Response>
+ | TaskFunctions<Data, Response>
+ | undefined
): void {
if (taskFunctions == null) {
throw new Error('taskFunctions parameter is mandatory')
this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn)
this.taskFunctions.set(
typeof taskFunctions.name === 'string' &&
- taskFunctions.name.trim().length > 0
+ taskFunctions.name.trim().length > 0
? taskFunctions.name
: 'fn1',
boundFn
} else if (isPlainObject(taskFunctions)) {
let firstEntry = true
for (const [name, fn] of Object.entries(taskFunctions)) {
- this.checkValidTaskFunction(name, fn)
+ checkValidTaskFunctionEntry<Data, Response>(name, fn)
const boundFn = fn.bind(this)
if (firstEntry) {
this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn)
*
* @param name - The name of the task function to check.
* @returns Whether the worker has a task function with the given name or not.
- * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
*/
- public hasTaskFunction (name: string): boolean {
- this.checkTaskFunctionName(name)
- return this.taskFunctions.has(name)
+ public hasTaskFunction (name: string): TaskFunctionOperationResult {
+ try {
+ checkTaskFunctionName(name)
+ } catch (error) {
+ return { status: false, error: error as Error }
+ }
+ return { status: this.taskFunctions.has(name) }
}
/**
* @param name - The name of the task function to add.
* @param fn - The task function to add.
* @returns Whether the task function was added or not.
- * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
- * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the default task function reserved name.
- * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `fn` parameter is not a function.
*/
public addTaskFunction (
name: string,
fn: TaskFunction<Data, Response>
- ): boolean {
- this.checkTaskFunctionName(name)
- if (name === DEFAULT_TASK_NAME) {
- throw new Error(
- 'Cannot add a task function with the default reserved name'
- )
- }
- if (typeof fn !== 'function') {
- throw new TypeError('fn parameter is not a function')
- }
+ ): TaskFunctionOperationResult {
try {
+ checkTaskFunctionName(name)
+ if (name === DEFAULT_TASK_NAME) {
+ throw new Error(
+ 'Cannot add a task function with the default reserved name'
+ )
+ }
+ if (typeof fn !== 'function') {
+ throw new TypeError('fn parameter is not a function')
+ }
const boundFn = fn.bind(this)
if (
this.taskFunctions.get(name) ===
this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn)
}
this.taskFunctions.set(name, boundFn)
- this.sendTaskFunctionsListToMainWorker()
- return true
- } catch {
- return false
+ this.sendTaskFunctionNamesToMainWorker()
+ return { status: true }
+ } catch (error) {
+ return { status: false, error: error as Error }
}
}
*
* @param name - The name of the task function to remove.
* @returns Whether the task function existed and was removed or not.
- * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
- * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the default task function reserved name.
- * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the task function used as default task function.
*/
- public removeTaskFunction (name: string): boolean {
- this.checkTaskFunctionName(name)
- if (name === DEFAULT_TASK_NAME) {
- throw new Error(
- 'Cannot remove the task function with the default reserved name'
- )
- }
- if (
- this.taskFunctions.get(name) === this.taskFunctions.get(DEFAULT_TASK_NAME)
- ) {
- throw new Error(
- 'Cannot remove the task function used as the default task function'
- )
+ public removeTaskFunction (name: string): TaskFunctionOperationResult {
+ try {
+ checkTaskFunctionName(name)
+ if (name === DEFAULT_TASK_NAME) {
+ throw new Error(
+ 'Cannot remove the task function with the default reserved name'
+ )
+ }
+ if (
+ this.taskFunctions.get(name) ===
+ this.taskFunctions.get(DEFAULT_TASK_NAME)
+ ) {
+ throw new Error(
+ 'Cannot remove the task function used as the default task function'
+ )
+ }
+ const deleteStatus = this.taskFunctions.delete(name)
+ this.sendTaskFunctionNamesToMainWorker()
+ return { status: deleteStatus }
+ } catch (error) {
+ return { status: false, error: error as Error }
}
- const deleteStatus = this.taskFunctions.delete(name)
- this.sendTaskFunctionsListToMainWorker()
- return deleteStatus
}
/**
*
* @returns The names of the worker's task functions.
*/
- public listTaskFunctions (): string[] {
- const names: string[] = [...this.taskFunctions.keys()]
- let defaultTaskFunctionName: string = DEFAULT_TASK_NAME
+ public listTaskFunctionNames (): string[] {
+ const names = [...this.taskFunctions.keys()]
+ let defaultTaskFunctionName = DEFAULT_TASK_NAME
for (const [name, fn] of this.taskFunctions) {
if (
name !== DEFAULT_TASK_NAME &&
*
* @param name - The name of the task function to use as default task function.
* @returns Whether the default task function was set or not.
- * @throws {@link https://nodejs.org/api/errors.html#class-typeerror} If the `name` parameter is not a string or an empty string.
- * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is the default task function reserved name.
- * @throws {@link https://nodejs.org/api/errors.html#class-error} If the `name` parameter is a non-existing task function.
*/
- public setDefaultTaskFunction (name: string): boolean {
- this.checkTaskFunctionName(name)
- if (name === DEFAULT_TASK_NAME) {
- throw new Error(
- 'Cannot set the default task function reserved name as the default task function'
- )
- }
- if (!this.taskFunctions.has(name)) {
- throw new Error(
- 'Cannot set the default task function to a non-existing task function'
- )
- }
+ public setDefaultTaskFunction (name: string): TaskFunctionOperationResult {
try {
- this.taskFunctions.set(
- DEFAULT_TASK_NAME,
- this.taskFunctions.get(name) as TaskFunction<Data, Response>
- )
- return true
- } catch {
- return false
- }
- }
-
- private checkTaskFunctionName (name: string): void {
- if (typeof name !== 'string') {
- throw new TypeError('name parameter is not a string')
- }
- if (typeof name === 'string' && name.trim().length === 0) {
- throw new TypeError('name parameter is an empty string')
+ checkTaskFunctionName(name)
+ if (name === DEFAULT_TASK_NAME) {
+ throw new Error(
+ 'Cannot set the default task function reserved name as the default task function'
+ )
+ }
+ if (!this.taskFunctions.has(name)) {
+ throw new Error(
+ 'Cannot set the default task function to a non-existing task function'
+ )
+ }
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ this.taskFunctions.set(DEFAULT_TASK_NAME, this.taskFunctions.get(name)!)
+ this.sendTaskFunctionNamesToMainWorker()
+ return { status: true }
+ } catch (error) {
+ return { status: false, error: error as Error }
}
}
} else if (message.checkActive != null) {
// Check active message received
message.checkActive ? this.startCheckActive() : this.stopCheckActive()
+ } else if (message.taskFunctionOperation != null) {
+ // Task function operation message received
+ this.handleTaskFunctionOperationMessage(message)
} else if (message.taskId != null && message.data != null) {
// Task message received
this.run(message)
}
}
+ protected handleTaskFunctionOperationMessage (
+ message: MessageValue<Data>
+ ): void {
+ const { taskFunctionOperation, taskFunctionName, taskFunction } = message
+ if (taskFunctionName == null) {
+ throw new Error(
+ 'Cannot handle task function operation message without a task function name'
+ )
+ }
+ let response: TaskFunctionOperationResult
+ switch (taskFunctionOperation) {
+ case 'add':
+ response = this.addTaskFunction(
+ taskFunctionName,
+ // eslint-disable-next-line @typescript-eslint/no-implied-eval, no-new-func
+ new Function(`return ${taskFunction}`)() as TaskFunction<
+ Data,
+ Response
+ >
+ )
+ break
+ case 'remove':
+ response = this.removeTaskFunction(taskFunctionName)
+ break
+ case 'default':
+ response = this.setDefaultTaskFunction(taskFunctionName)
+ break
+ default:
+ response = { status: false, error: new Error('Unknown task operation') }
+ break
+ }
+ this.sendToMainWorker({
+ taskFunctionOperation,
+ taskFunctionOperationStatus: response.status,
+ taskFunctionName,
+ ...(!response.status &&
+ response.error != null && {
+ workerError: {
+ name: taskFunctionName,
+ message: this.handleError(response.error as Error | string)
+ }
+ })
+ })
+ }
+
/**
* Handles a kill message sent by the main worker.
*
* @param message - The kill message.
*/
- protected handleKillMessage (message: MessageValue<Data>): void {
+ protected handleKillMessage (_message: MessageValue<Data>): void {
this.stopCheckActive()
if (isAsyncFunction(this.opts.killHandler)) {
- (this.opts.killHandler?.() as Promise<void>)
+ (this.opts.killHandler() as Promise<void>)
.then(() => {
- this.sendToMainWorker({ kill: 'success', workerId: this.id })
- return null
+ this.sendToMainWorker({ kill: 'success' })
+ return undefined
})
.catch(() => {
- this.sendToMainWorker({ kill: 'failure', workerId: this.id })
- })
- .finally(() => {
- this.emitDestroy()
+ this.sendToMainWorker({ kill: 'failure' })
})
- .catch(EMPTY_FUNCTION)
} else {
try {
// eslint-disable-next-line @typescript-eslint/no-invalid-void-type
this.opts.killHandler?.() as void
- this.sendToMainWorker({ kill: 'success', workerId: this.id })
+ this.sendToMainWorker({ kill: 'success' })
} catch {
- this.sendToMainWorker({ kill: 'failure', workerId: this.id })
- } finally {
- this.emitDestroy()
+ this.sendToMainWorker({ kill: 'failure' })
}
}
}
private checkMessageWorkerId (message: MessageValue<Data>): void {
if (message.workerId == null) {
throw new Error('Message worker id is not set')
- } else if (message.workerId != null && message.workerId !== this.id) {
+ } else if (message.workerId !== this.id) {
throw new Error(
`Message worker id ${message.workerId} does not match the worker id ${this.id}`
)
performance.now() - this.lastTaskTimestamp >
(this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME)
) {
- this.sendToMainWorker({ kill: this.opts.killBehavior, workerId: this.id })
+ this.sendToMainWorker({ kill: this.opts.killBehavior })
}
}
): void
/**
- * Sends the list of task function names to the main worker.
+ * Sends task function names to the main worker.
*/
- protected sendTaskFunctionsListToMainWorker (): void {
+ protected sendTaskFunctionNamesToMainWorker (): void {
this.sendToMainWorker({
- taskFunctions: this.listTaskFunctions(),
- workerId: this.id
+ taskFunctionNames: this.listTaskFunctionNames()
})
}
/**
* 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 error - The error raised by the worker.
* @returns The error message.
*/
- protected handleError (e: Error | string): string {
- return e instanceof Error ? e.message : e
+ protected handleError (error: Error | string): string {
+ return error instanceof Error ? error.message : error
}
/**
* Runs the given task.
*
* @param task - The task to execute.
- * @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found.
*/
- protected run (task: Task<Data>): void {
+ protected readonly run = (task: Task<Data>): void => {
const { name, taskId, data } = task
- const fn = this.taskFunctions.get(name ?? DEFAULT_TASK_NAME)
- if (fn == null) {
+ const taskFunctionName = name ?? DEFAULT_TASK_NAME
+ if (!this.taskFunctions.has(taskFunctionName)) {
this.sendToMainWorker({
- taskError: {
- name: name as string,
- message: `Task function '${name as string}' not found`,
+ workerError: {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ name: name!,
+ message: `Task function '${name}' not found`,
data
},
- workerId: this.id,
taskId
})
return
}
+ const fn = this.taskFunctions.get(taskFunctionName)
if (isAsyncFunction(fn)) {
- this.runInAsyncScope(this.runAsync.bind(this), this, fn, task)
+ this.runAsync(fn as TaskAsyncFunction<Data, Response>, task)
} else {
- this.runInAsyncScope(this.runSync.bind(this), this, fn, task)
+ this.runSync(fn as TaskSyncFunction<Data, Response>, task)
}
}
* @param fn - Task function that will be executed.
* @param task - Input data for the task function.
*/
- protected runSync (
+ protected readonly runSync = (
fn: TaskSyncFunction<Data, Response>,
task: Task<Data>
- ): void {
+ ): void => {
const { name, taskId, data } = task
try {
let taskPerformance = this.beginTaskPerformance(name)
this.sendToMainWorker({
data: res,
taskPerformance,
- workerId: this.id,
taskId
})
- } catch (e) {
- const errorMessage = this.handleError(e as Error | string)
+ } catch (error) {
this.sendToMainWorker({
- taskError: {
- name: name as string,
- message: errorMessage,
+ workerError: {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ name: name!,
+ message: this.handleError(error as Error | string),
data
},
- workerId: this.id,
taskId
})
} finally {
* @param fn - Task function that will be executed.
* @param task - Input data for the task function.
*/
- protected runAsync (
+ protected readonly runAsync = (
fn: TaskAsyncFunction<Data, Response>,
task: Task<Data>
- ): void {
+ ): void => {
const { name, taskId, data } = task
let taskPerformance = this.beginTaskPerformance(name)
fn(data)
this.sendToMainWorker({
data: res,
taskPerformance,
- workerId: this.id,
taskId
})
- return null
+ return undefined
})
- .catch(e => {
- const errorMessage = this.handleError(e as Error | string)
+ .catch((error: unknown) => {
this.sendToMainWorker({
- taskError: {
- name: name as string,
- message: errorMessage,
+ workerError: {
+ // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+ name: name!,
+ message: this.handleError(error as Error | string),
data
},
- workerId: this.id,
taskId
})
})
}
private beginTaskPerformance (name?: string): TaskPerformance {
- this.checkStatistics()
+ if (this.statistics == null) {
+ throw new Error('Performance statistics computation requirements not set')
+ }
return {
name: name ?? DEFAULT_TASK_NAME,
timestamp: performance.now(),
- ...(this.statistics.elu && { elu: performance.eventLoopUtilization() })
+ ...(this.statistics.elu && {
+ elu: performance.eventLoopUtilization()
+ })
}
}
private endTaskPerformance (
taskPerformance: TaskPerformance
): TaskPerformance {
- this.checkStatistics()
+ if (this.statistics == null) {
+ throw new Error('Performance statistics computation requirements not set')
+ }
return {
...taskPerformance,
...(this.statistics.runTime && {
}
}
- private checkStatistics (): void {
- if (this.statistics == null) {
- throw new Error('Performance statistics computation requirements not set')
- }
- }
-
private updateLastTaskTimestamp (): void {
if (this.activeInterval != null) {
this.lastTaskTimestamp = performance.now()
repositories / poolifier.git / blobdiff