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