test: improve INTERLEAVED_WEIGHTED_ROUND_ROBIN strategy test
[poolifier.git] / CHANGELOG.md
1 # Changelog
2
3 All notable changes to this project will be documented in this file.
4
5 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
8 ## [Unreleased]
9
10 ### Fixed
11
12 - Fix worker choice strategy retries mechanism on some edge cases.
13
14 ## [2.6.30] - 2023-08-19
15
16 ### Fixed
17
18 - Ensure pool event `backPressure` is emitted.
19 - Ensure pool event `full` is emitted only once.
20 - Ensure worker node cannot be instantiated without proper arguments.
21
22 ## [2.6.29] - 2023-08-18
23
24 ### Fixed
25
26 - Fix race condition between ready and task functions worker message handling at startup.
27 - Fix duplicate task function worker usage statistics computation per task function.
28 - Update task function worker usage statistics if and only if there's at least two different task functions.
29 - Fix race condition at task function worker usage executing task computation leading to negative value.
30
31 ### Added
32
33 - Add back pressure detection on the worker node queue. Event `backPressure` is emitted when all worker node queues are full (worker node queue size >= poolMaxSize^2).
34 - Use back pressure detection in worker choice strategies.
35 - Add worker choice strategies retries mechanism if no worker is eligible.
36
37 ## [2.6.28] - 2023-08-16
38
39 ### Fixed
40
41 - Ensure pool workers are properly initialized.
42
43 ### Added
44
45 - HTTP server pool examples: express-cluster, express-hybrid.
46
47 ### Changed
48
49 - Remove now useless branching in worker hot code path.
50
51 ## [2.6.27] - 2023-08-15
52
53 ### Fixed
54
55 - Add `KillHandler` type definition to exported types.
56
57 ### Added
58
59 - Add `destroy` event to pool API.
60
61 ## [2.6.26] - 2023-08-15
62
63 ### Added
64
65 - Add kill handler to worker options allowing to execute custom code when worker is killed.
66 - Add `listTaskFunctions()` method to pool API.
67 - SMTP server pool example: nodemailer.
68
69 ## [2.6.25] - 2023-08-13
70
71 ### Added
72
73 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
74 - WebSocket server pool examples: ws-cluster, ws-hybrid.
75
76 ## [2.6.24] - 2023-08-12
77
78 ### Added
79
80 - Add array of transferable objects to the `execute()` method arguments.
81 - WebSocket server pool examples: ws-worker_threads.
82
83 ## [2.6.23] - 2023-08-11
84
85 ### Fixed
86
87 - Fix pool busyness semantic when tasks queueing is enabled: the pool is busy when the number of executing tasks on each worker has reached the maximum tasks concurrency per worker.
88
89 ### Added
90
91 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
92 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
93
94 ## [2.6.22] - 2023-08-10
95
96 ### Fixed
97
98 - Add missing `types` field to package.json `exports`.
99
100 ### Changed
101
102 - Structure markdown documentation (PR #811).
103
104 ## [2.6.21] - 2023-08-03
105
106 ### Changed
107
108 - Improve code documentation.
109 - Code refactoring and cleanup for better maintainability and readability.
110
111 ## [2.6.20] - 2023-07-21
112
113 ### Fixed
114
115 - Fix queued tasks redistribution on error task execution starvation.
116 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
117
118 ### Changed
119
120 - Drastically reduce lookups by worker in the worker nodes.
121
122 ## [2.6.19] - 2023-07-20
123
124 ### Added
125
126 - Dedicated internal communication channel for worker_threads pools.
127
128 ## [2.6.18] - 2023-07-19
129
130 ### Changed
131
132 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
133
134 ## [2.6.17] - 2023-07-16
135
136 ### Added
137
138 - Add `listTaskFunctions()` method to worker API.
139
140 ## [2.6.16] - 2023-07-12
141
142 ### Fixed
143
144 - Fix pool startup detection.
145 - Fix worker task functions handling.
146
147 ## [2.6.15] - 2023-07-11
148
149 ### Added
150
151 - Take into account worker node readiness in worker choice strategies.
152
153 ## [2.6.14] - 2023-07-10
154
155 ### Fixed
156
157 - Fix task function statistics tracking.
158
159 ## [2.6.13] - 2023-07-10
160
161 ### Added
162
163 - Add per task function statistics tracking.
164 - Add public methods to manipulate the worker task functions at runtime.
165
166 ## [2.6.12] - 2023-07-09
167
168 ### Fixed
169
170 - Workaround import issue with `node:os` module in node 16.x.x.
171
172 ## [2.6.11] - 2023-07-09
173
174 ### Fixed
175
176 - Fix pool readiness semantic.
177
178 ## [2.6.10] - 2023-07-08
179
180 ### Fixed
181
182 - Ensure workers are not recreated on error at pool startup.
183
184 ### Added
185
186 - Add `ready` and `strategy` fields to pool information.
187 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
188 - Add dynamic pool sizing checks.
189
190 ## [2.6.9] - 2023-07-07
191
192 ### Fixed
193
194 - Recreate the right worker type on uncaught exception.
195
196 ### Added
197
198 - Add minimum and maximum to internal measurement statistics.
199 - Add `runTime` and `waitTime` to pool information.
200 - Check worker inactive time only on dynamic worker.
201
202 ## [2.6.8] - 2023-07-03
203
204 ### Fixed
205
206 - Brown paper bag release to fix version handling in pool information.
207
208 ## [2.6.7] - 2023-07-03
209
210 ### Fixed
211
212 - Ensure worker queued tasks at error are reassigned to other pool workers.
213
214 ### Added
215
216 - Add pool `utilization` ratio to pool information.
217 - Add `version` to pool information.
218 - Add worker information to worker nodes.
219
220 ## [2.6.6] - 2023-07-01
221
222 ### Added
223
224 - Add safe helper `availableParallelism()` to help sizing the pool.
225
226 ### Fixed
227
228 - Ensure message handler is only registered in worker.
229
230 ## [2.6.5] - 2023-06-27
231
232 ### Known issues
233
234 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
235
236 ### Fixed
237
238 - Artificial version bump to 2.6.5 to workaround publication issue.
239 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
240 - Ensure pool event is emitted before task error promise rejection.
241 - Fix queued tasks count computation.
242
243 ### Removed
244
245 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
246
247 ## [2.6.4] - 2023-06-27
248
249 ### Known issues
250
251 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
252
253 ### Fixed
254
255 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
256 - Ensure pool event is emitted before task error promise rejection.
257 - Fix queued tasks count computation.
258
259 ### Removed
260
261 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
262
263 ## [2.6.3] - 2023-06-19
264
265 ### Fixed
266
267 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
268 - Update strategies internals after statistics computation.
269
270 ### Changed
271
272 - Optimize O(1) queue implementation.
273
274 ## [2.6.2] - 2023-06-12
275
276 ### Fixed
277
278 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
279
280 ## [2.6.1] - 2023-06-10
281
282 ### Added
283
284 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
285
286 ### Fixed
287
288 - Fix average statistics computation: ensure failed tasks are not accounted.
289
290 ## [2.6.0] - 2023-06-09
291
292 ### Added
293
294 - Add `LEAST_ELU` worker choice strategy (experimental).
295 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
296
297 ### Changed
298
299 - Refactor pool worker node usage internals.
300 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
301 - Breaking change: pool information `info` property object fields have been renamed.
302
303 ### Fixed
304
305 - Fix wait time accounting.
306 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
307 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
308
309 ## [2.5.4] - 2023-06-07
310
311 ### Added
312
313 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
314
315 ### Changed
316
317 - Compute statistics at the worker level only if needed.
318 - Add `worker_threads` options to thread pool options.
319
320 ### Fixed
321
322 - Make the `LEAST_BUSY` strategy only relies on task runtime.
323
324 ## [2.5.3] - 2023-06-04
325
326 ### Changed
327
328 - Refine pool information content.
329 - Limit pool internals public exposure.
330
331 ## [2.5.2] - 2023-06-02
332
333 ### Added
334
335 - Add `taskError` pool event for task execution error.
336 - Add pool information `info` property to pool.
337 - Emit pool information on `busy` and `full` pool events.
338
339 ## [2.5.1] - 2023-06-01
340
341 ### Added
342
343 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
344 - Add `error` pool event for uncaught worker error.
345
346 ## [2.5.0] - 2023-05-31
347
348 ### Added
349
350 - Switch pool event emitter to `EventEmitterAsyncResource`.
351 - Add tasks wait time accounting in per worker tasks usage.
352 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
353
354 ### Changed
355
356 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
357
358 ## [2.4.14] - 2023-05-09
359
360 ### Fixed
361
362 - Ensure no undefined task runtime can land in the tasks history.
363 - Fix median computation implementation once again.
364
365 ### Added
366
367 - Unit tests for median and queue implementations.
368
369 ## [2.4.13] - 2023-05-08
370
371 ### Fixed
372
373 - Fix worker choice strategy options validation.
374 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
375
376 ## [2.4.12] - 2023-05-06
377
378 ### Added
379
380 - Support multiple task functions per worker.
381 - Add custom worker weights support to worker choice strategies options.
382
383 ### Changed
384
385 - Use O(1) queue implementation for tasks queueing.
386
387 ### Fixed
388
389 - Fix median computation implementation.
390 - Fix fair share worker choice strategy internals update.
391
392 ## [2.4.11] - 2023-04-23
393
394 ### Changed
395
396 - Optimize free worker finding in worker choice strategies.
397
398 ## [2.4.10] - 2023-04-15
399
400 ### Fixed
401
402 - Fix typescript type definition for task function: ensure the input data is optional.
403 - Fix typescript type definition for pool execute(): ensure the input data is optional.
404
405 ## [2.4.9] - 2023-04-15
406
407 ### Added
408
409 - Add tasks queue enablement runtime setter to pool.
410 - Add tasks queue options runtime setter to pool.
411 - Add worker choice strategy options runtime setter to pool.
412
413 ### Changed
414
415 - Remove the tasks queuing experimental status.
416
417 ### Fixed
418
419 - Fix task function type definition and validation.
420 - Fix worker choice strategy options handling.
421
422 ## [2.4.8] - 2023-04-12
423
424 ### Fixed
425
426 - Fix message between main worker and worker type definition for tasks.
427 - Fix code documentation.
428
429 ## [2.4.7] - 2023-04-11
430
431 ### Added
432
433 - Add worker tasks queue options to pool options.
434
435 ### Fixed
436
437 - Fix missing documentation.
438
439 ## [2.4.6] - 2023-04-10
440
441 ### Fixed
442
443 - Ensure one task at a time is executed per worker with tasks queueing enabled.
444 - Properly count worker executing tasks with tasks queueing enabled.
445
446 ## [2.4.5] - 2023-04-09
447
448 ### Added
449
450 - Use monotonic high resolution timer for worker tasks runtime.
451 - Add worker tasks median runtime to statistics.
452 - Add worker tasks queue (experimental).
453
454 ## [2.4.4] - 2023-04-07
455
456 ### Added
457
458 - Add `PoolEvents` enumeration and `PoolEvent` type.
459
460 ### Fixed
461
462 - Destroy worker only on alive check.
463
464 ## [2.4.3] - 2023-04-07
465
466 ### Fixed
467
468 - Fix typedoc generation with inheritance.
469
470 ## [2.4.2] - 2023-04-06
471
472 ### Added
473
474 - Add `full` event to dynamic pool.
475 - Keep worker choice strategy in memory for conditional reuse.
476
477 ### Fixed
478
479 - Fix possible negative worker key at worker removal in worker choice strategies.
480
481 ## [2.4.1] - 2023-04-05
482
483 ### Changed
484
485 - Optimize worker choice strategy for dynamic pool.
486
487 ### Fixed
488
489 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
490
491 ## [2.4.0] - 2023-04-04
492
493 ### Added
494
495 - Add `LESS_BUSY` worker choice strategy.
496
497 ### Changed
498
499 - Optimize worker storage in pool.
500 - Optimize worker alive status check.
501 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
502 - Optimize `LESS_USED` worker choice strategy.
503 - Update benchmarks versus external threads pools.
504 - Optimize tasks usage statistics requirements for worker choice strategy.
505
506 ### Fixed
507
508 - Ensure trimmable characters are checked at pool initialization.
509 - Fix message id integer overflow.
510 - Fix pool worker removal in worker choice strategy internals.
511 - Fix package publication with pnpm.
512
513 ## [2.4.0-3] - 2023-04-04
514
515 ### Added
516
517 - Add `LESS_BUSY` worker choice strategy.
518
519 ### Changed
520
521 - Optimize worker storage in pool.
522 - Optimize worker alive status check.
523 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
524 - Optimize `LESS_USED` worker choice strategy.
525 - Update benchmarks versus external threads pools.
526
527 ### Fixed
528
529 - Ensure trimmable characters are checked at pool initialization.
530 - Fix message id integer overflow.
531 - Fix pool worker removal in worker choice strategy internals.
532 - Fix package publication with pnpm.
533
534 ## [2.4.0-2] - 2023-04-03
535
536 ### Added
537
538 - Add `LESS_BUSY` worker choice strategy.
539
540 ### Changed
541
542 - Optimize worker storage in pool.
543 - Optimize worker alive status check.
544 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
545 - Optimize `LESS_USED` worker choice strategy.
546
547 ### Fixed
548
549 - Ensure trimmable characters are checked at pool initialization.
550 - Fix message id integer overflow.
551 - Fix pool worker removal in worker choice strategy internals.
552 - Fix package publication with pnpm.
553
554 ## [2.4.0-1] - 2023-04-03
555
556 ### Added
557
558 - Add `LESS_BUSY` worker choice strategy.
559
560 ### Changed
561
562 - Optimize worker storage in pool.
563 - Optimize worker alive status check.
564 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
565 - Optimize `LESS_USED` worker choice strategy.
566
567 ### Fixed
568
569 - Ensure trimmable characters are checked at pool initialization.
570 - Fix message id integer overflow.
571 - Fix pool worker removal in worker choice strategy internals.
572
573 ## [2.4.0-0] - 2023-04-03
574
575 ### Added
576
577 - Add `LESS_BUSY` worker choice strategy.
578
579 ### Changed
580
581 - Optimize worker storage in pool.
582 - Optimize worker alive status check.
583 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
584 - Optimize `LESS_USED` worker choice strategy.
585
586 ### Fixed
587
588 - Ensure trimmable characters are checked at pool initialization.
589 - Fix message id integer overflow.
590 - Fix pool worker removal in worker choice strategy internals.
591
592 ## [2.3.10] - 2023-03-18
593
594 ### Fixed
595
596 - Fix package.json `exports` syntax for ESM and CommonJS.
597
598 ### Changed
599
600 - Permit SemVer pre-release publication.
601
602 ## [2.3.10-2] - 2023-03-18
603
604 ### Fixed
605
606 - Fix package.json `exports` syntax for ESM and CommonJS.
607
608 ## [2.3.10-1] - 2023-03-18
609
610 ### Changed
611
612 - Permit SemVer pre-release publication.
613
614 ## [2.3.10-0] - 2023-03-18
615
616 ### Fixed
617
618 - Fix package.json `exports` syntax for ESM and CommonJS.
619
620 ## [2.3.9] - 2023-03-18
621
622 ### Changed
623
624 - Introduce ESM module support along with CommonJS one.
625
626 ### Fixed
627
628 - Fix brown paper bag bug referencing the same object literal.
629
630 ## [2.3.8] - 2023-03-18
631
632 ### Changed
633
634 - Switch internal benchmarking code to benny.
635 - Switch to TypeScript 5.x.x.
636 - Switch rollup bundler plugins to core ones.
637 - Switch to TSDoc syntax.
638 - Enforce conventional commits.
639
640 ### Fixed
641
642 - Fix random integer generator.
643 - Fix worker choice strategy pool type identification at initialization.
644
645 ## [2.3.7] - 2022-10-23
646
647 ### Changed
648
649 - Switch to open collective FOSS project funding platform.
650 - Switch to ts-standard linter configuration on TypeScript code.
651
652 ### Fixed
653
654 - Fixed missing async on pool execute method.
655 - Fixed typing in TypeScript example.
656 - Fixed types in unit tests.
657
658 ## [2.3.6] - 2022-10-22
659
660 ### Changed
661
662 - Cleanup pool attributes and methods.
663 - Refine error types thrown.
664
665 ### Fixed
666
667 - Fix continuous integration build on windows.
668 - Fix code coverage reporting by using c8 instead of nyc.
669
670 ## [2.3.5] - 2022-10-21
671
672 ### Changed
673
674 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
675 - Optimize tasks usage lookup implementation.
676
677 ### Fixed
678
679 - Fix missed pool event emitter type export.
680 - Fix typedoc documentation generation.
681
682 ## [2.3.4] - 2022-10-17
683
684 ### Added
685
686 - Fully automate release process with release-it.
687
688 ### Changed
689
690 - Optimize fair share task scheduling algorithm implementation.
691 - Update benchmarks versus external pools results with latest version.
692
693 ## [2.3.3] - 2022-10-15
694
695 ### Added
696
697 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
698
699 ## [2.3.2] - 2022-10-14
700
701 ### Changed
702
703 - Optimize fair share worker selection strategy implementation.
704
705 ### Fixed
706
707 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
708
709 ## [2.3.1] - 2022-10-13
710
711 ### Added
712
713 - Pool worker choice strategies:
714 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
715 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
716
717 ## [2.2.2] - 2022-10-09
718
719 ### Fixed
720
721 - Fixed `README.md` file.
722
723 ## [2.2.1] - 2022-10-08
724
725 ### Added
726
727 - Dynamic worker choice strategy change at runtime.
728
729 ## [2.2.0] - 2022-01-05
730
731 ### Breaking Changes
732
733 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
734
735 ## [2.1.0] - 2021-08-29
736
737 ### Added
738
739 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
740
741 ### Breaking Changes
742
743 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
744 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
745 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
746 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
747
748 ## [2.0.2] - 2021-05-12
749
750 ### Bug fixes
751
752 - Fix `busy` event emission on fixed pool type
753
754 ## [2.0.1] - 2021-03-16
755
756 ### Bug fixes
757
758 - Check if pool options are properly set.
759 - `busy` event is emitted on all pool types.
760
761 ## [2.0.0] - 2021-03-01
762
763 ### Bug fixes
764
765 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
766
767 ### Breaking Changes
768
769 - `FullPool` event is now renamed to `busy`.
770 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
771 _Find more details on our JSDoc._
772
773 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
774
775 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
776
777 ### Pool options types declaration merge
778
779 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
780
781 #### New `export` strategy
782
783 ```js
784 // Before
785 const DynamicThreadPool = require('poolifier/lib/dynamic')
786 // After
787 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
788 ```
789
790 But you should always prefer just using
791
792 ```js
793 const { DynamicThreadPool } = require('poolifier')
794 ```
795
796 #### New type definitions for input data and response
797
798 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
799 _This is not a limitation by poolifier but Node.js._
800
801 #### Public property replacements
802
803 `numWorkers` property is now `numberOfWorkers`
804
805 #### Internal (protected) properties and methods renaming
806
807 These properties are not intended for end users
808
809 - `id` => `nextMessageId`
810
811 These methods are not intended for end users
812
813 - `_chooseWorker` => `chooseWorker`
814 - `_newWorker` => `createWorker`
815 - `_execute` => `internalExecute`
816 - `_chooseWorker` => `chooseWorker`
817 - `_checkAlive` => `checkAlive`
818 - `_run` => `run`
819 - `_runAsync` => `runAsync`
820
821 ## [1.1.0] - 2020-05-21
822
823 ### Added
824
825 - ThreadWorker support async functions as option
826 - Various external library patches
827
828 ## [1.0.0] - 2020-01-24
829
830 ### Added
831
832 - FixedThreadPool implementation
833 - DynamicThreadPool implementation
834 - WorkerThread implementation to improve developer experience