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