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 | ||
e4543b14 JB |
10 | ### Added |
11 | ||
12 | - Switch pool event emitter to `EventEmitterAsyncResource`. | |
6da80d38 | 13 | - Add tasks wait time accounting in per worker tasks usage. |
e4543b14 JB |
14 | |
15 | ### Changed | |
16 | ||
17 | - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`. | |
18 | ||
570efb11 JB |
19 | ## [2.4.14] - 2023-05-09 |
20 | ||
b0f28bad JB |
21 | ### Fixed |
22 | ||
23 | - Ensure no undefined task runtime can land in the tasks history. | |
24 | - Fix median computation implementation once again. | |
25 | ||
110b6d13 JB |
26 | ### Added |
27 | ||
28 | - Unit tests for median and queue implementations. | |
29 | ||
72584880 JB |
30 | ## [2.4.13] - 2023-05-08 |
31 | ||
b0d6ed8f JB |
32 | ### Fixed |
33 | ||
e3058615 | 34 | - Fix worker choice strategy options validation. |
b0d6ed8f JB |
35 | - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission. |
36 | ||
06140c32 JB |
37 | ## [2.4.12] - 2023-05-06 |
38 | ||
a86b6df1 JB |
39 | ### Added |
40 | ||
41 | - Support multiple task functions per worker. | |
08f3f44c | 42 | - Add custom worker weights support to worker choice strategies options. |
a86b6df1 | 43 | |
29ee7e9a JB |
44 | ### Changed |
45 | ||
46 | - Use O(1) queue implementation for tasks queueing. | |
47 | ||
0682ba15 JB |
48 | ### Fixed |
49 | ||
50 | - Fix median computation implementation. | |
51 | - Fix fair share worker choice strategy internals update. | |
52 | ||
936d53ec JB |
53 | ## [2.4.11] - 2023-04-23 |
54 | ||
cb70b19d JB |
55 | ### Changed |
56 | ||
57 | - Optimize free worker finding in worker choice strategies. | |
58 | ||
15bb637a JB |
59 | ## [2.4.10] - 2023-04-15 |
60 | ||
ef41a6e6 JB |
61 | ### Fixed |
62 | ||
63 | - Fix typescript type definition for worker function: ensure the input data is optional. | |
64 | - Fix typescript type definition for pool execute(): ensure the input data is optional. | |
65 | ||
181eb2b4 JB |
66 | ## [2.4.9] - 2023-04-15 |
67 | ||
a20f0ba5 JB |
68 | ### Added |
69 | ||
70 | - Add tasks queue enablement runtime setter to pool. | |
71 | - Add tasks queue options runtime setter to pool. | |
72 | - Add worker choice strategy options runtime setter to pool. | |
73 | ||
74 | ### Changed | |
75 | ||
76 | - Remove the tasks queuing experimental status. | |
77 | ||
d4aeae5a JB |
78 | ### Fixed |
79 | ||
80 | - Fix worker function type definition and validation. | |
2fc5cae3 | 81 | - Fix worker choice strategy options handling. |
d4aeae5a | 82 | |
1d9e7023 JB |
83 | ## [2.4.8] - 2023-04-12 |
84 | ||
f9b4bbf8 JB |
85 | ### Fixed |
86 | ||
87 | - Fix message between main worker and worker type definition for tasks. | |
88 | - Fix code documentation. | |
89 | ||
12ae3210 JB |
90 | ## [2.4.7] - 2023-04-11 |
91 | ||
7171d33f JB |
92 | ### Added |
93 | ||
94 | - Add worker tasks queue options to pool options. | |
95 | ||
e8bd29ce JB |
96 | ### Fixed |
97 | ||
98 | - Fix missing documentation. | |
99 | ||
42c7bc10 JB |
100 | ## [2.4.6] - 2023-04-10 |
101 | ||
681196cc JB |
102 | ### Fixed |
103 | ||
104 | - Ensure one task at a time is executed per worker with tasks queueing enabled. | |
76545787 | 105 | - Properly count worker running tasks with tasks queueing enabled. |
681196cc | 106 | |
54d360e3 JB |
107 | ## [2.4.5] - 2023-04-09 |
108 | ||
3fafb1b2 JB |
109 | ### Added |
110 | ||
9e775f96 JB |
111 | - Use monotonic high resolution timer for worker tasks runtime. |
112 | - Add worker tasks median runtime to statistics. | |
ff733df7 | 113 | - Add worker tasks queue (experimental). |
3fafb1b2 | 114 | |
92fa3eb6 JB |
115 | ## [2.4.4] - 2023-04-07 |
116 | ||
aee46736 JB |
117 | ### Added |
118 | ||
119 | - Add `PoolEvents` enumeration and `PoolEvent` type. | |
120 | ||
36b5e78f JB |
121 | ### Fixed |
122 | ||
ff0c2b3e | 123 | - Destroy worker only on alive check. |
36b5e78f | 124 | |
9fb0f324 JB |
125 | ## [2.4.3] - 2023-04-07 |
126 | ||
28cf3617 JB |
127 | ### Fixed |
128 | ||
129 | - Fix typedoc generation with inheritance. | |
130 | ||
848f0f27 JB |
131 | ## [2.4.2] - 2023-04-06 |
132 | ||
164d950a JB |
133 | ### Added |
134 | ||
135 | - Add `full` event to dynamic pool. | |
32417142 | 136 | - Keep worker choice strategy in memory for conditional reuse. |
164d950a | 137 | |
78ab2555 JB |
138 | ### Fixed |
139 | ||
140 | - Fix possible negative worker key at worker removal in worker choice strategies. | |
141 | ||
79aafe9f JB |
142 | ## [2.4.1] - 2023-04-05 |
143 | ||
9cd39dd4 JB |
144 | ### Changed |
145 | ||
146 | - Optimize worker choice strategy for dynamic pool. | |
147 | ||
965415bb JB |
148 | ### Fixed |
149 | ||
150 | - Ensure dynamic pool does not alter worker choice strategy expected behavior. | |
151 | ||
d8b60b1c JB |
152 | ## [2.4.0] - 2023-04-04 |
153 | ||
c6bd2650 JB |
154 | ### Added |
155 | ||
156 | - Add `LESS_BUSY` worker choice strategy. | |
157 | ||
158 | ### Changed | |
159 | ||
160 | - Optimize worker storage in pool. | |
161 | - Optimize worker alive status check. | |
162 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
163 | - Optimize `LESS_USED` worker choice strategy. | |
164 | - Update benchmarks versus external threads pools. | |
165 | - Optimize tasks usage statistics requirements for worker choice strategy. | |
166 | ||
167 | ### Fixed | |
168 | ||
169 | - Ensure trimmable characters are checked at pool initialization. | |
170 | - Fix message id integer overflow. | |
171 | - Fix pool worker removal in worker choice strategy internals. | |
172 | - Fix package publication with pnpm. | |
173 | ||
d0a3f018 JB |
174 | ## [2.4.0-3] - 2023-04-04 |
175 | ||
b2ede285 JB |
176 | ### Added |
177 | ||
178 | - Add `LESS_BUSY` worker choice strategy. | |
179 | ||
180 | ### Changed | |
181 | ||
182 | - Optimize worker storage in pool. | |
183 | - Optimize worker alive status check. | |
184 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
185 | - Optimize `LESS_USED` worker choice strategy. | |
186 | - Update benchmarks versus external threads pools. | |
187 | ||
188 | ### Fixed | |
189 | ||
190 | - Ensure trimmable characters are checked at pool initialization. | |
191 | - Fix message id integer overflow. | |
192 | - Fix pool worker removal in worker choice strategy internals. | |
193 | - Fix package publication with pnpm. | |
194 | ||
a015ea40 JB |
195 | ## [2.4.0-2] - 2023-04-03 |
196 | ||
698f4bbc JB |
197 | ### Added |
198 | ||
199 | - Add `LESS_BUSY` worker choice strategy. | |
200 | ||
201 | ### Changed | |
202 | ||
203 | - Optimize worker storage in pool. | |
204 | - Optimize worker alive status check. | |
205 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
206 | - Optimize `LESS_USED` worker choice strategy. | |
207 | ||
208 | ### Fixed | |
209 | ||
210 | - Ensure trimmable characters are checked at pool initialization. | |
211 | - Fix message id integer overflow. | |
212 | - Fix pool worker removal in worker choice strategy internals. | |
213 | - Fix package publication with pnpm. | |
214 | ||
8fe15920 JB |
215 | ## [2.4.0-1] - 2023-04-03 |
216 | ||
5b301c28 JB |
217 | ### Added |
218 | ||
219 | - Add `LESS_BUSY` worker choice strategy. | |
220 | ||
221 | ### Changed | |
222 | ||
223 | - Optimize worker storage in pool. | |
224 | - Optimize worker alive status check. | |
225 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
226 | - Optimize `LESS_USED` worker choice strategy. | |
227 | ||
228 | ### Fixed | |
229 | ||
230 | - Ensure trimmable characters are checked at pool initialization. | |
231 | - Fix message id integer overflow. | |
232 | - Fix pool worker removal in worker choice strategy internals. | |
233 | ||
2fb9ca9c JB |
234 | ## [2.4.0-0] - 2023-04-03 |
235 | ||
168c526f JB |
236 | ### Added |
237 | ||
238 | - Add `LESS_BUSY` worker choice strategy. | |
239 | ||
1d71a908 JB |
240 | ### Changed |
241 | ||
ffcbbad8 | 242 | - Optimize worker storage in pool. |
1d71a908 | 243 | - Optimize worker alive status check. |
65a60b3b | 244 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. |
737c6d97 | 245 | - Optimize `LESS_USED` worker choice strategy. |
1d71a908 | 246 | |
ffcbbad8 JB |
247 | ### Fixed |
248 | ||
249 | - Ensure trimmable characters are checked at pool initialization. | |
b4e75778 | 250 | - Fix message id integer overflow. |
97a2abc3 | 251 | - Fix pool worker removal in worker choice strategy internals. |
ffcbbad8 | 252 | |
08372738 JB |
253 | ## [2.3.10] - 2023-03-18 |
254 | ||
710826bc JB |
255 | ### Fixed |
256 | ||
257 | - Fix `exports` syntax for ESM and CommonJS. | |
258 | ||
259 | ### Changed | |
260 | ||
261 | - Permit SemVer pre-release publication. | |
76e5ac6f | 262 | |
e4796ecd JB |
263 | ## [2.3.10-2] - 2023-03-18 |
264 | ||
6abad580 JB |
265 | ### Fixed |
266 | ||
267 | - Fix `exports` syntax for ESM and CommonJS. | |
268 | ||
a2ee98cc JB |
269 | ## [2.3.10-1] - 2023-03-18 |
270 | ||
7e060cee JB |
271 | ### Changed |
272 | ||
90483887 | 273 | - Permit SemVer pre-release publication. |
7e060cee | 274 | |
c81bfafb JB |
275 | ## [2.3.10-0] - 2023-03-18 |
276 | ||
fe18768d JB |
277 | ### Fixed |
278 | ||
279 | - Fix `exports` syntax for ESM and CommonJS. | |
280 | ||
d7b78217 JB |
281 | ## [2.3.9] - 2023-03-18 |
282 | ||
ed6dd37f JB |
283 | ### Changed |
284 | ||
285 | - Introduce ESM module support along with CommonJS one. | |
286 | ||
287 | ### Fixed | |
288 | ||
289 | - Fix brown paper bag bug referencing the same object literal. | |
290 | ||
68e2ad86 JB |
291 | ## [2.3.8] - 2023-03-18 |
292 | ||
ca6c7d70 JB |
293 | ### Changed |
294 | ||
295 | - Switch internal benchmarking code to benny. | |
fbdedeb9 JB |
296 | - Switch to TypeScript 5.x.x. |
297 | - Switch rollup bundler plugins to core ones. | |
ed6dd37f | 298 | - Switch to TSDoc syntax. |
fbdedeb9 | 299 | - Enforce conventional commits. |
ca6c7d70 | 300 | |
d15211d4 JB |
301 | ### Fixed |
302 | ||
303 | - Fix random integer generator. | |
fbdedeb9 | 304 | - Fix worker choice strategy pool type identification at initialization. |
d15211d4 | 305 | |
995705ea JB |
306 | ## [2.3.7] - 2022-10-23 |
307 | ||
b953022b JB |
308 | ### Changed |
309 | ||
310 | - Switch to open collective FOSS project funding platform. | |
78cea37e JB |
311 | - Switch to ts-standard linter configuration on TypeScript code. |
312 | ||
313 | ### Fixed | |
314 | ||
315 | - Fixed missing async on pool execute method. | |
316 | - Fixed typing in TypeScript example. | |
317 | - Fixed types in unit tests. | |
b953022b | 318 | |
3b9f6953 JB |
319 | ## [2.3.6] - 2022-10-22 |
320 | ||
f80cead4 JB |
321 | ### Changed |
322 | ||
323 | - Cleanup pool attributes and methods. | |
324 | - Refine error types thrown. | |
325 | ||
326 | ### Fixed | |
327 | ||
328 | - Fix continuous integration build on windows. | |
329 | - Fix code coverage reporting by using c8 instead of nyc. | |
330 | ||
efc22107 JB |
331 | ## [2.3.5] - 2022-10-21 |
332 | ||
7a6a0a96 JB |
333 | ### Changed |
334 | ||
a05c10de JB |
335 | - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter. |
336 | - Optimize tasks usage lookup implementation. | |
7a6a0a96 | 337 | |
b4904890 JB |
338 | ### Fixed |
339 | ||
340 | - Fix missed pool event emitter type export. | |
341 | - Fix typedoc documentation generation. | |
342 | ||
a875f8d1 JB |
343 | ## [2.3.4] - 2022-10-17 |
344 | ||
73cda448 JB |
345 | ### Added |
346 | ||
347 | - Fully automate release process with release-it. | |
348 | ||
45a5a54c JB |
349 | ### Changed |
350 | ||
73cda448 | 351 | - Optimize fair share task scheduling algorithm implementation. |
eb4a8a82 | 352 | - Update benchmarks versus external pools results with latest version. |
45a5a54c | 353 | |
90ee1b18 | 354 | ## [2.3.3] - 2022-10-15 |
1a76932b JB |
355 | |
356 | ### Added | |
357 | ||
358 | - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options. | |
359 | ||
90ee1b18 | 360 | ## [2.3.2] - 2022-10-14 |
11df3590 JB |
361 | |
362 | ### Changed | |
363 | ||
364 | - Optimize fair share worker selection strategy implementation. | |
365 | ||
366 | ### Fixed | |
367 | ||
368 | - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled. | |
369 | ||
90ee1b18 | 370 | ## [2.3.1] - 2022-10-13 |
23ff945a JB |
371 | |
372 | ### Added | |
373 | ||
374 | - Pool worker choice strategies: | |
375 | - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now. | |
376 | - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now. | |
377 | ||
90ee1b18 | 378 | ## [2.2.2] - 2022-10-09 |
cb2b6c69 JB |
379 | |
380 | ### Fixed | |
381 | ||
382 | - Fixed `README.md` file. | |
383 | ||
90ee1b18 | 384 | ## [2.2.1] - 2022-10-08 |
bdacc2d2 | 385 | |
bdaf31cd JB |
386 | ### Added |
387 | ||
388 | - Dynamic worker choice strategy change at runtime. | |
bdacc2d2 | 389 | |
90ee1b18 | 390 | ## [2.2.0] - 2022-01-05 |
7e0d447f JB |
391 | |
392 | ### Breaking Changes | |
393 | ||
394 | - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version. | |
395 | ||
90ee1b18 | 396 | ## [2.1.0] - 2021-08-29 |
35cf1c03 JB |
397 | |
398 | ### Added | |
399 | ||
400 | - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker. | |
e088a00c JB |
401 | |
402 | ### Breaking Changes | |
403 | ||
404 | - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute. | |
405 | - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`. | |
406 | - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`. | |
c365b2d3 | 407 | - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker. |
e088a00c | 408 | |
90ee1b18 | 409 | ## [2.0.2] - 2021-05-12 |
14916bf9 JB |
410 | |
411 | ### Bug fixes | |
412 | ||
413 | - Fix `busy` event emission on fixed pool type | |
414 | ||
90ee1b18 | 415 | ## [2.0.1] - 2021-03-16 |
7f685093 JB |
416 | |
417 | ### Bug fixes | |
418 | ||
419 | - Check if pool options are properly set. | |
420 | - `busy` event is emitted on all pool types. | |
421 | ||
90ee1b18 | 422 | ## [2.0.0] - 2021-03-01 |
fa0f5b28 | 423 | |
f3f833ab | 424 | ### Bug fixes |
d63d3be3 | 425 | |
ddbeaffd | 426 | - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70). |
d63d3be3 | 427 | |
fa0f5b28 S |
428 | ### Breaking Changes |
429 | ||
7f685093 | 430 | - `FullPool` event is now renamed to `busy`. |
1927ee67 | 431 | - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`. |
1a81f8af | 432 | _Find more details on our JSDoc._ |
ddbeaffd | 433 | |
1927ee67 APA |
434 | - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed. |
435 | ||
ddbeaffd | 436 | - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes. |
fa0f5b28 | 437 | |
ec2ccfc8 JB |
438 | ### Pool options types declaration merge |
439 | ||
440 | `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`. | |
441 | ||
fa0f5b28 S |
442 | #### New `export` strategy |
443 | ||
444 | ```js | |
445 | // Before | |
777b7824 | 446 | const DynamicThreadPool = require('poolifier/lib/dynamic') |
fa0f5b28 | 447 | // After |
777b7824 | 448 | const { DynamicThreadPool } = require('poolifier/lib/dynamic') |
fa0f5b28 S |
449 | ``` |
450 | ||
451 | But you should always prefer just using | |
452 | ||
453 | ```js | |
777b7824 | 454 | const { DynamicThreadPool } = require('poolifier') |
fa0f5b28 S |
455 | ``` |
456 | ||
d3c8a1a8 S |
457 | #### New type definitions for input data and response |
458 | ||
ec2ccfc8 | 459 | For cluster worker and worker-thread pools, you can now only send and receive serializable data. |
d3c8a1a8 S |
460 | _This is not a limitation by poolifier but NodeJS._ |
461 | ||
3a4b605f | 462 | #### Public property replacements |
5c5a1fb7 | 463 | |
3a4b605f | 464 | `numWorkers` property is now `numberOfWorkers` |
5c5a1fb7 | 465 | |
280c2a77 | 466 | #### Internal (protected) properties and methods renaming |
fa0f5b28 | 467 | |
280c2a77 S |
468 | These properties are not intended for end users |
469 | ||
470 | - `id` => `nextMessageId` | |
471 | ||
472 | These methods are not intended for end users | |
fa0f5b28 S |
473 | |
474 | - `_chooseWorker` => `chooseWorker` | |
280c2a77 | 475 | - `_newWorker` => `createWorker` |
fa0f5b28 S |
476 | - `_execute` => `internalExecute` |
477 | - `_chooseWorker` => `chooseWorker` | |
478 | - `_checkAlive` => `checkAlive` | |
479 | - `_run` => `run` | |
480 | - `_runAsync` => `runAsync` | |
481 | ||
90ee1b18 | 482 | ## [1.1.0] - 2020-05-21 |
0312f71a APA |
483 | |
484 | ### Added | |
485 | ||
486 | - ThreadWorker support async functions as option | |
cf9aa6c3 | 487 | - Various external library patches |
0312f71a | 488 | |
90ee1b18 | 489 | ## [1.0.0] - 2020-01-24 |
522eea03 | 490 | |
491 | ### Added | |
492 | ||
493 | - FixedThreadPool implementation | |
494 | - DynamicThreadPool implementation | |
0312f71a | 495 | - WorkerThread implementation to improve developer experience |