TaskPerformance,
WorkerStatistics
} from '../utility-types'
-import { EMPTY_FUNCTION, isAsyncFunction, isPlainObject } from '../utils'
+import {
+ DEFAULT_TASK_NAME,
+ EMPTY_FUNCTION,
+ isAsyncFunction,
+ isPlainObject
+} from '../utils'
import {
type KillBehavior,
KillBehaviors,
WorkerSyncFunction
} from './worker-functions'
-const DEFAULT_FUNCTION_NAME = 'default'
const DEFAULT_MAX_INACTIVE_TIME = 60000
const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT
}
this.taskFunctions = new Map<string, WorkerFunction<Data, Response>>()
if (typeof taskFunctions === 'function') {
- this.taskFunctions.set(DEFAULT_FUNCTION_NAME, taskFunctions.bind(this))
+ this.taskFunctions.set(DEFAULT_TASK_NAME, taskFunctions.bind(this))
} else if (isPlainObject(taskFunctions)) {
let firstEntry = true
for (const [name, fn] of Object.entries(taskFunctions)) {
}
this.taskFunctions.set(name, fn.bind(this))
if (firstEntry) {
- this.taskFunctions.set(DEFAULT_FUNCTION_NAME, fn.bind(this))
+ this.taskFunctions.set(DEFAULT_TASK_NAME, fn.bind(this))
firstEntry = false
}
}
}
}
+ /**
+ * Checks if the worker has a task function with the given name.
+ *
+ * @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 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')
+ }
+ return this.taskFunctions.has(name)
+ }
+
+ /**
+ * Adds a task function to the worker.
+ * If a task function with the same name already exists, it is replaced.
+ *
+ * @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 TypeError} If the `name` parameter is not a string.
+ * @throws {@link Error} If the `name` parameter is the default task function reserved name.
+ * @throws {@link TypeError} If the `fn` parameter is not a function.
+ */
+ public addTaskFunction (
+ name: string,
+ fn: WorkerFunction<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')
+ }
+ try {
+ if (
+ this.taskFunctions.get(name) ===
+ this.taskFunctions.get(DEFAULT_TASK_NAME)
+ ) {
+ this.taskFunctions.set(DEFAULT_TASK_NAME, fn.bind(this))
+ }
+ this.taskFunctions.set(name, fn.bind(this))
+ return true
+ } catch {
+ return false
+ }
+ }
+
+ /**
+ * Removes a task function from the worker.
+ *
+ * @param name - The name of the task function to remove.
+ * @returns Whether the task function existed and was removed or not.
+ * @throws {@link TypeError} If the `name` parameter is not a string.
+ * @throws {@link Error} If the `name` parameter is the default task function reserved name.
+ * @throws {@link 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'
+ )
+ }
+ return this.taskFunctions.delete(name)
+ }
+
+ /**
+ * Sets the default task function to use when no task function name is specified.
+ *
+ * @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 TypeError} If the `name` parameter is not a string.
+ * @throws {@link Error} If the `name` parameter is the default task function reserved name.
+ * @throws {@link 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'
+ )
+ }
+ try {
+ this.taskFunctions.set(
+ DEFAULT_TASK_NAME,
+ this.taskFunctions.get(name)?.bind(this) as WorkerFunction<
+ Data,
+ Response
+ >
+ )
+ return true
+ } catch {
+ return false
+ }
+ }
+
/**
* Worker message listener.
*
message: MessageValue<Data>
): void {
try {
- let taskPerformance = this.beginTaskPerformance()
+ let taskPerformance = this.beginTaskPerformance(message.name)
const res = fn(message.data)
taskPerformance = this.endTaskPerformance(taskPerformance)
this.sendToMainWorker({
const errorMessage = this.handleError(e as Error | string)
this.sendToMainWorker({
taskError: {
+ name: message.name ?? DEFAULT_TASK_NAME,
message: errorMessage,
data: message.data
},
fn: WorkerAsyncFunction<Data, Response>,
message: MessageValue<Data>
): void {
- let taskPerformance = this.beginTaskPerformance()
+ let taskPerformance = this.beginTaskPerformance(message.name)
fn(message.data)
.then(res => {
taskPerformance = this.endTaskPerformance(taskPerformance)
const errorMessage = this.handleError(e as Error | string)
this.sendToMainWorker({
taskError: {
+ name: message.name ?? DEFAULT_TASK_NAME,
message: errorMessage,
data: message.data
},
/**
* Gets the task function in the given scope.
*
- * @param name - Name of the function that will be returned.
+ * @param name - Name of the task function that will be returned.
*/
private getTaskFunction (name?: string): WorkerFunction<Data, Response> {
- name = name ?? DEFAULT_FUNCTION_NAME
+ 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 (): TaskPerformance {
+ private beginTaskPerformance (name?: string): TaskPerformance {
this.checkStatistics()
return {
+ name: name ?? DEFAULT_TASK_NAME,
timestamp: performance.now(),
...(this.statistics.elu && { elu: performance.eventLoopUtilization() })
}
repositories / poolifier.git / blobdiff