refactor: cleanup worker import
[poolifier.git] / src / worker / abstract-worker.ts
index 3ca52b69841c132f2f9e399f9aabc56a473c721e..91a45e94b0f36c568326460891332d61d7de0731 100644 (file)
@@ -1,16 +1,19 @@
 import { AsyncResource } from 'node:async_hooks'
 import type { Worker } from 'node:cluster'
 import type { MessagePort } from 'node:worker_threads'
-import {
-  type MessageValue,
-  type TaskFunctions,
-  type WorkerAsyncFunction,
-  type WorkerFunction,
-  type WorkerSyncFunction
+import type {
+  MessageValue,
+  TaskFunctions,
+  WorkerAsyncFunction,
+  WorkerFunction,
+  WorkerSyncFunction
 } from '../utility-types'
-import { EMPTY_FUNCTION } from '../utils'
-import type { KillBehavior, WorkerOptions } from './worker-options'
-import { KillBehaviors } from './worker-options'
+import { EMPTY_FUNCTION, isPlainObject } from '../utils'
+import {
+  type KillBehavior,
+  KillBehaviors,
+  type WorkerOptions
+} from './worker-options'
 
 const DEFAULT_FUNCTION_NAME = 'default'
 const DEFAULT_MAX_INACTIVE_TIME = 60000
@@ -45,7 +48,7 @@ export abstract class AbstractWorker<
    *
    * @param type - The type of async event.
    * @param isMain - Whether this is the main worker or not.
-   * @param taskFunctions - Task function(s) processed by the worker when the pool's `execution` function is invoked.
+   * @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 mainWorker - Reference to main worker.
    * @param opts - Options for the worker.
    */
@@ -80,25 +83,20 @@ export abstract class AbstractWorker<
       this.checkAlive.bind(this)()
     }
 
-    this.mainWorker?.on(
-      'message',
-      (message: MessageValue<Data, MainWorker>) => {
-        this.messageListener(message)
-      }
-    )
+    this.mainWorker?.on('message', this.messageListener.bind(this))
   }
 
   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
+    delete this.opts.async
   }
 
   /**
    * Checks if the `taskFunctions` parameter is passed to the constructor.
    *
-   * @param taskFunctions - The task function(s) that should be defined.
+   * @param taskFunctions - The task function(s) parameter that should be checked.
    */
   private checkTaskFunctions (
     taskFunctions:
@@ -108,31 +106,30 @@ export abstract class AbstractWorker<
     if (taskFunctions == null) {
       throw new Error('taskFunctions parameter is mandatory')
     }
-    if (
-      typeof taskFunctions !== 'function' &&
-      typeof taskFunctions !== 'object'
-    ) {
-      throw new Error('taskFunctions parameter is not a function or an object')
-    }
-    if (
-      typeof taskFunctions === 'object' &&
-      taskFunctions.constructor !== Object &&
-      Object.prototype.toString.call(taskFunctions) !== '[object Object]'
-    ) {
-      throw new Error('taskFunctions parameter is not an object literal')
-    }
     this.taskFunctions = new Map<string, WorkerFunction<Data, Response>>()
-    if (typeof taskFunctions !== 'function') {
+    if (typeof taskFunctions === 'function') {
+      this.taskFunctions.set(DEFAULT_FUNCTION_NAME, taskFunctions.bind(this))
+    } else if (isPlainObject(taskFunctions)) {
+      let firstEntry = true
       for (const [name, fn] of Object.entries(taskFunctions)) {
         if (typeof fn !== 'function') {
-          throw new Error(
+          throw new TypeError(
             'A taskFunctions parameter object value is not a function'
           )
         }
         this.taskFunctions.set(name, fn.bind(this))
+        if (firstEntry) {
+          this.taskFunctions.set(DEFAULT_FUNCTION_NAME, fn.bind(this))
+          firstEntry = false
+        }
+      }
+      if (firstEntry) {
+        throw new Error('taskFunctions parameter object is empty')
       }
     } else {
-      this.taskFunctions.set(DEFAULT_FUNCTION_NAME, taskFunctions.bind(this))
+      throw new TypeError(
+        'taskFunctions parameter is not a function or a plain object'
+      )
     }
   }
 
@@ -213,16 +210,22 @@ export abstract class AbstractWorker<
   ): void {
     try {
       const startTimestamp = performance.now()
+      const waitTime = startTimestamp - (message.submissionTimestamp ?? 0)
       const res = fn(message.data)
       const runTime = performance.now() - startTimestamp
       this.sendToMainWorker({
         data: res,
-        id: message.id,
-        runTime
+        runTime,
+        waitTime,
+        id: message.id
       })
     } catch (e) {
       const err = this.handleError(e as Error)
-      this.sendToMainWorker({ error: err, id: message.id })
+      this.sendToMainWorker({
+        error: err,
+        errorData: message.data,
+        id: message.id
+      })
     } finally {
       !this.isMain && (this.lastTaskTimestamp = performance.now())
     }
@@ -239,19 +242,25 @@ export abstract class AbstractWorker<
     message: MessageValue<Data>
   ): void {
     const startTimestamp = performance.now()
+    const waitTime = startTimestamp - (message.submissionTimestamp ?? 0)
     fn(message.data)
       .then(res => {
         const runTime = performance.now() - startTimestamp
         this.sendToMainWorker({
           data: res,
-          id: message.id,
-          runTime
+          runTime,
+          waitTime,
+          id: message.id
         })
         return null
       })
       .catch(e => {
         const err = this.handleError(e as Error)
-        this.sendToMainWorker({ error: err, id: message.id })
+        this.sendToMainWorker({
+          error: err,
+          errorData: message.data,
+          id: message.id
+        })
       })
       .finally(() => {
         !this.isMain && (this.lastTaskTimestamp = performance.now())
@@ -259,11 +268,16 @@ export abstract class AbstractWorker<
       .catch(EMPTY_FUNCTION)
   }
 
+  /**
+   * Gets the task function in the given scope.
+   *
+   * @param name - Name of the function that will be returned.
+   */
   private getTaskFunction (name?: string): WorkerFunction<Data, Response> {
     name = name ?? DEFAULT_FUNCTION_NAME
     const fn = this.taskFunctions.get(name)
     if (fn == null) {
-      throw new Error(`Task function "${name}" not found`)
+      throw new Error(`Task function '${name}' not found`)
     }
     return fn
   }