Merge dependabot/npm_and_yarn/examples/typescript/websocket-server-pool/ws-hybrid...
[poolifier.git] / CHANGELOG.md
... / ...
CommitLineData
1# Changelog
2
3All notable changes to this project will be documented in this file.
4
5The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
8## [Unreleased]
9
10## [3.1.16] - 2024-01-03
11
12### Fixed
13
14- Add missing type to TS type definitions.
15
16## [3.1.15] - 2024-01-02
17
18### Fixed
19
20- Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
21
22## [3.1.15-0] - 2024-01-02
23
24### Fixed
25
26- Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
27
28## [3.1.14] - 2024-01-01
29
30### Fixed
31
32- Properly handle dynamic pool with zero minimum size.
33
34## [3.1.13] - 2023-12-30
35
36### Changed
37
38- Reduce branching in several hot code paths.
39- Use faster object cloning implementation.
40
41## [3.1.12] - 2023-12-27
42
43### Fixed
44
45- Fix tasks redistribution triggers at pool destroying.
46
47### Changed
48
49- Switch TypeScript module resolution to Node16.
50
51## [3.1.12-0] - 2023-12-27
52
53### Fixed
54
55- Fix tasks redistribution triggers at pool destroying.
56
57## [3.1.11] - 2023-12-24
58
59### Fixed
60
61- Avoid worker node cross tasks stealing.
62- Ensure only half the pool worker nodes can steal tasks.
63
64## [3.1.10] - 2023-12-23
65
66### Changed
67
68- Avoid useless branching on pool type.
69
70## [3.1.9] - 2023-12-22
71
72### Changed
73
74- Readd ThreadPoolOptions and ClusterPoolOptions TS type aliases to PoolOptions.
75
76## [3.1.8] - 2023-12-21
77
78### Fixed
79
80- Fix default worker weight computation.
81- Fix possible null exception at pool destroying.
82
83## [3.1.7] - 2023-12-20
84
85### Fixed
86
87- Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748).
88
89## [3.1.6] - 2023-12-18
90
91### Fixed
92
93- Fix pool destroying with tasks queuing enabled.
94
95## [3.1.5] - 2023-12-18
96
97### Added
98
99- Add queued tasks end timeout support to worker node termination.
100
101## [3.1.4] - 2023-12-18
102
103### Fixed
104
105- Make more robust the fix for possible null exception at handling task execution response.
106
107## [3.1.3] - 2023-12-17
108
109### Fixed
110
111- Fix possible null exception at handling task execution response.
112
113## [3.1.2] - 2023-12-17
114
115### Fixed
116
117- Wait for queued tasks to end at worker node termination.
118
119## [3.1.1] - 2023-12-16
120
121### Fixed
122
123- Fix pool options TS type definition.
124
125## [3.1.0] - 2023-12-16
126
127### Changed
128
129- TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type.
130
131## [3.0.14] - 2023-12-13
132
133### Fixed
134
135- Fix possible null exception with worker_threads pools.
136
137## [3.0.13] - 2023-12-12
138
139### Fixed
140
141- Ensure worker choice strategy wait for worker nodes readiness.
142
143### Changed
144
145- Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop.
146
147## [3.0.12] - 2023-12-12
148
149### Changed
150
151- Add infinite retries support in worker choice strategy.
152
153## [3.0.11] - 2023-12-11
154
155### Fixed
156
157- Ensure pool asynchronous resource properly track tasks execution.
158
159## [3.0.10] - 2023-12-08
160
161### Changed
162
163- Add a fastpath when tasks stealing or redistribution is impossible.
164
165## [3.0.9] - 2023-11-26
166
167### Fixed
168
169- Remove all pool events listener at pool destroying.
170- Remove all worker node events listener at worker node destroying.
171- Fix worker node event emitter listeners handling memory leak at pool options runtime change.
172
173## [3.0.8] - 2023-11-25
174
175### Fixed
176
177- Ensure continuous tasks stealing on idle start at worker node idling.
178
179## [3.0.7] - 2023-11-24
180
181### Changed
182
183- Make continuous tasks stealing start at worker node idling.
184
185## [3.0.6] - 2023-11-24
186
187### Fixed
188
189- Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
190- Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
191
192## [3.0.5] - 2023-10-27
193
194### Fixed
195
196- Ensure pool `ready` event can be emitted only once.
197
198## [3.0.4] - 2023-10-20
199
200### Changed
201
202- Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
203- Use builtin retry mechanism in worker choice strategies instead of custom one.
204
205## [3.0.3] - 2023-10-19
206
207### Fixed
208
209- Avoid null exception at sending message to worker.
210- Avoid null exception at checking worker node readiness.
211
212## [3.0.2] - 2023-10-17
213
214### Fixed
215
216- Fix race condition at dynamic worker node task assignment and scheduled removal. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468) and [#1496](https://github.com/poolifier/poolifier/issues/1496).
217
218## [3.0.1] - 2023-10-16
219
220### Fixed
221
222- Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
223
224### Changed
225
226- Switch the worker node eventing code to `EventTarget` API.
227
228## [3.0.0] - 2023-10-08
229
230### Changed
231
232- Remove Node.js 16.x.x (EOL) support.
233
234## [2.7.5] - 2023-10-03
235
236### Changed
237
238- Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
239
240## [2.7.4] - 2023-09-25
241
242### Fixed
243
244- Fix source maps (bundler issue).
245
246## [2.7.3] - 2023-09-24
247
248### Changed
249
250- Convert pool event emitter to event emitter async resource.
251
252## [2.7.2] - 2023-09-23
253
254### Changed
255
256- Add source maps to npm package to ease debugging.
257
258### Added
259
260- Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
261
262## [2.7.1] - 2023-09-20
263
264### Fixed
265
266- Ensure worker message listener used one time are removed after usage.
267
268## [2.7.0] - 2023-09-19
269
270### Fixed
271
272- Fix task stealing related tasks queue options handling at runtime.
273
274### Changed
275
276- Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
277
278### Added
279
280- Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
281- Stricter worker constructor arguments validation.
282
283## [2.6.45] - 2023-09-17
284
285### Changed
286
287- Disable publication on GitHub packages registry on release until authentication issue is fixed.
288
289### Added
290
291- Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
292- Add `start()` method to pool API to start the minimum number of workers.
293- Add `taskStealing` and `tasksStealingOnPressure` to tasks queue options to whether enable task stealing or not and whether enable tasks stealing under back pressure or not.
294- Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
295
296## [2.6.44] - 2023-09-08
297
298### Fixed
299
300- Use a dedicated PAT to publish on GitHub packages registry.
301
302### Added
303
304- Publish on GitHub packages registry on release.
305
306### Changed
307
308- Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
309
310## [2.6.43] - 2023-09-08
311
312### Added
313
314- Publish on GitHub packages registry on release.
315
316### Changed
317
318- Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
319
320## [2.6.42] - 2023-09-06
321
322### Changed
323
324- Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
325
326## [2.6.41] - 2023-09-03
327
328### Changed
329
330- Optimize worker choice strategies implementation.
331
332## [2.6.40] - 2023-09-01
333
334### Fixed
335
336- Do not pre-choose in WRR worker choice strategy to avoid bias.
337- Avoid array out of bound in worker choice strategies after worker node removal.
338
339## [2.6.39] - 2023-08-30
340
341### Fixed
342
343- Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
344
345## [2.6.38] - 2023-08-30
346
347### Added
348
349- Bundle typescript types declaration into one file.
350
351### Changed
352
353- Improve interleaved weighted round robin worker choice strategy implementation.
354
355## [2.6.37] - 2023-08-28
356
357### Fixed
358
359- Ensure unused worker usage statistics are deleted at runtime.
360
361### Changed
362
363- Rename worker choice strategy options `choiceRetries` to `retries`.
364- Avoid unnecessary branching in worker choice strategies.
365
366## [2.6.36] - 2023-08-27
367
368### Fixed
369
370- Fix pool `execute()` arguments check.
371
372### Changed
373
374- Make continuous tasks stealing algorithm less aggressive.
375- Fine tune tasks stealing algorithm under back pressure.
376
377## [2.6.35] - 2023-08-25
378
379### Fixed
380
381- Don't account worker usage statistics for tasks that have failed.
382- Fix pool information runtime and wait time median computation.
383
384### Changed
385
386- Update simple moving average implementation to use a circular buffer.
387- Update simple moving median implementation to use a circular buffer.
388- Account for stolen tasks in worker usage statistics and pool information.
389
390### Added
391
392- Continuous tasks stealing algorithm.
393
394## [2.6.34] - 2023-08-24
395
396### Fixes
397
398- Avoid cascading tasks stealing under back pressure.
399
400### Changed
401
402- Add fastpath to queued tasks rescheduling.
403
404## [2.6.33] - 2023-08-24
405
406### Fixed
407
408- Fix queued tasks rescheduling.
409
410### Changed
411
412- Rename tasks queue options `queueMaxSize` to `size`.
413
414### Added
415
416- Task stealing scheduling algorithm if tasks queueing is enabled.
417
418## [2.6.32] - 2023-08-23
419
420### Fixed
421
422- Ensure no task can be executed when the pool is destroyed.
423
424### Added
425
426- Add `queueMaxSize` option to tasks queue options.
427- Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
428- Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
429
430## [2.6.31] - 2023-08-20
431
432### Fixed
433
434- Fix worker choice strategy retries mechanism in some edge cases.
435
436### Changed
437
438- Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
439- Remove the experimental status of the `LEAST_ELU` worker choice strategy.
440
441## [2.6.30] - 2023-08-19
442
443### Fixed
444
445- Ensure pool event `backPressure` is emitted.
446- Ensure pool event `full` is emitted only once.
447- Ensure worker node cannot be instantiated without proper arguments.
448
449## [2.6.29] - 2023-08-18
450
451### Fixed
452
453- Fix race condition between readiness and task functions worker message handling at startup.
454- Fix duplicate task function worker usage statistics computation per task function.
455- Update task function worker usage statistics if and only if there's at least two different task functions.
456- Fix race condition at task function worker usage executing task computation leading to negative value.
457
458### Added
459
460- 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).
461- Use back pressure detection in worker choice strategies.
462- Add worker choice strategies retries mechanism if no worker is eligible.
463
464## [2.6.28] - 2023-08-16
465
466### Fixed
467
468- Ensure pool workers are properly initialized.
469
470### Added
471
472- HTTP server pool examples: express-cluster, express-hybrid.
473
474### Changed
475
476- Remove now useless branching in worker hot code path.
477
478## [2.6.27] - 2023-08-15
479
480### Fixed
481
482- Add `KillHandler` type definition to exported types.
483
484### Added
485
486- Add `destroy` event to pool API.
487
488## [2.6.26] - 2023-08-15
489
490### Added
491
492- Add kill handler to worker options allowing to execute custom code when worker is killed.
493- Add `listTaskFunctions()` method to pool API.
494- SMTP client pool example: nodemailer.
495
496## [2.6.25] - 2023-08-13
497
498### Added
499
500- HTTP server pool examples: fastify-cluster, fastify-hybrid.
501- WebSocket server pool examples: ws-cluster, ws-hybrid.
502
503## [2.6.24] - 2023-08-12
504
505### Added
506
507- Add array of transferable objects to the `execute()` method arguments.
508- WebSocket server pool examples: ws-worker_threads.
509
510## [2.6.23] - 2023-08-11
511
512### Fixed
513
514- 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.
515
516### Added
517
518- HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
519- HTTP server pool examples: express-worker_threads, fastify-worker_threads.
520
521## [2.6.22] - 2023-08-10
522
523### Fixed
524
525- Add missing `types` field to package.json `exports`.
526
527### Changed
528
529- Structure markdown documentation (PR #811).
530
531## [2.6.21] - 2023-08-03
532
533### Changed
534
535- Improve code documentation.
536- Code refactoring and cleanup for better maintainability and readability.
537
538## [2.6.20] - 2023-07-21
539
540### Fixed
541
542- Fix queued tasks redistribution on error task execution starvation.
543- Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
544
545### Changed
546
547- Drastically reduce lookups by worker in the worker nodes.
548
549## [2.6.19] - 2023-07-20
550
551### Added
552
553- Dedicated internal communication channel for worker_threads pools.
554
555## [2.6.18] - 2023-07-19
556
557### Changed
558
559- Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
560
561## [2.6.17] - 2023-07-16
562
563### Added
564
565- Add `listTaskFunctions()` method to worker API.
566
567## [2.6.16] - 2023-07-12
568
569### Fixed
570
571- Fix pool startup detection.
572- Fix worker task functions handling.
573
574## [2.6.15] - 2023-07-11
575
576### Added
577
578- Take into account worker node readiness in worker choice strategies.
579
580## [2.6.14] - 2023-07-10
581
582### Fixed
583
584- Fix task function statistics tracking.
585
586## [2.6.13] - 2023-07-10
587
588### Added
589
590- Add per task function statistics tracking.
591- Add public methods to manipulate the worker task functions at runtime.
592
593## [2.6.12] - 2023-07-09
594
595### Fixed
596
597- Workaround import issue with `node:os` module in node 16.x.x.
598
599## [2.6.11] - 2023-07-09
600
601### Fixed
602
603- Fix pool readiness semantic.
604
605## [2.6.10] - 2023-07-08
606
607### Fixed
608
609- Ensure workers are not recreated on error at pool startup.
610
611### Added
612
613- Add `ready` and `strategy` fields to pool information.
614- Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
615- Add dynamic pool sizing checks.
616
617## [2.6.9] - 2023-07-07
618
619### Fixed
620
621- Recreate the right worker type on uncaught exception.
622
623### Added
624
625- Add minimum and maximum to internal measurement statistics.
626- Add `runTime` and `waitTime` to pool information.
627- Check worker inactive time only on dynamic worker.
628
629## [2.6.8] - 2023-07-03
630
631### Fixed
632
633- Brown paper bag release to fix version handling in pool information.
634
635## [2.6.7] - 2023-07-03
636
637### Fixed
638
639- Ensure worker queued tasks at error are reassigned to other pool workers.
640
641### Added
642
643- Add pool `utilization` ratio to pool information.
644- Add `version` to pool information.
645- Add worker information to worker nodes.
646
647## [2.6.6] - 2023-07-01
648
649### Added
650
651- Add safe helper `availableParallelism()` to help sizing the pool.
652
653### Fixed
654
655- Ensure message handler is only registered in worker.
656
657## [2.6.5] - 2023-06-27
658
659### Known issues
660
661- Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
662
663### Fixed
664
665- Artificial version bump to 2.6.5 to workaround publication issue.
666- Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
667- Ensure pool event is emitted before task error promise rejection.
668- Fix queued tasks count computation.
669
670### Removed
671
672- Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
673
674## [2.6.4] - 2023-06-27
675
676### Known issues
677
678- Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
679
680### Fixed
681
682- Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
683- Ensure pool event is emitted before task error promise rejection.
684- Fix queued tasks count computation.
685
686### Removed
687
688- Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
689
690## [2.6.3] - 2023-06-19
691
692### Fixed
693
694- Ensure no tasks are queued when trying to soft kill a dynamic worker.
695- Update strategies internals after statistics computation.
696
697### Changed
698
699- Optimize O(1) queue implementation.
700
701## [2.6.2] - 2023-06-12
702
703### Fixed
704
705- Fix new worker use after creation in dynamic pool given the current worker choice strategy.
706
707## [2.6.1] - 2023-06-10
708
709### Added
710
711- Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
712
713### Fixed
714
715- Fix average statistics computation: ensure failed tasks are not accounted.
716
717## [2.6.0] - 2023-06-09
718
719### Added
720
721- Add `LEAST_ELU` worker choice strategy (experimental).
722- Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
723
724### Changed
725
726- Refactor pool worker node usage internals.
727- Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
728- Breaking change: pool information `info` property object fields have been renamed.
729
730### Fixed
731
732- Fix wait time accounting.
733- Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
734- Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
735
736## [2.5.4] - 2023-06-07
737
738### Added
739
740- Add Event Loop Utilization (ELU) statistics to worker tasks usage.
741
742### Changed
743
744- Compute statistics at the worker level only if needed.
745- Add `worker_threads` options to thread pool options.
746
747### Fixed
748
749- Make the `LEAST_BUSY` strategy only relies on task runtime.
750
751## [2.5.3] - 2023-06-04
752
753### Changed
754
755- Refine pool information content.
756- Limit pool internals public exposure.
757
758## [2.5.2] - 2023-06-02
759
760### Added
761
762- Add `taskError` pool event for task execution error.
763- Add pool information `info` property to pool.
764- Emit pool information on `busy` and `full` pool events.
765
766## [2.5.1] - 2023-06-01
767
768### Added
769
770- Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
771- Add `error` pool event for uncaught worker error.
772
773## [2.5.0] - 2023-05-31
774
775### Added
776
777- Switch pool event emitter to `EventEmitterAsyncResource`.
778- Add tasks wait time accounting in per worker tasks usage.
779- Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
780
781### Changed
782
783- Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
784
785## [2.4.14] - 2023-05-09
786
787### Fixed
788
789- Ensure no undefined task runtime can land in the tasks history.
790- Fix median computation implementation once again.
791
792### Added
793
794- Unit tests for median and queue implementations.
795
796## [2.4.13] - 2023-05-08
797
798### Fixed
799
800- Fix worker choice strategy options validation.
801- Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
802
803## [2.4.12] - 2023-05-06
804
805### Added
806
807- Support multiple task functions per worker.
808- Add custom worker weights support to worker choice strategies options.
809
810### Changed
811
812- Use O(1) queue implementation for tasks queueing.
813
814### Fixed
815
816- Fix median computation implementation.
817- Fix fair share worker choice strategy internals update.
818
819## [2.4.11] - 2023-04-23
820
821### Changed
822
823- Optimize free worker finding in worker choice strategies.
824
825## [2.4.10] - 2023-04-15
826
827### Fixed
828
829- Fix typescript type definition for task function: ensure the input data is optional.
830- Fix typescript type definition for pool execute(): ensure the input data is optional.
831
832## [2.4.9] - 2023-04-15
833
834### Added
835
836- Add tasks queue enablement runtime setter to pool.
837- Add tasks queue options runtime setter to pool.
838- Add worker choice strategy options runtime setter to pool.
839
840### Changed
841
842- Remove the tasks queuing experimental status.
843
844### Fixed
845
846- Fix task function type definition and validation.
847- Fix worker choice strategy options handling.
848
849## [2.4.8] - 2023-04-12
850
851### Fixed
852
853- Fix message between main worker and worker type definition for tasks.
854- Fix code documentation.
855
856## [2.4.7] - 2023-04-11
857
858### Added
859
860- Add worker tasks queue options to pool options.
861
862### Fixed
863
864- Fix missing documentation.
865
866## [2.4.6] - 2023-04-10
867
868### Fixed
869
870- Ensure one task at a time is executed per worker with tasks queueing enabled.
871- Properly count worker executing tasks with tasks queueing enabled.
872
873## [2.4.5] - 2023-04-09
874
875### Added
876
877- Use monotonic high resolution timer for worker tasks runtime.
878- Add worker tasks median runtime to statistics.
879- Add worker tasks queue (experimental).
880
881## [2.4.4] - 2023-04-07
882
883### Added
884
885- Add `PoolEvents` enumeration and `PoolEvent` type.
886
887### Fixed
888
889- Destroy worker only on alive check.
890
891## [2.4.3] - 2023-04-07
892
893### Fixed
894
895- Fix typedoc generation with inheritance.
896
897## [2.4.2] - 2023-04-06
898
899### Added
900
901- Add `full` event to dynamic pool.
902- Keep worker choice strategy in memory for conditional reuse.
903
904### Fixed
905
906- Fix possible negative worker key at worker removal in worker choice strategies.
907
908## [2.4.1] - 2023-04-05
909
910### Changed
911
912- Optimize worker choice strategy for dynamic pool.
913
914### Fixed
915
916- Ensure dynamic pool does not alter worker choice strategy expected behavior.
917
918## [2.4.0] - 2023-04-04
919
920### Added
921
922- Add `LESS_BUSY` worker choice strategy.
923
924### Changed
925
926- Optimize worker storage in pool.
927- Optimize worker alive status check.
928- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
929- Optimize `LESS_USED` worker choice strategy.
930- Update benchmark versus external threads pools.
931- Optimize tasks usage statistics requirements for worker choice strategy.
932
933### Fixed
934
935- Ensure trimmable characters are checked at pool initialization.
936- Fix message id integer overflow.
937- Fix pool worker removal in worker choice strategy internals.
938- Fix package publication with pnpm.
939
940## [2.4.0-3] - 2023-04-04
941
942### Added
943
944- Add `LESS_BUSY` worker choice strategy.
945
946### Changed
947
948- Optimize worker storage in pool.
949- Optimize worker alive status check.
950- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
951- Optimize `LESS_USED` worker choice strategy.
952- Update benchmark versus external threads pools.
953
954### Fixed
955
956- Ensure trimmable characters are checked at pool initialization.
957- Fix message id integer overflow.
958- Fix pool worker removal in worker choice strategy internals.
959- Fix package publication with pnpm.
960
961## [2.4.0-2] - 2023-04-03
962
963### Added
964
965- Add `LESS_BUSY` worker choice strategy.
966
967### Changed
968
969- Optimize worker storage in pool.
970- Optimize worker alive status check.
971- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
972- Optimize `LESS_USED` worker choice strategy.
973
974### Fixed
975
976- Ensure trimmable characters are checked at pool initialization.
977- Fix message id integer overflow.
978- Fix pool worker removal in worker choice strategy internals.
979- Fix package publication with pnpm.
980
981## [2.4.0-1] - 2023-04-03
982
983### Added
984
985- Add `LESS_BUSY` worker choice strategy.
986
987### Changed
988
989- Optimize worker storage in pool.
990- Optimize worker alive status check.
991- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
992- Optimize `LESS_USED` worker choice strategy.
993
994### Fixed
995
996- Ensure trimmable characters are checked at pool initialization.
997- Fix message id integer overflow.
998- Fix pool worker removal in worker choice strategy internals.
999
1000## [2.4.0-0] - 2023-04-03
1001
1002### Added
1003
1004- Add `LESS_BUSY` worker choice strategy.
1005
1006### Changed
1007
1008- Optimize worker storage in pool.
1009- Optimize worker alive status check.
1010- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1011- Optimize `LESS_USED` worker choice strategy.
1012
1013### Fixed
1014
1015- Ensure trimmable characters are checked at pool initialization.
1016- Fix message id integer overflow.
1017- Fix pool worker removal in worker choice strategy internals.
1018
1019## [2.3.10] - 2023-03-18
1020
1021### Fixed
1022
1023- Fix package.json `exports` syntax for ESM and CommonJS.
1024
1025### Changed
1026
1027- Permit SemVer pre-release publication.
1028
1029## [2.3.10-2] - 2023-03-18
1030
1031### Fixed
1032
1033- Fix package.json `exports` syntax for ESM and CommonJS.
1034
1035## [2.3.10-1] - 2023-03-18
1036
1037### Changed
1038
1039- Permit SemVer pre-release publication.
1040
1041## [2.3.10-0] - 2023-03-18
1042
1043### Fixed
1044
1045- Fix package.json `exports` syntax for ESM and CommonJS.
1046
1047## [2.3.9] - 2023-03-18
1048
1049### Changed
1050
1051- Introduce ESM module support along with CommonJS one.
1052
1053### Fixed
1054
1055- Fix brown paper bag bug referencing the same object literal.
1056
1057## [2.3.8] - 2023-03-18
1058
1059### Changed
1060
1061- Switch internal benchmarking code to benny.
1062- Switch to TypeScript 5.x.x.
1063- Switch rollup bundler plugins to core ones.
1064- Switch to TSDoc syntax.
1065- Enforce conventional commits.
1066
1067### Fixed
1068
1069- Fix random integer generator.
1070- Fix worker choice strategy pool type identification at initialization.
1071
1072## [2.3.7] - 2022-10-23
1073
1074### Changed
1075
1076- Switch to open collective FOSS project funding platform.
1077- Switch to ts-standard linter configuration on TypeScript code.
1078
1079### Fixed
1080
1081- Fixed missing async on pool execute method.
1082- Fixed typing in TypeScript example.
1083- Fixed types in unit tests.
1084
1085## [2.3.6] - 2022-10-22
1086
1087### Changed
1088
1089- Cleanup pool attributes and methods.
1090- Refine error types thrown.
1091
1092### Fixed
1093
1094- Fix continuous integration build on windows.
1095- Fix code coverage reporting by using c8 instead of nyc.
1096
1097## [2.3.5] - 2022-10-21
1098
1099### Changed
1100
1101- Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
1102- Optimize tasks usage lookup implementation.
1103
1104### Fixed
1105
1106- Fix missed pool event emitter type export.
1107- Fix typedoc documentation generation.
1108
1109## [2.3.4] - 2022-10-17
1110
1111### Added
1112
1113- Fully automate release process with release-it.
1114
1115### Changed
1116
1117- Optimize fair share task scheduling algorithm implementation.
1118- Update benchmark versus external pools results with latest version.
1119
1120## [2.3.3] - 2022-10-15
1121
1122### Added
1123
1124- Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
1125
1126## [2.3.2] - 2022-10-14
1127
1128### Changed
1129
1130- Optimize fair share worker selection strategy implementation.
1131
1132### Fixed
1133
1134- Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
1135
1136## [2.3.1] - 2022-10-13
1137
1138### Added
1139
1140- Pool worker choice strategies:
1141 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
1142 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
1143
1144## [2.2.2] - 2022-10-09
1145
1146### Fixed
1147
1148- Fixed `README.md` file.
1149
1150## [2.2.1] - 2022-10-08
1151
1152### Added
1153
1154- Dynamic worker choice strategy change at runtime.
1155
1156## [2.2.0] - 2022-01-05
1157
1158### Breaking Changes
1159
1160- Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
1161
1162## [2.1.0] - 2021-08-29
1163
1164### Added
1165
1166- Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
1167
1168### Breaking Changes
1169
1170- `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
1171- `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
1172- `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
1173- `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
1174
1175## [2.0.2] - 2021-05-12
1176
1177### Bug fixes
1178
1179- Fix `busy` event emission on fixed pool type
1180
1181## [2.0.1] - 2021-03-16
1182
1183### Bug fixes
1184
1185- Check if pool options are properly set.
1186- `busy` event is emitted on all pool types.
1187
1188## [2.0.0] - 2021-03-01
1189
1190### Bug fixes
1191
1192- Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
1193
1194### Breaking Changes
1195
1196- `FullPool` event is now renamed to `busy`.
1197- `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1198 _Find more details on our JSDoc._
1199
1200- `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1201
1202- We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
1203
1204### Pool options types declaration merge
1205
1206`FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1207
1208#### New `export` strategy
1209
1210```js
1211// Before
1212const DynamicThreadPool = require('poolifier/lib/dynamic')
1213// After
1214const { DynamicThreadPool } = require('poolifier/lib/dynamic')
1215```
1216
1217But you should always prefer just using
1218
1219```js
1220const { DynamicThreadPool } = require('poolifier')
1221```
1222
1223#### New type definitions for input data and response
1224
1225For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
1226_This is not a limitation by poolifier but Node.js._
1227
1228#### Public property replacements
1229
1230`numWorkers` property is now `numberOfWorkers`
1231
1232#### Internal (protected) properties and methods renaming
1233
1234These properties are not intended for end users
1235
1236- `id` => `nextMessageId`
1237
1238These methods are not intended for end users
1239
1240- `_chooseWorker` => `chooseWorker`
1241- `_newWorker` => `createWorker`
1242- `_execute` => `internalExecute`
1243- `_chooseWorker` => `chooseWorker`
1244- `_checkAlive` => `checkAlive`
1245- `_run` => `run`
1246- `_runAsync` => `runAsync`
1247
1248## [1.1.0] - 2020-05-21
1249
1250### Added
1251
1252- ThreadWorker support async functions as option
1253- Various external library patches
1254
1255## [1.0.0] - 2020-01-24
1256
1257### Added
1258
1259- FixedThreadPool implementation
1260- DynamicThreadPool implementation
1261- WorkerThread implementation to improve developer experience