pollen-crdt 0.1.0

CRDT synchronization for Pollen
Documentation
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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
//! CRDT synchronization service.
//!
//! Implements anti-entropy synchronization using hierarchical Merkle tree diffing
//! for efficient detection of divergent state between nodes.

use crate::{CrdtEntry, CrdtKv, CrdtStore};
use bytes::Bytes;
use pollen_membership::Membership;
use pollen_transport::{Envelope, MessageType, Transport};
use pollen_types::{NodeId, Result};
use serde::{Deserialize, Serialize};
use std::sync::Arc;
use std::time::Duration;
use tokio::sync::watch;
use tracing::{debug, info, warn};

/// Configuration for CRDT sync.
#[derive(Clone, Debug)]
pub struct CrdtSyncConfig {
    /// Interval for anti-entropy sync.
    pub sync_interval: Duration,
    /// Interval for delta broadcasting.
    pub broadcast_interval: Duration,
    /// Maximum entries per sync message.
    pub max_entries_per_msg: usize,
    /// Timeout for sync requests.
    pub sync_timeout: Duration,
}

impl Default for CrdtSyncConfig {
    fn default() -> Self {
        Self {
            sync_interval: Duration::from_secs(10),
            broadcast_interval: Duration::from_millis(100),
            max_entries_per_msg: 100,
            sync_timeout: Duration::from_secs(5),
        }
    }
}

/// Merkle tree sync request.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct MerkleRequest {
    /// Level in the Merkle tree (0 = root, 1 = first level, etc.)
    pub level: usize,
    /// Our hashes at this level.
    pub hashes: Vec<(String, Bytes)>,
}

/// Merkle tree sync response.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct MerkleResponse {
    /// Level in the Merkle tree.
    pub level: usize,
    /// Their hashes at this level.
    pub hashes: Vec<(String, Bytes)>,
    /// Differing buckets to drill down into.
    pub differing_buckets: Vec<String>,
}

/// Data range request.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct DataRangeRequest {
    /// Start key (inclusive).
    pub start: String,
    /// End key (exclusive).
    pub end: String,
}

/// CRDT synchronization service.
pub struct CrdtSyncService {
    node_id: NodeId,
    crdt_store: Arc<CrdtStore>,
    transport: Arc<dyn Transport>,
    membership: Arc<dyn Membership>,
    config: CrdtSyncConfig,
    shutdown: watch::Sender<bool>,
}

impl CrdtSyncService {
    /// Create a new sync service.
    pub fn new(
        node_id: NodeId,
        crdt_store: Arc<CrdtStore>,
        transport: Arc<dyn Transport>,
        membership: Arc<dyn Membership>,
        config: CrdtSyncConfig,
    ) -> Self {
        let (shutdown, _) = watch::channel(false);

        Self {
            node_id,
            crdt_store,
            transport,
            membership,
            config,
            shutdown,
        }
    }

    /// Start the sync service.
    pub fn start(self: Arc<Self>) {
        let service = Arc::clone(&self);
        tokio::spawn(async move {
            service.run_anti_entropy().await;
        });

        let service = Arc::clone(&self);
        tokio::spawn(async move {
            service.run_delta_broadcast().await;
        });

        info!("CRDT sync service started");
    }

    /// Run anti-entropy loop.
    async fn run_anti_entropy(&self) {
        let mut interval = tokio::time::interval(self.config.sync_interval);
        let mut shutdown_rx = self.shutdown.subscribe();

        loop {
            tokio::select! {
                _ = shutdown_rx.changed() => {
                    if *shutdown_rx.borrow() {
                        break;
                    }
                }
                _ = interval.tick() => {
                    if let Err(e) = self.anti_entropy_round().await {
                        warn!("Anti-entropy round failed: {}", e);
                    }
                }
            }
        }
    }

    /// Perform one round of anti-entropy sync with a random peer.
    async fn anti_entropy_round(&self) -> Result<()> {
        let peers = self.membership.alive_members();
        if peers.len() <= 1 {
            // No other peers to sync with
            return Ok(());
        }

        // Pick a random peer (excluding self)
        let other_peers: Vec<_> = peers.iter().filter(|p| p.id != self.node_id).collect();
        if other_peers.is_empty() {
            return Ok(());
        }

        let peer_idx = rand::random::<usize>() % other_peers.len();
        let peer = other_peers[peer_idx];

        debug!("Starting anti-entropy sync with {:?}", peer.id);

        // Start with root level comparison
        self.sync_with_peer(peer.id, peer.addr).await
    }

    /// Perform hierarchical Merkle tree sync with a specific peer.
    async fn sync_with_peer(&self, peer_id: NodeId, peer_addr: std::net::SocketAddr) -> Result<()> {
        // Get our Merkle root
        let my_root = self.crdt_store.merkle_root();

        // Request peer's root
        let request = MerkleRequest {
            level: 0,
            hashes: vec![("root".to_string(), my_root.clone())],
        };

        let payload = bincode::serialize(&request)?;
        let envelope = Envelope::new(
            self.node_id,
            peer_id,
            MessageType::MerkleTreeRequest,
            Bytes::from(payload),
            pollen_clock::Timestamp::zero(),
        );

        // Send and wait for response
        let response = match tokio::time::timeout(
            self.config.sync_timeout,
            self.transport.send_recv(peer_addr, envelope),
        )
        .await
        {
            Ok(Ok(resp)) => resp,
            Ok(Err(e)) => {
                debug!("Failed to get Merkle response from {:?}: {}", peer_id, e);
                return Ok(());
            }
            Err(_) => {
                debug!("Merkle request to {:?} timed out", peer_id);
                return Ok(());
            }
        };

        // Parse response
        if response.msg_type != MessageType::MerkleTreeResponse {
            return Ok(());
        }

        let merkle_response: MerkleResponse = bincode::deserialize(&response.payload)?;

        // If roots match, we're in sync
        if merkle_response.differing_buckets.is_empty() {
            debug!("In sync with {:?}", peer_id);
            return Ok(());
        }

        // Drill down into differing buckets
        self.sync_differing_ranges(peer_id, peer_addr, &merkle_response.differing_buckets)
            .await
    }

    /// Sync specific key ranges that differ.
    async fn sync_differing_ranges(
        &self,
        peer_id: NodeId,
        peer_addr: std::net::SocketAddr,
        ranges: &[String],
    ) -> Result<()> {
        for range in ranges {
            // Request data in this range
            let (start, end) = self.range_from_bucket(range);

            let request = DataRangeRequest {
                start: start.clone(),
                end: end.clone(),
            };

            let payload = bincode::serialize(&request)?;
            let envelope = Envelope::new(
                self.node_id,
                peer_id,
                MessageType::DataRangeRequest,
                Bytes::from(payload),
                pollen_clock::Timestamp::zero(),
            );

            let response = match tokio::time::timeout(
                self.config.sync_timeout,
                self.transport.send_recv(peer_addr, envelope),
            )
            .await
            {
                Ok(Ok(resp)) => resp,
                Ok(Err(e)) => {
                    warn!("Failed to get data range from {:?}: {}", peer_id, e);
                    continue;
                }
                Err(_) => {
                    warn!("Data range request to {:?} timed out", peer_id);
                    continue;
                }
            };

            if response.msg_type != MessageType::DataRangeResponse {
                continue;
            }

            // Apply received entries
            let entries: Vec<CrdtEntry> = bincode::deserialize(&response.payload)?;
            for entry in entries {
                if let Err(e) = self.crdt_store.apply_delta(entry).await {
                    warn!("Failed to apply synced entry: {}", e);
                }
            }

            // Send our entries in this range to peer
            let our_entries = self.crdt_store.entries_in_range(&start, &end);
            if !our_entries.is_empty() {
                for chunk in our_entries.chunks(self.config.max_entries_per_msg) {
                    let payload = bincode::serialize(&chunk.to_vec())?;
                    let envelope = Envelope::new(
                        self.node_id,
                        peer_id,
                        MessageType::CrdtFullSync,
                        Bytes::from(payload),
                        pollen_clock::Timestamp::zero(),
                    );
                    let _ = self.transport.send(peer_addr, envelope).await;
                }
            }
        }

        Ok(())
    }

    /// Convert a bucket identifier to a key range.
    fn range_from_bucket(&self, bucket: &str) -> (String, String) {
        // Bucket format: "level:index" or just use the bucket as a prefix
        // For simplicity, treat bucket as a key prefix
        let start = bucket.to_string();
        let end = format!("{}~", bucket); // '~' is after most printable chars in ASCII
        (start, end)
    }

    /// Run delta broadcast loop.
    async fn run_delta_broadcast(&self) {
        let mut rx = self.crdt_store.subscribe("");
        let mut shutdown_rx = self.shutdown.subscribe();

        loop {
            tokio::select! {
                _ = shutdown_rx.changed() => {
                    if *shutdown_rx.borrow() {
                        break;
                    }
                }
                event = rx.recv() => {
                    match event {
                        Ok(crate::CrdtEvent::Updated { key }) => {
                            if let Err(e) = self.broadcast_key(&key).await {
                                warn!("Failed to broadcast delta for {}: {}", key, e);
                            }
                        }
                        Ok(crate::CrdtEvent::Deleted { key }) => {
                            if let Err(e) = self.broadcast_key(&key).await {
                                warn!("Failed to broadcast deletion for {}: {}", key, e);
                            }
                        }
                        Err(_) => {
                            // Channel lagged, that's okay
                        }
                    }
                }
            }
        }
    }

    /// Broadcast a key update to all peers.
    async fn broadcast_key(&self, key: &str) -> Result<()> {
        let entries = self.crdt_store.entries_in_range(key, &format!("{}~", key));
        if entries.is_empty() {
            return Ok(());
        }

        let entry = &entries[0];
        let peers = self.membership.alive_members();

        for peer in peers {
            if peer.id == self.node_id {
                continue;
            }

            let payload = bincode::serialize(&vec![entry.clone()])?;
            let envelope = Envelope::new(
                self.node_id,
                peer.id,
                MessageType::CrdtDelta,
                Bytes::from(payload),
                pollen_clock::Timestamp::zero(),
            );

            // Fire and forget
            let transport = Arc::clone(&self.transport);
            let addr = peer.addr;
            tokio::spawn(async move {
                let _ = transport.send(addr, envelope).await;
            });
        }

        Ok(())
    }

    /// Handle incoming CRDT messages.
    pub async fn handle_message(&self, envelope: Envelope) -> Result<Option<Envelope>> {
        match envelope.msg_type {
            MessageType::CrdtDelta | MessageType::CrdtFullSync => {
                let entries: Vec<CrdtEntry> = bincode::deserialize(&envelope.payload)?;
                for entry in entries {
                    if let Err(e) = self.crdt_store.apply_delta(entry).await {
                        warn!("Failed to apply delta: {}", e);
                    }
                }
                Ok(None)
            }

            MessageType::MerkleTreeRequest => {
                let request: MerkleRequest = bincode::deserialize(&envelope.payload)?;
                let response = self.handle_merkle_request(request);
                let payload = bincode::serialize(&response)?;

                Ok(Some(Envelope::new(
                    self.node_id,
                    envelope.from,
                    MessageType::MerkleTreeResponse,
                    Bytes::from(payload),
                    pollen_clock::Timestamp::zero(),
                )))
            }

            MessageType::DataRangeRequest => {
                let request: DataRangeRequest = bincode::deserialize(&envelope.payload)?;
                let entries = self.crdt_store.entries_in_range(&request.start, &request.end);
                let payload = bincode::serialize(&entries)?;

                Ok(Some(Envelope::new(
                    self.node_id,
                    envelope.from,
                    MessageType::DataRangeResponse,
                    Bytes::from(payload),
                    pollen_clock::Timestamp::zero(),
                )))
            }

            _ => Ok(None),
        }
    }

    /// Handle Merkle tree request and compute differing buckets.
    fn handle_merkle_request(&self, request: MerkleRequest) -> MerkleResponse {
        let my_hashes = self.crdt_store.merkle_level(request.level);

        // Find differing buckets
        let mut differing = Vec::new();

        for (bucket, their_hash) in &request.hashes {
            let my_hash = my_hashes
                .iter()
                .find(|(b, _)| b == bucket)
                .map(|(_, h)| h.clone());

            match my_hash {
                Some(h) if h != *their_hash => {
                    differing.push(bucket.clone());
                }
                None => {
                    // We don't have this bucket, might need their data
                    differing.push(bucket.clone());
                }
                _ => {}
            }
        }

        // Also check for buckets we have that they don't
        for (bucket, _) in &my_hashes {
            if !request.hashes.iter().any(|(b, _)| b == bucket) {
                differing.push(bucket.clone());
            }
        }

        MerkleResponse {
            level: request.level,
            hashes: my_hashes,
            differing_buckets: differing,
        }
    }

    /// Shutdown the sync service.
    pub fn shutdown(&self) {
        let _ = self.shutdown.send(true);
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_config_default() {
        let config = CrdtSyncConfig::default();
        assert_eq!(config.sync_interval, Duration::from_secs(10));
        assert_eq!(config.sync_timeout, Duration::from_secs(5));
    }

    #[test]
    fn test_merkle_request_serialization() {
        let request = MerkleRequest {
            level: 1,
            hashes: vec![
                ("bucket1".to_string(), Bytes::from("hash1")),
                ("bucket2".to_string(), Bytes::from("hash2")),
            ],
        };

        let serialized = bincode::serialize(&request).unwrap();
        let deserialized: MerkleRequest = bincode::deserialize(&serialized).unwrap();

        assert_eq!(deserialized.level, 1);
        assert_eq!(deserialized.hashes.len(), 2);
    }

    #[test]
    fn test_data_range_request_serialization() {
        let request = DataRangeRequest {
            start: "task:".to_string(),
            end: "task:~".to_string(),
        };

        let serialized = bincode::serialize(&request).unwrap();
        let deserialized: DataRangeRequest = bincode::deserialize(&serialized).unwrap();

        assert_eq!(deserialized.start, "task:");
        assert_eq!(deserialized.end, "task:~");
    }
}