3 All notable changes to this project will be documented in this file.
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).
12 - Ensure message handler is only registered in worker.
14 ## [2.6.5] - 2023-06-27
18 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
22 - Artificial version bump to 2.6.5 to workaround publication issue.
23 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
24 - Ensure pool event is emitted before task error promise rejection.
25 - Fix queued tasks count computation.
29 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
31 ## [2.6.4] - 2023-06-27
35 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
39 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
40 - Ensure pool event is emitted before task error promise rejection.
41 - Fix queued tasks count computation.
45 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
47 ## [2.6.3] - 2023-06-19
51 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
52 - Update strategies internals after statistics computation.
56 - Optimize O(1) queue implementation.
58 ## [2.6.2] - 2023-06-12
62 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
64 ## [2.6.1] - 2023-06-10
68 - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
72 - Fix average statistics computation: ensure failed tasks are not accounted.
74 ## [2.6.0] - 2023-06-09
78 - Add `LEAST_ELU` worker choice strategy (experimental).
79 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
83 - Refactor pool worker node usage internals.
84 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
85 - Breaking change: pool information `info` property object fields have been renamed.
89 - Fix wait time accounting.
90 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
91 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
93 ## [2.5.4] - 2023-06-07
97 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
101 - Compute statistics at the worker level only if needed.
102 - Add `worker-threads` options to thread pool options.
106 - Make the `LEAST_BUSY` strategy only relies on task runtime.
108 ## [2.5.3] - 2023-06-04
112 - Refine pool information content.
113 - Limit pool internals public exposure.
115 ## [2.5.2] - 2023-06-02
119 - Add `taskError` pool event for task execution error.
120 - Add pool information `info` property to pool.
121 - Emit pool information on `busy` and `full` pool events.
123 ## [2.5.1] - 2023-06-01
127 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
128 - Add `error` pool event for uncaught worker error.
130 ## [2.5.0] - 2023-05-31
134 - Switch pool event emitter to `EventEmitterAsyncResource`.
135 - Add tasks wait time accounting in per worker tasks usage.
136 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
140 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
142 ## [2.4.14] - 2023-05-09
146 - Ensure no undefined task runtime can land in the tasks history.
147 - Fix median computation implementation once again.
151 - Unit tests for median and queue implementations.
153 ## [2.4.13] - 2023-05-08
157 - Fix worker choice strategy options validation.
158 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
160 ## [2.4.12] - 2023-05-06
164 - Support multiple task functions per worker.
165 - Add custom worker weights support to worker choice strategies options.
169 - Use O(1) queue implementation for tasks queueing.
173 - Fix median computation implementation.
174 - Fix fair share worker choice strategy internals update.
176 ## [2.4.11] - 2023-04-23
180 - Optimize free worker finding in worker choice strategies.
182 ## [2.4.10] - 2023-04-15
186 - Fix typescript type definition for worker function: ensure the input data is optional.
187 - Fix typescript type definition for pool execute(): ensure the input data is optional.
189 ## [2.4.9] - 2023-04-15
193 - Add tasks queue enablement runtime setter to pool.
194 - Add tasks queue options runtime setter to pool.
195 - Add worker choice strategy options runtime setter to pool.
199 - Remove the tasks queuing experimental status.
203 - Fix worker function type definition and validation.
204 - Fix worker choice strategy options handling.
206 ## [2.4.8] - 2023-04-12
210 - Fix message between main worker and worker type definition for tasks.
211 - Fix code documentation.
213 ## [2.4.7] - 2023-04-11
217 - Add worker tasks queue options to pool options.
221 - Fix missing documentation.
223 ## [2.4.6] - 2023-04-10
227 - Ensure one task at a time is executed per worker with tasks queueing enabled.
228 - Properly count worker executing tasks with tasks queueing enabled.
230 ## [2.4.5] - 2023-04-09
234 - Use monotonic high resolution timer for worker tasks runtime.
235 - Add worker tasks median runtime to statistics.
236 - Add worker tasks queue (experimental).
238 ## [2.4.4] - 2023-04-07
242 - Add `PoolEvents` enumeration and `PoolEvent` type.
246 - Destroy worker only on alive check.
248 ## [2.4.3] - 2023-04-07
252 - Fix typedoc generation with inheritance.
254 ## [2.4.2] - 2023-04-06
258 - Add `full` event to dynamic pool.
259 - Keep worker choice strategy in memory for conditional reuse.
263 - Fix possible negative worker key at worker removal in worker choice strategies.
265 ## [2.4.1] - 2023-04-05
269 - Optimize worker choice strategy for dynamic pool.
273 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
275 ## [2.4.0] - 2023-04-04
279 - Add `LESS_BUSY` worker choice strategy.
283 - Optimize worker storage in pool.
284 - Optimize worker alive status check.
285 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
286 - Optimize `LESS_USED` worker choice strategy.
287 - Update benchmarks versus external threads pools.
288 - Optimize tasks usage statistics requirements for worker choice strategy.
292 - Ensure trimmable characters are checked at pool initialization.
293 - Fix message id integer overflow.
294 - Fix pool worker removal in worker choice strategy internals.
295 - Fix package publication with pnpm.
297 ## [2.4.0-3] - 2023-04-04
301 - Add `LESS_BUSY` worker choice strategy.
305 - Optimize worker storage in pool.
306 - Optimize worker alive status check.
307 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
308 - Optimize `LESS_USED` worker choice strategy.
309 - Update benchmarks versus external threads pools.
313 - Ensure trimmable characters are checked at pool initialization.
314 - Fix message id integer overflow.
315 - Fix pool worker removal in worker choice strategy internals.
316 - Fix package publication with pnpm.
318 ## [2.4.0-2] - 2023-04-03
322 - Add `LESS_BUSY` worker choice strategy.
326 - Optimize worker storage in pool.
327 - Optimize worker alive status check.
328 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
329 - Optimize `LESS_USED` worker choice strategy.
333 - Ensure trimmable characters are checked at pool initialization.
334 - Fix message id integer overflow.
335 - Fix pool worker removal in worker choice strategy internals.
336 - Fix package publication with pnpm.
338 ## [2.4.0-1] - 2023-04-03
342 - Add `LESS_BUSY` worker choice strategy.
346 - Optimize worker storage in pool.
347 - Optimize worker alive status check.
348 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
349 - Optimize `LESS_USED` worker choice strategy.
353 - Ensure trimmable characters are checked at pool initialization.
354 - Fix message id integer overflow.
355 - Fix pool worker removal in worker choice strategy internals.
357 ## [2.4.0-0] - 2023-04-03
361 - Add `LESS_BUSY` worker choice strategy.
365 - Optimize worker storage in pool.
366 - Optimize worker alive status check.
367 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
368 - Optimize `LESS_USED` worker choice strategy.
372 - Ensure trimmable characters are checked at pool initialization.
373 - Fix message id integer overflow.
374 - Fix pool worker removal in worker choice strategy internals.
376 ## [2.3.10] - 2023-03-18
380 - Fix `exports` syntax for ESM and CommonJS.
384 - Permit SemVer pre-release publication.
386 ## [2.3.10-2] - 2023-03-18
390 - Fix `exports` syntax for ESM and CommonJS.
392 ## [2.3.10-1] - 2023-03-18
396 - Permit SemVer pre-release publication.
398 ## [2.3.10-0] - 2023-03-18
402 - Fix `exports` syntax for ESM and CommonJS.
404 ## [2.3.9] - 2023-03-18
408 - Introduce ESM module support along with CommonJS one.
412 - Fix brown paper bag bug referencing the same object literal.
414 ## [2.3.8] - 2023-03-18
418 - Switch internal benchmarking code to benny.
419 - Switch to TypeScript 5.x.x.
420 - Switch rollup bundler plugins to core ones.
421 - Switch to TSDoc syntax.
422 - Enforce conventional commits.
426 - Fix random integer generator.
427 - Fix worker choice strategy pool type identification at initialization.
429 ## [2.3.7] - 2022-10-23
433 - Switch to open collective FOSS project funding platform.
434 - Switch to ts-standard linter configuration on TypeScript code.
438 - Fixed missing async on pool execute method.
439 - Fixed typing in TypeScript example.
440 - Fixed types in unit tests.
442 ## [2.3.6] - 2022-10-22
446 - Cleanup pool attributes and methods.
447 - Refine error types thrown.
451 - Fix continuous integration build on windows.
452 - Fix code coverage reporting by using c8 instead of nyc.
454 ## [2.3.5] - 2022-10-21
458 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
459 - Optimize tasks usage lookup implementation.
463 - Fix missed pool event emitter type export.
464 - Fix typedoc documentation generation.
466 ## [2.3.4] - 2022-10-17
470 - Fully automate release process with release-it.
474 - Optimize fair share task scheduling algorithm implementation.
475 - Update benchmarks versus external pools results with latest version.
477 ## [2.3.3] - 2022-10-15
481 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
483 ## [2.3.2] - 2022-10-14
487 - Optimize fair share worker selection strategy implementation.
491 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
493 ## [2.3.1] - 2022-10-13
497 - Pool worker choice strategies:
498 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
499 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
501 ## [2.2.2] - 2022-10-09
505 - Fixed `README.md` file.
507 ## [2.2.1] - 2022-10-08
511 - Dynamic worker choice strategy change at runtime.
513 ## [2.2.0] - 2022-01-05
517 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
519 ## [2.1.0] - 2021-08-29
523 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
527 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
528 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
529 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
530 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
532 ## [2.0.2] - 2021-05-12
536 - Fix `busy` event emission on fixed pool type
538 ## [2.0.1] - 2021-03-16
542 - Check if pool options are properly set.
543 - `busy` event is emitted on all pool types.
545 ## [2.0.0] - 2021-03-01
549 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
553 - `FullPool` event is now renamed to `busy`.
554 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
555 _Find more details on our JSDoc._
557 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
559 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
561 ### Pool options types declaration merge
563 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
565 #### New `export` strategy
569 const DynamicThreadPool = require('poolifier/lib/dynamic')
571 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
574 But you should always prefer just using
577 const { DynamicThreadPool } = require('poolifier')
580 #### New type definitions for input data and response
582 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
583 _This is not a limitation by poolifier but NodeJS._
585 #### Public property replacements
587 `numWorkers` property is now `numberOfWorkers`
589 #### Internal (protected) properties and methods renaming
591 These properties are not intended for end users
593 - `id` => `nextMessageId`
595 These methods are not intended for end users
597 - `_chooseWorker` => `chooseWorker`
598 - `_newWorker` => `createWorker`
599 - `_execute` => `internalExecute`
600 - `_chooseWorker` => `chooseWorker`
601 - `_checkAlive` => `checkAlive`
603 - `_runAsync` => `runAsync`
605 ## [1.1.0] - 2020-05-21
609 - ThreadWorker support async functions as option
610 - Various external library patches
612 ## [1.0.0] - 2020-01-24
616 - FixedThreadPool implementation
617 - DynamicThreadPool implementation
618 - WorkerThread implementation to improve developer experience