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