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