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