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