refactor: add worker strategy name to help UTs debug

jerome-benoit · jerome-benoit · commit e445aa7352f0 · 2025-07-08T20:35:36.000+02:00
Signed-off-by: Jérôme Benoit &lt;jerome.benoit@piment-noir.org&gt;
diff --git a/src/pools/selection-strategies/abstract-worker-choice-strategy.ts b/src/pools/selection-strategies/abstract-worker-choice-strategy.ts
@@ -5,6 +5,7 @@ import type {
   IWorkerChoiceStrategy,
   StrategyPolicy,
   TaskStatisticsRequirements,
+  WorkerChoiceStrategy,
   WorkerChoiceStrategyOptions,
 } from './selection-strategies-types.ts'
 import {
@@ -24,6 +25,9 @@ export abstract class AbstractWorkerChoiceStrategy<
   Data = unknown,
   Response = unknown,
 > implements IWorkerChoiceStrategy {
+  /** @inheritDoc */
+  public abstract readonly name: WorkerChoiceStrategy
+
   /**
    * The next worker node key.
    */
diff --git a/src/pools/selection-strategies/fair-share-worker-choice-strategy.ts b/src/pools/selection-strategies/fair-share-worker-choice-strategy.ts
@@ -1,10 +1,12 @@
 import type { IPool } from '../pool.ts'
 import type { IWorker } from '../worker.ts'
 import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy.ts'
-import type {
-  IWorkerChoiceStrategy,
-  TaskStatisticsRequirements,
-  WorkerChoiceStrategyOptions,
+import {
+  type IWorkerChoiceStrategy,
+  type TaskStatisticsRequirements,
+  WorkerChoiceStrategies,
+  type WorkerChoiceStrategy,
+  type WorkerChoiceStrategyOptions,
 } from './selection-strategies-types.ts'
 
 /**
@@ -21,6 +23,9 @@ export class FairShareWorkerChoiceStrategy<
   Response = unknown,
 > extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
   implements IWorkerChoiceStrategy {
+  /** @inheritDoc */
+  public readonly name: WorkerChoiceStrategy = WorkerChoiceStrategies.FAIR_SHARE
+
   /** @inheritDoc */
   public override readonly taskStatisticsRequirements:
     TaskStatisticsRequirements = Object.freeze({
diff --git a/src/pools/selection-strategies/interleaved-weighted-round-robin-worker-choice-strategy.ts b/src/pools/selection-strategies/interleaved-weighted-round-robin-worker-choice-strategy.ts
@@ -2,10 +2,12 @@ import type { IPool } from '../pool.ts'
 import { DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS } from '../utils.ts'
 import type { IWorker } from '../worker.ts'
 import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy.ts'
-import type {
-  IWorkerChoiceStrategy,
-  TaskStatisticsRequirements,
-  WorkerChoiceStrategyOptions,
+import {
+  type IWorkerChoiceStrategy,
+  type TaskStatisticsRequirements,
+  WorkerChoiceStrategies,
+  type WorkerChoiceStrategy,
+  type WorkerChoiceStrategyOptions,
 } from './selection-strategies-types.ts'
 
 /**
@@ -21,6 +23,10 @@ export class InterleavedWeightedRoundRobinWorkerChoiceStrategy<
   Response = unknown,
 > extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
   implements IWorkerChoiceStrategy {
+  /** @inheritDoc */
+  public readonly name: WorkerChoiceStrategy =
+    WorkerChoiceStrategies.INTERLEAVED_WEIGHTED_ROUND_ROBIN
+
   /** @inheritDoc */
   public override readonly taskStatisticsRequirements:
     TaskStatisticsRequirements = Object.freeze({
diff --git a/src/pools/selection-strategies/least-busy-worker-choice-strategy.ts b/src/pools/selection-strategies/least-busy-worker-choice-strategy.ts
@@ -2,10 +2,12 @@ import type { IPool } from '../pool.ts'
 import { DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS } from '../utils.ts'
 import type { IWorker } from '../worker.ts'
 import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy.ts'
-import type {
-  IWorkerChoiceStrategy,
-  TaskStatisticsRequirements,
-  WorkerChoiceStrategyOptions,
+import {
+  type IWorkerChoiceStrategy,
+  type TaskStatisticsRequirements,
+  WorkerChoiceStrategies,
+  type WorkerChoiceStrategy,
+  type WorkerChoiceStrategyOptions,
 } from './selection-strategies-types.ts'
 
 /**
@@ -21,6 +23,9 @@ export class LeastBusyWorkerChoiceStrategy<
   Response = unknown,
 > extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
   implements IWorkerChoiceStrategy {
+  /** @inheritDoc */
+  public readonly name: WorkerChoiceStrategy = WorkerChoiceStrategies.LEAST_BUSY
+
   /** @inheritDoc */
   public override readonly taskStatisticsRequirements:
     TaskStatisticsRequirements = Object.freeze({
diff --git a/src/pools/selection-strategies/least-elu-worker-choice-strategy.ts b/src/pools/selection-strategies/least-elu-worker-choice-strategy.ts
@@ -5,6 +5,7 @@ import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy.
 import type {
   IWorkerChoiceStrategy,
   TaskStatisticsRequirements,
+  WorkerChoiceStrategy,
   WorkerChoiceStrategyOptions,
 } from './selection-strategies-types.ts'
 
@@ -21,6 +22,10 @@ export class LeastEluWorkerChoiceStrategy<
   Response = unknown,
 > extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
   implements IWorkerChoiceStrategy {
+  /** @inheritDoc */
+  // public readonly name: WorkerChoiceStrategy = WorkerChoiceStrategies.LEAST_ELU
+  public readonly name: WorkerChoiceStrategy = 'LEAST_ELU'
+
   /** @inheritDoc */
   public override readonly taskStatisticsRequirements:
     TaskStatisticsRequirements = Object.freeze({
diff --git a/src/pools/selection-strategies/least-used-worker-choice-strategy.ts b/src/pools/selection-strategies/least-used-worker-choice-strategy.ts
@@ -1,9 +1,11 @@
 import type { IPool } from '../pool.ts'
 import type { IWorker } from '../worker.ts'
 import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy.ts'
-import type {
-  IWorkerChoiceStrategy,
-  WorkerChoiceStrategyOptions,
+import {
+  type IWorkerChoiceStrategy,
+  WorkerChoiceStrategies,
+  type WorkerChoiceStrategy,
+  type WorkerChoiceStrategyOptions,
 } from './selection-strategies-types.ts'
 
 /**
@@ -19,6 +21,9 @@ export class LeastUsedWorkerChoiceStrategy<
   Response = unknown,
 > extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
   implements IWorkerChoiceStrategy {
+  /** @inheritDoc */
+  public readonly name: WorkerChoiceStrategy = WorkerChoiceStrategies.LEAST_USED
+
   /** @inheritDoc */
   public constructor(
     pool: IPool<Worker, Data, Response>,
diff --git a/src/pools/selection-strategies/round-robin-worker-choice-strategy.ts b/src/pools/selection-strategies/round-robin-worker-choice-strategy.ts
@@ -1,9 +1,11 @@
 import type { IPool } from '../pool.ts'
 import type { IWorker } from '../worker.ts'
 import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy.ts'
-import type {
-  IWorkerChoiceStrategy,
-  WorkerChoiceStrategyOptions,
+import {
+  type IWorkerChoiceStrategy,
+  WorkerChoiceStrategies,
+  type WorkerChoiceStrategy,
+  type WorkerChoiceStrategyOptions,
 } from './selection-strategies-types.ts'
 
 /**
@@ -19,6 +21,10 @@ export class RoundRobinWorkerChoiceStrategy<
   Response = unknown,
 > extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
   implements IWorkerChoiceStrategy {
+  /** @inheritDoc */
+  public readonly name: WorkerChoiceStrategy =
+    WorkerChoiceStrategies.ROUND_ROBIN
+
   /** @inheritDoc */
   public constructor(
     pool: IPool<Worker, Data, Response>,
diff --git a/src/pools/selection-strategies/selection-strategies-types.ts b/src/pools/selection-strategies/selection-strategies-types.ts
@@ -176,6 +176,10 @@ export interface StrategyPolicy {
  * @internal
  */
 export interface IWorkerChoiceStrategy {
+  /**
+   * The worker choice strategy name.
+   */
+  readonly name: WorkerChoiceStrategy
   /**
    * Strategy policy.
    */
diff --git a/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts b/src/pools/selection-strategies/weighted-round-robin-worker-choice-strategy.ts
@@ -2,10 +2,12 @@ import type { IPool } from '../pool.ts'
 import { DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS } from '../utils.ts'
 import type { IWorker } from '../worker.ts'
 import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy.ts'
-import type {
-  IWorkerChoiceStrategy,
-  TaskStatisticsRequirements,
-  WorkerChoiceStrategyOptions,
+import {
+  type IWorkerChoiceStrategy,
+  type TaskStatisticsRequirements,
+  WorkerChoiceStrategies,
+  type WorkerChoiceStrategy,
+  type WorkerChoiceStrategyOptions,
 } from './selection-strategies-types.ts'
 
 /**
@@ -22,6 +24,10 @@ export class WeightedRoundRobinWorkerChoiceStrategy<
   Response = unknown,
 > extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
   implements IWorkerChoiceStrategy {
+  /** @inheritDoc */
+  public readonly name: WorkerChoiceStrategy =
+    WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN
+
   /** @inheritDoc */
   public override readonly taskStatisticsRequirements:
     TaskStatisticsRequirements = Object.freeze({
diff --git a/src/pools/selection-strategies/worker-choice-strategies-context.ts b/src/pools/selection-strategies/worker-choice-strategies-context.ts
@@ -179,7 +179,7 @@ export class WorkerChoiceStrategiesContext<
     }
     if (workerNodeKey == null) {
       throw new Error(
-        `Worker node key chosen is null or undefined after ${retriesCount.toString()} retries`,
+        `Worker node key chosen by ${workerChoiceStrategy.name} is null or undefined after ${retriesCount.toString()} retries`,
       )
     }
     return workerNodeKey
diff --git a/tests/pools/selection-strategies/selection-strategies.test.mjs b/tests/pools/selection-strategies/selection-strategies.test.mjs
@@ -92,6 +92,11 @@ describe('Selection strategies test suite', () => {
         new URL('./../../worker-files/thread/testWorker.mjs', import.meta.url),
         { workerChoiceStrategy },
       )
+      expect(
+        pool.workerChoiceStrategiesContext.workerChoiceStrategies.get(
+          workerChoiceStrategy,
+        ).name,
+      ).toBe(workerChoiceStrategy)
       expect(
         pool.workerChoiceStrategiesContext.workerChoiceStrategies.get(
           workerChoiceStrategy,
diff --git a/tests/pools/selection-strategies/worker-choice-strategies-context.test.mjs b/tests/pools/selection-strategies/worker-choice-strategies-context.test.mjs
@@ -93,7 +93,7 @@ describe('Worker choice strategies context test suite', () => {
     )
     expect(() => workerChoiceStrategiesContext.execute()).toThrow(
       new Error(
-        `Worker node key chosen is null or undefined after ${workerChoiceStrategiesContext.retries} retries`,
+        `Worker node key chosen by ${workerChoiceStrategyUndefinedStub.name} is null or undefined after ${workerChoiceStrategiesContext.retries} retries`,
       ),
     )
     workerChoiceStrategyUndefinedStub.choose.restore()
@@ -111,7 +111,7 @@ describe('Worker choice strategies context test suite', () => {
     )
     expect(() => workerChoiceStrategiesContext.execute()).toThrow(
       new Error(
-        `Worker node key chosen is null or undefined after ${workerChoiceStrategiesContext.retries} retries`,
+        `Worker node key chosen by ${workerChoiceStrategyNullStub.name} is null or undefined after ${workerChoiceStrategiesContext.retries} retries`,
       ),
     )
     workerChoiceStrategyNullStub.choose.restore()

Original file line number	Diff line number	Diff line change
`@@ -179,7 +179,7 @@ export class WorkerChoiceStrategiesContext<`
`179`	`179`	`}`
`180`	`180`	`if (workerNodeKey == null) {`
`181`	`181`	`throw new Error(`
`182`		- `Worker node key chosen is null or undefined after ${retriesCount.toString()} retries`,
	`182`	+ `Worker node key chosen by ${workerChoiceStrategy.name} is null or undefined after ${retriesCount.toString()} retries`,
`183`	`183`	`)`
`184`	`184`	`}`
`185`	`185`	`return workerNodeKey`