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