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