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.6.7] - 2023-07-03
14 - Ensure worker queued tasks at error are reassigned to other pool workers.
18 - Add pool `utilization` ratio to pool information.
19 - Add `version` to pool information.
20 - Add worker information to worker nodes.
22 ## [2.6.6] - 2023-07-01
26 - Add safe helper `availableParallelism` to help sizing the pool.
30 - Ensure message handler is only registered in worker.
32 ## [2.6.5] - 2023-06-27
36 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
40 - Artificial version bump to 2.6.5 to workaround publication issue.
41 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
42 - Ensure pool event is emitted before task error promise rejection.
43 - Fix queued tasks count computation.
47 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
49 ## [2.6.4] - 2023-06-27
53 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
57 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
58 - Ensure pool event is emitted before task error promise rejection.
59 - Fix queued tasks count computation.
63 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
65 ## [2.6.3] - 2023-06-19
69 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
70 - Update strategies internals after statistics computation.
74 - Optimize O(1) queue implementation.
76 ## [2.6.2] - 2023-06-12
80 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
82 ## [2.6.1] - 2023-06-10
86 - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
90 - Fix average statistics computation: ensure failed tasks are not accounted.
92 ## [2.6.0] - 2023-06-09
96 - Add `LEAST_ELU` worker choice strategy (experimental).
97 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
101 - Refactor pool worker node usage internals.
102 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
103 - Breaking change: pool information `info` property object fields have been renamed.
107 - Fix wait time accounting.
108 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
109 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
111 ## [2.5.4] - 2023-06-07
115 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
119 - Compute statistics at the worker level only if needed.
120 - Add `worker-threads` options to thread pool options.
124 - Make the `LEAST_BUSY` strategy only relies on task runtime.
126 ## [2.5.3] - 2023-06-04
130 - Refine pool information content.
131 - Limit pool internals public exposure.
133 ## [2.5.2] - 2023-06-02
137 - Add `taskError` pool event for task execution error.
138 - Add pool information `info` property to pool.
139 - Emit pool information on `busy` and `full` pool events.
141 ## [2.5.1] - 2023-06-01
145 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
146 - Add `error` pool event for uncaught worker error.
148 ## [2.5.0] - 2023-05-31
152 - Switch pool event emitter to `EventEmitterAsyncResource`.
153 - Add tasks wait time accounting in per worker tasks usage.
154 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
158 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
160 ## [2.4.14] - 2023-05-09
164 - Ensure no undefined task runtime can land in the tasks history.
165 - Fix median computation implementation once again.
169 - Unit tests for median and queue implementations.
171 ## [2.4.13] - 2023-05-08
175 - Fix worker choice strategy options validation.
176 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
178 ## [2.4.12] - 2023-05-06
182 - Support multiple task functions per worker.
183 - Add custom worker weights support to worker choice strategies options.
187 - Use O(1) queue implementation for tasks queueing.
191 - Fix median computation implementation.
192 - Fix fair share worker choice strategy internals update.
194 ## [2.4.11] - 2023-04-23
198 - Optimize free worker finding in worker choice strategies.
200 ## [2.4.10] - 2023-04-15
204 - Fix typescript type definition for worker function: ensure the input data is optional.
205 - Fix typescript type definition for pool execute(): ensure the input data is optional.
207 ## [2.4.9] - 2023-04-15
211 - Add tasks queue enablement runtime setter to pool.
212 - Add tasks queue options runtime setter to pool.
213 - Add worker choice strategy options runtime setter to pool.
217 - Remove the tasks queuing experimental status.
221 - Fix worker function type definition and validation.
222 - Fix worker choice strategy options handling.
224 ## [2.4.8] - 2023-04-12
228 - Fix message between main worker and worker type definition for tasks.
229 - Fix code documentation.
231 ## [2.4.7] - 2023-04-11
235 - Add worker tasks queue options to pool options.
239 - Fix missing documentation.
241 ## [2.4.6] - 2023-04-10
245 - Ensure one task at a time is executed per worker with tasks queueing enabled.
246 - Properly count worker executing tasks with tasks queueing enabled.
248 ## [2.4.5] - 2023-04-09
252 - Use monotonic high resolution timer for worker tasks runtime.
253 - Add worker tasks median runtime to statistics.
254 - Add worker tasks queue (experimental).
256 ## [2.4.4] - 2023-04-07
260 - Add `PoolEvents` enumeration and `PoolEvent` type.
264 - Destroy worker only on alive check.
266 ## [2.4.3] - 2023-04-07
270 - Fix typedoc generation with inheritance.
272 ## [2.4.2] - 2023-04-06
276 - Add `full` event to dynamic pool.
277 - Keep worker choice strategy in memory for conditional reuse.
281 - Fix possible negative worker key at worker removal in worker choice strategies.
283 ## [2.4.1] - 2023-04-05
287 - Optimize worker choice strategy for dynamic pool.
291 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
293 ## [2.4.0] - 2023-04-04
297 - Add `LESS_BUSY` worker choice strategy.
301 - Optimize worker storage in pool.
302 - Optimize worker alive status check.
303 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
304 - Optimize `LESS_USED` worker choice strategy.
305 - Update benchmarks versus external threads pools.
306 - Optimize tasks usage statistics requirements for worker choice strategy.
310 - Ensure trimmable characters are checked at pool initialization.
311 - Fix message id integer overflow.
312 - Fix pool worker removal in worker choice strategy internals.
313 - Fix package publication with pnpm.
315 ## [2.4.0-3] - 2023-04-04
319 - Add `LESS_BUSY` worker choice strategy.
323 - Optimize worker storage in pool.
324 - Optimize worker alive status check.
325 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
326 - Optimize `LESS_USED` worker choice strategy.
327 - Update benchmarks versus external threads pools.
331 - Ensure trimmable characters are checked at pool initialization.
332 - Fix message id integer overflow.
333 - Fix pool worker removal in worker choice strategy internals.
334 - Fix package publication with pnpm.
336 ## [2.4.0-2] - 2023-04-03
340 - Add `LESS_BUSY` worker choice strategy.
344 - Optimize worker storage in pool.
345 - Optimize worker alive status check.
346 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
347 - Optimize `LESS_USED` worker choice strategy.
351 - Ensure trimmable characters are checked at pool initialization.
352 - Fix message id integer overflow.
353 - Fix pool worker removal in worker choice strategy internals.
354 - Fix package publication with pnpm.
356 ## [2.4.0-1] - 2023-04-03
360 - Add `LESS_BUSY` worker choice strategy.
364 - Optimize worker storage in pool.
365 - Optimize worker alive status check.
366 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
367 - Optimize `LESS_USED` worker choice strategy.
371 - Ensure trimmable characters are checked at pool initialization.
372 - Fix message id integer overflow.
373 - Fix pool worker removal in worker choice strategy internals.
375 ## [2.4.0-0] - 2023-04-03
379 - Add `LESS_BUSY` worker choice strategy.
383 - Optimize worker storage in pool.
384 - Optimize worker alive status check.
385 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
386 - Optimize `LESS_USED` worker choice strategy.
390 - Ensure trimmable characters are checked at pool initialization.
391 - Fix message id integer overflow.
392 - Fix pool worker removal in worker choice strategy internals.
394 ## [2.3.10] - 2023-03-18
398 - Fix `exports` syntax for ESM and CommonJS.
402 - Permit SemVer pre-release publication.
404 ## [2.3.10-2] - 2023-03-18
408 - Fix `exports` syntax for ESM and CommonJS.
410 ## [2.3.10-1] - 2023-03-18
414 - Permit SemVer pre-release publication.
416 ## [2.3.10-0] - 2023-03-18
420 - Fix `exports` syntax for ESM and CommonJS.
422 ## [2.3.9] - 2023-03-18
426 - Introduce ESM module support along with CommonJS one.
430 - Fix brown paper bag bug referencing the same object literal.
432 ## [2.3.8] - 2023-03-18
436 - Switch internal benchmarking code to benny.
437 - Switch to TypeScript 5.x.x.
438 - Switch rollup bundler plugins to core ones.
439 - Switch to TSDoc syntax.
440 - Enforce conventional commits.
444 - Fix random integer generator.
445 - Fix worker choice strategy pool type identification at initialization.
447 ## [2.3.7] - 2022-10-23
451 - Switch to open collective FOSS project funding platform.
452 - Switch to ts-standard linter configuration on TypeScript code.
456 - Fixed missing async on pool execute method.
457 - Fixed typing in TypeScript example.
458 - Fixed types in unit tests.
460 ## [2.3.6] - 2022-10-22
464 - Cleanup pool attributes and methods.
465 - Refine error types thrown.
469 - Fix continuous integration build on windows.
470 - Fix code coverage reporting by using c8 instead of nyc.
472 ## [2.3.5] - 2022-10-21
476 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
477 - Optimize tasks usage lookup implementation.
481 - Fix missed pool event emitter type export.
482 - Fix typedoc documentation generation.
484 ## [2.3.4] - 2022-10-17
488 - Fully automate release process with release-it.
492 - Optimize fair share task scheduling algorithm implementation.
493 - Update benchmarks versus external pools results with latest version.
495 ## [2.3.3] - 2022-10-15
499 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
501 ## [2.3.2] - 2022-10-14
505 - Optimize fair share worker selection strategy implementation.
509 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
511 ## [2.3.1] - 2022-10-13
515 - Pool worker choice strategies:
516 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
517 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
519 ## [2.2.2] - 2022-10-09
523 - Fixed `README.md` file.
525 ## [2.2.1] - 2022-10-08
529 - Dynamic worker choice strategy change at runtime.
531 ## [2.2.0] - 2022-01-05
535 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
537 ## [2.1.0] - 2021-08-29
541 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
545 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
546 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
547 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
548 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
550 ## [2.0.2] - 2021-05-12
554 - Fix `busy` event emission on fixed pool type
556 ## [2.0.1] - 2021-03-16
560 - Check if pool options are properly set.
561 - `busy` event is emitted on all pool types.
563 ## [2.0.0] - 2021-03-01
567 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
571 - `FullPool` event is now renamed to `busy`.
572 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
573 _Find more details on our JSDoc._
575 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
577 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
579 ### Pool options types declaration merge
581 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
583 #### New `export` strategy
587 const DynamicThreadPool = require('poolifier/lib/dynamic')
589 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
592 But you should always prefer just using
595 const { DynamicThreadPool } = require('poolifier')
598 #### New type definitions for input data and response
600 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
601 _This is not a limitation by poolifier but NodeJS._
603 #### Public property replacements
605 `numWorkers` property is now `numberOfWorkers`
607 #### Internal (protected) properties and methods renaming
609 These properties are not intended for end users
611 - `id` => `nextMessageId`
613 These methods are not intended for end users
615 - `_chooseWorker` => `chooseWorker`
616 - `_newWorker` => `createWorker`
617 - `_execute` => `internalExecute`
618 - `_chooseWorker` => `chooseWorker`
619 - `_checkAlive` => `checkAlive`
621 - `_runAsync` => `runAsync`
623 ## [1.1.0] - 2020-05-21
627 - ThreadWorker support async functions as option
628 - Various external library patches
630 ## [1.0.0] - 2020-01-24
634 - FixedThreadPool implementation
635 - DynamicThreadPool implementation
636 - WorkerThread implementation to improve developer experience