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 | ||
bdacc2d2 JB |
8 | ## [2.2.1] - 2022-05-01 |
9 | ||
bdaf31cd JB |
10 | ### Added |
11 | ||
12 | - Dynamic worker choice strategy change at runtime. | |
bdacc2d2 | 13 | |
72ddc5cb | 14 | ## [2.2.0] - 2022-05-01 |
7e0d447f JB |
15 | |
16 | ### Breaking Changes | |
17 | ||
18 | - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version. | |
19 | ||
f30df385 | 20 | ## [2.1.0] - 2021-29-08 |
35cf1c03 JB |
21 | |
22 | ### Added | |
23 | ||
24 | - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker. | |
e088a00c JB |
25 | |
26 | ### Breaking Changes | |
27 | ||
28 | - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute. | |
29 | - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`. | |
30 | - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`. | |
c365b2d3 | 31 | - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker. |
e088a00c | 32 | |
d7a0c5c5 | 33 | ## [2.0.2] - 2021-12-05 |
14916bf9 JB |
34 | |
35 | ### Bug fixes | |
36 | ||
37 | - Fix `busy` event emission on fixed pool type | |
38 | ||
59af1281 | 39 | ## [2.0.1] - 2021-16-03 |
7f685093 JB |
40 | |
41 | ### Bug fixes | |
42 | ||
43 | - Check if pool options are properly set. | |
44 | - `busy` event is emitted on all pool types. | |
45 | ||
3695a6b0 | 46 | ## [2.0.0] - 2021-01-03 |
fa0f5b28 | 47 | |
f3f833ab | 48 | ### Bug fixes |
d63d3be3 | 49 | |
ddbeaffd | 50 | - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70). |
d63d3be3 | 51 | |
fa0f5b28 S |
52 | ### Breaking Changes |
53 | ||
7f685093 | 54 | - `FullPool` event is now renamed to `busy`. |
1927ee67 | 55 | - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`. |
1a81f8af | 56 | _Find more details on our JSDoc._ |
ddbeaffd | 57 | |
1927ee67 APA |
58 | - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed. |
59 | ||
ddbeaffd | 60 | - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes. |
fa0f5b28 | 61 | |
ec2ccfc8 JB |
62 | ### Pool options types declaration merge |
63 | ||
64 | `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`. | |
65 | ||
fa0f5b28 S |
66 | #### New `export` strategy |
67 | ||
68 | ```js | |
69 | // Before | |
777b7824 | 70 | const DynamicThreadPool = require('poolifier/lib/dynamic') |
fa0f5b28 | 71 | // After |
777b7824 | 72 | const { DynamicThreadPool } = require('poolifier/lib/dynamic') |
fa0f5b28 S |
73 | ``` |
74 | ||
75 | But you should always prefer just using | |
76 | ||
77 | ```js | |
777b7824 | 78 | const { DynamicThreadPool } = require('poolifier') |
fa0f5b28 S |
79 | ``` |
80 | ||
d3c8a1a8 S |
81 | #### New type definitions for input data and response |
82 | ||
ec2ccfc8 | 83 | For cluster worker and worker-thread pools, you can now only send and receive serializable data. |
d3c8a1a8 S |
84 | _This is not a limitation by poolifier but NodeJS._ |
85 | ||
3a4b605f | 86 | #### Public property replacements |
5c5a1fb7 | 87 | |
3a4b605f | 88 | `numWorkers` property is now `numberOfWorkers` |
5c5a1fb7 | 89 | |
280c2a77 | 90 | #### Internal (protected) properties and methods renaming |
fa0f5b28 | 91 | |
280c2a77 S |
92 | These properties are not intended for end users |
93 | ||
94 | - `id` => `nextMessageId` | |
95 | ||
96 | These methods are not intended for end users | |
fa0f5b28 S |
97 | |
98 | - `_chooseWorker` => `chooseWorker` | |
280c2a77 | 99 | - `_newWorker` => `createWorker` |
fa0f5b28 S |
100 | - `_execute` => `internalExecute` |
101 | - `_chooseWorker` => `chooseWorker` | |
102 | - `_checkAlive` => `checkAlive` | |
103 | - `_run` => `run` | |
104 | - `_runAsync` => `runAsync` | |
105 | ||
0312f71a APA |
106 | ## [1.1.0] - 2020-21-05 |
107 | ||
108 | ### Added | |
109 | ||
110 | - ThreadWorker support async functions as option | |
cf9aa6c3 | 111 | - Various external library patches |
0312f71a | 112 | |
522eea03 | 113 | ## [1.0.0] - 2020-24-01 |
114 | ||
115 | ### Added | |
116 | ||
117 | - FixedThreadPool implementation | |
118 | - DynamicThreadPool implementation | |
0312f71a | 119 | - WorkerThread implementation to improve developer experience |