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.12] - 2023-05-06
14 - Support multiple task functions per worker.
15 - Add custom worker weights support to worker choice strategies options.
19 - Use O(1) queue implementation for tasks queueing.
23 - Fix median computation implementation.
24 - Fix fair share worker choice strategy internals update.
26 ## [2.4.11] - 2023-04-23
30 - Optimize free worker finding in worker choice strategies.
32 ## [2.4.10] - 2023-04-15
36 - Fix typescript type definition for worker function: ensure the input data is optional.
37 - Fix typescript type definition for pool execute(): ensure the input data is optional.
39 ## [2.4.9] - 2023-04-15
43 - Add tasks queue enablement runtime setter to pool.
44 - Add tasks queue options runtime setter to pool.
45 - Add worker choice strategy options runtime setter to pool.
49 - Remove the tasks queuing experimental status.
53 - Fix worker function type definition and validation.
54 - Fix worker choice strategy options handling.
56 ## [2.4.8] - 2023-04-12
60 - Fix message between main worker and worker type definition for tasks.
61 - Fix code documentation.
63 ## [2.4.7] - 2023-04-11
67 - Add worker tasks queue options to pool options.
71 - Fix missing documentation.
73 ## [2.4.6] - 2023-04-10
77 - Ensure one task at a time is executed per worker with tasks queueing enabled.
78 - Properly count worker running tasks with tasks queueing enabled.
80 ## [2.4.5] - 2023-04-09
84 - Use monotonic high resolution timer for worker tasks run time.
85 - Add worker tasks median run time to statistics.
86 - Add worker tasks queue (experimental).
88 ## [2.4.4] - 2023-04-07
92 - Add `PoolEvents` enumeration and `PoolEvent` type.
96 - Destroy worker only on alive check.
98 ## [2.4.3] - 2023-04-07
102 - Fix typedoc generation with inheritance.
104 ## [2.4.2] - 2023-04-06
108 - Add `full` event to dynamic pool.
109 - Keep worker choice strategy in memory for conditional reuse.
113 - Fix possible negative worker key at worker removal in worker choice strategies.
115 ## [2.4.1] - 2023-04-05
119 - Optimize worker choice strategy for dynamic pool.
123 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
125 ## [2.4.0] - 2023-04-04
129 - Add `LESS_BUSY` worker choice strategy.
133 - Optimize worker storage in pool.
134 - Optimize worker alive status check.
135 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
136 - Optimize `LESS_USED` worker choice strategy.
137 - Update benchmarks versus external threads pools.
138 - Optimize tasks usage statistics requirements for worker choice strategy.
142 - Ensure trimmable characters are checked at pool initialization.
143 - Fix message id integer overflow.
144 - Fix pool worker removal in worker choice strategy internals.
145 - Fix package publication with pnpm.
147 ## [2.4.0-3] - 2023-04-04
151 - Add `LESS_BUSY` worker choice strategy.
155 - Optimize worker storage in pool.
156 - Optimize worker alive status check.
157 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
158 - Optimize `LESS_USED` worker choice strategy.
159 - Update benchmarks versus external threads pools.
163 - Ensure trimmable characters are checked at pool initialization.
164 - Fix message id integer overflow.
165 - Fix pool worker removal in worker choice strategy internals.
166 - Fix package publication with pnpm.
168 ## [2.4.0-2] - 2023-04-03
172 - Add `LESS_BUSY` worker choice strategy.
176 - Optimize worker storage in pool.
177 - Optimize worker alive status check.
178 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
179 - Optimize `LESS_USED` worker choice strategy.
183 - Ensure trimmable characters are checked at pool initialization.
184 - Fix message id integer overflow.
185 - Fix pool worker removal in worker choice strategy internals.
186 - Fix package publication with pnpm.
188 ## [2.4.0-1] - 2023-04-03
192 - Add `LESS_BUSY` worker choice strategy.
196 - Optimize worker storage in pool.
197 - Optimize worker alive status check.
198 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
199 - Optimize `LESS_USED` worker choice strategy.
203 - Ensure trimmable characters are checked at pool initialization.
204 - Fix message id integer overflow.
205 - Fix pool worker removal in worker choice strategy internals.
207 ## [2.4.0-0] - 2023-04-03
211 - Add `LESS_BUSY` worker choice strategy.
215 - Optimize worker storage in pool.
216 - Optimize worker alive status check.
217 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
218 - Optimize `LESS_USED` worker choice strategy.
222 - Ensure trimmable characters are checked at pool initialization.
223 - Fix message id integer overflow.
224 - Fix pool worker removal in worker choice strategy internals.
226 ## [2.3.10] - 2023-03-18
230 - Fix `exports` syntax for ESM and CommonJS.
234 - Permit SemVer pre-release publication.
236 ## [2.3.10-2] - 2023-03-18
240 - Fix `exports` syntax for ESM and CommonJS.
242 ## [2.3.10-1] - 2023-03-18
246 - Permit SemVer pre-release publication.
248 ## [2.3.10-0] - 2023-03-18
252 - Fix `exports` syntax for ESM and CommonJS.
254 ## [2.3.9] - 2023-03-18
258 - Introduce ESM module support along with CommonJS one.
262 - Fix brown paper bag bug referencing the same object literal.
264 ## [2.3.8] - 2023-03-18
268 - Switch internal benchmarking code to benny.
269 - Switch to TypeScript 5.x.x.
270 - Switch rollup bundler plugins to core ones.
271 - Switch to TSDoc syntax.
272 - Enforce conventional commits.
276 - Fix random integer generator.
277 - Fix worker choice strategy pool type identification at initialization.
279 ## [2.3.7] - 2022-10-23
283 - Switch to open collective FOSS project funding platform.
284 - Switch to ts-standard linter configuration on TypeScript code.
288 - Fixed missing async on pool execute method.
289 - Fixed typing in TypeScript example.
290 - Fixed types in unit tests.
292 ## [2.3.6] - 2022-10-22
296 - Cleanup pool attributes and methods.
297 - Refine error types thrown.
301 - Fix continuous integration build on windows.
302 - Fix code coverage reporting by using c8 instead of nyc.
304 ## [2.3.5] - 2022-10-21
308 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
309 - Optimize tasks usage lookup implementation.
313 - Fix missed pool event emitter type export.
314 - Fix typedoc documentation generation.
316 ## [2.3.4] - 2022-10-17
320 - Fully automate release process with release-it.
324 - Optimize fair share task scheduling algorithm implementation.
325 - Update benchmarks versus external pools results with latest version.
327 ## [2.3.3] - 2022-10-15
331 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
333 ## [2.3.2] - 2022-10-14
337 - Optimize fair share worker selection strategy implementation.
341 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
343 ## [2.3.1] - 2022-10-13
347 - Pool worker choice strategies:
348 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
349 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
351 ## [2.2.2] - 2022-10-09
355 - Fixed `README.md` file.
357 ## [2.2.1] - 2022-10-08
361 - Dynamic worker choice strategy change at runtime.
363 ## [2.2.0] - 2022-01-05
367 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
369 ## [2.1.0] - 2021-08-29
373 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
377 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
378 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
379 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
380 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
382 ## [2.0.2] - 2021-05-12
386 - Fix `busy` event emission on fixed pool type
388 ## [2.0.1] - 2021-03-16
392 - Check if pool options are properly set.
393 - `busy` event is emitted on all pool types.
395 ## [2.0.0] - 2021-03-01
399 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
403 - `FullPool` event is now renamed to `busy`.
404 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
405 _Find more details on our JSDoc._
407 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
409 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
411 ### Pool options types declaration merge
413 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
415 #### New `export` strategy
419 const DynamicThreadPool = require('poolifier/lib/dynamic')
421 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
424 But you should always prefer just using
427 const { DynamicThreadPool } = require('poolifier')
430 #### New type definitions for input data and response
432 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
433 _This is not a limitation by poolifier but NodeJS._
435 #### Public property replacements
437 `numWorkers` property is now `numberOfWorkers`
439 #### Internal (protected) properties and methods renaming
441 These properties are not intended for end users
443 - `id` => `nextMessageId`
445 These methods are not intended for end users
447 - `_chooseWorker` => `chooseWorker`
448 - `_newWorker` => `createWorker`
449 - `_execute` => `internalExecute`
450 - `_chooseWorker` => `chooseWorker`
451 - `_checkAlive` => `checkAlive`
453 - `_runAsync` => `runAsync`
455 ## [1.1.0] - 2020-05-21
459 - ThreadWorker support async functions as option
460 - Various external library patches
462 ## [1.0.0] - 2020-01-24
466 - FixedThreadPool implementation
467 - DynamicThreadPool implementation
468 - WorkerThread implementation to improve developer experience