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