docs: refine README.md

[poolifier.git] / src / worker / abstract-worker.ts

diff --git a/src/worker/abstract-worker.ts b/src/worker/abstract-worker.ts
index ab56a5e9bb2f8c16c8b774eb2bdd6789de882ee5..0ea3fa6253103292775550bfb2d13fa329f19079 100644 (file)
--- a/src/worker/abstract-worker.ts
+++ b/src/worker/abstract-worker.ts
@@ -1,9 +1,13 @@
-import { AsyncResource } from 'async_hooks'
-import type { Worker } from 'cluster'
-import type { MessagePort } from 'worker_threads'
+import { AsyncResource } from 'node:async_hooks'
+import type { Worker } from 'node:cluster'
+import type { MessagePort } from 'node:worker_threads'
 import type { MessageValue } from '../utility-types'
 import { EMPTY_FUNCTION } from '../utils'
-import type { KillBehavior, WorkerOptions } from './worker-options'
+import {
+  isKillBehavior,
+  type KillBehavior,
+  type WorkerOptions
+} from './worker-options'
 import { KillBehaviors } from './worker-options'
 
 const DEFAULT_MAX_INACTIVE_TIME = 60000
@@ -12,9 +16,9 @@ const DEFAULT_KILL_BEHAVIOR: KillBehavior = KillBehaviors.SOFT
 /**
  * Base class that implements some shared logic for all poolifier workers.
  *
- * @template MainWorker Type of main worker.
- * @template Data Type of data this worker receives from pool's execution. This can only be serializable data.
- * @template Response Type of response the worker sends back to the main worker. This can only be serializable data.
+ * @typeParam MainWorker - Type of main worker.
+ * @typeParam Data - Type of data this worker receives from pool's execution. This can only be serializable data.
+ * @typeParam Response - Type of response the worker sends back to the main worker. This can only be serializable data.
  */
 export abstract class AbstractWorker<
   MainWorker extends Worker | MessagePort,
@@ -24,7 +28,7 @@ export abstract class AbstractWorker<
   /**
    * Timestamp of the last task processed by this worker.
    */
-  protected lastTaskTimestamp: number
+  protected lastTaskTimestamp!: number
   /**
    * Handler Id of the `aliveInterval` worker alive check.
    */
@@ -36,11 +40,11 @@ export abstract class AbstractWorker<
   /**
    * Constructs a new poolifier worker.
    *
-   * @param type The type of async event.
-   * @param isMain Whether this is the main worker or not.
-   * @param fn Function processed by the worker when the pool's `execution` function is invoked.
-   * @param mainWorker Reference to main worker.
-   * @param opts Options for the worker.
+   * @param type - The type of async event.
+   * @param isMain - Whether this is the main worker or not.
+   * @param fn - Function processed by the worker when the pool's `execution` function is invoked.
+   * @param mainWorker - Reference to main worker.
+   * @param opts - Options for the worker.
    */
   public constructor (
     type: string,
@@ -63,9 +67,8 @@ export abstract class AbstractWorker<
     this.opts = opts
     this.checkFunctionInput(fn)
     this.checkWorkerOptions(this.opts)
-    this.lastTaskTimestamp = Date.now()
-    // Keep the worker active
-    if (!isMain) {
+    if (!isMain && isKillBehavior(KillBehaviors.HARD, this.opts.killBehavior)) {
+      this.lastTaskTimestamp = Date.now()
       this.aliveInterval = setInterval(
         this.checkAlive.bind(this),
         (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME) / 2
@@ -95,7 +98,7 @@ export abstract class AbstractWorker<
       this.mainWorker = value.parent
     } else if (value.kill !== undefined) {
       // Here is time to kill this worker, just clearing the interval
-      if (this.aliveInterval != null) clearInterval(this.aliveInterval)
+      this.aliveInterval != null && clearInterval(this.aliveInterval)
       this.emitDestroy()
     }
   }
@@ -110,11 +113,13 @@ export abstract class AbstractWorker<
   /**
    * Checks if the `fn` parameter is passed to the constructor.
    *
-   * @param fn The function that should be defined.
+   * @param fn - The function that should be defined.
    */
   private checkFunctionInput (fn: (data: Data) => Response): void {
     if (fn == null) throw new Error('fn parameter is mandatory')
-    if (typeof fn !== 'function') { throw new TypeError('fn parameter is not a function') }
+    if (typeof fn !== 'function') {
+      throw new TypeError('fn parameter is not a function')
+    }
   }
 
   /**
@@ -132,7 +137,7 @@ export abstract class AbstractWorker<
   /**
    * Sends a message to the main worker.
    *
-   * @param message The response message.
+   * @param message - The response message.
    */
   protected abstract sendToMainWorker (message: MessageValue<Response>): void
 
@@ -151,7 +156,7 @@ export abstract class AbstractWorker<
   /**
    * 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 e - The error raised by the worker.
    * @returns Message of the error.
    */
   protected handleError (e: Error | string): string {
@@ -161,8 +166,8 @@ export abstract class AbstractWorker<
   /**
    * Runs the given function synchronously.
    *
-   * @param fn Function that will be executed.
-   * @param value Input data for the given function.
+   * @param fn - Function that will be executed.
+   * @param value - Input data for the given function.
    */
   protected run (
     fn: (data?: Data) => Response,
@@ -177,15 +182,16 @@ export abstract class AbstractWorker<
       const err = this.handleError(e as Error)
       this.sendToMainWorker({ error: err, id: value.id })
     } finally {
-      this.lastTaskTimestamp = Date.now()
+      isKillBehavior(KillBehaviors.HARD, this.opts.killBehavior) &&
+        (this.lastTaskTimestamp = Date.now())
     }
   }
 
   /**
    * Runs the given function asynchronously.
    *
-   * @param fn Function that will be executed.
-   * @param value Input data for the given function.
+   * @param fn - Function that will be executed.
+   * @param value - Input data for the given function.
    */
   protected runAsync (
     fn: (data?: Data) => Promise<Response>,
@@ -203,7 +209,8 @@ export abstract class AbstractWorker<
         this.sendToMainWorker({ error: err, id: value.id })
       })
       .finally(() => {
-        this.lastTaskTimestamp = Date.now()
+        isKillBehavior(KillBehaviors.HARD, this.opts.killBehavior) &&
+          (this.lastTaskTimestamp = Date.now())
       })
       .catch(EMPTY_FUNCTION)
   }