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