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 | ||
168c526f JB |
10 | ### Added |
11 | ||
12 | - Add `LESS_BUSY` worker choice strategy. | |
13 | ||
1d71a908 JB |
14 | ### Changed |
15 | ||
ffcbbad8 | 16 | - Optimize worker storage in pool. |
1d71a908 | 17 | - Optimize worker alive status check. |
168c526f | 18 | - Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. |
737c6d97 | 19 | - Optimize `LESS_USED` worker choice strategy. |
1d71a908 | 20 | |
ffcbbad8 JB |
21 | ### Fixed |
22 | ||
23 | - Ensure trimmable characters are checked at pool initialization. | |
b4e75778 | 24 | - Fix message id integer overflow. |
ffcbbad8 | 25 | |
08372738 JB |
26 | ## [2.3.10] - 2023-03-18 |
27 | ||
710826bc JB |
28 | ### Fixed |
29 | ||
30 | - Fix `exports` syntax for ESM and CommonJS. | |
31 | ||
32 | ### Changed | |
33 | ||
34 | - Permit SemVer pre-release publication. | |
76e5ac6f | 35 | |
e4796ecd JB |
36 | ## [2.3.10-2] - 2023-03-18 |
37 | ||
6abad580 JB |
38 | ### Fixed |
39 | ||
40 | - Fix `exports` syntax for ESM and CommonJS. | |
41 | ||
a2ee98cc JB |
42 | ## [2.3.10-1] - 2023-03-18 |
43 | ||
7e060cee JB |
44 | ### Changed |
45 | ||
90483887 | 46 | - Permit SemVer pre-release publication. |
7e060cee | 47 | |
c81bfafb JB |
48 | ## [2.3.10-0] - 2023-03-18 |
49 | ||
fe18768d JB |
50 | ### Fixed |
51 | ||
52 | - Fix `exports` syntax for ESM and CommonJS. | |
53 | ||
d7b78217 JB |
54 | ## [2.3.9] - 2023-03-18 |
55 | ||
ed6dd37f JB |
56 | ### Changed |
57 | ||
58 | - Introduce ESM module support along with CommonJS one. | |
59 | ||
60 | ### Fixed | |
61 | ||
62 | - Fix brown paper bag bug referencing the same object literal. | |
63 | ||
68e2ad86 JB |
64 | ## [2.3.8] - 2023-03-18 |
65 | ||
ca6c7d70 JB |
66 | ### Changed |
67 | ||
68 | - Switch internal benchmarking code to benny. | |
fbdedeb9 JB |
69 | - Switch to TypeScript 5.x.x. |
70 | - Switch rollup bundler plugins to core ones. | |
ed6dd37f | 71 | - Switch to TSDoc syntax. |
fbdedeb9 | 72 | - Enforce conventional commits. |
ca6c7d70 | 73 | |
d15211d4 JB |
74 | ### Fixed |
75 | ||
76 | - Fix random integer generator. | |
fbdedeb9 | 77 | - Fix worker choice strategy pool type identification at initialization. |
d15211d4 | 78 | |
995705ea JB |
79 | ## [2.3.7] - 2022-10-23 |
80 | ||
b953022b JB |
81 | ### Changed |
82 | ||
83 | - Switch to open collective FOSS project funding platform. | |
78cea37e JB |
84 | - Switch to ts-standard linter configuration on TypeScript code. |
85 | ||
86 | ### Fixed | |
87 | ||
88 | - Fixed missing async on pool execute method. | |
89 | - Fixed typing in TypeScript example. | |
90 | - Fixed types in unit tests. | |
b953022b | 91 | |
3b9f6953 JB |
92 | ## [2.3.6] - 2022-10-22 |
93 | ||
f80cead4 JB |
94 | ### Changed |
95 | ||
96 | - Cleanup pool attributes and methods. | |
97 | - Refine error types thrown. | |
98 | ||
99 | ### Fixed | |
100 | ||
101 | - Fix continuous integration build on windows. | |
102 | - Fix code coverage reporting by using c8 instead of nyc. | |
103 | ||
efc22107 JB |
104 | ## [2.3.5] - 2022-10-21 |
105 | ||
7a6a0a96 JB |
106 | ### Changed |
107 | ||
a05c10de JB |
108 | - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter. |
109 | - Optimize tasks usage lookup implementation. | |
7a6a0a96 | 110 | |
b4904890 JB |
111 | ### Fixed |
112 | ||
113 | - Fix missed pool event emitter type export. | |
114 | - Fix typedoc documentation generation. | |
115 | ||
a875f8d1 JB |
116 | ## [2.3.4] - 2022-10-17 |
117 | ||
73cda448 JB |
118 | ### Added |
119 | ||
120 | - Fully automate release process with release-it. | |
121 | ||
45a5a54c JB |
122 | ### Changed |
123 | ||
73cda448 | 124 | - Optimize fair share task scheduling algorithm implementation. |
eb4a8a82 | 125 | - Update benchmarks versus external pools results with latest version. |
45a5a54c | 126 | |
90ee1b18 | 127 | ## [2.3.3] - 2022-10-15 |
1a76932b JB |
128 | |
129 | ### Added | |
130 | ||
131 | - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options. | |
132 | ||
90ee1b18 | 133 | ## [2.3.2] - 2022-10-14 |
11df3590 JB |
134 | |
135 | ### Changed | |
136 | ||
137 | - Optimize fair share worker selection strategy implementation. | |
138 | ||
139 | ### Fixed | |
140 | ||
141 | - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled. | |
142 | ||
90ee1b18 | 143 | ## [2.3.1] - 2022-10-13 |
23ff945a JB |
144 | |
145 | ### Added | |
146 | ||
147 | - Pool worker choice strategies: | |
148 | - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now. | |
149 | - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now. | |
150 | ||
90ee1b18 | 151 | ## [2.2.2] - 2022-10-09 |
cb2b6c69 JB |
152 | |
153 | ### Fixed | |
154 | ||
155 | - Fixed `README.md` file. | |
156 | ||
90ee1b18 | 157 | ## [2.2.1] - 2022-10-08 |
bdacc2d2 | 158 | |
bdaf31cd JB |
159 | ### Added |
160 | ||
161 | - Dynamic worker choice strategy change at runtime. | |
bdacc2d2 | 162 | |
90ee1b18 | 163 | ## [2.2.0] - 2022-01-05 |
7e0d447f JB |
164 | |
165 | ### Breaking Changes | |
166 | ||
167 | - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version. | |
168 | ||
90ee1b18 | 169 | ## [2.1.0] - 2021-08-29 |
35cf1c03 JB |
170 | |
171 | ### Added | |
172 | ||
173 | - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker. | |
e088a00c JB |
174 | |
175 | ### Breaking Changes | |
176 | ||
177 | - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute. | |
178 | - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`. | |
179 | - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`. | |
c365b2d3 | 180 | - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker. |
e088a00c | 181 | |
90ee1b18 | 182 | ## [2.0.2] - 2021-05-12 |
14916bf9 JB |
183 | |
184 | ### Bug fixes | |
185 | ||
186 | - Fix `busy` event emission on fixed pool type | |
187 | ||
90ee1b18 | 188 | ## [2.0.1] - 2021-03-16 |
7f685093 JB |
189 | |
190 | ### Bug fixes | |
191 | ||
192 | - Check if pool options are properly set. | |
193 | - `busy` event is emitted on all pool types. | |
194 | ||
90ee1b18 | 195 | ## [2.0.0] - 2021-03-01 |
fa0f5b28 | 196 | |
f3f833ab | 197 | ### Bug fixes |
d63d3be3 | 198 | |
ddbeaffd | 199 | - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70). |
d63d3be3 | 200 | |
fa0f5b28 S |
201 | ### Breaking Changes |
202 | ||
7f685093 | 203 | - `FullPool` event is now renamed to `busy`. |
1927ee67 | 204 | - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`. |
1a81f8af | 205 | _Find more details on our JSDoc._ |
ddbeaffd | 206 | |
1927ee67 APA |
207 | - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed. |
208 | ||
ddbeaffd | 209 | - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes. |
fa0f5b28 | 210 | |
ec2ccfc8 JB |
211 | ### Pool options types declaration merge |
212 | ||
213 | `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`. | |
214 | ||
fa0f5b28 S |
215 | #### New `export` strategy |
216 | ||
217 | ```js | |
218 | // Before | |
777b7824 | 219 | const DynamicThreadPool = require('poolifier/lib/dynamic') |
fa0f5b28 | 220 | // After |
777b7824 | 221 | const { DynamicThreadPool } = require('poolifier/lib/dynamic') |
fa0f5b28 S |
222 | ``` |
223 | ||
224 | But you should always prefer just using | |
225 | ||
226 | ```js | |
777b7824 | 227 | const { DynamicThreadPool } = require('poolifier') |
fa0f5b28 S |
228 | ``` |
229 | ||
d3c8a1a8 S |
230 | #### New type definitions for input data and response |
231 | ||
ec2ccfc8 | 232 | For cluster worker and worker-thread pools, you can now only send and receive serializable data. |
d3c8a1a8 S |
233 | _This is not a limitation by poolifier but NodeJS._ |
234 | ||
3a4b605f | 235 | #### Public property replacements |
5c5a1fb7 | 236 | |
3a4b605f | 237 | `numWorkers` property is now `numberOfWorkers` |
5c5a1fb7 | 238 | |
280c2a77 | 239 | #### Internal (protected) properties and methods renaming |
fa0f5b28 | 240 | |
280c2a77 S |
241 | These properties are not intended for end users |
242 | ||
243 | - `id` => `nextMessageId` | |
244 | ||
245 | These methods are not intended for end users | |
fa0f5b28 S |
246 | |
247 | - `_chooseWorker` => `chooseWorker` | |
280c2a77 | 248 | - `_newWorker` => `createWorker` |
fa0f5b28 S |
249 | - `_execute` => `internalExecute` |
250 | - `_chooseWorker` => `chooseWorker` | |
251 | - `_checkAlive` => `checkAlive` | |
252 | - `_run` => `run` | |
253 | - `_runAsync` => `runAsync` | |
254 | ||
90ee1b18 | 255 | ## [1.1.0] - 2020-05-21 |
0312f71a APA |
256 | |
257 | ### Added | |
258 | ||
259 | - ThreadWorker support async functions as option | |
cf9aa6c3 | 260 | - Various external library patches |
0312f71a | 261 | |
90ee1b18 | 262 | ## [1.0.0] - 2020-01-24 |
522eea03 | 263 | |
264 | ### Added | |
265 | ||
266 | - FixedThreadPool implementation | |
267 | - DynamicThreadPool implementation | |
0312f71a | 268 | - WorkerThread implementation to improve developer experience |