rostra-client 0.1.3

Integration runtime for Rostra peer-to-peer clients
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
use std::collections::{BTreeMap, BTreeSet, HashMap};
use std::sync::Arc;
use std::time::Duration;

use rostra_client_db::{
    CurrentState, Database, EventContentState, EventRecord, IdsFollowersRecord,
};
use rostra_core::ShortEventId;
use rostra_core::event::{EventContentRaw, EventExt as _, SignedEvent, VerifiedEventContent};
use rostra_core::id::{RostraId, ToShort as _};
use rostra_util_error::{FmtCompact, WhateverResult};
use snafu::ResultExt as _;
use tokio::sync::broadcast;
use tokio::time::Instant;
use tracing::{debug, instrument, trace, warn};

/// Arc-wrapped followers map for cheap cloning
type FollowersMap = Arc<HashMap<RostraId, IdsFollowersRecord>>;

use crate::client::Client;
use crate::task::head_selection::sorted_heads;
use crate::task::outbound_deadline::{PEER_OPERATION_DEADLINE, within};

const LOG_TARGET: &str = "rostra::head_broadcaster";
const BROADCAST_RETRY_INITIAL_DELAY: Duration = Duration::from_secs(1);
const BROADCAST_RETRY_MAX_DELAY: Duration = Duration::from_secs(60);

#[derive(Debug, Clone, Copy)]
struct BroadcastPolicy {
    peer_deadline: Duration,
    retry_initial_delay: Duration,
    retry_max_delay: Duration,
}

const BROADCAST_POLICY: BroadcastPolicy = BroadcastPolicy {
    peer_deadline: PEER_OPERATION_DEADLINE,
    retry_initial_delay: BROADCAST_RETRY_INITIAL_DELAY,
    retry_max_delay: BROADCAST_RETRY_MAX_DELAY,
};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum BroadcastHeadOutcome {
    Delivered,
    Retry,
    Stop,
}

#[derive(Debug, Clone, Copy)]
struct BroadcastHeadReport {
    outcome: BroadcastHeadOutcome,
    delivered: usize,
    errors: usize,
    timeouts: usize,
}

pub struct HeadUpdateBroadcaster {
    client: crate::client::ClientHandle,
    networking: Arc<crate::net::ClientNetworking>,
    db: Arc<Database>,
    self_id: RostraId,
    self_followers: CurrentState<FollowersMap>,
    new_heads_rx: broadcast::Receiver<(RostraId, ShortEventId)>,
    new_content_rx: broadcast::Receiver<VerifiedEventContent>,
}

impl HeadUpdateBroadcaster {
    pub fn new(client: &Client) -> Self {
        debug!(target: LOG_TARGET, "Starting followee head broadcasting task" );
        Self {
            client: client.handle(),
            networking: client.networking().clone(),
            db: client.db().to_owned(),
            self_id: client.rostra_id(),

            self_followers: client.self_followers_subscribe(),
            new_heads_rx: client.db().new_heads_subscribe(),
            new_content_rx: client.db().new_content_subscribe(),
        }
    }

    /// Run the thread
    #[instrument(name = "head-update-broadcaster", skip(self), fields(self_id = %self.self_id.fmt_short()), ret)]
    pub async fn run(self) {
        self.run_with_policy(BROADCAST_POLICY).await;
    }

    async fn run_with_policy(mut self, policy: BroadcastPolicy) {
        let mut self_followers = self.self_followers.clone();
        let mut pending_heads = BTreeSet::new();
        let mut retry_at = BTreeMap::new();
        reconcile_pending_heads(&self.db, &mut pending_heads, &mut retry_at).await;

        loop {
            let followers = self_followers.snapshot();
            if let Some((head, event, event_content)) =
                take_one_ready_head(&self.db, &mut pending_heads, &retry_at).await
            {
                let attempt = retry_at
                    .get(&head)
                    .map_or(1, |retry| retry.retry_count.saturating_add(1));
                let started_at = Instant::now();
                let report = self
                    .broadcast_head(
                        head,
                        &event,
                        &event_content,
                        &followers,
                        policy.peer_deadline,
                    )
                    .await;
                let elapsed = started_at.elapsed();
                match report.outcome {
                    BroadcastHeadOutcome::Delivered => {
                        pending_heads.remove(&head);
                        retry_at.remove(&head);
                        log_broadcast_pass(
                            head,
                            followers.len() + 1,
                            attempt,
                            report,
                            elapsed,
                            None,
                        );
                    }
                    BroadcastHeadOutcome::Retry => {
                        let retry_count = retry_at
                            .get(&head)
                            .map_or(0, |retry_at| retry_at.retry_count);
                        let retry_delay = broadcast_retry_delay(retry_count, policy);
                        retry_at.insert(
                            head,
                            BroadcastRetry {
                                retry_count: retry_count.saturating_add(1),
                                at: Instant::now() + retry_delay,
                            },
                        );
                        log_broadcast_pass(
                            head,
                            followers.len() + 1,
                            attempt,
                            report,
                            elapsed,
                            Some(retry_delay),
                        );
                    }
                    BroadcastHeadOutcome::Stop => {
                        log_broadcast_pass(
                            head,
                            followers.len() + 1,
                            attempt,
                            report,
                            elapsed,
                            None,
                        );
                        return;
                    }
                }
                continue;
            }

            loop {
                let next_retry = retry_at
                    .iter()
                    .filter(|(head, _)| pending_heads.contains(head))
                    .map(|(_, retry_at)| retry_at.at)
                    .min()
                    .unwrap_or_else(|| Instant::now() + Duration::from_secs(24 * 60 * 60));
                let should_retry = tokio::select! {
                    res = self.new_heads_rx.recv() => {
                        match res {
                        Ok((author, head)) if author == self.self_id => {
                            trace!(target: LOG_TARGET, event_id = %head.to_short(), "Received exact self-head signal");
                            reconcile_pending_heads(&self.db, &mut pending_heads, &mut retry_at).await;
                            true
                        }
                        Ok(_) => false,
                        Err(broadcast::error::RecvError::Closed) => return,
                        Err(broadcast::error::RecvError::Lagged(skipped)) => {
                            warn!(
                                target: LOG_TARGET,
                                skipped,
                                "Head broadcast receiver lagged; recovering durable heads"
                            );
                            reconcile_pending_heads(&self.db, &mut pending_heads, &mut retry_at).await;
                            true
                        }
                    }
                    }
                    res = self.new_content_rx.recv() => {
                        match res {
                        Ok(content)
                            if content_completes_pending(
                                &content,
                                self.self_id,
                                &pending_heads,
                            ) =>
                        {
                            true
                        }
                        Ok(_) => false,
                        Err(broadcast::error::RecvError::Closed) => return,
                        Err(broadcast::error::RecvError::Lagged(skipped)) => {
                            warn!(
                                target: LOG_TARGET,
                                skipped,
                                "Content broadcast receiver lagged; reconciling durable heads"
                            );
                            reconcile_pending_heads(&self.db, &mut pending_heads, &mut retry_at).await;
                            true
                        }
                    }
                    }
                    res = self_followers.changed() => {
                        if res.is_err() {
                            return;
                        }
                        // New followers did not observe earlier incremental signals.
                        // Recover from the complete durable set.
                        reconcile_pending_heads(&self.db, &mut pending_heads, &mut retry_at).await;
                        true
                    }
                    _ = tokio::time::sleep_until(next_retry) => true,
                };
                if should_retry {
                    break;
                }
            }
            trace!(target: LOG_TARGET, "Woke up");
        }
    }

    async fn broadcast_head(
        &self,
        head: ShortEventId,
        event: &EventRecord,
        event_content: &EventContentRaw,
        followers: &FollowersMap,
        deadline: Duration,
    ) -> BroadcastHeadReport {
        debug!(
            target: LOG_TARGET,
            event_id = %head.to_short(),
            followers_num = followers.len(),
            "Broadcasting new head event to followers"
        );

        let mut delivered = 0;
        let mut errors = 0;
        let mut timeouts = 0;

        // Send to ourselves first, in case we have redundant nodes.
        for id in [self.self_id].into_iter().chain(followers.keys().copied()) {
            if self.client.app_ref_opt().is_none() {
                debug!(target: LOG_TARGET, "Client gone, quitting");
                return BroadcastHeadReport {
                    outcome: BroadcastHeadOutcome::Stop,
                    delivered,
                    errors,
                    timeouts,
                };
            }

            match within(
                deadline,
                self.broadcast_event(id, &event.signed, event_content),
            )
            .await
            {
                Ok(Ok(())) => delivered += 1,
                Ok(Err(err)) => {
                    errors += 1;
                    debug!(
                        target: LOG_TARGET,
                        err = %err.fmt_compact(),
                        id = %id.to_short(),
                        "Failed to broadcast new head to node"
                    );
                }
                Err(_) => {
                    timeouts += 1;
                    warn!(
                        target: LOG_TARGET,
                        id = %id.to_short(),
                        timeout_ms = deadline.as_millis(),
                        "Timed out broadcasting new head to node"
                    );
                }
            }
        }
        let outcome = if errors != 0 || timeouts != 0 {
            BroadcastHeadOutcome::Retry
        } else {
            BroadcastHeadOutcome::Delivered
        };
        BroadcastHeadReport {
            outcome,
            delivered,
            errors,
            timeouts,
        }
    }

    async fn broadcast_event(
        &self,
        id: RostraId,
        signed_event: &SignedEvent,
        event_content: &EventContentRaw,
    ) -> WhateverResult<()> {
        let conn = self
            .networking
            .connect_cached(id)
            .await
            .whatever_context("Couldn't connect")?;

        conn.feed_event(*signed_event, event_content.clone())
            .await
            .whatever_context("Failed broadcasting head event")?;

        Ok(())
    }
}

fn log_broadcast_pass(
    head: ShortEventId,
    recipients: usize,
    attempt: u32,
    report: BroadcastHeadReport,
    elapsed: Duration,
    retry_delay: Option<Duration>,
) {
    let outcome = match report.outcome {
        BroadcastHeadOutcome::Delivered => "delivered",
        BroadcastHeadOutcome::Retry => "retry",
        BroadcastHeadOutcome::Stop => "stop",
    };
    debug!(
        target: LOG_TARGET,
        parent: None,
        head = %head.to_short(),
        recipients,
        delivered = report.delivered,
        errors = report.errors,
        timeouts = report.timeouts,
        attempt,
        elapsed_ms = elapsed.as_millis(),
        outcome,
        retry_delay_ms = retry_delay.map_or(0, |delay| delay.as_millis()),
        "Head broadcast pass completed"
    );
}

async fn reconcile_current_heads(db: &Database, pending_heads: &mut BTreeSet<ShortEventId>) {
    *pending_heads = sorted_heads(&db.get_heads_self().await)
        .into_iter()
        .collect();
}

async fn reconcile_pending_heads(
    db: &Database,
    pending_heads: &mut BTreeSet<ShortEventId>,
    retry_at: &mut BTreeMap<ShortEventId, BroadcastRetry>,
) {
    reconcile_current_heads(db, pending_heads).await;
    retry_at.retain(|head, _| pending_heads.contains(head));
}

#[derive(Debug, Clone, Copy)]
struct BroadcastRetry {
    retry_count: u32,
    at: Instant,
}

fn broadcast_retry_delay(retry_count: u32, policy: BroadcastPolicy) -> Duration {
    policy
        .retry_initial_delay
        .checked_mul(1u32 << retry_count.min(31))
        .unwrap_or(Duration::MAX)
        .min(policy.retry_max_delay)
}

fn content_completes_pending(
    content: &VerifiedEventContent,
    self_id: RostraId,
    pending_heads: &BTreeSet<ShortEventId>,
) -> bool {
    content.event.event.author == self_id && pending_heads.contains(&content.event_id().to_short())
}

async fn take_one_ready_head(
    db: &Database,
    pending_heads: &mut BTreeSet<ShortEventId>,
    retry_at: &BTreeMap<ShortEventId, BroadcastRetry>,
) -> Option<(ShortEventId, EventRecord, EventContentRaw)> {
    for head in pending_heads.iter().copied().collect::<Vec<_>>() {
        if retry_at
            .get(&head)
            .is_some_and(|retry_at| Instant::now() < retry_at.at)
        {
            continue;
        }
        let Some(event) = db.get_event(head).await else {
            warn!(target: LOG_TARGET, event_id = %head.to_short(), "No head event!?");
            pending_heads.remove(&head);
            continue;
        };
        let content = db.get_event_content(head).await;
        if let Some(content) = content {
            return Some((head, event, content));
        }
        if event.content_len() == 0 {
            return Some((head, event, EventContentRaw::new(Vec::new())));
        }

        let content_state = db.get_event_content_state(head).await;
        if content_is_terminal(content_state) {
            debug!(target: LOG_TARGET, event_id = %head.to_short(), "Head content is terminally unavailable");
            pending_heads.remove(&head);
        } else {
            // `None` may mean content became ready after the availability read.
            // Keep the head so the already-queued content signal retries it.
            trace!(target: LOG_TARGET, event_id = %head.to_short(), "Head content not ready");
        }
        continue;
    }
    None
}

fn content_is_terminal(content_state: Option<EventContentState>) -> bool {
    matches!(
        content_state,
        Some(
            EventContentState::Deleted { .. }
                | EventContentState::Pruned
                | EventContentState::Invalid
        )
    )
}

#[cfg(test)]
mod tests;