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