refactor: cleanup message passing code
authorJérôme Benoit <jerome.benoit@sap.com>
Fri, 7 Jul 2023 17:33:38 +0000 (19:33 +0200)
committerJérôme Benoit <jerome.benoit@sap.com>
Fri, 7 Jul 2023 17:33:38 +0000 (19:33 +0200)
Signed-off-by: Jérôme Benoit <jerome.benoit@sap.com>
src/pools/abstract-pool.ts
src/pools/cluster/fixed.ts
src/pools/thread/fixed.ts
src/utility-types.ts
src/worker/abstract-worker.ts

index 097882b7dc971112b98050d95c52d43776f27362..48d0ed9afed3cd9071aaf1e854f598f4118810e1 100644 (file)
@@ -957,7 +957,7 @@ export abstract class AbstractPool<
         void (this.destroyWorker(worker) as Promise<void>)
       }
     })
-    this.sendToWorker(worker, { dynamic: true })
+    this.sendToWorker(worker, { checkAlive: true })
     return worker
   }
 
index fe920f8a48126529a31dafc2d0c9f31bb4c0e4cf..3c69ec2f74318188d1a2b8ac1dcd40b59369aa80 100644 (file)
@@ -61,7 +61,7 @@ export class FixedClusterPool<
 
   /** @inheritDoc */
   protected destroyWorker (worker: Worker): void {
-    this.sendToWorker(worker, { kill: 1 })
+    this.sendToWorker(worker, { kill: true })
     worker.on('disconnect', () => {
       worker.kill()
     })
index 9861a3c15c15bc79b9ec6e4966dddb8021d8ecc3..29f008806663aea87b837cbf412a5ed561d1974e 100644 (file)
@@ -55,7 +55,7 @@ export class FixedThreadPool<
 
   /** @inheritDoc */
   protected async destroyWorker (worker: Worker): Promise<void> {
-    this.sendToWorker(worker, { kill: 1 })
+    this.sendToWorker(worker, { kill: true })
     await worker.terminate()
   }
 
index 980c00896a0ebf23f75162605cccf52548cc535f..2035235022d13f49cb39c98e3ea10b91cf7ca8ec 100644 (file)
@@ -68,7 +68,7 @@ export interface MessageValue<Data = unknown, ErrorData = unknown>
   /**
    * Kill code.
    */
-  readonly kill?: KillBehavior | 1
+  readonly kill?: KillBehavior | true
   /**
    * Task error.
    */
@@ -86,9 +86,9 @@ export interface MessageValue<Data = unknown, ErrorData = unknown>
    */
   readonly started?: boolean
   /**
-   * Whether the worker is dynamic or not.
+   * Whether the worker starts or stops its aliveness check.
    */
-  readonly dynamic?: boolean
+  readonly checkAlive?: boolean
 }
 
 /**
index ba74409e2b5c53aa7ddb3c9a3b34ad8ec2515b11..92d68bcb6e9d4f38fdb3cc87170a038c4f226722 100644 (file)
@@ -148,9 +148,9 @@ export abstract class AbstractWorker<
     if (message.statistics != null) {
       // Statistics message received
       this.statistics = message.statistics
-    } else if (message.dynamic === true) {
-      // Worker dynamic message received
-      this.startCheckAlive()
+    } else if (message.checkAlive != null) {
+      // Check alive message received
+      message.checkAlive ? this.startCheckAlive() : this.stopCheckAlive()
     } else if (message.id != null && message.data != null) {
       // Task message received
       const fn = this.getTaskFunction(message.name)
@@ -159,13 +159,16 @@ export abstract class AbstractWorker<
       } else {
         this.runInAsyncScope(this.runSync.bind(this), this, fn, message)
       }
-    } else if (message.kill != null) {
+    } else if (message.kill === true) {
       // Kill message received
-      this.aliveInterval != null && clearInterval(this.aliveInterval)
+      this.stopCheckAlive()
       this.emitDestroy()
     }
   }
 
+  /**
+   * Starts the worker alive check interval.
+   */
   private startCheckAlive (): void {
     this.lastTaskTimestamp = performance.now()
     this.aliveInterval = setInterval(
@@ -175,6 +178,25 @@ export abstract class AbstractWorker<
     this.checkAlive.bind(this)()
   }
 
+  /**
+   * Stops the worker alive check interval.
+   */
+  private stopCheckAlive (): void {
+    this.aliveInterval != null && clearInterval(this.aliveInterval)
+  }
+
+  /**
+   * Checks if the worker should be terminated, because its living too long.
+   */
+  private checkAlive (): void {
+    if (
+      performance.now() - this.lastTaskTimestamp >
+      (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME)
+    ) {
+      this.sendToMainWorker({ kill: this.opts.killBehavior })
+    }
+  }
+
   /**
    * Returns the main worker.
    *
@@ -196,18 +218,6 @@ export abstract class AbstractWorker<
     message: MessageValue<Response, Data>
   ): void
 
-  /**
-   * Checks if the worker should be terminated, because its living too long.
-   */
-  protected checkAlive (): void {
-    if (
-      performance.now() - this.lastTaskTimestamp >
-      (this.opts.maxInactiveTime ?? DEFAULT_MAX_INACTIVE_TIME)
-    ) {
-      this.sendToMainWorker({ kill: this.opts.killBehavior })
-    }
-  }
-
   /**
    * Handles an error and convert it to a string so it can be sent back to the main worker.
    *