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