Apply dependencies update
[poolifier.git] / CHANGELOG.md
... / ...
CommitLineData
1# Changelog
2
3All notable changes to this project will be documented in this file.
4
5The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
8## [2.2.0] - 2022-05-01
9
10### Breaking Changes
11
12- Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
13
14## [2.1.0] - 2021-29-08
15
16### Added
17
18- Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
19
20### Breaking Changes
21
22- `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
23- `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
24- `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
25- `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
26
27## [2.0.2] - 2021-12-05
28
29### Bug fixes
30
31- Fix `busy` event emission on fixed pool type
32
33## [2.0.1] - 2021-16-03
34
35### Bug fixes
36
37- Check if pool options are properly set.
38- `busy` event is emitted on all pool types.
39
40## [2.0.0] - 2021-01-03
41
42### Bug fixes
43
44- Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
45
46### Breaking Changes
47
48- `FullPool` event is now renamed to `busy`.
49- `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
50 _Find more details on our JSDoc._
51
52- `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
53
54- We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
55
56### Pool options types declaration merge
57
58`FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
59
60#### New `export` strategy
61
62```js
63// Before
64const DynamicThreadPool = require('poolifier/lib/dynamic')
65// After
66const { DynamicThreadPool } = require('poolifier/lib/dynamic')
67```
68
69But you should always prefer just using
70
71```js
72const { DynamicThreadPool } = require('poolifier')
73```
74
75#### New type definitions for input data and response
76
77For cluster worker and worker-thread pools, you can now only send and receive serializable data.
78_This is not a limitation by poolifier but NodeJS._
79
80#### Public property replacements
81
82`numWorkers` property is now `numberOfWorkers`
83
84#### Internal (protected) properties and methods renaming
85
86These properties are not intended for end users
87
88- `id` => `nextMessageId`
89
90These methods are not intended for end users
91
92- `_chooseWorker` => `chooseWorker`
93- `_newWorker` => `createWorker`
94- `_execute` => `internalExecute`
95- `_chooseWorker` => `chooseWorker`
96- `_checkAlive` => `checkAlive`
97- `_run` => `run`
98- `_runAsync` => `runAsync`
99
100## [1.1.0] - 2020-21-05
101
102### Added
103
104- ThreadWorker support async functions as option
105- Various external library patches
106
107## [1.0.0] - 2020-24-01
108
109### Added
110
111- FixedThreadPool implementation
112- DynamicThreadPool implementation
113- WorkerThread implementation to improve developer experience