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