isAsyncFunction,
isPlainObject
} from '../utils'
-import {
- type KillBehavior,
- KillBehaviors,
- type WorkerOptions
-} from './worker-options'
+import { KillBehaviors, type WorkerOptions } from './worker-options'
import type {
TaskAsyncFunction,
TaskFunction,
+ TaskFunctionOperationReturnType,
TaskFunctions,
TaskSyncFunction
} from './task-functions'
const DEFAULT_MAX_INACTIVE_TIME = 60000
-const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT
+const DEFAULT_WORKER_OPTIONS: WorkerOptions = {
+ /**
+ * The kill behavior option on this worker or its default value.
+ */
+ killBehavior: KillBehaviors.SOFT,
+ /**
+ * The maximum time to keep this worker active while idle.
+ * The pool automatically checks and terminates this worker when the time expires.
+ */
+ maxInactiveTime: DEFAULT_MAX_INACTIVE_TIME,
+ /**
+ * The function to call when the worker is killed.
+ */
+ killHandler: EMPTY_FUNCTION
+}
/**
* Base class that implements some shared logic for all poolifier workers.
protected readonly isMain: boolean,
private readonly mainWorker: MainWorker,
taskFunctions: TaskFunction<Data, Response> | TaskFunctions<Data, Response>,
- 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 active while idle.
- * The pool automatically checks and terminates this worker when the time expires.
- */
- maxInactiveTime: DEFAULT_MAX_INACTIVE_TIME,
- /**
- * The function to call when the worker is killed.
- */
- killHandler: EMPTY_FUNCTION
- }
+ protected opts: WorkerOptions = DEFAULT_WORKER_OPTIONS
) {
super(type)
- this.checkWorkerOptions(this.opts)
+ if (this.isMain == null) {
+ throw new Error('isMain parameter is mandatory')
+ }
this.checkTaskFunctions(taskFunctions)
+ this.checkWorkerOptions(this.opts)
if (!this.isMain) {
- this.getMainWorker()?.on('message', this.handleReadyMessage.bind(this))
+ this.getMainWorker().on('message', this.handleReadyMessage.bind(this))
}
}
private checkWorkerOptions (opts: WorkerOptions): void {
- this.opts.killBehavior = opts.killBehavior ?? DEFAULT_KILL_BEHAVIOR
- this.opts.maxInactiveTime =
- opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME
- delete this.opts.async
- this.opts.killHandler = opts.killHandler ?? EMPTY_FUNCTION
+ if (opts != null && !isPlainObject(opts)) {
+ throw new TypeError('opts worker options parameter is not a plain object')
+ }
+ if (
+ opts?.killBehavior != null &&
+ !Object.values(KillBehaviors).includes(opts.killBehavior)
+ ) {
+ throw new TypeError(
+ `killBehavior option '${opts.killBehavior}' is not valid`
+ )
+ }
+ if (
+ opts?.maxInactiveTime != null &&
+ !Number.isSafeInteger(opts.maxInactiveTime)
+ ) {
+ throw new TypeError('maxInactiveTime option is not an integer')
+ }
+ if (opts?.maxInactiveTime != null && opts.maxInactiveTime < 5) {
+ throw new TypeError(
+ 'maxInactiveTime option is not a positive integer greater or equal than 5'
+ )
+ }
+ if (opts?.killHandler != null && typeof opts.killHandler !== 'function') {
+ throw new TypeError('killHandler option is not a function')
+ }
+ if (opts?.async != null) {
+ throw new Error('async option is deprecated')
+ }
+ this.opts = { ...DEFAULT_WORKER_OPTIONS, ...opts }
+ }
+
+ private checkValidTaskFunctionEntry (
+ 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.
*/
} else if (isPlainObject(taskFunctions)) {
let firstEntry = true
for (const [name, fn] of Object.entries(taskFunctions)) {
- if (typeof name !== 'string') {
- throw new TypeError(
- 'A taskFunctions parameter object key is not a string'
- )
- }
- if (typeof fn !== 'function') {
- throw new TypeError(
- 'A taskFunctions parameter object value is not a function'
- )
- }
+ this.checkValidTaskFunctionEntry(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.
*/
- public hasTaskFunction (name: string): boolean {
- if (typeof name !== 'string') {
- throw new TypeError('name parameter is not a string')
+ public hasTaskFunction (name: string): TaskFunctionOperationReturnType {
+ try {
+ this.checkTaskFunctionName(name)
+ } catch (error) {
+ return { status: false, error: error as Error }
}
- return this.taskFunctions.has(name)
+ 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.
- * @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 {
- if (typeof name !== 'string') {
- throw new TypeError('name parameter is not a string')
- }
- 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')
- }
+ ): TaskFunctionOperationReturnType {
try {
+ 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')
+ }
const boundFn = fn.bind(this)
if (
this.taskFunctions.get(name) ===
this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn)
}
this.taskFunctions.set(name, boundFn)
- 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.
- * @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 {
- if (typeof name !== 'string') {
- throw new TypeError('name parameter is not a string')
- }
- 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): TaskFunctionOperationReturnType {
+ try {
+ 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'
+ )
+ }
+ const deleteStatus = this.taskFunctions.delete(name)
+ this.sendTaskFunctionNamesToMainWorker()
+ return { status: deleteStatus }
+ } catch (error) {
+ return { status: false, error: error as Error }
}
- return this.taskFunctions.delete(name)
}
/**
*
* @returns The names of the worker's task functions.
*/
- public listTaskFunctions (): string[] {
- return [...this.taskFunctions.keys()]
+ public listTaskFunctionNames (): string[] {
+ const names: string[] = [...this.taskFunctions.keys()]
+ let defaultTaskFunctionName: string = DEFAULT_TASK_NAME
+ for (const [name, fn] of this.taskFunctions) {
+ if (
+ name !== DEFAULT_TASK_NAME &&
+ fn === this.taskFunctions.get(DEFAULT_TASK_NAME)
+ ) {
+ defaultTaskFunctionName = name
+ break
+ }
+ }
+ return [
+ names[names.indexOf(DEFAULT_TASK_NAME)],
+ defaultTaskFunctionName,
+ ...names.filter(
+ name => name !== DEFAULT_TASK_NAME && name !== defaultTaskFunctionName
+ )
+ ]
}
/**
*
* @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.
- * @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 {
- if (typeof name !== 'string') {
- throw new TypeError('name parameter is not a string')
- }
- 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): TaskFunctionOperationReturnType {
try {
+ 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'
+ )
+ }
this.taskFunctions.set(
DEFAULT_TASK_NAME,
this.taskFunctions.get(name) as TaskFunction<Data, Response>
)
- return true
- } catch {
- return false
+ return { status: true }
+ } catch (error) {
+ return { status: false, error: error as Error }
+ }
+ }
+
+ 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')
}
}
* @param message - The received message.
*/
protected messageListener (message: MessageValue<Data>): void {
- if (this.isMain) {
- throw new Error('Cannot handle message to worker in main worker')
- } else if (message.workerId != null && message.workerId !== this.id) {
- throw new Error('Message worker id does not match the worker id')
- } else if (message.workerId === this.id) {
- if (message.statistics != null) {
- // Statistics message received
- this.statistics = message.statistics
- } else if (message.checkActive != null) {
- // Check active message received
- message.checkActive ? this.startCheckActive() : this.stopCheckActive()
- } else if (message.taskId != null && message.data != null) {
- // Task message received
- this.run(message)
- } else if (message.kill === true) {
- // Kill message received
- this.handleKillMessage(message)
- }
+ this.checkMessageWorkerId(message)
+ if (message.statistics != null) {
+ // Statistics message received
+ this.statistics = message.statistics
+ } 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)
+ } else if (message.kill === true) {
+ // Kill message received
+ this.handleKillMessage(message)
+ }
+ }
+
+ protected handleTaskFunctionOperationMessage (
+ message: MessageValue<Data>
+ ): void {
+ const { taskFunctionOperation, taskFunction, taskFunctionName } = message
+ let response!: TaskFunctionOperationReturnType
+ if (taskFunctionOperation === 'add') {
+ response = this.addTaskFunction(
+ taskFunctionName as string,
+ // eslint-disable-next-line @typescript-eslint/no-implied-eval, no-new-func
+ new Function(`return ${taskFunction as string}`)() as TaskFunction<
+ Data,
+ Response
+ >
+ )
+ } else if (taskFunctionOperation === 'remove') {
+ response = this.removeTaskFunction(taskFunctionName as string)
+ } else if (taskFunctionOperation === 'default') {
+ response = this.setDefaultTaskFunction(taskFunctionName as string)
}
+ this.sendToMainWorker({
+ taskFunctionOperation,
+ taskFunctionOperationStatus: response.status,
+ workerError: {
+ name: taskFunctionName as string,
+ message: this.handleError(response.error as Error | string)
+ }
+ })
}
/**
*/
protected handleKillMessage (message: MessageValue<Data>): void {
this.stopCheckActive()
- this.opts.killHandler?.()
- this.emitDestroy()
+ if (isAsyncFunction(this.opts.killHandler)) {
+ (this.opts.killHandler?.() as Promise<void>)
+ .then(() => {
+ this.sendToMainWorker({ kill: 'success' })
+ return null
+ })
+ .catch(() => {
+ this.sendToMainWorker({ kill: 'failure' })
+ })
+ .finally(() => {
+ this.emitDestroy()
+ })
+ .catch(EMPTY_FUNCTION)
+ } else {
+ try {
+ // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+ this.opts.killHandler?.() as void
+ this.sendToMainWorker({ kill: 'success' })
+ } catch {
+ this.sendToMainWorker({ kill: 'failure' })
+ } finally {
+ this.emitDestroy()
+ }
+ }
+ }
+
+ /**
+ * Check if the message worker id is set and matches the worker id.
+ *
+ * @param message - The message to check.
+ * @throws {@link https://nodejs.org/api/errors.html#class-error} If the message worker id is not set or does not match the worker id.
+ */
+ 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) {
+ 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 })
}
}
* Returns the main worker.
*
* @returns Reference to the main worker.
+ * @throws {@link https://nodejs.org/api/errors.html#class-error} If the main worker is not set.
*/
protected getMainWorker (): MainWorker {
if (this.mainWorker == null) {
message: MessageValue<Response, Data>
): void
+ /**
+ * Sends task function names to the main worker.
+ */
+ protected sendTaskFunctionNamesToMainWorker (): void {
+ this.sendToMainWorker({
+ 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
}
/**
* @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found.
*/
protected run (task: Task<Data>): void {
- const fn = this.getTaskFunction(task.name)
+ const { name, taskId, data } = task
+ const fn = this.taskFunctions.get(name ?? DEFAULT_TASK_NAME)
+ if (fn == null) {
+ this.sendToMainWorker({
+ workerError: {
+ name: name as string,
+ message: `Task function '${name as string}' not found`,
+ data
+ },
+ taskId
+ })
+ return
+ }
if (isAsyncFunction(fn)) {
this.runInAsyncScope(this.runAsync.bind(this), this, fn, task)
} else {
fn: TaskSyncFunction<Data, Response>,
task: Task<Data>
): void {
+ const { name, taskId, data } = task
try {
- let taskPerformance = this.beginTaskPerformance(task.name)
- const res = fn(task.data)
+ let taskPerformance = this.beginTaskPerformance(name)
+ const res = fn(data)
taskPerformance = this.endTaskPerformance(taskPerformance)
this.sendToMainWorker({
data: res,
taskPerformance,
- workerId: this.id,
- taskId: task.taskId
+ taskId
})
- } catch (e) {
- const errorMessage = this.handleError(e as Error | string)
+ } catch (error) {
this.sendToMainWorker({
- taskError: {
- name: task.name ?? DEFAULT_TASK_NAME,
- message: errorMessage,
- data: task.data
+ workerError: {
+ name: name as string,
+ message: this.handleError(error as Error | string),
+ data
},
- workerId: this.id,
- taskId: task.taskId
+ taskId
})
} finally {
this.updateLastTaskTimestamp()
fn: TaskAsyncFunction<Data, Response>,
task: Task<Data>
): void {
- let taskPerformance = this.beginTaskPerformance(task.name)
- fn(task.data)
- .then((res) => {
+ const { name, taskId, data } = task
+ let taskPerformance = this.beginTaskPerformance(name)
+ fn(data)
+ .then(res => {
taskPerformance = this.endTaskPerformance(taskPerformance)
this.sendToMainWorker({
data: res,
taskPerformance,
- workerId: this.id,
- taskId: task.taskId
+ taskId
})
return null
})
- .catch((e) => {
- const errorMessage = this.handleError(e as Error | string)
+ .catch(error => {
this.sendToMainWorker({
- taskError: {
- name: task.name ?? DEFAULT_TASK_NAME,
- message: errorMessage,
- data: task.data
+ workerError: {
+ name: name as string,
+ message: this.handleError(error as Error | string),
+ data
},
- workerId: this.id,
- taskId: task.taskId
+ taskId
})
})
.finally(() => {
.catch(EMPTY_FUNCTION)
}
- /**
- * Gets the task function with the given name.
- *
- * @param name - Name of the task function that will be returned.
- * @returns The task function.
- * @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found.
- */
- private getTaskFunction (name?: string): TaskFunction<Data, Response> {
- name = name ?? DEFAULT_TASK_NAME
- const fn = this.taskFunctions.get(name)
- if (fn == null) {
- throw new Error(`Task function '${name}' not found`)
- }
- return fn
- }
-
private beginTaskPerformance (name?: string): TaskPerformance {
this.checkStatistics()
return {
repositories / poolifier.git / blobdiff