mrpc 0.1.0

MessagePack-RPC for Rust
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

//! Ping-pong integration tests for mrpc bidirectional communication.

#![allow(clippy::tests_outside_test_module)]

use std::{error::Error, sync::Arc, time::Duration};

use async_trait::async_trait;
use mrpc::{self, Client, Connection, RpcError, RpcSender, Server};
use rmpv::Value;
use tempfile::tempdir;
use tokio::{
    sync::{Mutex, oneshot},
    time::timeout,
};
use tracing_test::traced_test;

#[derive(Clone)]
struct PingService {
    pong_count: Arc<Mutex<i32>>,
    connected_count: Arc<Mutex<i32>>,
    done_tx: Arc<Mutex<Option<oneshot::Sender<()>>>>,
    target_pongs: i32,
}

#[async_trait]
impl Connection for PingService {
    async fn connected(&self, _client: RpcSender) -> mrpc::Result<()> {
        let mut count = self.connected_count.lock().await;
        *count += 1;
        Ok(())
    }

    async fn handle_request(
        &self,
        _sender: RpcSender,
        method: &str,
        _params: Vec<Value>,
    ) -> mrpc::Result<Value> {
        Err(RpcError::Protocol(
            format!("PingService: Unknown method: {}", method).into(),
        ))
    }

    async fn handle_notification(
        &self,
        _sender: RpcSender,
        method: &str,
        _params: Vec<Value>,
    ) -> mrpc::Result<()> {
        if method == "pong" {
            let mut count = self.pong_count.lock().await;
            *count += 1;
            if *count == self.target_pongs {
                let done_tx = self.done_tx.lock().await.take();
                if let Some(done_tx) = done_tx {
                    let _send_result = done_tx.send(());
                }
            }
        }
        Ok(())
    }
}

#[derive(Clone, Default)]
struct PongService {
    connected_count: Arc<Mutex<i32>>,
}

#[async_trait]
impl Connection for PongService {
    async fn connected(&self, _client: RpcSender) -> mrpc::Result<()> {
        let mut count = self.connected_count.lock().await;
        *count += 1;
        Ok(())
    }

    async fn handle_request(
        &self,
        sender: RpcSender,
        method: &str,
        _params: Vec<Value>,
    ) -> mrpc::Result<Value> {
        match method {
            "ping" => {
                sender
                    .send_notification("pong", &[Value::String("pong".into())])
                    .await?;
                Ok(Value::Boolean(true))
            }
            _ => Err(RpcError::Protocol(
                format!("PongService: Unknown method: {}", method).into(),
            )),
        }
    }
}

#[traced_test]
#[tokio::test]
async fn test_pingpong() -> Result<(), Box<dyn Error>> {
    let temp_dir = tempdir()?;
    let socket_path = temp_dir.path().join("pong.sock");

    // Set up the Pong server
    let server: Server<PongService> = Server::from_fn(PongService::default)
        .unix(&socket_path)
        .await?;
    let server_handle = server.spawn().await?;

    // Set up the Ping client
    let pong_count = Arc::new(Mutex::new(0));
    let num_pings = 5;
    let (done_tx, done_rx) = oneshot::channel();
    let ping_service = PingService {
        pong_count: pong_count.clone(),
        connected_count: Arc::new(Mutex::new(0)),
        done_tx: Arc::new(Mutex::new(Some(done_tx))),
        target_pongs: num_pings,
    };
    let client = Client::connect_unix(&socket_path, ping_service.clone()).await?;

    // Start the ping-pong process
    for _ in 0..num_pings {
        client.send_request("ping", &[]).await?;
    }

    timeout(Duration::from_secs(5), done_rx)
        .await
        .map_err(|_| RpcError::Protocol("Timed out waiting for pongs".into()))?
        .map_err(|_| RpcError::Protocol("Pong signal dropped unexpectedly".into()))?;

    let final_pong_count = *pong_count.lock().await;
    let final_connected_count = *ping_service.connected_count.lock().await;

    assert_eq!(final_pong_count, num_pings, "Pong count mismatch");
    assert_eq!(final_connected_count, 1, "Connected count mismatch");

    drop(client);
    server_handle.shutdown();
    server_handle.join().await?;
    Ok(())
}