fix: fix tasks stealing dynamic worker node handling

Signed-off-by: Jérôme Benoit <jerome.benoit@piment-noir.org>
poolifier · May 20, 2024 · 2fe5023 · 2fe5023
1 parent 51aa64a
commit 2fe5023
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,10 @@ and this project adheres to
 
 ## [Unreleased]
 
+### Fixed
+
+- Ensure tasks stealing dynamic worker node is not destroyed on inactivity.
+
 ## [0.4.5] - 2024-05-15
 
 ### Fixed

diff --git a/docs/api.md b/docs/api.md
@@ -217,11 +217,11 @@ levels.\
 - `killBehavior` (optional) - Dictates if your worker will be deleted in case a
  task is active on it.\
  **KillBehaviors.SOFT**: If `currentTime - lastActiveTime` is greater than
- `maxInactiveTime` but a task is still executing or queued, then the worker
- **won't** be deleted.\
+ `maxInactiveTime` but the worker is stealing tasks or a task is executing or
+ queued, then the worker **won't** be deleted.\
  **KillBehaviors.HARD**: If `currentTime - lastActiveTime` is greater than
- `maxInactiveTime` but a task is still executing or queued, then the worker
- will be deleted.\
+ `maxInactiveTime` but the worker is stealing tasks or a task is executing or
+ queued, then the worker will be deleted.\
  This option only apply to the newly created workers.\
  Default: `KillBehaviors.SOFT`
 

diff --git a/src/pools/abstract-pool.ts b/src/pools/abstract-pool.ts
@@ -1477,15 +1477,18 @@ export abstract class AbstractPool<
  const localWorkerNodeKey = this.getWorkerNodeKeyByWorkerId(
  message.workerId,
  )
+ const workerInfo = this.getWorkerInfo(localWorkerNodeKey)
  const workerUsage = this.workerNodes[localWorkerNodeKey]?.usage
  // Kill message received from worker
  if (
  isKillBehavior(KillBehaviors.HARD, message.kill) ||
- (isKillBehavior(KillBehaviors.SOFT, message.kill) &&
- workerUsage != null &&
+ (workerUsage != null &&
+ isKillBehavior(KillBehaviors.SOFT, message.kill) &&
  ((this.opts.enableTasksQueue === false &&
  workerUsage.tasks.executing === 0) ||
  (this.opts.enableTasksQueue === true &&
+ workerInfo != null &&
+ workerInfo.stealing === false &&
  workerUsage.tasks.executing === 0 &&
  this.tasksQueueSize(localWorkerNodeKey) === 0)))
  ) {

diff --git a/src/worker/worker-options.ts b/src/worker/worker-options.ts
@@ -5,11 +5,11 @@ export const KillBehaviors: Readonly<{ SOFT: 'SOFT'; HARD: 'HARD' }> = Object
  .freeze(
  {
  /**
- * If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker **wont** be deleted.
+ * If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but the worker is stealing tasks or a task is executing or queued, then the worker **wont** be deleted.
  */
  SOFT: 'SOFT',
  /**
- * If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker will be deleted.
+ * If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but the worker is stealing tasks or a task is executing or queued, then the worker will be deleted.
  */
  HARD: 'HARD',
  } as const,
@@ -32,8 +32,8 @@ export interface WorkerOptions {
  /**
  * `killBehavior` dictates if your worker will be deleted in case a task is active on it.
  *
- * - SOFT: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker **won't** be deleted.
- * - HARD: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but a task is still executing or queued, then the worker will be deleted.
+ * - SOFT: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but the worker is stealing tasks or a task is executing or queued, then the worker **won't** be deleted.
+ * - HARD: If `currentTime - lastActiveTime` is greater than `maxInactiveTime` but the worker is stealing tasks or a task is executing or queued, then the worker will be deleted.
  *
  * This option only apply to the newly created workers.
  *