Commit | Line | Data |
---|---|---|
522eea03 | 1 | # Changelog |
2 | ||
3 | All notable changes to this project will be documented in this file. | |
4 | ||
5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | |
6 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | |
7 | ||
45a5a54c JB |
8 | ## [Unreleased] |
9 | ||
ca6c7d70 JB |
10 | ### Changed |
11 | ||
12 | - Switch internal benchmarking code to benny. | |
13 | ||
995705ea JB |
14 | ## [2.3.7] - 2022-10-23 |
15 | ||
b953022b JB |
16 | ### Changed |
17 | ||
18 | - Switch to open collective FOSS project funding platform. | |
78cea37e JB |
19 | - Switch to ts-standard linter configuration on TypeScript code. |
20 | ||
21 | ### Fixed | |
22 | ||
23 | - Fixed missing async on pool execute method. | |
24 | - Fixed typing in TypeScript example. | |
25 | - Fixed types in unit tests. | |
b953022b | 26 | |
3b9f6953 JB |
27 | ## [2.3.6] - 2022-10-22 |
28 | ||
f80cead4 JB |
29 | ### Changed |
30 | ||
31 | - Cleanup pool attributes and methods. | |
32 | - Refine error types thrown. | |
33 | ||
34 | ### Fixed | |
35 | ||
36 | - Fix continuous integration build on windows. | |
37 | - Fix code coverage reporting by using c8 instead of nyc. | |
38 | ||
efc22107 JB |
39 | ## [2.3.5] - 2022-10-21 |
40 | ||
7a6a0a96 JB |
41 | ### Changed |
42 | ||
a05c10de JB |
43 | - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter. |
44 | - Optimize tasks usage lookup implementation. | |
7a6a0a96 | 45 | |
b4904890 JB |
46 | ### Fixed |
47 | ||
48 | - Fix missed pool event emitter type export. | |
49 | - Fix typedoc documentation generation. | |
50 | ||
a875f8d1 JB |
51 | ## [2.3.4] - 2022-10-17 |
52 | ||
73cda448 JB |
53 | ### Added |
54 | ||
55 | - Fully automate release process with release-it. | |
56 | ||
45a5a54c JB |
57 | ### Changed |
58 | ||
73cda448 | 59 | - Optimize fair share task scheduling algorithm implementation. |
eb4a8a82 | 60 | - Update benchmarks versus external pools results with latest version. |
45a5a54c | 61 | |
90ee1b18 | 62 | ## [2.3.3] - 2022-10-15 |
1a76932b JB |
63 | |
64 | ### Added | |
65 | ||
66 | - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options. | |
67 | ||
90ee1b18 | 68 | ## [2.3.2] - 2022-10-14 |
11df3590 JB |
69 | |
70 | ### Changed | |
71 | ||
72 | - Optimize fair share worker selection strategy implementation. | |
73 | ||
74 | ### Fixed | |
75 | ||
76 | - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled. | |
77 | ||
90ee1b18 | 78 | ## [2.3.1] - 2022-10-13 |
23ff945a JB |
79 | |
80 | ### Added | |
81 | ||
82 | - Pool worker choice strategies: | |
83 | - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now. | |
84 | - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now. | |
85 | ||
90ee1b18 | 86 | ## [2.2.2] - 2022-10-09 |
cb2b6c69 JB |
87 | |
88 | ### Fixed | |
89 | ||
90 | - Fixed `README.md` file. | |
91 | ||
90ee1b18 | 92 | ## [2.2.1] - 2022-10-08 |
bdacc2d2 | 93 | |
bdaf31cd JB |
94 | ### Added |
95 | ||
96 | - Dynamic worker choice strategy change at runtime. | |
bdacc2d2 | 97 | |
90ee1b18 | 98 | ## [2.2.0] - 2022-01-05 |
7e0d447f JB |
99 | |
100 | ### Breaking Changes | |
101 | ||
102 | - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version. | |
103 | ||
90ee1b18 | 104 | ## [2.1.0] - 2021-08-29 |
35cf1c03 JB |
105 | |
106 | ### Added | |
107 | ||
108 | - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker. | |
e088a00c JB |
109 | |
110 | ### Breaking Changes | |
111 | ||
112 | - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute. | |
113 | - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`. | |
114 | - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`. | |
c365b2d3 | 115 | - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker. |
e088a00c | 116 | |
90ee1b18 | 117 | ## [2.0.2] - 2021-05-12 |
14916bf9 JB |
118 | |
119 | ### Bug fixes | |
120 | ||
121 | - Fix `busy` event emission on fixed pool type | |
122 | ||
90ee1b18 | 123 | ## [2.0.1] - 2021-03-16 |
7f685093 JB |
124 | |
125 | ### Bug fixes | |
126 | ||
127 | - Check if pool options are properly set. | |
128 | - `busy` event is emitted on all pool types. | |
129 | ||
90ee1b18 | 130 | ## [2.0.0] - 2021-03-01 |
fa0f5b28 | 131 | |
f3f833ab | 132 | ### Bug fixes |
d63d3be3 | 133 | |
ddbeaffd | 134 | - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70). |
d63d3be3 | 135 | |
fa0f5b28 S |
136 | ### Breaking Changes |
137 | ||
7f685093 | 138 | - `FullPool` event is now renamed to `busy`. |
1927ee67 | 139 | - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`. |
1a81f8af | 140 | _Find more details on our JSDoc._ |
ddbeaffd | 141 | |
1927ee67 APA |
142 | - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed. |
143 | ||
ddbeaffd | 144 | - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes. |
fa0f5b28 | 145 | |
ec2ccfc8 JB |
146 | ### Pool options types declaration merge |
147 | ||
148 | `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`. | |
149 | ||
fa0f5b28 S |
150 | #### New `export` strategy |
151 | ||
152 | ```js | |
153 | // Before | |
777b7824 | 154 | const DynamicThreadPool = require('poolifier/lib/dynamic') |
fa0f5b28 | 155 | // After |
777b7824 | 156 | const { DynamicThreadPool } = require('poolifier/lib/dynamic') |
fa0f5b28 S |
157 | ``` |
158 | ||
159 | But you should always prefer just using | |
160 | ||
161 | ```js | |
777b7824 | 162 | const { DynamicThreadPool } = require('poolifier') |
fa0f5b28 S |
163 | ``` |
164 | ||
d3c8a1a8 S |
165 | #### New type definitions for input data and response |
166 | ||
ec2ccfc8 | 167 | For cluster worker and worker-thread pools, you can now only send and receive serializable data. |
d3c8a1a8 S |
168 | _This is not a limitation by poolifier but NodeJS._ |
169 | ||
3a4b605f | 170 | #### Public property replacements |
5c5a1fb7 | 171 | |
3a4b605f | 172 | `numWorkers` property is now `numberOfWorkers` |
5c5a1fb7 | 173 | |
280c2a77 | 174 | #### Internal (protected) properties and methods renaming |
fa0f5b28 | 175 | |
280c2a77 S |
176 | These properties are not intended for end users |
177 | ||
178 | - `id` => `nextMessageId` | |
179 | ||
180 | These methods are not intended for end users | |
fa0f5b28 S |
181 | |
182 | - `_chooseWorker` => `chooseWorker` | |
280c2a77 | 183 | - `_newWorker` => `createWorker` |
fa0f5b28 S |
184 | - `_execute` => `internalExecute` |
185 | - `_chooseWorker` => `chooseWorker` | |
186 | - `_checkAlive` => `checkAlive` | |
187 | - `_run` => `run` | |
188 | - `_runAsync` => `runAsync` | |
189 | ||
90ee1b18 | 190 | ## [1.1.0] - 2020-05-21 |
0312f71a APA |
191 | |
192 | ### Added | |
193 | ||
194 | - ThreadWorker support async functions as option | |
cf9aa6c3 | 195 | - Various external library patches |
0312f71a | 196 | |
90ee1b18 | 197 | ## [1.0.0] - 2020-01-24 |
522eea03 | 198 | |
199 | ### Added | |
200 | ||
201 | - FixedThreadPool implementation | |
202 | - DynamicThreadPool implementation | |
0312f71a | 203 | - WorkerThread implementation to improve developer experience |