[poolifier.git] / tests / pools / abstract / abstract-pool.test.js

const { expect } = require('expect')
const {
  DynamicClusterPool,
  DynamicThreadPool,
  FixedClusterPool,
  FixedThreadPool,
  PoolEvents,
  WorkerChoiceStrategies,
  PoolTypes,
  WorkerTypes
} = require('../../../lib')
const { CircularArray } = require('../../../lib/circular-array')
const { Queue } = require('../../../lib/queue')

describe('Abstract pool test suite', () => {
  const numberOfWorkers = 2
  class StubPoolWithRemoveAllWorker extends FixedThreadPool {
    removeAllWorker () {
      this.workerNodes = []
      this.promiseResponseMap.clear()
    }
  }
  class StubPoolWithIsMain extends FixedThreadPool {
    isMain () {
      return false
    }
  }

  it('Simulate pool creation from a non main thread/process', () => {
    expect(
      () =>
        new StubPoolWithIsMain(
          numberOfWorkers,
          './tests/worker-files/thread/testWorker.js',
          {
            errorHandler: e => console.error(e)
          }
        )
    ).toThrowError('Cannot start a pool from a worker!')
  })

  it('Verify that filePath is checked', () => {
    const expectedError = new Error(
      'Please specify a file with a worker implementation'
    )
    expect(() => new FixedThreadPool(numberOfWorkers)).toThrowError(
      expectedError
    )
    expect(() => new FixedThreadPool(numberOfWorkers, '')).toThrowError(
      expectedError
    )
  })

  it('Verify that numberOfWorkers is checked', () => {
    expect(() => new FixedThreadPool()).toThrowError(
      'Cannot instantiate a pool without specifying the number of workers'
    )
  })

  it('Verify that a negative number of workers is checked', () => {
    expect(
      () =>
        new FixedClusterPool(-1, './tests/worker-files/cluster/testWorker.js')
    ).toThrowError(
      new RangeError(
        'Cannot instantiate a pool with a negative number of workers'
      )
    )
  })

  it('Verify that a non integer number of workers is checked', () => {
    expect(
      () =>
        new FixedThreadPool(0.25, './tests/worker-files/thread/testWorker.js')
    ).toThrowError(
      new TypeError(
        'Cannot instantiate a pool with a non safe integer number of workers'
      )
    )
  })

  it('Verify that pool options are checked', async () => {
    let pool = new FixedThreadPool(
      numberOfWorkers,
      './tests/worker-files/thread/testWorker.js'
    )
    expect(pool.emitter).toBeDefined()
    expect(pool.opts.enableEvents).toBe(true)
    expect(pool.opts.restartWorkerOnError).toBe(true)
    expect(pool.opts.enableTasksQueue).toBe(false)
    expect(pool.opts.tasksQueueOptions).toBeUndefined()
    expect(pool.opts.workerChoiceStrategy).toBe(
      WorkerChoiceStrategies.ROUND_ROBIN
    )
    expect(pool.opts.workerChoiceStrategyOptions).toStrictEqual({
      runTime: { median: false },
      waitTime: { median: false },
      elu: { median: false }
    })
    expect(pool.opts.messageHandler).toBeUndefined()
    expect(pool.opts.errorHandler).toBeUndefined()
    expect(pool.opts.onlineHandler).toBeUndefined()
    expect(pool.opts.exitHandler).toBeUndefined()
    await pool.destroy()
    const testHandler = () => console.log('test handler executed')
    pool = new FixedThreadPool(
      numberOfWorkers,
      './tests/worker-files/thread/testWorker.js',
      {
        workerChoiceStrategy: WorkerChoiceStrategies.LEAST_USED,
        workerChoiceStrategyOptions: {
          runTime: { median: true },
          weights: { 0: 300, 1: 200 }
        },
        enableEvents: false,
        restartWorkerOnError: false,
        enableTasksQueue: true,
        tasksQueueOptions: { concurrency: 2 },
        messageHandler: testHandler,
        errorHandler: testHandler,
        onlineHandler: testHandler,
        exitHandler: testHandler
      }
    )
    expect(pool.emitter).toBeUndefined()
    expect(pool.opts.enableEvents).toBe(false)
    expect(pool.opts.restartWorkerOnError).toBe(false)
    expect(pool.opts.enableTasksQueue).toBe(true)
    expect(pool.opts.tasksQueueOptions).toStrictEqual({ concurrency: 2 })
    expect(pool.opts.workerChoiceStrategy).toBe(
      WorkerChoiceStrategies.LEAST_USED
    )
    expect(pool.opts.workerChoiceStrategyOptions).toStrictEqual({
      runTime: { median: true },
      weights: { 0: 300, 1: 200 }
    })
    expect(pool.opts.messageHandler).toStrictEqual(testHandler)
    expect(pool.opts.errorHandler).toStrictEqual(testHandler)
    expect(pool.opts.onlineHandler).toStrictEqual(testHandler)
    expect(pool.opts.exitHandler).toStrictEqual(testHandler)
    await pool.destroy()
  })

  it('Verify that pool options are validated', async () => {
    expect(
      () =>
        new FixedThreadPool(
          numberOfWorkers,
          './tests/worker-files/thread/testWorker.js',
          {
            workerChoiceStrategy: 'invalidStrategy'
          }
        )
    ).toThrowError("Invalid worker choice strategy 'invalidStrategy'")
    expect(
      () =>
        new FixedThreadPool(
          numberOfWorkers,
          './tests/worker-files/thread/testWorker.js',
          {
            workerChoiceStrategyOptions: 'invalidOptions'
          }
        )
    ).toThrowError(
      'Invalid worker choice strategy options: must be a plain object'
    )
    expect(
      () =>
        new FixedThreadPool(
          numberOfWorkers,
          './tests/worker-files/thread/testWorker.js',
          {
            workerChoiceStrategyOptions: { weights: {} }
          }
        )
    ).toThrowError(
      'Invalid worker choice strategy options: must have a weight for each worker node'
    )
    expect(
      () =>
        new FixedThreadPool(
          numberOfWorkers,
          './tests/worker-files/thread/testWorker.js',
          {
            workerChoiceStrategyOptions: { measurement: 'invalidMeasurement' }
          }
        )
    ).toThrowError(
      "Invalid worker choice strategy options: invalid measurement 'invalidMeasurement'"
    )
    expect(
      () =>
        new FixedThreadPool(
          numberOfWorkers,
          './tests/worker-files/thread/testWorker.js',
          {
            enableTasksQueue: true,
            tasksQueueOptions: { concurrency: 0 }
          }
        )
    ).toThrowError("Invalid worker tasks concurrency '0'")
    expect(
      () =>
        new FixedThreadPool(
          numberOfWorkers,
          './tests/worker-files/thread/testWorker.js',
          {
            enableTasksQueue: true,
            tasksQueueOptions: 'invalidTasksQueueOptions'
          }
        )
    ).toThrowError('Invalid tasks queue options: must be a plain object')
    expect(
      () =>
        new FixedThreadPool(
          numberOfWorkers,
          './tests/worker-files/thread/testWorker.js',
          {
            enableTasksQueue: true,
            tasksQueueOptions: { concurrency: 0.2 }
          }
        )
    ).toThrowError('Invalid worker tasks concurrency: must be an integer')
  })

  it('Verify that worker choice strategy options can be set', async () => {
    const pool = new FixedThreadPool(
      numberOfWorkers,
      './tests/worker-files/thread/testWorker.js',
      { workerChoiceStrategy: WorkerChoiceStrategies.FAIR_SHARE }
    )
    expect(pool.opts.workerChoiceStrategyOptions).toStrictEqual({
      runTime: { median: false },
      waitTime: { median: false },
      elu: { median: false }
    })
    for (const [, workerChoiceStrategy] of pool.workerChoiceStrategyContext
      .workerChoiceStrategies) {
      expect(workerChoiceStrategy.opts).toStrictEqual({
        runTime: { median: false },
        waitTime: { median: false },
        elu: { median: false }
      })
    }
    expect(
      pool.workerChoiceStrategyContext.getTaskStatisticsRequirements()
    ).toStrictEqual({
      runTime: {
        aggregate: true,
        average: true,
        median: false
      },
      waitTime: {
        aggregate: false,
        average: false,
        median: false
      },
      elu: {
        aggregate: true,
        average: true,
        median: false
      }
    })
    pool.setWorkerChoiceStrategyOptions({
      runTime: { median: true },
      elu: { median: true }
    })
    expect(pool.opts.workerChoiceStrategyOptions).toStrictEqual({
      runTime: { median: true },
      elu: { median: true }
    })
    for (const [, workerChoiceStrategy] of pool.workerChoiceStrategyContext
      .workerChoiceStrategies) {
      expect(workerChoiceStrategy.opts).toStrictEqual({
        runTime: { median: true },
        elu: { median: true }
      })
    }
    expect(
      pool.workerChoiceStrategyContext.getTaskStatisticsRequirements()
    ).toStrictEqual({
      runTime: {
        aggregate: true,
        average: false,
        median: true
      },
      waitTime: {
        aggregate: false,
        average: false,
        median: false
      },
      elu: {
        aggregate: true,
        average: false,
        median: true
      }
    })
    pool.setWorkerChoiceStrategyOptions({
      runTime: { median: false },
      elu: { median: false }
    })
    expect(pool.opts.workerChoiceStrategyOptions).toStrictEqual({
      runTime: { median: false },
      elu: { median: false }
    })
    for (const [, workerChoiceStrategy] of pool.workerChoiceStrategyContext
      .workerChoiceStrategies) {
      expect(workerChoiceStrategy.opts).toStrictEqual({
        runTime: { median: false },
        elu: { median: false }
      })
    }
    expect(
      pool.workerChoiceStrategyContext.getTaskStatisticsRequirements()
    ).toStrictEqual({
      runTime: {
        aggregate: true,
        average: true,
        median: false
      },
      waitTime: {
        aggregate: false,
        average: false,
        median: false
      },
      elu: {
        aggregate: true,
        average: true,
        median: false
      }
    })
    expect(() =>
      pool.setWorkerChoiceStrategyOptions('invalidWorkerChoiceStrategyOptions')
    ).toThrowError(
      'Invalid worker choice strategy options: must be a plain object'
    )
    expect(() =>
      pool.setWorkerChoiceStrategyOptions({ weights: {} })
    ).toThrowError(
      'Invalid worker choice strategy options: must have a weight for each worker node'
    )
    expect(() =>
      pool.setWorkerChoiceStrategyOptions({ measurement: 'invalidMeasurement' })
    ).toThrowError(
      "Invalid worker choice strategy options: invalid measurement 'invalidMeasurement'"
    )
    await pool.destroy()
  })

  it('Verify that tasks queue can be enabled/disabled', async () => {
    const pool = new FixedThreadPool(
      numberOfWorkers,
      './tests/worker-files/thread/testWorker.js'
    )
    expect(pool.opts.enableTasksQueue).toBe(false)
    expect(pool.opts.tasksQueueOptions).toBeUndefined()
    pool.enableTasksQueue(true)
    expect(pool.opts.enableTasksQueue).toBe(true)
    expect(pool.opts.tasksQueueOptions).toStrictEqual({ concurrency: 1 })
    pool.enableTasksQueue(true, { concurrency: 2 })
    expect(pool.opts.enableTasksQueue).toBe(true)
    expect(pool.opts.tasksQueueOptions).toStrictEqual({ concurrency: 2 })
    pool.enableTasksQueue(false)
    expect(pool.opts.enableTasksQueue).toBe(false)
    expect(pool.opts.tasksQueueOptions).toBeUndefined()
    await pool.destroy()
  })

  it('Verify that tasks queue options can be set', async () => {
    const pool = new FixedThreadPool(
      numberOfWorkers,
      './tests/worker-files/thread/testWorker.js',
      { enableTasksQueue: true }
    )
    expect(pool.opts.tasksQueueOptions).toStrictEqual({ concurrency: 1 })
    pool.setTasksQueueOptions({ concurrency: 2 })
    expect(pool.opts.tasksQueueOptions).toStrictEqual({ concurrency: 2 })
    expect(() =>
      pool.setTasksQueueOptions('invalidTasksQueueOptions')
    ).toThrowError('Invalid tasks queue options: must be a plain object')
    expect(() => pool.setTasksQueueOptions({ concurrency: 0 })).toThrowError(
      "Invalid worker tasks concurrency '0'"
    )
    expect(() => pool.setTasksQueueOptions({ concurrency: 0.2 })).toThrowError(
      'Invalid worker tasks concurrency: must be an integer'
    )
    await pool.destroy()
  })

  it('Verify that pool info is set', async () => {
    let pool = new FixedThreadPool(
      numberOfWorkers,
      './tests/worker-files/thread/testWorker.js'
    )
    expect(pool.info).toStrictEqual({
      type: PoolTypes.fixed,
      worker: WorkerTypes.thread,
      minSize: numberOfWorkers,
      maxSize: numberOfWorkers,
      utilization: 0,
      workerNodes: numberOfWorkers,
      idleWorkerNodes: numberOfWorkers,
      busyWorkerNodes: 0,
      executedTasks: 0,
      executingTasks: 0,
      queuedTasks: 0,
      maxQueuedTasks: 0,
      failedTasks: 0
    })
    for (const workerNode of pool.workerNodes) {
      console.log('thread:workerNode.info', workerNode.info)
    }
    await pool.destroy()
    pool = new DynamicClusterPool(
      numberOfWorkers,
      numberOfWorkers * 2,
      './tests/worker-files/cluster/testWorker.js'
    )
    expect(pool.info).toStrictEqual({
      type: PoolTypes.dynamic,
      worker: WorkerTypes.cluster,
      minSize: numberOfWorkers,
      maxSize: numberOfWorkers * 2,
      utilization: 0,
      workerNodes: numberOfWorkers,
      idleWorkerNodes: numberOfWorkers,
      busyWorkerNodes: 0,
      executedTasks: 0,
      executingTasks: 0,
      queuedTasks: 0,
      maxQueuedTasks: 0,
      failedTasks: 0
    })
    for (const workerNode of pool.workerNodes) {
      console.log('cluster:workerNode.info', workerNode.info)
    }
    await pool.destroy()
  })

  it('Simulate worker not found', async () => {
    const pool = new StubPoolWithRemoveAllWorker(
      numberOfWorkers,
      './tests/worker-files/thread/testWorker.js',
      {
        errorHandler: e => console.error(e)
      }
    )
    expect(pool.workerNodes.length).toBe(numberOfWorkers)
    // Simulate worker not found.
    pool.removeAllWorker()
    expect(pool.workerNodes.length).toBe(0)
    await pool.destroy()
  })

  it('Verify that worker pool tasks usage are initialized', async () => {
    const pool = new FixedClusterPool(
      numberOfWorkers,
      './tests/worker-files/cluster/testWorker.js'
    )
    for (const workerNode of pool.workerNodes) {
      expect(workerNode.usage).toStrictEqual({
        tasks: {
          executed: 0,
          executing: 0,
          queued: 0,
          maxQueued: 0,
          failed: 0
        },
        runTime: {
          aggregate: 0,
          average: 0,
          median: 0,
          history: expect.any(CircularArray)
        },
        waitTime: {
          aggregate: 0,
          average: 0,
          median: 0,
          history: expect.any(CircularArray)
        },
        elu: {
          idle: {
            aggregate: 0,
            average: 0,
            median: 0,
            history: expect.any(CircularArray)
          },
          active: {
            aggregate: 0,
            average: 0,
            median: 0,
            history: expect.any(CircularArray)
          },
          utilization: 0
        }
      })
    }
    await pool.destroy()
  })

  it('Verify that worker pool tasks queue are initialized', async () => {
    const pool = new FixedClusterPool(
      numberOfWorkers,
      './tests/worker-files/cluster/testWorker.js'
    )
    for (const workerNode of pool.workerNodes) {
      expect(workerNode.tasksQueue).toBeDefined()
      expect(workerNode.tasksQueue).toBeInstanceOf(Queue)
      expect(workerNode.tasksQueue.size).toBe(0)
      expect(workerNode.tasksQueue.maxSize).toBe(0)
    }
    await pool.destroy()
  })

  it('Verify that worker pool tasks usage are computed', async () => {
    const pool = new FixedClusterPool(
      numberOfWorkers,
      './tests/worker-files/cluster/testWorker.js'
    )
    const promises = new Set()
    const maxMultiplier = 2
    for (let i = 0; i < numberOfWorkers * maxMultiplier; i++) {
      promises.add(pool.execute())
    }
    for (const workerNode of pool.workerNodes) {
      expect(workerNode.usage).toStrictEqual({
        tasks: {
          executed: 0,
          executing: maxMultiplier,
          queued: 0,
          maxQueued: 0,
          failed: 0
        },
        runTime: {
          aggregate: 0,
          average: 0,
          median: 0,
          history: expect.any(CircularArray)
        },
        waitTime: {
          aggregate: 0,
          average: 0,
          median: 0,
          history: expect.any(CircularArray)
        },
        elu: {
          idle: {
            aggregate: 0,
            average: 0,
            median: 0,
            history: expect.any(CircularArray)
          },
          active: {
            aggregate: 0,
            average: 0,
            median: 0,
            history: expect.any(CircularArray)
          },
          utilization: 0
        }
      })
    }
    await Promise.all(promises)
    for (const workerNode of pool.workerNodes) {
      expect(workerNode.usage).toStrictEqual({
        tasks: {
          executed: maxMultiplier,
          executing: 0,
          queued: 0,
          maxQueued: 0,
          failed: 0
        },
        runTime: {
          aggregate: 0,
          average: 0,
          median: 0,
          history: expect.any(CircularArray)
        },
        waitTime: {
          aggregate: 0,
          average: 0,
          median: 0,
          history: expect.any(CircularArray)
        },
        elu: {
          idle: {
            aggregate: 0,
            average: 0,
            median: 0,
            history: expect.any(CircularArray)
          },
          active: {
            aggregate: 0,
            average: 0,
            median: 0,
            history: expect.any(CircularArray)
          },
          utilization: 0
        }
      })
    }
    await pool.destroy()
  })

  it('Verify that worker pool tasks usage are reset at worker choice strategy change', async () => {
    const pool = new DynamicThreadPool(
      numberOfWorkers,
      numberOfWorkers,
      './tests/worker-files/thread/testWorker.js'
    )
    const promises = new Set()
    const maxMultiplier = 2
    for (let i = 0; i < numberOfWorkers * maxMultiplier; i++) {
      promises.add(pool.execute())
    }
    await Promise.all(promises)
    for (const workerNode of pool.workerNodes) {
      expect(workerNode.usage).toStrictEqual({
        tasks: {
          executed: expect.any(Number),
          executing: 0,
          queued: 0,
          maxQueued: 0,
          failed: 0
        },
        runTime: {
          aggregate: 0,
          average: 0,
          median: 0,
          history: expect.any(CircularArray)
        },
        waitTime: {
          aggregate: 0,
          average: 0,
          median: 0,
          history: expect.any(CircularArray)
        },
        elu: {
          idle: {
            aggregate: 0,
            average: 0,
            median: 0,
            history: expect.any(CircularArray)
          },
          active: {
            aggregate: 0,
            average: 0,
            median: 0,
            history: expect.any(CircularArray)
          },
          utilization: 0
        }
      })
      expect(workerNode.usage.tasks.executed).toBeGreaterThan(0)
      expect(workerNode.usage.tasks.executed).toBeLessThanOrEqual(maxMultiplier)
    }
    pool.setWorkerChoiceStrategy(WorkerChoiceStrategies.FAIR_SHARE)
    for (const workerNode of pool.workerNodes) {
      expect(workerNode.usage).toStrictEqual({
        tasks: {
          executed: 0,
          executing: 0,
          queued: 0,
          maxQueued: 0,
          failed: 0
        },
        runTime: {
          aggregate: 0,
          average: 0,
          median: 0,
          history: expect.any(CircularArray)
        },
        waitTime: {
          aggregate: 0,
          average: 0,
          median: 0,
          history: expect.any(CircularArray)
        },
        elu: {
          idle: {
            aggregate: 0,
            average: 0,
            median: 0,
            history: expect.any(CircularArray)
          },
          active: {
            aggregate: 0,
            average: 0,
            median: 0,
            history: expect.any(CircularArray)
          },
          utilization: 0
        }
      })
      expect(workerNode.usage.runTime.history.length).toBe(0)
      expect(workerNode.usage.waitTime.history.length).toBe(0)
    }
    await pool.destroy()
  })

  it("Verify that pool event emitter 'full' event can register a callback", async () => {
    const pool = new DynamicThreadPool(
      numberOfWorkers,
      numberOfWorkers,
      './tests/worker-files/thread/testWorker.js'
    )
    const promises = new Set()
    let poolFull = 0
    let poolInfo
    pool.emitter.on(PoolEvents.full, info => {
      ++poolFull
      poolInfo = info
    })
    for (let i = 0; i < numberOfWorkers * 2; i++) {
      promises.add(pool.execute())
    }
    await Promise.all(promises)
    // The `full` event is triggered when the number of submitted tasks at once reach the max number of workers in the dynamic pool.
    // So in total numberOfWorkers * 2 times for a loop submitting up to numberOfWorkers * 2 tasks to the dynamic pool with min = max = numberOfWorkers.
    expect(poolFull).toBe(numberOfWorkers * 2)
    expect(poolInfo).toStrictEqual({
      type: PoolTypes.dynamic,
      worker: WorkerTypes.thread,
      minSize: expect.any(Number),
      maxSize: expect.any(Number),
      utilization: 0,
      workerNodes: expect.any(Number),
      idleWorkerNodes: expect.any(Number),
      busyWorkerNodes: expect.any(Number),
      executedTasks: expect.any(Number),
      executingTasks: expect.any(Number),
      queuedTasks: expect.any(Number),
      maxQueuedTasks: expect.any(Number),
      failedTasks: expect.any(Number)
    })
    await pool.destroy()
  })

  it("Verify that pool event emitter 'busy' event can register a callback", async () => {
    const pool = new FixedThreadPool(
      numberOfWorkers,
      './tests/worker-files/thread/testWorker.js'
    )
    const promises = new Set()
    let poolBusy = 0
    let poolInfo
    pool.emitter.on(PoolEvents.busy, info => {
      ++poolBusy
      poolInfo = info
    })
    for (let i = 0; i < numberOfWorkers * 2; i++) {
      promises.add(pool.execute())
    }
    await Promise.all(promises)
    // The `busy` event is triggered when the number of submitted tasks at once reach the number of fixed pool workers.
    // So in total numberOfWorkers + 1 times for a loop submitting up to numberOfWorkers * 2 tasks to the fixed pool.
    expect(poolBusy).toBe(numberOfWorkers + 1)
    expect(poolInfo).toStrictEqual({
      type: PoolTypes.fixed,
      worker: WorkerTypes.thread,
      minSize: expect.any(Number),
      maxSize: expect.any(Number),
      utilization: 0,
      workerNodes: expect.any(Number),
      idleWorkerNodes: expect.any(Number),
      busyWorkerNodes: expect.any(Number),
      executedTasks: expect.any(Number),
      executingTasks: expect.any(Number),
      queuedTasks: expect.any(Number),
      maxQueuedTasks: expect.any(Number),
      failedTasks: expect.any(Number)
    })
    await pool.destroy()
  })

  it('Verify that multiple tasks worker is working', async () => {
    const pool = new DynamicClusterPool(
      numberOfWorkers,
      numberOfWorkers * 2,
      './tests/worker-files/cluster/testMultiTasksWorker.js'
    )
    const data = { n: 10 }
    const result0 = await pool.execute(data)
    expect(result0).toBe(false)
    const result1 = await pool.execute(data, 'jsonIntegerSerialization')
    expect(result1).toBe(false)
    const result2 = await pool.execute(data, 'factorial')
    expect(result2).toBe(3628800)
    const result3 = await pool.execute(data, 'fibonacci')
    expect(result3).toBe(55)
  })
})