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).
10 ## [2.5.2] - 2023-06-02
14 - Add `taskError` pool event for task execution error.
15 - Add pool information `info` property to pool.
16 - Emit pool information on `busy` and `full` pool events.
18 ## [2.5.1] - 2023-06-01
22 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
23 - Add `error` pool event for uncaught worker error.
25 ## [2.5.0] - 2023-05-31
29 - Switch pool event emitter to `EventEmitterAsyncResource`.
30 - Add tasks wait time accounting in per worker tasks usage.
31 - Add interleaved weighted round robin worker choice strategy (experimental).
35 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
37 ## [2.4.14] - 2023-05-09
41 - Ensure no undefined task runtime can land in the tasks history.
42 - Fix median computation implementation once again.
46 - Unit tests for median and queue implementations.
48 ## [2.4.13] - 2023-05-08
52 - Fix worker choice strategy options validation.
53 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
55 ## [2.4.12] - 2023-05-06
59 - Support multiple task functions per worker.
60 - Add custom worker weights support to worker choice strategies options.
64 - Use O(1) queue implementation for tasks queueing.
68 - Fix median computation implementation.
69 - Fix fair share worker choice strategy internals update.
71 ## [2.4.11] - 2023-04-23
75 - Optimize free worker finding in worker choice strategies.
77 ## [2.4.10] - 2023-04-15
81 - Fix typescript type definition for worker function: ensure the input data is optional.
82 - Fix typescript type definition for pool execute(): ensure the input data is optional.
84 ## [2.4.9] - 2023-04-15
88 - Add tasks queue enablement runtime setter to pool.
89 - Add tasks queue options runtime setter to pool.
90 - Add worker choice strategy options runtime setter to pool.
94 - Remove the tasks queuing experimental status.
98 - Fix worker function type definition and validation.
99 - Fix worker choice strategy options handling.
101 ## [2.4.8] - 2023-04-12
105 - Fix message between main worker and worker type definition for tasks.
106 - Fix code documentation.
108 ## [2.4.7] - 2023-04-11
112 - Add worker tasks queue options to pool options.
116 - Fix missing documentation.
118 ## [2.4.6] - 2023-04-10
122 - Ensure one task at a time is executed per worker with tasks queueing enabled.
123 - Properly count worker running tasks with tasks queueing enabled.
125 ## [2.4.5] - 2023-04-09
129 - Use monotonic high resolution timer for worker tasks runtime.
130 - Add worker tasks median runtime to statistics.
131 - Add worker tasks queue (experimental).
133 ## [2.4.4] - 2023-04-07
137 - Add `PoolEvents` enumeration and `PoolEvent` type.
141 - Destroy worker only on alive check.
143 ## [2.4.3] - 2023-04-07
147 - Fix typedoc generation with inheritance.
149 ## [2.4.2] - 2023-04-06
153 - Add `full` event to dynamic pool.
154 - Keep worker choice strategy in memory for conditional reuse.
158 - Fix possible negative worker key at worker removal in worker choice strategies.
160 ## [2.4.1] - 2023-04-05
164 - Optimize worker choice strategy for dynamic pool.
168 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
170 ## [2.4.0] - 2023-04-04
174 - Add `LESS_BUSY` worker choice strategy.
178 - Optimize worker storage in pool.
179 - Optimize worker alive status check.
180 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
181 - Optimize `LESS_USED` worker choice strategy.
182 - Update benchmarks versus external threads pools.
183 - Optimize tasks usage statistics requirements for worker choice strategy.
187 - Ensure trimmable characters are checked at pool initialization.
188 - Fix message id integer overflow.
189 - Fix pool worker removal in worker choice strategy internals.
190 - Fix package publication with pnpm.
192 ## [2.4.0-3] - 2023-04-04
196 - Add `LESS_BUSY` worker choice strategy.
200 - Optimize worker storage in pool.
201 - Optimize worker alive status check.
202 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
203 - Optimize `LESS_USED` worker choice strategy.
204 - Update benchmarks versus external threads pools.
208 - Ensure trimmable characters are checked at pool initialization.
209 - Fix message id integer overflow.
210 - Fix pool worker removal in worker choice strategy internals.
211 - Fix package publication with pnpm.
213 ## [2.4.0-2] - 2023-04-03
217 - Add `LESS_BUSY` worker choice strategy.
221 - Optimize worker storage in pool.
222 - Optimize worker alive status check.
223 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
224 - Optimize `LESS_USED` worker choice strategy.
228 - Ensure trimmable characters are checked at pool initialization.
229 - Fix message id integer overflow.
230 - Fix pool worker removal in worker choice strategy internals.
231 - Fix package publication with pnpm.
233 ## [2.4.0-1] - 2023-04-03
237 - Add `LESS_BUSY` worker choice strategy.
241 - Optimize worker storage in pool.
242 - Optimize worker alive status check.
243 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
244 - Optimize `LESS_USED` worker choice strategy.
248 - Ensure trimmable characters are checked at pool initialization.
249 - Fix message id integer overflow.
250 - Fix pool worker removal in worker choice strategy internals.
252 ## [2.4.0-0] - 2023-04-03
256 - Add `LESS_BUSY` worker choice strategy.
260 - Optimize worker storage in pool.
261 - Optimize worker alive status check.
262 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
263 - Optimize `LESS_USED` worker choice strategy.
267 - Ensure trimmable characters are checked at pool initialization.
268 - Fix message id integer overflow.
269 - Fix pool worker removal in worker choice strategy internals.
271 ## [2.3.10] - 2023-03-18
275 - Fix `exports` syntax for ESM and CommonJS.
279 - Permit SemVer pre-release publication.
281 ## [2.3.10-2] - 2023-03-18
285 - Fix `exports` syntax for ESM and CommonJS.
287 ## [2.3.10-1] - 2023-03-18
291 - Permit SemVer pre-release publication.
293 ## [2.3.10-0] - 2023-03-18
297 - Fix `exports` syntax for ESM and CommonJS.
299 ## [2.3.9] - 2023-03-18
303 - Introduce ESM module support along with CommonJS one.
307 - Fix brown paper bag bug referencing the same object literal.
309 ## [2.3.8] - 2023-03-18
313 - Switch internal benchmarking code to benny.
314 - Switch to TypeScript 5.x.x.
315 - Switch rollup bundler plugins to core ones.
316 - Switch to TSDoc syntax.
317 - Enforce conventional commits.
321 - Fix random integer generator.
322 - Fix worker choice strategy pool type identification at initialization.
324 ## [2.3.7] - 2022-10-23
328 - Switch to open collective FOSS project funding platform.
329 - Switch to ts-standard linter configuration on TypeScript code.
333 - Fixed missing async on pool execute method.
334 - Fixed typing in TypeScript example.
335 - Fixed types in unit tests.
337 ## [2.3.6] - 2022-10-22
341 - Cleanup pool attributes and methods.
342 - Refine error types thrown.
346 - Fix continuous integration build on windows.
347 - Fix code coverage reporting by using c8 instead of nyc.
349 ## [2.3.5] - 2022-10-21
353 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
354 - Optimize tasks usage lookup implementation.
358 - Fix missed pool event emitter type export.
359 - Fix typedoc documentation generation.
361 ## [2.3.4] - 2022-10-17
365 - Fully automate release process with release-it.
369 - Optimize fair share task scheduling algorithm implementation.
370 - Update benchmarks versus external pools results with latest version.
372 ## [2.3.3] - 2022-10-15
376 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
378 ## [2.3.2] - 2022-10-14
382 - Optimize fair share worker selection strategy implementation.
386 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
388 ## [2.3.1] - 2022-10-13
392 - Pool worker choice strategies:
393 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
394 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
396 ## [2.2.2] - 2022-10-09
400 - Fixed `README.md` file.
402 ## [2.2.1] - 2022-10-08
406 - Dynamic worker choice strategy change at runtime.
408 ## [2.2.0] - 2022-01-05
412 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
414 ## [2.1.0] - 2021-08-29
418 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
422 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
423 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
424 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
425 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
427 ## [2.0.2] - 2021-05-12
431 - Fix `busy` event emission on fixed pool type
433 ## [2.0.1] - 2021-03-16
437 - Check if pool options are properly set.
438 - `busy` event is emitted on all pool types.
440 ## [2.0.0] - 2021-03-01
444 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
448 - `FullPool` event is now renamed to `busy`.
449 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
450 _Find more details on our JSDoc._
452 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
454 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
456 ### Pool options types declaration merge
458 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
460 #### New `export` strategy
464 const DynamicThreadPool = require('poolifier/lib/dynamic')
466 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
469 But you should always prefer just using
472 const { DynamicThreadPool } = require('poolifier')
475 #### New type definitions for input data and response
477 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
478 _This is not a limitation by poolifier but NodeJS._
480 #### Public property replacements
482 `numWorkers` property is now `numberOfWorkers`
484 #### Internal (protected) properties and methods renaming
486 These properties are not intended for end users
488 - `id` => `nextMessageId`
490 These methods are not intended for end users
492 - `_chooseWorker` => `chooseWorker`
493 - `_newWorker` => `createWorker`
494 - `_execute` => `internalExecute`
495 - `_chooseWorker` => `chooseWorker`
496 - `_checkAlive` => `checkAlive`
498 - `_runAsync` => `runAsync`
500 ## [1.1.0] - 2020-05-21
504 - ThreadWorker support async functions as option
505 - Various external library patches
507 ## [1.0.0] - 2020-01-24
511 - FixedThreadPool implementation
512 - DynamicThreadPool implementation
513 - WorkerThread implementation to improve developer experience