fix: avoid null exception at sending message to worker
[poolifier.git] / CHANGELOG.md
CommitLineData
522eea03 1# Changelog
2
3All notable changes to this project will be documented in this file.
4
d4abc60a 5The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
522eea03 6and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
45a5a54c
JB
8## [Unreleased]
9
9761e404
JB
10### Fixed
11
12- Avoid null exception at sending message to worker.
13
358dc40f
JB
14## [3.0.2] - 2023-10-17
15
97256a85
JB
16### Fixed
17
c3c2b35e 18- Fix race condition at dynamic worker node task assignment and scheduled removal. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468) and [#1496](https://github.com/poolifier/poolifier/issues/1496).
97256a85 19
7a570743
JB
20## [3.0.1] - 2023-10-16
21
dbfa7948
JB
22### Fixed
23
fc84edac 24- Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
dbfa7948 25
365f13e4
JB
26### Changed
27
c3c2b35e 28- Switch the worker node eventing code to `EventTarget` API.
365f13e4 29
003b3275
JB
30## [3.0.0] - 2023-10-08
31
277c49bf
JB
32### Changed
33
34- Remove Node.js 16.x.x (EOL) support.
35
3c9e911a
JB
36## [2.7.5] - 2023-10-03
37
f80125ca
JB
38### Changed
39
40- Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
41
3466e757
JB
42## [2.7.4] - 2023-09-25
43
67b26ae2
JB
44### Fixed
45
46- Fix source maps (bundler issue).
47
eeb1f961
JB
48## [2.7.3] - 2023-09-24
49
b5604034
JB
50### Changed
51
52- Convert pool event emitter to event emitter async resource.
53
f2df6dc8
JB
54## [2.7.2] - 2023-09-23
55
116ca64b
JB
56### Changed
57
58- Add source maps to npm package to ease debugging.
59
1e319a70
JB
60### Added
61
62- Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
63
aab2819b
JB
64## [2.7.1] - 2023-09-20
65
ae036c3e
JB
66### Fixed
67
68- Ensure worker message listener used one time are removed after usage.
69
15d7c489
JB
70## [2.7.0] - 2023-09-19
71
160557ff
JB
72### Fixed
73
74- Fix task stealing related tasks queue options handling at runtime.
75
c3284191
JB
76### Changed
77
78- Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
79
80### Added
81
35808931 82- Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
c20084b6 83- Stricter worker constructor arguments validation.
c3284191 84
04054352
JB
85## [2.6.45] - 2023-09-17
86
093af25b
JB
87### Changed
88
89- Disable publication on GitHub packages registry on release until authentication issue is fixed.
09d9af02
JB
90
91### Added
92
ce0ab2d7 93- Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
cde5b54e 94- Add `start()` method to pool API to start the minimum number of workers.
af98b972 95- Add `taskStealing` and `tasksStealingOnPressure` to tasks queue options to whether enable task stealing or not and whether enable tasks stealing under back pressure or not.
1e319a70 96- Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
f1c674cd 97
bce9ffdf
JB
98## [2.6.44] - 2023-09-08
99
4cb259d3
JB
100### Fixed
101
102- Use a dedicated PAT to publish on GitHub packages registry.
103
104### Added
105
106- Publish on GitHub packages registry on release.
107
108### Changed
109
110- Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
111
fbda1e26
JB
112## [2.6.43] - 2023-09-08
113
15fc82ba
JB
114### Added
115
4cb259d3 116- Publish on GitHub packages registry on release.
15fc82ba
JB
117
118### Changed
119
4cb259d3 120- Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
15fc82ba 121
b47306a3
JB
122## [2.6.42] - 2023-09-06
123
ad11ca81
JB
124### Changed
125
126- Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
127
1b37751d
JB
128## [2.6.41] - 2023-09-03
129
f3a91bac
JB
130### Changed
131
132- Optimize worker choice strategies implementation.
133
7790a494
JB
134## [2.6.40] - 2023-09-01
135
6fe200b4
JB
136### Fixed
137
138- Do not pre-choose in WRR worker choice strategy to avoid bias.
68738842 139- Avoid array out of bound in worker choice strategies after worker node removal.
6fe200b4 140
766c7f84
JB
141## [2.6.39] - 2023-08-30
142
edf8ce4e
JB
143### Fixed
144
4cb259d3 145- Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
edf8ce4e 146
904a5689
JB
147## [2.6.38] - 2023-08-30
148
b40c4b06
JB
149### Added
150
151- Bundle typescript types declaration into one file.
152
619f403b
JB
153### Changed
154
155- Improve interleaved weighted round robin worker choice strategy implementation.
156
5a24d71c
JB
157## [2.6.37] - 2023-08-28
158
bdb9d712
JB
159### Fixed
160
161- Ensure unused worker usage statistics are deleted at runtime.
162
8c0b113f
JB
163### Changed
164
165- Rename worker choice strategy options `choiceRetries` to `retries`.
574c5c8d 166- Avoid unnecessary branching in worker choice strategies.
8c0b113f 167
ba821940
JB
168## [2.6.36] - 2023-08-27
169
9d2d0da1
JB
170### Fixed
171
172- Fix pool `execute()` arguments check.
173
1f0766e7
JB
174### Changed
175
176- Make continuous tasks stealing algorithm less aggressive.
8780236f 177- Fine tune tasks stealing algorithm under back pressure.
1f0766e7 178
ffd2c1ff
JB
179## [2.6.35] - 2023-08-25
180
dc021bcc
JB
181### Fixed
182
183- Don't account worker usage statistics for tasks that have failed.
3baa0837 184- Fix pool information runtime and wait time median computation.
dc021bcc
JB
185
186### Changed
187
188- Update simple moving average implementation to use a circular buffer.
189- Update simple moving median implementation to use a circular buffer.
68cbdc84
JB
190- Account for stolen tasks in worker usage statistics and pool information.
191
192### Added
193
194- Continuous tasks stealing algorithm.
dc021bcc 195
c58bc2a1
JB
196## [2.6.34] - 2023-08-24
197
0bc68267
JB
198### Fixes
199
200- Avoid cascading tasks stealing under back pressure.
201
202### Changed
203
204- Add fastpath to queued tasks rescheduling.
205
39fb7ad0
JB
206## [2.6.33] - 2023-08-24
207
dd951876
JB
208### Fixed
209
210- Fix queued tasks rescheduling.
211
ff3f866a
JB
212### Changed
213
214- Rename tasks queue options `queueMaxSize` to `size`.
215
a6b3272b 216### Added
dd951876 217
a6b3272b 218- Task stealing scheduling algorithm if tasks queueing is enabled.
dd951876 219
c55c9b5d
JB
220## [2.6.32] - 2023-08-23
221
15b176e0
JB
222### Fixed
223
224- Ensure no task can be executed when the pool is destroyed.
225
20c6f652
JB
226### Added
227
228- Add `queueMaxSize` option to tasks queue options.
574b351d 229- Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
72695f86 230- Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
20c6f652 231
e560a9f2
JB
232## [2.6.31] - 2023-08-20
233
b1aae695
JB
234### Fixed
235
3e8611a8 236- Fix worker choice strategy retries mechanism in some edge cases.
b1aae695 237
94407def
JB
238### Changed
239
e695d66f 240- Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
a71b05bc 241- Remove the experimental status of the `LEAST_ELU` worker choice strategy.
94407def 242
962b9863
JB
243## [2.6.30] - 2023-08-19
244
33e6bb4c
JB
245### Fixed
246
247- Ensure pool event `backPressure` is emitted.
248- Ensure pool event `full` is emitted only once.
8735b4e5 249- Ensure worker node cannot be instantiated without proper arguments.
33e6bb4c 250
8cc4ea81
JB
251## [2.6.29] - 2023-08-18
252
6169563b
JB
253### Fixed
254
255- Fix race condition between ready and task functions worker message handling at startup.
5dd4043c 256- Fix duplicate task function worker usage statistics computation per task function.
db0e38ee 257- Update task function worker usage statistics if and only if there's at least two different task functions.
5bb5be17 258- Fix race condition at task function worker usage executing task computation leading to negative value.
6169563b 259
8990357d
JB
260### Added
261
445264e8 262- 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).
8990357d
JB
263- Use back pressure detection in worker choice strategies.
264- Add worker choice strategies retries mechanism if no worker is eligible.
265
21157987
JB
266## [2.6.28] - 2023-08-16
267
f05ed93c
JB
268### Fixed
269
270- Ensure pool workers are properly initialized.
271
12d67776
JB
272### Added
273
274- HTTP server pool examples: express-cluster, express-hybrid.
275
d18fccb1
JB
276### Changed
277
278- Remove now useless branching in worker hot code path.
279
741cdb34
JB
280## [2.6.27] - 2023-08-15
281
50e7f498
JB
282### Fixed
283
284- Add `KillHandler` type definition to exported types.
285
ef3891a3
JB
286### Added
287
288- Add `destroy` event to pool API.
289
e9dc6efa
JB
290## [2.6.26] - 2023-08-15
291
2b099bf7
JB
292### Added
293
294- Add kill handler to worker options allowing to execute custom code when worker is killed.
ef3891a3 295- Add `listTaskFunctions()` method to pool API.
1f4553c6 296- SMTP client pool example: nodemailer.
2b099bf7 297
5b726f72
JB
298## [2.6.25] - 2023-08-13
299
72855e92
JB
300### Added
301
3b311539 302- HTTP server pool examples: fastify-cluster, fastify-hybrid.
02999424 303- WebSocket server pool examples: ws-cluster, ws-hybrid.
72855e92 304
7aadd6e5
JB
305## [2.6.24] - 2023-08-12
306
7d91a8cd
JB
307### Added
308
309- Add array of transferable objects to the `execute()` method arguments.
02999424 310- WebSocket server pool examples: ws-worker_threads.
7d91a8cd 311
6b4263b4
JB
312## [2.6.23] - 2023-08-11
313
3d76750a 314### Fixed
8e0af894 315
3d76750a 316- 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.
9606b474 317
3d76750a
JB
318### Added
319
320- HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
02999424 321- HTTP server pool examples: express-worker_threads, fastify-worker_threads.
3d76750a
JB
322
323## [2.6.22] - 2023-08-10
9606b474 324
3d76750a 325### Fixed
9606b474
JB
326
327- Add missing `types` field to package.json `exports`.
328
3d76750a
JB
329### Changed
330
331- Structure markdown documentation (PR #811).
332
d9647bdd
JB
333## [2.6.21] - 2023-08-03
334
2111ec12
JB
335### Changed
336
337- Improve code documentation.
338- Code refactoring and cleanup for better maintainability and readability.
339
5c30b9d9
JB
340## [2.6.20] - 2023-07-21
341
10ecf8fd
JB
342### Fixed
343
344- Fix queued tasks redistribution on error task execution starvation.
a1763c54 345- Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
10ecf8fd 346
aa9eede8
JB
347### Changed
348
7c89e6a4 349- Drastically reduce lookups by worker in the worker nodes.
aa9eede8 350
62485908
JB
351## [2.6.19] - 2023-07-20
352
2e2ef9c3
JB
353### Added
354
355- Dedicated internal communication channel for worker_threads pools.
356
8f4c9491
JB
357## [2.6.18] - 2023-07-19
358
8660b972
JB
359### Changed
360
361- Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
362
206a3519
JB
363## [2.6.17] - 2023-07-16
364
b4899fae
JB
365### Added
366
1a3e01ba 367- Add `listTaskFunctions()` method to worker API.
b4899fae 368
58a06a6c
JB
369## [2.6.16] - 2023-07-12
370
2a69b8c5
JB
371### Fixed
372
80520ca4 373- Fix pool startup detection.
2a69b8c5
JB
374- Fix worker task functions handling.
375
b5900b02
JB
376## [2.6.15] - 2023-07-11
377
19dbc45b
JB
378### Added
379
380- Take into account worker node readiness in worker choice strategies.
381
4a0db581
JB
382## [2.6.14] - 2023-07-10
383
87e44747
JB
384### Fixed
385
386- Fix task function statistics tracking.
387
0265272f
JB
388## [2.6.13] - 2023-07-10
389
968a2e8c
JB
390### Added
391
392- Add per task function statistics tracking.
782299f8 393- Add public methods to manipulate the worker task functions at runtime.
968a2e8c 394
44c8c00f
JB
395## [2.6.12] - 2023-07-09
396
aa4bf4b2
JB
397### Fixed
398
399- Workaround import issue with `node:os` module in node 16.x.x.
400
b7cfced1
JB
401## [2.6.11] - 2023-07-09
402
d5024c00
JB
403### Fixed
404
405- Fix pool readiness semantic.
406
f313a208
JB
407## [2.6.10] - 2023-07-08
408
2431bdb4
JB
409### Fixed
410
411- Ensure workers are not recreated on error at pool startup.
412
413### Added
414
415- Add `ready` and `strategy` fields to pool information.
416- Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
caadbd41 417- Add dynamic pool sizing checks.
2431bdb4 418
369d0a51
JB
419## [2.6.9] - 2023-07-07
420
2845f2a5
JB
421### Fixed
422
423- Recreate the right worker type on uncaught exception.
424
425### Added
426
427- Add minimum and maximum to internal measurement statistics.
1dcf8b7b 428- Add `runTime` and `waitTime` to pool information.
75d3401a 429- Check worker inactive time only on dynamic worker.
2845f2a5 430
fc97d613
JB
431## [2.6.8] - 2023-07-03
432
92b1feaa
JB
433### Fixed
434
435- Brown paper bag release to fix version handling in pool information.
436
52d54060
JB
437## [2.6.7] - 2023-07-03
438
5bc91f3e
JB
439### Fixed
440
441- Ensure worker queued tasks at error are reassigned to other pool workers.
442
afe0d5bf
JB
443### Added
444
445- Add pool `utilization` ratio to pool information.
23ccf9d7 446- Add `version` to pool information.
e5b3047d 447- Add worker information to worker nodes.
afe0d5bf 448
f42c583f
JB
449## [2.6.6] - 2023-07-01
450
6961ca9a
JB
451### Added
452
d5e3c4ff 453- Add safe helper `availableParallelism()` to help sizing the pool.
6961ca9a 454
3749facb
JB
455### Fixed
456
457- Ensure message handler is only registered in worker.
458
6fed2513
JB
459## [2.6.5] - 2023-06-27
460
c72f6987
JB
461### Known issues
462
70726c28 463- Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
c72f6987
JB
464
465### Fixed
466
467- Artificial version bump to 2.6.5 to workaround publication issue.
d5e3c4ff 468- Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
c72f6987
JB
469- Ensure pool event is emitted before task error promise rejection.
470- Fix queued tasks count computation.
471
472### Removed
473
2fbe1783 474- Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
c72f6987 475
6426631b
JB
476## [2.6.4] - 2023-06-27
477
941f9a7c
JB
478### Known issues
479
70726c28 480- Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
941f9a7c 481
2c039e43
JB
482### Fixed
483
d5e3c4ff 484- Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
2c039e43 485- Ensure pool event is emitted before task error promise rejection.
9c16fb4b 486- Fix queued tasks count computation.
2c039e43 487
941f9a7c
JB
488### Removed
489
2fbe1783 490- Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
941f9a7c 491
bc1b0765
JB
492## [2.6.3] - 2023-06-19
493
a6a2dc4c
JB
494### Fixed
495
496- Ensure no tasks are queued when trying to soft kill a dynamic worker.
f0d7f803 497- Update strategies internals after statistics computation.
a6a2dc4c 498
7b56f532
JB
499### Changed
500
501- Optimize O(1) queue implementation.
502
b628596c
JB
503## [2.6.2] - 2023-06-12
504
a9e89d00
JB
505### Fixed
506
507- Fix new worker use after creation in dynamic pool given the current worker choice strategy.
508
4368a898
JB
509## [2.6.1] - 2023-06-10
510
931d43e2
JB
511### Added
512
13ab5b87 513- Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
931d43e2 514
f1c06930
JB
515### Fixed
516
517- Fix average statistics computation: ensure failed tasks are not accounted.
518
16671b07
JB
519## [2.6.0] - 2023-06-09
520
a1347286
JB
521### Added
522
5af9c0f7 523- Add `LEAST_ELU` worker choice strategy (experimental).
9adcefab 524- Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
a1347286 525
1c6fe997
JB
526### Changed
527
528- Refactor pool worker node usage internals.
477f48e7 529- Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
f63a9dda 530- Breaking change: pool information `info` property object fields have been renamed.
1c6fe997
JB
531
532### Fixed
533
534- Fix wait time accounting.
535- Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
536- Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
537
aa07d6ee
JB
538## [2.5.4] - 2023-06-07
539
b6b32453
JB
540### Added
541
542- Add Event Loop Utilization (ELU) statistics to worker tasks usage.
543
544### Changed
545
546- Compute statistics at the worker level only if needed.
2fbe1783 547- Add `worker_threads` options to thread pool options.
b6b32453 548
272d4d8f
JB
549### Fixed
550
551- Make the `LEAST_BUSY` strategy only relies on task runtime.
552
ed47fb3d
JB
553## [2.5.3] - 2023-06-04
554
89a4abfd
JB
555### Changed
556
557- Refine pool information content.
b4213b7f 558- Limit pool internals public exposure.
89a4abfd 559
8a9febf5
JB
560## [2.5.2] - 2023-06-02
561
91ee39ed
JB
562### Added
563
564- Add `taskError` pool event for task execution error.
6b27d407 565- Add pool information `info` property to pool.
91ee39ed
JB
566- Emit pool information on `busy` and `full` pool events.
567
8babb151
JB
568## [2.5.1] - 2023-06-01
569
0e05c4dc
JB
570### Added
571
1f68cede 572- Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
91ee39ed 573- Add `error` pool event for uncaught worker error.
0e05c4dc 574
a8766181
JB
575## [2.5.0] - 2023-05-31
576
e4543b14
JB
577### Added
578
579- Switch pool event emitter to `EventEmitterAsyncResource`.
6da80d38 580- Add tasks wait time accounting in per worker tasks usage.
5af9c0f7 581- Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
e4543b14
JB
582
583### Changed
584
585- Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
586
570efb11
JB
587## [2.4.14] - 2023-05-09
588
b0f28bad
JB
589### Fixed
590
591- Ensure no undefined task runtime can land in the tasks history.
592- Fix median computation implementation once again.
593
110b6d13
JB
594### Added
595
596- Unit tests for median and queue implementations.
597
72584880
JB
598## [2.4.13] - 2023-05-08
599
b0d6ed8f
JB
600### Fixed
601
e3058615 602- Fix worker choice strategy options validation.
b0d6ed8f
JB
603- Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
604
06140c32
JB
605## [2.4.12] - 2023-05-06
606
a86b6df1
JB
607### Added
608
609- Support multiple task functions per worker.
08f3f44c 610- Add custom worker weights support to worker choice strategies options.
a86b6df1 611
29ee7e9a
JB
612### Changed
613
614- Use O(1) queue implementation for tasks queueing.
615
0682ba15
JB
616### Fixed
617
618- Fix median computation implementation.
619- Fix fair share worker choice strategy internals update.
620
936d53ec
JB
621## [2.4.11] - 2023-04-23
622
cb70b19d
JB
623### Changed
624
625- Optimize free worker finding in worker choice strategies.
626
15bb637a
JB
627## [2.4.10] - 2023-04-15
628
ef41a6e6
JB
629### Fixed
630
82ea6492 631- Fix typescript type definition for task function: ensure the input data is optional.
ef41a6e6
JB
632- Fix typescript type definition for pool execute(): ensure the input data is optional.
633
181eb2b4
JB
634## [2.4.9] - 2023-04-15
635
a20f0ba5
JB
636### Added
637
638- Add tasks queue enablement runtime setter to pool.
639- Add tasks queue options runtime setter to pool.
640- Add worker choice strategy options runtime setter to pool.
641
642### Changed
643
644- Remove the tasks queuing experimental status.
645
d4aeae5a
JB
646### Fixed
647
82ea6492 648- Fix task function type definition and validation.
2fc5cae3 649- Fix worker choice strategy options handling.
d4aeae5a 650
1d9e7023
JB
651## [2.4.8] - 2023-04-12
652
f9b4bbf8
JB
653### Fixed
654
655- Fix message between main worker and worker type definition for tasks.
656- Fix code documentation.
657
12ae3210
JB
658## [2.4.7] - 2023-04-11
659
7171d33f
JB
660### Added
661
662- Add worker tasks queue options to pool options.
663
e8bd29ce
JB
664### Fixed
665
666- Fix missing documentation.
667
42c7bc10
JB
668## [2.4.6] - 2023-04-10
669
681196cc
JB
670### Fixed
671
672- Ensure one task at a time is executed per worker with tasks queueing enabled.
1c6fe997 673- Properly count worker executing tasks with tasks queueing enabled.
681196cc 674
54d360e3
JB
675## [2.4.5] - 2023-04-09
676
3fafb1b2
JB
677### Added
678
9e775f96
JB
679- Use monotonic high resolution timer for worker tasks runtime.
680- Add worker tasks median runtime to statistics.
ff733df7 681- Add worker tasks queue (experimental).
3fafb1b2 682
92fa3eb6
JB
683## [2.4.4] - 2023-04-07
684
aee46736
JB
685### Added
686
687- Add `PoolEvents` enumeration and `PoolEvent` type.
688
36b5e78f
JB
689### Fixed
690
ff0c2b3e 691- Destroy worker only on alive check.
36b5e78f 692
9fb0f324
JB
693## [2.4.3] - 2023-04-07
694
28cf3617
JB
695### Fixed
696
697- Fix typedoc generation with inheritance.
698
848f0f27
JB
699## [2.4.2] - 2023-04-06
700
164d950a
JB
701### Added
702
703- Add `full` event to dynamic pool.
32417142 704- Keep worker choice strategy in memory for conditional reuse.
164d950a 705
78ab2555
JB
706### Fixed
707
708- Fix possible negative worker key at worker removal in worker choice strategies.
709
79aafe9f
JB
710## [2.4.1] - 2023-04-05
711
9cd39dd4
JB
712### Changed
713
714- Optimize worker choice strategy for dynamic pool.
715
965415bb
JB
716### Fixed
717
718- Ensure dynamic pool does not alter worker choice strategy expected behavior.
719
d8b60b1c
JB
720## [2.4.0] - 2023-04-04
721
c6bd2650
JB
722### Added
723
724- Add `LESS_BUSY` worker choice strategy.
725
726### Changed
727
728- Optimize worker storage in pool.
729- Optimize worker alive status check.
730- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
731- Optimize `LESS_USED` worker choice strategy.
2a87030e 732- Update benchmark versus external threads pools.
c6bd2650
JB
733- Optimize tasks usage statistics requirements for worker choice strategy.
734
735### Fixed
736
737- Ensure trimmable characters are checked at pool initialization.
738- Fix message id integer overflow.
739- Fix pool worker removal in worker choice strategy internals.
740- Fix package publication with pnpm.
741
d0a3f018
JB
742## [2.4.0-3] - 2023-04-04
743
b2ede285
JB
744### Added
745
746- Add `LESS_BUSY` worker choice strategy.
747
748### Changed
749
750- Optimize worker storage in pool.
751- Optimize worker alive status check.
752- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
753- Optimize `LESS_USED` worker choice strategy.
2a87030e 754- Update benchmark versus external threads pools.
b2ede285
JB
755
756### Fixed
757
758- Ensure trimmable characters are checked at pool initialization.
759- Fix message id integer overflow.
760- Fix pool worker removal in worker choice strategy internals.
761- Fix package publication with pnpm.
762
a015ea40
JB
763## [2.4.0-2] - 2023-04-03
764
698f4bbc
JB
765### Added
766
767- Add `LESS_BUSY` worker choice strategy.
768
769### Changed
770
771- Optimize worker storage in pool.
772- Optimize worker alive status check.
773- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
774- Optimize `LESS_USED` worker choice strategy.
775
776### Fixed
777
778- Ensure trimmable characters are checked at pool initialization.
779- Fix message id integer overflow.
780- Fix pool worker removal in worker choice strategy internals.
781- Fix package publication with pnpm.
782
8fe15920
JB
783## [2.4.0-1] - 2023-04-03
784
5b301c28
JB
785### Added
786
787- Add `LESS_BUSY` worker choice strategy.
788
789### Changed
790
791- Optimize worker storage in pool.
792- Optimize worker alive status check.
793- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
794- Optimize `LESS_USED` worker choice strategy.
795
796### Fixed
797
798- Ensure trimmable characters are checked at pool initialization.
799- Fix message id integer overflow.
800- Fix pool worker removal in worker choice strategy internals.
801
2fb9ca9c
JB
802## [2.4.0-0] - 2023-04-03
803
168c526f
JB
804### Added
805
806- Add `LESS_BUSY` worker choice strategy.
807
1d71a908
JB
808### Changed
809
ffcbbad8 810- Optimize worker storage in pool.
1d71a908 811- Optimize worker alive status check.
65a60b3b 812- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
737c6d97 813- Optimize `LESS_USED` worker choice strategy.
1d71a908 814
ffcbbad8
JB
815### Fixed
816
817- Ensure trimmable characters are checked at pool initialization.
b4e75778 818- Fix message id integer overflow.
97a2abc3 819- Fix pool worker removal in worker choice strategy internals.
ffcbbad8 820
08372738
JB
821## [2.3.10] - 2023-03-18
822
710826bc
JB
823### Fixed
824
9606b474 825- Fix package.json `exports` syntax for ESM and CommonJS.
710826bc
JB
826
827### Changed
828
829- Permit SemVer pre-release publication.
76e5ac6f 830
e4796ecd
JB
831## [2.3.10-2] - 2023-03-18
832
6abad580
JB
833### Fixed
834
9606b474 835- Fix package.json `exports` syntax for ESM and CommonJS.
6abad580 836
a2ee98cc
JB
837## [2.3.10-1] - 2023-03-18
838
7e060cee
JB
839### Changed
840
90483887 841- Permit SemVer pre-release publication.
7e060cee 842
c81bfafb
JB
843## [2.3.10-0] - 2023-03-18
844
fe18768d
JB
845### Fixed
846
9606b474 847- Fix package.json `exports` syntax for ESM and CommonJS.
fe18768d 848
d7b78217
JB
849## [2.3.9] - 2023-03-18
850
ed6dd37f
JB
851### Changed
852
853- Introduce ESM module support along with CommonJS one.
854
855### Fixed
856
857- Fix brown paper bag bug referencing the same object literal.
858
68e2ad86
JB
859## [2.3.8] - 2023-03-18
860
ca6c7d70
JB
861### Changed
862
863- Switch internal benchmarking code to benny.
fbdedeb9
JB
864- Switch to TypeScript 5.x.x.
865- Switch rollup bundler plugins to core ones.
ed6dd37f 866- Switch to TSDoc syntax.
fbdedeb9 867- Enforce conventional commits.
ca6c7d70 868
d15211d4
JB
869### Fixed
870
871- Fix random integer generator.
fbdedeb9 872- Fix worker choice strategy pool type identification at initialization.
d15211d4 873
995705ea
JB
874## [2.3.7] - 2022-10-23
875
b953022b
JB
876### Changed
877
878- Switch to open collective FOSS project funding platform.
78cea37e
JB
879- Switch to ts-standard linter configuration on TypeScript code.
880
881### Fixed
882
883- Fixed missing async on pool execute method.
884- Fixed typing in TypeScript example.
885- Fixed types in unit tests.
b953022b 886
3b9f6953
JB
887## [2.3.6] - 2022-10-22
888
f80cead4
JB
889### Changed
890
891- Cleanup pool attributes and methods.
892- Refine error types thrown.
893
894### Fixed
895
896- Fix continuous integration build on windows.
897- Fix code coverage reporting by using c8 instead of nyc.
898
efc22107
JB
899## [2.3.5] - 2022-10-21
900
7a6a0a96
JB
901### Changed
902
a05c10de
JB
903- Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
904- Optimize tasks usage lookup implementation.
7a6a0a96 905
b4904890
JB
906### Fixed
907
908- Fix missed pool event emitter type export.
909- Fix typedoc documentation generation.
910
a875f8d1
JB
911## [2.3.4] - 2022-10-17
912
73cda448
JB
913### Added
914
915- Fully automate release process with release-it.
916
45a5a54c
JB
917### Changed
918
73cda448 919- Optimize fair share task scheduling algorithm implementation.
2a87030e 920- Update benchmark versus external pools results with latest version.
45a5a54c 921
90ee1b18 922## [2.3.3] - 2022-10-15
1a76932b
JB
923
924### Added
925
926- Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
927
90ee1b18 928## [2.3.2] - 2022-10-14
11df3590
JB
929
930### Changed
931
932- Optimize fair share worker selection strategy implementation.
933
934### Fixed
935
936- Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
937
90ee1b18 938## [2.3.1] - 2022-10-13
23ff945a
JB
939
940### Added
941
942- Pool worker choice strategies:
943 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
944 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
945
90ee1b18 946## [2.2.2] - 2022-10-09
cb2b6c69
JB
947
948### Fixed
949
950- Fixed `README.md` file.
951
90ee1b18 952## [2.2.1] - 2022-10-08
bdacc2d2 953
bdaf31cd
JB
954### Added
955
956- Dynamic worker choice strategy change at runtime.
bdacc2d2 957
90ee1b18 958## [2.2.0] - 2022-01-05
7e0d447f
JB
959
960### Breaking Changes
961
9606b474 962- Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
7e0d447f 963
90ee1b18 964## [2.1.0] - 2021-08-29
35cf1c03
JB
965
966### Added
967
968- Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
e088a00c
JB
969
970### Breaking Changes
971
972- `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
973- `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
974- `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
c365b2d3 975- `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
e088a00c 976
90ee1b18 977## [2.0.2] - 2021-05-12
14916bf9
JB
978
979### Bug fixes
980
981- Fix `busy` event emission on fixed pool type
982
90ee1b18 983## [2.0.1] - 2021-03-16
7f685093
JB
984
985### Bug fixes
986
987- Check if pool options are properly set.
988- `busy` event is emitted on all pool types.
989
90ee1b18 990## [2.0.0] - 2021-03-01
fa0f5b28 991
f3f833ab 992### Bug fixes
d63d3be3 993
ddbeaffd 994- Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
d63d3be3 995
fa0f5b28
S
996### Breaking Changes
997
7f685093 998- `FullPool` event is now renamed to `busy`.
1927ee67 999- `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1a81f8af 1000 _Find more details on our JSDoc._
ddbeaffd 1001
1927ee67
APA
1002- `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1003
ddbeaffd 1004- We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
fa0f5b28 1005
ec2ccfc8
JB
1006### Pool options types declaration merge
1007
1008`FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1009
fa0f5b28
S
1010#### New `export` strategy
1011
1012```js
1013// Before
0eee77cb 1014const DynamicThreadPool = require('poolifier/lib/dynamic')
fa0f5b28 1015// After
0eee77cb 1016const { DynamicThreadPool } = require('poolifier/lib/dynamic')
fa0f5b28
S
1017```
1018
1019But you should always prefer just using
1020
1021```js
0eee77cb 1022const { DynamicThreadPool } = require('poolifier')
fa0f5b28
S
1023```
1024
d3c8a1a8
S
1025#### New type definitions for input data and response
1026
6677a3d3 1027For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
9606b474 1028_This is not a limitation by poolifier but Node.js._
d3c8a1a8 1029
3a4b605f 1030#### Public property replacements
5c5a1fb7 1031
3a4b605f 1032`numWorkers` property is now `numberOfWorkers`
5c5a1fb7 1033
280c2a77 1034#### Internal (protected) properties and methods renaming
fa0f5b28 1035
280c2a77
S
1036These properties are not intended for end users
1037
1038- `id` => `nextMessageId`
1039
1040These methods are not intended for end users
fa0f5b28
S
1041
1042- `_chooseWorker` => `chooseWorker`
280c2a77 1043- `_newWorker` => `createWorker`
fa0f5b28
S
1044- `_execute` => `internalExecute`
1045- `_chooseWorker` => `chooseWorker`
1046- `_checkAlive` => `checkAlive`
1047- `_run` => `run`
1048- `_runAsync` => `runAsync`
1049
90ee1b18 1050## [1.1.0] - 2020-05-21
0312f71a
APA
1051
1052### Added
1053
1054- ThreadWorker support async functions as option
cf9aa6c3 1055- Various external library patches
0312f71a 1056
90ee1b18 1057## [1.0.0] - 2020-01-24
522eea03 1058
1059### Added
1060
1061- FixedThreadPool implementation
1062- DynamicThreadPool implementation
0312f71a 1063- WorkerThread implementation to improve developer experience