fix: unref() message port at worker exit
[poolifier.git] / src / worker / abstract-worker.ts
index 3adc56d13ee3d5aa4be402cd38dd179bc05ec594..0f1d442a6f242ef2a25068f8e212f2fbff686a37 100644 (file)
@@ -66,17 +66,17 @@ 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. The first function is the default function.
    * @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,
     taskFunctions:
     | WorkerFunction<Data, Response>
     | TaskFunctions<Data, Response>,
-    protected readonly mainWorker: MainWorker,
     protected readonly opts: WorkerOptions = {
       /**
        * The kill behavior option on this worker or its default value.
@@ -93,7 +93,7 @@ export abstract class AbstractWorker<
     this.checkWorkerOptions(this.opts)
     this.checkTaskFunctions(taskFunctions)
     if (!this.isMain) {
-      this.mainWorker?.on('message', this.messageListener.bind(this))
+      this.getMainWorker()?.on('message', this.handleReadyMessage.bind(this))
     }
   }
 
@@ -142,11 +142,11 @@ export abstract class AbstractWorker<
           )
         }
         const boundFn = fn.bind(this)
-        this.taskFunctions.set(name, boundFn)
         if (firstEntry) {
           this.taskFunctions.set(DEFAULT_TASK_NAME, boundFn)
           firstEntry = false
         }
+        this.taskFunctions.set(name, boundFn)
       }
       if (firstEntry) {
         throw new Error('taskFunctions parameter object is empty')
@@ -198,8 +198,8 @@ export abstract class AbstractWorker<
     if (typeof fn !== 'function') {
       throw new TypeError('fn parameter is not a function')
     }
-    const boundFn = fn.bind(this)
     try {
+      const boundFn = fn.bind(this)
       if (
         this.taskFunctions.get(name) ===
         this.taskFunctions.get(DEFAULT_TASK_NAME)
@@ -242,7 +242,16 @@ export abstract class AbstractWorker<
   }
 
   /**
-   * Sets the default task function to use when no task function name is specified.
+   * Lists the names of the worker's task functions.
+   *
+   * @returns The names of the worker's task functions.
+   */
+  public listTaskFunctions (): string[] {
+    return Array.from(this.taskFunctions.keys())
+  }
+
+  /**
+   * Sets the default task function to use in the worker.
    *
    * @param name - The name of the task function to use as default task function.
    * @returns Whether the default task function was set or not.
@@ -275,38 +284,46 @@ export abstract class AbstractWorker<
     }
   }
 
+  /**
+   * Handles the ready message sent by the main worker.
+   *
+   * @param message - The ready message.
+   */
+  protected abstract handleReadyMessage (message: MessageValue<Data>): void
+
   /**
    * Worker message listener.
    *
    * @param message - The received message.
    */
-  protected messageListener (message: MessageValue<Data, Data>): void {
+  protected messageListener (message: MessageValue<Data>): void {
     if (message.workerId === this.id) {
-      if (message.ready != null) {
-        // Startup message received
-        this.sendReadyResponse()
-      } else if (message.statistics != null) {
+      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()
+        !this.isMain && message.checkActive
+          ? this.startCheckActive()
+          : this.stopCheckActive()
       } else if (message.id != null && message.data != null) {
         // Task message received
         this.run(message)
       } else if (message.kill === true) {
         // Kill message received
-        this.stopCheckActive()
-        this.emitDestroy()
+        this.handleKillMessage(message)
       }
     }
   }
 
   /**
-   * Sends the ready response to the main worker.
+   * Handles a kill message sent by the main worker.
+   *
+   * @param message - The kill message.
    */
-  protected sendReadyResponse (): void {
-    !this.isMain && this.sendToMainWorker({ ready: true, workerId: this.id })
+  protected handleKillMessage (message: MessageValue<Data>): void {
+    !this.isMain && this.stopCheckActive()
+    this.emitDestroy()
   }
 
   /**
@@ -317,14 +334,18 @@ export abstract class AbstractWorker<
     this.activeInterval = setInterval(
       this.checkActive.bind(this),
       (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2
-    ).unref()
+    )
+    this.activeInterval.unref()
   }
 
   /**
    * Stops the worker check active interval.
    */
   private stopCheckActive (): void {
-    this.activeInterval != null && clearInterval(this.activeInterval)
+    if (this.activeInterval != null) {
+      clearInterval(this.activeInterval)
+      delete this.activeInterval
+    }
   }
 
   /**
@@ -377,6 +398,9 @@ export abstract class AbstractWorker<
    * @throws {@link https://nodejs.org/api/errors.html#class-error} If the task function is not found.
    */
   protected run (task: Task<Data>): void {
+    if (this.isMain) {
+      throw new Error('Cannot run a task in the main worker')
+    }
     const fn = this.getTaskFunction(task.name)
     if (isAsyncFunction(fn)) {
       this.runInAsyncScope(this.runAsync.bind(this), this, fn, task)
@@ -417,9 +441,7 @@ export abstract class AbstractWorker<
         id: task.id
       })
     } finally {
-      if (!this.isMain && this.activeInterval != null) {
-        this.lastTaskTimestamp = performance.now()
-      }
+      this.updateLastTaskTimestamp()
     }
   }
 
@@ -458,9 +480,7 @@ export abstract class AbstractWorker<
         })
       })
       .finally(() => {
-        if (!this.isMain && this.activeInterval != null) {
-          this.lastTaskTimestamp = performance.now()
-        }
+        this.updateLastTaskTimestamp()
       })
       .catch(EMPTY_FUNCTION)
   }
@@ -510,4 +530,10 @@ export abstract class AbstractWorker<
       throw new Error('Performance statistics computation requirements not set')
     }
   }
+
+  private updateLastTaskTimestamp (): void {
+    if (!this.isMain && this.activeInterval != null) {
+      this.lastTaskTimestamp = performance.now()
+    }
+  }
 }