commonware-collector 2026.4.0

Collect responses to committable requests.
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

use super::types::{Request, Response};
use commonware_cryptography::ed25519::PublicKey;
use commonware_utils::channel::{fallible::OneshotExt, mpsc, oneshot};
use std::collections::HashMap;

/// A mock [crate::Handler] received a request.
#[derive(Debug, Clone)]
pub struct Processed {
    pub origin: PublicKey,
    pub request: Request,
    pub responded: bool,
}

/// A mock [crate::Handler].
#[derive(Clone)]
pub struct Handler {
    sender: mpsc::UnboundedSender<Processed>,

    /// Configured responses for specific request IDs
    responses: HashMap<u64, Response>,

    /// Whether to respond by default (if no specific response configured)
    respond_by_default: bool,
}

impl Handler {
    /// Create a new [Handler].
    pub fn new(respond_by_default: bool) -> (Self, mpsc::UnboundedReceiver<Processed>) {
        let (sender, receiver) = mpsc::unbounded_channel();
        (
            Self {
                sender,
                responses: HashMap::new(),
                respond_by_default,
            },
            receiver,
        )
    }

    /// Create a dummy [Handler] that doesn't track events.
    pub fn dummy() -> Self {
        let (sender, _) = mpsc::unbounded_channel();
        Self {
            sender,
            responses: HashMap::new(),
            respond_by_default: true,
        }
    }

    /// Configure a specific response for a request ID.
    pub fn set_response(&mut self, request_id: u64, response: Response) {
        self.responses.insert(request_id, response);
    }
}

impl crate::Handler for Handler {
    type PublicKey = PublicKey;
    type Request = Request;
    type Response = Response;

    async fn process(
        &mut self,
        origin: Self::PublicKey,
        request: Self::Request,
        responder: oneshot::Sender<Self::Response>,
    ) {
        let request_id = request.id;

        // Determine if we should respond
        let should_respond = self.responses.contains_key(&request_id) || self.respond_by_default;

        // Send event
        let _ = self.sender.send(Processed {
            origin,
            request: request.clone(),
            responded: should_respond,
        });

        // Send response if configured
        if let Some(response) = self.responses.get(&request_id) {
            responder.send_lossy(response.clone());
        } else if self.respond_by_default {
            responder.send_lossy(Response {
                id: request_id,
                result: request.data.wrapping_mul(2) as u64,
            });
        }
    }
}