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