1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
// Copyright 2021 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0
//! The node manager that takes care of sending requests with healthy nodes and quorum if enabled
pub mod builder;
pub(crate) mod http_client;
/// Structs for nodes
pub mod node;
pub(crate) mod syncing;
use std::{
collections::{HashMap, HashSet},
sync::RwLock,
time::Duration,
};
use serde_json::Value;
use self::{http_client::HttpClient, node::Node};
use crate::{
client::{
error::{Error, Result},
node_manager::builder::NodeManagerBuilder,
},
types::api::core::response::InfoResponse,
};
// The node manager takes care of selecting node(s) for requests until a result is returned or if quorum is enabled it
// will send the requests for some endpoints to multiple nodes and compares the results.
pub struct NodeManager {
pub(crate) primary_node: Option<Node>,
primary_pow_node: Option<Node>,
pub(crate) nodes: HashSet<Node>,
permanodes: Option<HashSet<Node>>,
pub(crate) ignore_node_health: bool,
node_sync_interval: Duration,
pub(crate) healthy_nodes: RwLock<HashMap<Node, InfoResponse>>,
quorum: bool,
min_quorum_size: usize,
quorum_threshold: usize,
pub(crate) http_client: HttpClient,
}
impl std::fmt::Debug for NodeManager {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
let mut d = f.debug_struct("NodeManager");
d.field("primary_node", &self.primary_node);
d.field("primary_pow_node", &self.primary_pow_node);
d.field("nodes", &self.nodes);
d.field("permanodes", &self.permanodes);
d.field("ignore_node_health", &self.ignore_node_health);
d.field("node_sync_interval", &self.node_sync_interval);
d.field("healthy_nodes", &self.healthy_nodes);
d.field("quorum", &self.quorum);
d.field("min_quorum_size", &self.min_quorum_size);
d.field("quorum_threshold", &self.quorum_threshold).finish()
}
}
impl NodeManager {
pub(crate) fn builder() -> NodeManagerBuilder {
NodeManagerBuilder::new()
}
fn get_nodes(
&self,
path: &str,
query: Option<&str>,
use_pow_nodes: bool,
prefer_permanode: bool,
) -> Result<Vec<Node>> {
let mut nodes_with_modified_url: Vec<Node> = Vec::new();
if prefer_permanode || (path == "api/core/v2/blocks" && query.is_some()) {
if let Some(permanodes) = self.permanodes.clone() {
for permanode in permanodes {
if !nodes_with_modified_url.iter().any(|n| n.url == permanode.url) {
nodes_with_modified_url.push(permanode);
}
}
}
}
if use_pow_nodes {
if let Some(pow_node) = self.primary_pow_node.clone() {
if !nodes_with_modified_url.iter().any(|n| n.url == pow_node.url) {
nodes_with_modified_url.push(pow_node);
}
}
}
if let Some(primary_node) = self.primary_node.clone() {
if !nodes_with_modified_url.iter().any(|n| n.url == primary_node.url) {
nodes_with_modified_url.push(primary_node);
}
}
// Add other nodes in random order, so they are not always used in the same order
let nodes_random_order = if !self.ignore_node_health {
#[cfg(not(target_family = "wasm"))]
{
self.healthy_nodes
.read()
.map_err(|_| crate::client::Error::PoisonError)?
.iter()
.filter_map(|(n, info)| {
// Only add nodes with pow feature enabled, when remote PoW is used
if use_pow_nodes {
let pow_feature = String::from("pow");
if info.features.contains(&pow_feature) {
Some(n.clone())
} else {
None
}
} else {
Some(n.clone())
}
})
.collect()
}
#[cfg(target_family = "wasm")]
{
self.nodes.clone()
}
} else {
self.nodes.clone()
};
// Add remaining nodes in random order
for node in nodes_random_order {
if !nodes_with_modified_url.iter().any(|n| n.url == node.url) {
nodes_with_modified_url.push(node);
}
}
// remove disabled nodes
nodes_with_modified_url.retain(|n| !n.disabled);
if nodes_with_modified_url.is_empty() {
if use_pow_nodes {
return Err(crate::client::Error::Node(
crate::client::node_api::error::Error::UnavailablePow,
));
}
return Err(crate::client::Error::HealthyNodePoolEmpty);
}
// Set path and query parameters
for node in &mut nodes_with_modified_url {
node.url.set_path(path);
node.url.set_query(query);
if let Some(auth) = &node.auth {
if let Some((name, password)) = &auth.basic_auth_name_pwd {
node.url
.set_username(name)
.map_err(|_| crate::client::Error::UrlAuth("username"))?;
node.url
.set_password(Some(password))
.map_err(|_| crate::client::Error::UrlAuth("password"))?;
}
}
}
Ok(nodes_with_modified_url)
}
pub(crate) async fn get_request<T: serde::de::DeserializeOwned + std::fmt::Debug + serde::Serialize>(
&self,
path: &str,
query: Option<&str>,
timeout: Duration,
need_quorum: bool,
prefer_permanode: bool,
) -> Result<T> {
let mut result: HashMap<String, usize> = HashMap::new();
// primary_pow_node should only be used for post request with remote PoW
// Get node urls and set path
let nodes = self.get_nodes(path, query, false, prefer_permanode)?;
if self.quorum && need_quorum && nodes.len() < self.min_quorum_size {
return Err(Error::QuorumPoolSizeError {
available_nodes: nodes.len(),
minimum_threshold: self.min_quorum_size,
});
}
// Track amount of results for quorum
let mut result_counter = 0;
let mut error: Option<Error> = None;
// Send requests parallel for quorum
#[cfg(target_family = "wasm")]
let wasm = true;
#[cfg(not(target_family = "wasm"))]
let wasm = false;
if !wasm && self.quorum && need_quorum && query.is_none() {
#[cfg(not(target_family = "wasm"))]
{
let mut tasks = Vec::new();
for (index, node) in nodes.into_iter().enumerate() {
if index < self.min_quorum_size {
let client_ = self.http_client.clone();
tasks.push(async move { tokio::spawn(async move { client_.get(node, timeout).await }).await });
}
}
for res in futures::future::try_join_all(tasks).await? {
match res {
Ok(res) => (res.into_text().await).map_or_else(
|_| {
log::warn!("couldn't convert node response to text");
},
|res_text| {
let counters = result.entry(res_text).or_insert(0);
*counters += 1;
result_counter += 1;
},
),
Err(err) => {
error.replace(err.into());
}
}
}
}
} else {
// Send requests
for node in nodes {
match self.http_client.get(node.clone(), timeout).await {
Ok(res) => {
// Handle node_info extra because we also want to return the url
if path == crate::client::node_api::core::routes::INFO_PATH {
let node_info: InfoResponse = res.into_json().await?;
let wrapper = crate::client::node_api::core::routes::NodeInfoWrapper {
node_info,
url: format!("{}://{}", node.url.scheme(), node.url.host_str().unwrap_or("")),
};
let serde_res = serde_json::to_string(&wrapper)?;
return Ok(serde_json::from_str(&serde_res)?);
}
match res.into_json::<T>().await {
Ok(result_data) => {
let counters = result.entry(serde_json::to_string(&result_data)?).or_insert(0);
*counters += 1;
result_counter += 1;
// Without quorum it's enough if we got one response
if !self.quorum
|| result_counter >= self.min_quorum_size
|| !need_quorum
// with query we ignore quorum because the nodes can store a different amount of history
|| query.is_some()
{
break;
}
}
Err(e) => {
error.replace(e.into());
}
}
}
Err(err) => {
error.replace(err.into());
}
}
}
}
// Safe unwrap, there are nodes because we throw on empty nodepool.
// Each node will throw an error or return Ok()
let res = result.into_iter().max_by_key(|v| v.1).ok_or_else(|| error.unwrap())?;
// Return if quorum is false or check if quorum was reached
if !self.quorum
|| res.1 as f64 >= self.min_quorum_size as f64 * (self.quorum_threshold as f64 / 100.0)
|| !need_quorum
// with query we ignore quorum because the nodes can store a different amount of history
|| query.is_some()
{
Ok(serde_json::from_str(&res.0)?)
} else {
Err(Error::QuorumThresholdError {
quorum_size: res.1,
minimum_threshold: self.min_quorum_size,
})
}
}
// Only used for api/core/v2/blocks/{blockID}, that's why we don't need the quorum stuff
pub(crate) async fn get_request_bytes(
&self,
path: &str,
query: Option<&str>,
timeout: Duration,
) -> Result<Vec<u8>> {
// primary_pow_node should only be used for post request with remote Pow
// Get node urls and set path
let nodes = self.get_nodes(path, query, false, false)?;
let mut error = None;
// Send requests
for node in nodes {
match self.http_client.get_bytes(node, timeout).await {
Ok(res) => {
match res.into_bytes().await {
Ok(res_text) => return Ok(res_text),
Err(e) => error.replace(e.into()),
};
}
Err(err) => {
error.replace(err.into());
}
}
}
// Safe unwrap, there are nodes because we throw on empty nodepool.
// Each node will throw an error or return Ok()
Err(error.unwrap())
}
pub(crate) async fn post_request_bytes<T: serde::de::DeserializeOwned>(
&self,
path: &str,
timeout: Duration,
body: &[u8],
local_pow: bool,
) -> Result<T> {
// primary_pow_node should only be used for post request with remote PoW
let nodes = self.get_nodes(path, None, !local_pow, false)?;
let mut error = None;
// Send requests
for node in nodes {
match self.http_client.post_bytes(node, timeout, body).await {
Ok(res) => {
match res.into_json::<T>().await {
Ok(res) => return Ok(res),
Err(e) => error.replace(e.into()),
};
}
Err(e) => {
error.replace(Error::Node(e));
}
}
}
// Safe unwrap, there are nodes because we throw on empty nodepool.
// Each node will throw an error or return Ok()
Err(error.unwrap())
}
pub(crate) async fn post_request_json<T: serde::de::DeserializeOwned>(
&self,
path: &str,
timeout: Duration,
json: Value,
local_pow: bool,
) -> Result<T> {
// primary_pow_node should only be used for post request with remote PoW
let nodes = self.get_nodes(path, None, !local_pow, false)?;
let mut error = None;
// Send requests
for node in nodes {
match self.http_client.post_json(node, timeout, json.clone()).await {
Ok(res) => {
match res.into_json::<T>().await {
Ok(res) => return Ok(res),
Err(e) => error.replace(e.into()),
};
}
Err(e) => {
error.replace(Error::Node(e));
}
}
}
// Safe unwrap, there are nodes because we throw on empty nodepool.
// Each node will throw an error or return Ok()
Err(error.unwrap())
}
}