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