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