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