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