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