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