import { cpus } from 'node:os'
-import type { IPoolInternal } from '../pool-internal'
-import type { IPoolWorker } from '../pool-worker'
+import type { IWorker } from '../worker'
+import type { IPool } from '../pool'
+import { DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS } from '../../utils'
import { AbstractWorkerChoiceStrategy } from './abstract-worker-choice-strategy'
import type {
IWorkerChoiceStrategy,
- RequiredStatistics
+ RequiredStatistics,
+ WorkerChoiceStrategyOptions
} from './selection-strategies-types'
-/**
- * Virtual task runtime.
- */
-interface TaskRunTime {
- weight: number
- runTime: number
-}
-
/**
* Selects the next worker with a weighted round robin scheduling algorithm.
* Loosely modeled after the weighted round robin queueing algorithm: https://en.wikipedia.org/wiki/Weighted_round_robin.
*
* @typeParam Worker - Type of worker which manages the strategy.
* @typeParam Data - Type of data sent to the worker. This can only be serializable data.
- * @typeParam Response - Type of response of execution. This can only be serializable data.
+ * @typeParam Response - Type of execution response. This can only be serializable data.
*/
export class WeightedRoundRobinWorkerChoiceStrategy<
- Worker extends IPoolWorker,
- Data,
- Response
+ Worker extends IWorker,
+ Data = unknown,
+ Response = unknown
>
extends AbstractWorkerChoiceStrategy<Worker, Data, Response>
- implements IWorkerChoiceStrategy<Worker, Data, Response> {
- /** {@inheritDoc} */
+ implements IWorkerChoiceStrategy {
+ /** @inheritDoc */
public readonly requiredStatistics: RequiredStatistics = {
runTime: true,
- avgRunTime: true
+ avgRunTime: true,
+ medRunTime: false
}
/**
- * Worker id where the current task will be submitted.
+ * Worker node id where the current task will be submitted.
*/
- private currentWorkerId: number = 0
+ private currentWorkerNodeId: number = 0
/**
* Default worker weight.
*/
private readonly defaultWorkerWeight: number
/**
- * Per worker virtual task runtime map.
+ * Worker virtual task runtime.
*/
- private readonly workersTaskRunTime: Map<number, TaskRunTime> = new Map<
- number,
- TaskRunTime
- >()
+ private workerVirtualTaskRunTime: number = 0
- /**
- * Constructs a worker choice strategy that selects with a weighted round robin scheduling algorithm.
- *
- * @param pool - The pool instance.
- */
- public constructor (pool: IPoolInternal<Worker, Data, Response>) {
- super(pool)
- this.defaultWorkerWeight = this.computeWorkerWeight()
- this.initWorkersTaskRunTime()
+ /** @inheritDoc */
+ public constructor (
+ pool: IPool<Worker, Data, Response>,
+ opts: WorkerChoiceStrategyOptions = DEFAULT_WORKER_CHOICE_STRATEGY_OPTIONS
+ ) {
+ super(pool, opts)
+ this.checkOptions(this.opts)
+ this.defaultWorkerWeight = this.computeDefaultWorkerWeight()
}
- /** {@inheritDoc} */
+ /** @inheritDoc */
public reset (): boolean {
- this.currentWorkerId = 0
- this.workersTaskRunTime.clear()
- this.initWorkersTaskRunTime()
+ this.currentWorkerNodeId = 0
+ this.workerVirtualTaskRunTime = 0
return true
}
- /** {@inheritDoc} */
+ /** @inheritDoc */
public choose (): number {
- const chosenWorkerKey = this.currentWorkerId
- if (this.isDynamicPool && !this.workersTaskRunTime.has(chosenWorkerKey)) {
- this.initWorkerTaskRunTime(chosenWorkerKey)
- }
- const workerTaskRunTime =
- this.workersTaskRunTime.get(chosenWorkerKey)?.runTime ?? 0
+ const chosenWorkerNodeKey = this.currentWorkerNodeId
+ const workerVirtualTaskRunTime = this.workerVirtualTaskRunTime ?? 0
const workerTaskWeight =
- this.workersTaskRunTime.get(chosenWorkerKey)?.weight ??
- this.defaultWorkerWeight
- if (workerTaskRunTime < workerTaskWeight) {
- this.setWorkerTaskRunTime(
- chosenWorkerKey,
- workerTaskWeight,
- workerTaskRunTime +
- (this.getWorkerVirtualTaskRunTime(chosenWorkerKey) ?? 0)
- )
+ this.opts.weights?.[chosenWorkerNodeKey] ?? this.defaultWorkerWeight
+ if (workerVirtualTaskRunTime < workerTaskWeight) {
+ this.workerVirtualTaskRunTime =
+ workerVirtualTaskRunTime +
+ (this.getWorkerVirtualTaskRunTime(chosenWorkerNodeKey) ?? 0)
} else {
- this.currentWorkerId =
- this.currentWorkerId === this.pool.workers.length - 1
+ this.currentWorkerNodeId =
+ this.currentWorkerNodeId === this.pool.workerNodes.length - 1
? 0
- : this.currentWorkerId + 1
- this.setWorkerTaskRunTime(this.currentWorkerId, workerTaskWeight, 0)
+ : this.currentWorkerNodeId + 1
+ this.workerVirtualTaskRunTime = 0
}
- return chosenWorkerKey
+ return chosenWorkerNodeKey
}
- /** {@inheritDoc} */
- public remove (workerKey: number): boolean {
- if (this.currentWorkerId === workerKey) {
- this.currentWorkerId =
- this.currentWorkerId > this.pool.workers.length - 1
- ? this.pool.workers.length - 1
- : this.currentWorkerId
- }
- const workerDeleted = this.workersTaskRunTime.delete(workerKey)
- for (const [key, value] of this.workersTaskRunTime) {
- if (key > workerKey) {
- this.workersTaskRunTime.set(key - 1, value)
+ /** @inheritDoc */
+ public remove (workerNodeKey: number): boolean {
+ if (this.currentWorkerNodeId === workerNodeKey) {
+ if (this.pool.workerNodes.length === 0) {
+ this.currentWorkerNodeId = 0
+ } else {
+ this.currentWorkerNodeId =
+ this.currentWorkerNodeId > this.pool.workerNodes.length - 1
+ ? this.pool.workerNodes.length - 1
+ : this.currentWorkerNodeId
}
+ this.workerVirtualTaskRunTime = 0
}
- return workerDeleted
- }
-
- private initWorkersTaskRunTime (): void {
- for (const [index] of this.pool.workers.entries()) {
- this.initWorkerTaskRunTime(index)
- }
- }
-
- private initWorkerTaskRunTime (workerKey: number): void {
- this.setWorkerTaskRunTime(workerKey, this.defaultWorkerWeight, 0)
- }
-
- private setWorkerTaskRunTime (
- workerKey: number,
- weight: number,
- runTime: number
- ): void {
- this.workersTaskRunTime.set(workerKey, {
- weight,
- runTime
- })
+ return true
}
- private getWorkerVirtualTaskRunTime (workerKey: number): number {
- return this.pool.workers[workerKey].tasksUsage.avgRunTime
+ private getWorkerVirtualTaskRunTime (workerNodeKey: number): number {
+ return this.requiredStatistics.medRunTime
+ ? this.pool.workerNodes[workerNodeKey].tasksUsage.medRunTime
+ : this.pool.workerNodes[workerNodeKey].tasksUsage.avgRunTime
}
- private computeWorkerWeight (): number {
+ private computeDefaultWorkerWeight (): number {
let cpusCycleTimeWeight = 0
for (const cpu of cpus()) {
// CPU estimated cycle time
repositories / poolifier.git / blobdiff