X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=CHANGELOG.md;h=94ddcdf97388917855a63ed3cac2a60bf4fe99ab;hb=2e2ef9c39a37f5d32bfaf75b7cfe886aac69d8cb;hp=df8b21748db1adfc47f03b6281bcc32c2fdc2cbc;hpb=324171427be5e610ad6f0a9d7fd180db1a8bf991;p=poolifier.git

diff --git a/CHANGELOG.md b/CHANGELOG.md
index df8b2174..0e7f83ae 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -9,6 +9,354 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Dedicated internal communication channel for worker_threads pools.
+
+## [2.6.18] - 2023-07-19
+
+### Changed
+
+- Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
+
+## [2.6.17] - 2023-07-16
+
+### Added
+
+- Add `listTaskFunctions()` method to worker class.
+
+## [2.6.16] - 2023-07-12
+
+### Fixed
+
+- Fix pool startup detection.
+- Fix worker task functions handling.
+
+## [2.6.15] - 2023-07-11
+
+### Added
+
+- Take into account worker node readiness in worker choice strategies.
+
+## [2.6.14] - 2023-07-10
+
+### Fixed
+
+- Fix task function statistics tracking.
+
+## [2.6.13] - 2023-07-10
+
+### Added
+
+- Add per task function statistics tracking.
+- Add public methods to manipulate the worker task functions at runtime.
+
+## [2.6.12] - 2023-07-09
+
+### Fixed
+
+- Workaround import issue with `node:os` module in node 16.x.x.
+
+## [2.6.11] - 2023-07-09
+
+### Fixed
+
+- Fix pool readiness semantic.
+
+## [2.6.10] - 2023-07-08
+
+### Fixed
+
+- Ensure workers are not recreated on error at pool startup.
+
+### Added
+
+- Add `ready` and `strategy` fields to pool information.
+- Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
+- Add dynamic pool sizing checks.
+
+## [2.6.9] - 2023-07-07
+
+### Fixed
+
+- Recreate the right worker type on uncaught exception.
+
+### Added
+
+- Add minimum and maximum to internal measurement statistics.
+- Add `runTime` and `waitTime` to pool information.
+- Check worker inactive time only on dynamic worker.
+
+## [2.6.8] - 2023-07-03
+
+### Fixed
+
+- Brown paper bag release to fix version handling in pool information.
+
+## [2.6.7] - 2023-07-03
+
+### Fixed
+
+- Ensure worker queued tasks at error are reassigned to other pool workers.
+
+### Added
+
+- Add pool `utilization` ratio to pool information.
+- Add `version` to pool information.
+- Add worker information to worker nodes.
+
+## [2.6.6] - 2023-07-01
+
+### Added
+
+- Add safe helper `availableParallelism` to help sizing the pool.
+
+### Fixed
+
+- Ensure message handler is only registered in worker.
+
+## [2.6.5] - 2023-06-27
+
+### Known issues
+
+- Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
+
+### Fixed
+
+- Artificial version bump to 2.6.5 to workaround publication issue.
+- Ensure cluster pool destroy() gracefully shutdowns worker's server.
+- Ensure pool event is emitted before task error promise rejection.
+- Fix queued tasks count computation.
+
+### Removed
+
+- Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
+
+## [2.6.4] - 2023-06-27
+
+### Known issues
+
+- Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
+
+### Fixed
+
+- Ensure cluster pool destroy() gracefully shutdowns worker's server.
+- Ensure pool event is emitted before task error promise rejection.
+- Fix queued tasks count computation.
+
+### Removed
+
+- Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
+
+## [2.6.3] - 2023-06-19
+
+### Fixed
+
+- Ensure no tasks are queued when trying to soft kill a dynamic worker.
+- Update strategies internals after statistics computation.
+
+### Changed
+
+- Optimize O(1) queue implementation.
+
+## [2.6.2] - 2023-06-12
+
+### Fixed
+
+- Fix new worker use after creation in dynamic pool given the current worker choice strategy.
+
+## [2.6.1] - 2023-06-10
+
+### Added
+
+- Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
+
+### Fixed
+
+- Fix average statistics computation: ensure failed tasks are not accounted.
+
+## [2.6.0] - 2023-06-09
+
+### Added
+
+- Add `LEAST_ELU` worker choice strategy (experimental).
+- Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
+
+### Changed
+
+- Refactor pool worker node usage internals.
+- Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
+- Breaking change: pool information `info` property object fields have been renamed.
+
+### Fixed
+
+- Fix wait time accounting.
+- Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
+- Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
+
+## [2.5.4] - 2023-06-07
+
+### Added
+
+- Add Event Loop Utilization (ELU) statistics to worker tasks usage.
+
+### Changed
+
+- Compute statistics at the worker level only if needed.
+- Add `worker_threads` options to thread pool options.
+
+### Fixed
+
+- Make the `LEAST_BUSY` strategy only relies on task runtime.
+
+## [2.5.3] - 2023-06-04
+
+### Changed
+
+- Refine pool information content.
+- Limit pool internals public exposure.
+
+## [2.5.2] - 2023-06-02
+
+### Added
+
+- Add `taskError` pool event for task execution error.
+- Add pool information `info` property to pool.
+- Emit pool information on `busy` and `full` pool events.
+
+## [2.5.1] - 2023-06-01
+
+### Added
+
+- Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
+- Add `error` pool event for uncaught worker error.
+
+## [2.5.0] - 2023-05-31
+
+### Added
+
+- Switch pool event emitter to `EventEmitterAsyncResource`.
+- Add tasks wait time accounting in per worker tasks usage.
+- Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
+
+### Changed
+
+- Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
+
+## [2.4.14] - 2023-05-09
+
+### Fixed
+
+- Ensure no undefined task runtime can land in the tasks history.
+- Fix median computation implementation once again.
+
+### Added
+
+- Unit tests for median and queue implementations.
+
+## [2.4.13] - 2023-05-08
+
+### Fixed
+
+- Fix worker choice strategy options validation.
+- Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
+
+## [2.4.12] - 2023-05-06
+
+### Added
+
+- Support multiple task functions per worker.
+- Add custom worker weights support to worker choice strategies options.
+
+### Changed
+
+- Use O(1) queue implementation for tasks queueing.
+
+### Fixed
+
+- Fix median computation implementation.
+- Fix fair share worker choice strategy internals update.
+
+## [2.4.11] - 2023-04-23
+
+### Changed
+
+- Optimize free worker finding in worker choice strategies.
+
+## [2.4.10] - 2023-04-15
+
+### Fixed
+
+- Fix typescript type definition for worker function: ensure the input data is optional.
+- Fix typescript type definition for pool execute(): ensure the input data is optional.
+
+## [2.4.9] - 2023-04-15
+
+### Added
+
+- Add tasks queue enablement runtime setter to pool.
+- Add tasks queue options runtime setter to pool.
+- Add worker choice strategy options runtime setter to pool.
+
+### Changed
+
+- Remove the tasks queuing experimental status.
+
+### Fixed
+
+- Fix worker function type definition and validation.
+- Fix worker choice strategy options handling.
+
+## [2.4.8] - 2023-04-12
+
+### Fixed
+
+- Fix message between main worker and worker type definition for tasks.
+- Fix code documentation.
+
+## [2.4.7] - 2023-04-11
+
+### Added
+
+- Add worker tasks queue options to pool options.
+
+### Fixed
+
+- Fix missing documentation.
+
+## [2.4.6] - 2023-04-10
+
+### Fixed
+
+- Ensure one task at a time is executed per worker with tasks queueing enabled.
+- Properly count worker executing tasks with tasks queueing enabled.
+
+## [2.4.5] - 2023-04-09
+
+### Added
+
+- Use monotonic high resolution timer for worker tasks runtime.
+- Add worker tasks median runtime to statistics.
+- Add worker tasks queue (experimental).
+
+## [2.4.4] - 2023-04-07
+
+### Added
+
+- Add `PoolEvents` enumeration and `PoolEvent` type.
+
+### Fixed
+
+- Destroy worker only on alive check.
+
+## [2.4.3] - 2023-04-07
+
+### Fixed
+
+- Fix typedoc generation with inheritance.
+
+## [2.4.2] - 2023-04-06
+
+### Added
+
 - Add `full` event to dynamic pool.
 - Keep worker choice strategy in memory for conditional reuse.
 
@@ -333,7 +681,7 @@ const { DynamicThreadPool } = require('poolifier')
 
 #### New type definitions for input data and response
 
-For cluster worker and worker-thread pools, you can now only send and receive serializable data.  
+For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.  
 _This is not a limitation by poolifier but NodeJS._
 
 #### Public property replacements