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
use std::borrow::Cow;
use std::collections::BTreeMap;
use std::fmt::Debug;
use std::net::SocketAddr;
use std::sync::atomic::{AtomicBool, Ordering};
use std::sync::Arc;
use std::time::Duration;
use chitchat::transport::Transport;
use chitchat::{
spawn_chitchat,
ChitchatConfig,
ChitchatHandle,
ClusterStateSnapshot,
FailureDetectorConfig,
NodeId,
};
use tokio::sync::watch;
use tokio_stream::wrappers::WatchStream;
use tokio_stream::StreamExt;
use tracing::{debug, error, info};
use crate::error::NodeError;
use crate::statistics::ClusterStatistics;
use crate::DEFAULT_DATA_CENTER;
static DATA_CENTER_KEY: &str = "data_center";
const GOSSIP_INTERVAL: Duration = if cfg!(test) {
Duration::from_millis(500)
} else {
Duration::from_secs(1)
};
pub type NodeMembership = BTreeMap<crate::NodeId, ClusterMember>;
#[derive(Clone, Debug, Eq, PartialEq)]
pub struct ClusterMember {
pub node_id: crate::NodeId,
pub public_addr: SocketAddr,
pub data_center: String,
}
impl ClusterMember {
pub fn new(
node_id: crate::NodeId,
public_addr: SocketAddr,
data_center: String,
) -> Self {
Self {
node_id,
public_addr,
data_center,
}
}
pub fn chitchat_id(&self) -> String {
self.node_id.to_string()
}
}
impl From<ClusterMember> for NodeId {
fn from(member: ClusterMember) -> Self {
Self::new(member.chitchat_id(), member.public_addr)
}
}
pub struct ChitchatNode {
pub me: Cow<'static, ClusterMember>,
statistics: ClusterStatistics,
chitchat_handle: ChitchatHandle,
members: watch::Receiver<NodeMembership>,
stop: Arc<AtomicBool>,
}
impl ChitchatNode {
pub async fn connect(
me: ClusterMember,
listen_addr: SocketAddr,
cluster_id: String,
seed_nodes: Vec<String>,
failure_detector_config: FailureDetectorConfig,
transport: &dyn Transport,
statistics: ClusterStatistics,
) -> Result<Self, NodeError> {
info!(
cluster_id = %cluster_id,
node_id = %me.node_id,
public_addr = %me.public_addr,
listen_gossip_addr = %listen_addr,
peer_seed_addrs = %seed_nodes.join(", "),
"Joining cluster."
);
statistics.num_live_members.store(1, Ordering::Relaxed);
statistics.num_data_centers.store(1, Ordering::Relaxed);
let cfg = ChitchatConfig {
node_id: NodeId::from(me.clone()),
cluster_id: cluster_id.clone(),
gossip_interval: GOSSIP_INTERVAL,
listen_addr,
seed_nodes,
failure_detector_config,
is_ready_predicate: None,
};
let chitchat_handle = spawn_chitchat(
cfg,
vec![(DATA_CENTER_KEY.to_string(), me.data_center.clone())],
transport,
)
.await
.map_err(|e| NodeError::ChitChat(e.to_string()))?;
let chitchat = chitchat_handle.chitchat();
let (members_tx, members_rx) = watch::channel(BTreeMap::new());
let cluster = ChitchatNode {
me: Cow::Owned(me.clone()),
chitchat_handle,
statistics: statistics.clone(),
members: members_rx,
stop: Arc::new(Default::default()),
};
let initial_members: BTreeMap<crate::NodeId, ClusterMember> =
BTreeMap::from_iter([(me.node_id, me.clone())]);
if members_tx.send(initial_members).is_err() {
error!("Failed to add itself as the initial member of the cluster.");
}
let stop_flag = cluster.stop.clone();
tokio::spawn(async move {
let mut node_change_rx = chitchat.lock().await.ready_nodes_watcher();
while let Some(members_set) = node_change_rx.next().await {
let state_snapshot = {
let lock = chitchat.lock().await;
let dead_member_count = lock.dead_nodes().count();
statistics
.num_dead_members
.store(dead_member_count as u64, Ordering::Relaxed);
lock.state_snapshot()
};
let mut members = members_set
.into_iter()
.map(|node_id| build_cluster_member(&node_id, &state_snapshot))
.filter_map(|member_res| {
match member_res {
Ok(member) => {
Some((member.node_id, member))
},
Err(error) => {
error!(
error = ?error,
"Failed to build cluster member from cluster state, ignoring member.",
);
None
},
}
})
.collect::<BTreeMap<_, _>>();
members.insert(me.node_id, me.clone());
statistics
.num_live_members
.store(members.len() as u64, Ordering::Relaxed);
if stop_flag.load(Ordering::Relaxed) {
debug!("Received a stop signal. Stopping.");
break;
}
if members_tx.send(members).is_err() {
error!("Failed to update members list. Stopping.");
break;
}
}
Result::<(), NodeError>::Ok(())
});
Ok(cluster)
}
pub fn member_change_watcher(&self) -> WatchStream<NodeMembership> {
WatchStream::new(self.members.clone())
}
pub fn members_watcher(&self) -> watch::Receiver<NodeMembership> {
self.members.clone()
}
#[cfg(test)]
pub fn members(&self) -> NodeMembership {
self.members.borrow().clone()
}
#[inline]
pub fn statistics(&self) -> ClusterStatistics {
self.statistics.clone()
}
pub async fn shutdown(self) {
info!(self_addr = ?self.me.public_addr, "Shutting down the cluster.");
let result = self.chitchat_handle.shutdown().await;
if let Err(error) = result {
error!(self_addr = ?self.me.public_addr, error = ?error, "Error while shutting down.");
}
self.stop.store(true, Ordering::Relaxed);
}
pub async fn wait_for_members<F>(
self: &ChitchatNode,
mut predicate: F,
timeout_after: Duration,
) -> Result<(), anyhow::Error>
where
F: FnMut(&NodeMembership) -> bool,
{
use tokio::time::timeout;
timeout(
timeout_after,
self.member_change_watcher()
.skip_while(|members| !predicate(members))
.next(),
)
.await?;
Ok(())
}
}
fn build_cluster_member<'a>(
chitchat_id: &'a NodeId,
state: &'a ClusterStateSnapshot,
) -> Result<ClusterMember, String> {
let node_state = state.node_states.get(&chitchat_id.id).ok_or_else(|| {
format!(
"Could not find node ID `{}` in ChitChat state.",
chitchat_id.id
)
})?;
let data_center = node_state
.get(DATA_CENTER_KEY)
.unwrap_or(DEFAULT_DATA_CENTER);
let node_id = chitchat_id
.id
.parse::<crate::NodeId>()
.map_err(|e| format!("Invalid node ID: {e}"))?;
Ok(ClusterMember::new(
node_id,
chitchat_id.gossip_public_address,
data_center.to_owned(),
))
}
#[cfg(test)]
mod tests {
use std::sync::atomic::AtomicU8;
use anyhow::Result;
use chitchat::transport::{ChannelTransport, Transport};
use super::*;
#[tokio::test]
async fn test_cluster_single_node() -> Result<()> {
let _ = tracing_subscriber::fmt::try_init();
let transport = ChannelTransport::default();
let cluster = create_node_for_test(Vec::new(), &transport).await?;
let members: Vec<SocketAddr> = cluster
.members()
.values()
.map(|member| member.public_addr)
.collect();
let expected_members = vec![cluster.me.public_addr];
assert_eq!(members, expected_members);
cluster.shutdown().await;
Ok(())
}
#[tokio::test]
async fn test_cluster_propagated_state() -> Result<()> {
let _ = tracing_subscriber::fmt::try_init();
let transport = ChannelTransport::default();
let node1 = create_node_for_test(Vec::new(), &transport).await?;
let node_1_gossip_addr = node1.me.public_addr.to_string();
let node2 =
create_node_for_test(vec![node_1_gossip_addr.clone()], &transport).await?;
let node3 = create_node_for_test(vec![node_1_gossip_addr], &transport).await?;
let wait_secs = Duration::from_secs(30);
for cluster in [&node1, &node2, &node3] {
cluster
.wait_for_members(|members| members.len() == 3, wait_secs)
.await
.unwrap();
}
for (id, member) in node1.members() {
dbg!(id, &member.public_addr);
}
Ok(())
}
fn create_failure_detector_config_for_test() -> FailureDetectorConfig {
FailureDetectorConfig {
phi_threshold: 6.0,
initial_interval: GOSSIP_INTERVAL,
..Default::default()
}
}
pub async fn create_node_for_test_with_id(
node_id: crate::NodeId,
cluster_id: String,
seeds: Vec<String>,
transport: &dyn Transport,
) -> Result<ChitchatNode> {
let public_addr: SocketAddr = ([127, 0, 0, 1], node_id as u16).into();
let failure_detector_config = create_failure_detector_config_for_test();
let node = ChitchatNode::connect(
ClusterMember::new(node_id, public_addr, "unknown".to_string()),
public_addr,
cluster_id,
seeds,
failure_detector_config,
transport,
ClusterStatistics::default(),
)
.await?;
Ok(node)
}
pub async fn create_node_for_test(
seeds: Vec<String>,
transport: &dyn Transport,
) -> Result<ChitchatNode> {
static NODE_AUTO_INCREMENT: AtomicU8 = AtomicU8::new(1);
let node_id = NODE_AUTO_INCREMENT.fetch_add(1, Ordering::Relaxed);
let node = create_node_for_test_with_id(
node_id,
"test-cluster".to_string(),
seeds,
transport,
)
.await?;
Ok(node)
}
}