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