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.4.14] - 2023-05-09
14 - Ensure no undefined task runtime can land in the tasks history.
15 - Fix median computation implementation once again.
19 - Unit tests for median and queue implementations.
21 ## [2.4.13] - 2023-05-08
25 - Fix worker choice strategy options validation.
26 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
28 ## [2.4.12] - 2023-05-06
32 - Support multiple task functions per worker.
33 - Add custom worker weights support to worker choice strategies options.
37 - Use O(1) queue implementation for tasks queueing.
41 - Fix median computation implementation.
42 - Fix fair share worker choice strategy internals update.
44 ## [2.4.11] - 2023-04-23
48 - Optimize free worker finding in worker choice strategies.
50 ## [2.4.10] - 2023-04-15
54 - Fix typescript type definition for worker function: ensure the input data is optional.
55 - Fix typescript type definition for pool execute(): ensure the input data is optional.
57 ## [2.4.9] - 2023-04-15
61 - Add tasks queue enablement runtime setter to pool.
62 - Add tasks queue options runtime setter to pool.
63 - Add worker choice strategy options runtime setter to pool.
67 - Remove the tasks queuing experimental status.
71 - Fix worker function type definition and validation.
72 - Fix worker choice strategy options handling.
74 ## [2.4.8] - 2023-04-12
78 - Fix message between main worker and worker type definition for tasks.
79 - Fix code documentation.
81 ## [2.4.7] - 2023-04-11
85 - Add worker tasks queue options to pool options.
89 - Fix missing documentation.
91 ## [2.4.6] - 2023-04-10
95 - Ensure one task at a time is executed per worker with tasks queueing enabled.
96 - Properly count worker running tasks with tasks queueing enabled.
98 ## [2.4.5] - 2023-04-09
102 - Use monotonic high resolution timer for worker tasks runtime.
103 - Add worker tasks median runtime to statistics.
104 - Add worker tasks queue (experimental).
106 ## [2.4.4] - 2023-04-07
110 - Add `PoolEvents` enumeration and `PoolEvent` type.
114 - Destroy worker only on alive check.
116 ## [2.4.3] - 2023-04-07
120 - Fix typedoc generation with inheritance.
122 ## [2.4.2] - 2023-04-06
126 - Add `full` event to dynamic pool.
127 - Keep worker choice strategy in memory for conditional reuse.
131 - Fix possible negative worker key at worker removal in worker choice strategies.
133 ## [2.4.1] - 2023-04-05
137 - Optimize worker choice strategy for dynamic pool.
141 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
143 ## [2.4.0] - 2023-04-04
147 - Add `LESS_BUSY` worker choice strategy.
151 - Optimize worker storage in pool.
152 - Optimize worker alive status check.
153 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
154 - Optimize `LESS_USED` worker choice strategy.
155 - Update benchmarks versus external threads pools.
156 - Optimize tasks usage statistics requirements for worker choice strategy.
160 - Ensure trimmable characters are checked at pool initialization.
161 - Fix message id integer overflow.
162 - Fix pool worker removal in worker choice strategy internals.
163 - Fix package publication with pnpm.
165 ## [2.4.0-3] - 2023-04-04
169 - Add `LESS_BUSY` worker choice strategy.
173 - Optimize worker storage in pool.
174 - Optimize worker alive status check.
175 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
176 - Optimize `LESS_USED` worker choice strategy.
177 - Update benchmarks versus external threads pools.
181 - Ensure trimmable characters are checked at pool initialization.
182 - Fix message id integer overflow.
183 - Fix pool worker removal in worker choice strategy internals.
184 - Fix package publication with pnpm.
186 ## [2.4.0-2] - 2023-04-03
190 - Add `LESS_BUSY` worker choice strategy.
194 - Optimize worker storage in pool.
195 - Optimize worker alive status check.
196 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
197 - Optimize `LESS_USED` worker choice strategy.
201 - Ensure trimmable characters are checked at pool initialization.
202 - Fix message id integer overflow.
203 - Fix pool worker removal in worker choice strategy internals.
204 - Fix package publication with pnpm.
206 ## [2.4.0-1] - 2023-04-03
210 - Add `LESS_BUSY` worker choice strategy.
214 - Optimize worker storage in pool.
215 - Optimize worker alive status check.
216 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
217 - Optimize `LESS_USED` worker choice strategy.
221 - Ensure trimmable characters are checked at pool initialization.
222 - Fix message id integer overflow.
223 - Fix pool worker removal in worker choice strategy internals.
225 ## [2.4.0-0] - 2023-04-03
229 - Add `LESS_BUSY` worker choice strategy.
233 - Optimize worker storage in pool.
234 - Optimize worker alive status check.
235 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
236 - Optimize `LESS_USED` worker choice strategy.
240 - Ensure trimmable characters are checked at pool initialization.
241 - Fix message id integer overflow.
242 - Fix pool worker removal in worker choice strategy internals.
244 ## [2.3.10] - 2023-03-18
248 - Fix `exports` syntax for ESM and CommonJS.
252 - Permit SemVer pre-release publication.
254 ## [2.3.10-2] - 2023-03-18
258 - Fix `exports` syntax for ESM and CommonJS.
260 ## [2.3.10-1] - 2023-03-18
264 - Permit SemVer pre-release publication.
266 ## [2.3.10-0] - 2023-03-18
270 - Fix `exports` syntax for ESM and CommonJS.
272 ## [2.3.9] - 2023-03-18
276 - Introduce ESM module support along with CommonJS one.
280 - Fix brown paper bag bug referencing the same object literal.
282 ## [2.3.8] - 2023-03-18
286 - Switch internal benchmarking code to benny.
287 - Switch to TypeScript 5.x.x.
288 - Switch rollup bundler plugins to core ones.
289 - Switch to TSDoc syntax.
290 - Enforce conventional commits.
294 - Fix random integer generator.
295 - Fix worker choice strategy pool type identification at initialization.
297 ## [2.3.7] - 2022-10-23
301 - Switch to open collective FOSS project funding platform.
302 - Switch to ts-standard linter configuration on TypeScript code.
306 - Fixed missing async on pool execute method.
307 - Fixed typing in TypeScript example.
308 - Fixed types in unit tests.
310 ## [2.3.6] - 2022-10-22
314 - Cleanup pool attributes and methods.
315 - Refine error types thrown.
319 - Fix continuous integration build on windows.
320 - Fix code coverage reporting by using c8 instead of nyc.
322 ## [2.3.5] - 2022-10-21
326 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
327 - Optimize tasks usage lookup implementation.
331 - Fix missed pool event emitter type export.
332 - Fix typedoc documentation generation.
334 ## [2.3.4] - 2022-10-17
338 - Fully automate release process with release-it.
342 - Optimize fair share task scheduling algorithm implementation.
343 - Update benchmarks versus external pools results with latest version.
345 ## [2.3.3] - 2022-10-15
349 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
351 ## [2.3.2] - 2022-10-14
355 - Optimize fair share worker selection strategy implementation.
359 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
361 ## [2.3.1] - 2022-10-13
365 - Pool worker choice strategies:
366 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
367 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
369 ## [2.2.2] - 2022-10-09
373 - Fixed `README.md` file.
375 ## [2.2.1] - 2022-10-08
379 - Dynamic worker choice strategy change at runtime.
381 ## [2.2.0] - 2022-01-05
385 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
387 ## [2.1.0] - 2021-08-29
391 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
395 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
396 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
397 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
398 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
400 ## [2.0.2] - 2021-05-12
404 - Fix `busy` event emission on fixed pool type
406 ## [2.0.1] - 2021-03-16
410 - Check if pool options are properly set.
411 - `busy` event is emitted on all pool types.
413 ## [2.0.0] - 2021-03-01
417 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
421 - `FullPool` event is now renamed to `busy`.
422 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
423 _Find more details on our JSDoc._
425 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
427 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
429 ### Pool options types declaration merge
431 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
433 #### New `export` strategy
437 const DynamicThreadPool = require('poolifier/lib/dynamic')
439 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
442 But you should always prefer just using
445 const { DynamicThreadPool } = require('poolifier')
448 #### New type definitions for input data and response
450 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
451 _This is not a limitation by poolifier but NodeJS._
453 #### Public property replacements
455 `numWorkers` property is now `numberOfWorkers`
457 #### Internal (protected) properties and methods renaming
459 These properties are not intended for end users
461 - `id` => `nextMessageId`
463 These methods are not intended for end users
465 - `_chooseWorker` => `chooseWorker`
466 - `_newWorker` => `createWorker`
467 - `_execute` => `internalExecute`
468 - `_chooseWorker` => `chooseWorker`
469 - `_checkAlive` => `checkAlive`
471 - `_runAsync` => `runAsync`
473 ## [1.1.0] - 2020-05-21
477 - ThreadWorker support async functions as option
478 - Various external library patches
480 ## [1.0.0] - 2020-01-24
484 - FixedThreadPool implementation
485 - DynamicThreadPool implementation
486 - WorkerThread implementation to improve developer experience