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