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