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