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