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