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