perf: use optimized circular buffer implementation to store measurements history
[poolifier.git] / tests / pools / utils.test.mjs
1 import cluster, { Worker as ClusterWorker } from 'node:cluster'
2 import { Worker as ThreadWorker } from 'node:worker_threads'
3
4 import { expect } from 'expect'
5
6 import { CircularBuffer } from '../../lib/circular-buffer.cjs'
7 import { WorkerTypes } from '../../lib/index.cjs'
8 import {
9 createWorker,
10 DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS,
11 getDefaultTasksQueueOptions,
12 getWorkerId,
13 getWorkerType,
14 updateMeasurementStatistics
15 } from '../../lib/pools/utils.cjs'
16 import { MeasurementHistorySize } from '../../lib/pools/worker.cjs'
17
18 describe('Pool utils test suite', () => {
19 it('Verify DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS values', () => {
20 expect(DEFAULT_MEASUREMENT_STATISTICS_REQUIREMENTS).toStrictEqual({
21 aggregate: false,
22 average: false,
23 median: false
24 })
25 })
26
27 it('Verify getDefaultTasksQueueOptions() behavior', () => {
28 const poolMaxSize = 4
29 expect(getDefaultTasksQueueOptions(poolMaxSize)).toStrictEqual({
30 concurrency: 1,
31 size: Math.pow(poolMaxSize, 2),
32 taskStealing: true,
33 tasksStealingOnBackPressure: false,
34 tasksFinishedTimeout: 2000
35 })
36 })
37
38 it('Verify updateMeasurementStatistics() behavior', () => {
39 const circularBuffer = new CircularBuffer(MeasurementHistorySize)
40 const measurementStatistics = {
41 history: circularBuffer
42 }
43 updateMeasurementStatistics(
44 measurementStatistics,
45 { aggregate: true, average: false, median: false },
46 0.01
47 )
48 expect(measurementStatistics).toStrictEqual({
49 aggregate: 0.01,
50 maximum: 0.01,
51 minimum: 0.01,
52 history: circularBuffer
53 })
54 updateMeasurementStatistics(
55 measurementStatistics,
56 { aggregate: true, average: false, median: false },
57 0.02
58 )
59 expect(measurementStatistics).toStrictEqual({
60 aggregate: 0.03,
61 maximum: 0.02,
62 minimum: 0.01,
63 history: circularBuffer
64 })
65 updateMeasurementStatistics(
66 measurementStatistics,
67 { aggregate: true, average: true, median: false },
68 0.001
69 )
70 expect(measurementStatistics).toStrictEqual({
71 aggregate: 0.031,
72 maximum: 0.02,
73 minimum: 0.001,
74 average: 0.001,
75 history: circularBuffer
76 })
77 updateMeasurementStatistics(
78 measurementStatistics,
79 { aggregate: true, average: true, median: false },
80 0.003
81 )
82 expect(measurementStatistics).toStrictEqual({
83 aggregate: 0.034,
84 maximum: 0.02,
85 minimum: 0.001,
86 average: 0.002,
87 history: circularBuffer
88 })
89 updateMeasurementStatistics(
90 measurementStatistics,
91 { aggregate: true, average: false, median: true },
92 0.006
93 )
94 expect(measurementStatistics).toStrictEqual({
95 aggregate: 0.04,
96 maximum: 0.02,
97 minimum: 0.001,
98 median: 0.003,
99 history: circularBuffer
100 })
101 updateMeasurementStatistics(
102 measurementStatistics,
103 { aggregate: true, average: true, median: false },
104 0.01
105 )
106 expect(measurementStatistics).toStrictEqual({
107 aggregate: 0.05,
108 maximum: 0.02,
109 minimum: 0.001,
110 average: 0.005,
111 history: circularBuffer
112 })
113 })
114
115 it('Verify createWorker() behavior', () => {
116 expect(
117 createWorker(
118 WorkerTypes.thread,
119 './tests/worker-files/thread/testWorker.mjs',
120 {}
121 )
122 ).toBeInstanceOf(ThreadWorker)
123 expect(
124 createWorker(
125 WorkerTypes.cluster,
126 './tests/worker-files/cluster/testWorker.mjs',
127 {}
128 )
129 ).toBeInstanceOf(ClusterWorker)
130 })
131
132 it('Verify getWorkerType() behavior', () => {
133 expect(
134 getWorkerType(
135 new ThreadWorker('./tests/worker-files/thread/testWorker.mjs')
136 )
137 ).toBe(WorkerTypes.thread)
138 expect(getWorkerType(cluster.fork())).toBe(WorkerTypes.cluster)
139 })
140
141 it('Verify getWorkerId() behavior', () => {
142 const threadWorker = new ThreadWorker(
143 './tests/worker-files/thread/testWorker.mjs'
144 )
145 const clusterWorker = cluster.fork()
146 expect(getWorkerId(threadWorker)).toBe(threadWorker.threadId)
147 expect(getWorkerId(clusterWorker)).toBe(clusterWorker.id)
148 })
149 })