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