vox 0.4.0

Core Vox library crate
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

//! Tests for vox::serve().

use std::sync::Arc;

#[vox::service]
trait Echo {
    async fn echo(&self, value: u32) -> u32;
}

#[derive(Clone)]
struct EchoService;

impl Echo for EchoService {
    async fn echo(&self, value: u32) -> u32 {
        value
    }
}

#[vox::service]
trait Ping {
    async fn ping(&self, value: u32) -> u32;
}

#[derive(Clone)]
struct PingService;

impl Ping for PingService {
    async fn ping(&self, value: u32) -> u32 {
        value
    }
}

#[tokio::test]
async fn serve_and_connect() {
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0")
        .await
        .expect("bind");
    let addr = listener.local_addr().expect("local_addr");

    let server = tokio::spawn(async move {
        vox::serve_listener(listener, EchoDispatcher::new(EchoService))
            .await
            .expect("serve");
    });

    // Give server a moment to start accepting.
    tokio::time::sleep(std::time::Duration::from_millis(50)).await;

    let client: EchoClient = vox::connect(format!("tcp://{addr}"))
        .await
        .expect("connect");
    let result = client.echo(42).await.expect("echo");
    assert_eq!(result, 42);

    server.abort();
}

// r[verify rpc.session-setup]
#[tokio::test]
async fn connect_builder_establish_matches_await() {
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0")
        .await
        .expect("bind");
    let addr = listener.local_addr().expect("local_addr");

    let server = tokio::spawn(async move {
        vox::serve_listener(listener, EchoDispatcher::new(EchoService))
            .await
            .expect("serve");
    });

    tokio::time::sleep(std::time::Duration::from_millis(50)).await;

    let client = vox::connect::<EchoClient>(format!("tcp://{addr}"))
        .establish()
        .await
        .expect("connect");
    let result = client.echo(77).await.expect("echo");
    assert_eq!(result, 77);

    server.abort();
}

// r[verify rpc.virtual-connection.accept]
#[tokio::test]
async fn connect_builder_can_configure_inbound_virtual_connections_before_await() {
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0")
        .await
        .expect("bind");
    let addr = listener.local_addr().expect("local_addr");
    let accepted = Arc::new(tokio::sync::Notify::new());
    let accepted_server = accepted.clone();

    let server = tokio::spawn(async move {
        let (socket, _) = listener.accept().await.expect("accept");
        let root = vox::acceptor_on(vox::transport::tcp::StreamLink::tcp(socket))
            .on_connection(PingDispatcher::new(PingService))
            .establish::<vox::NoopClient>()
            .await
            .expect("server establish");
        let session = root.session.clone().expect("server session");
        let client: EchoClient = session
            .open(vox::ConnectionSettings {
                parity: vox::Parity::Odd,
                max_concurrent_requests: 64,
            })
            .await
            .expect("open echo client");
        let echoed = client.echo(41).await.expect("echo");
        assert_eq!(echoed, 41);
        accepted_server.notify_one();
        root
    });

    let client: PingClient = vox::connect(format!("tcp://{addr}"))
        .on_connection(EchoDispatcher::new(EchoService))
        .await
        .expect("connect");

    let pinged = client.ping(9).await.expect("ping");
    assert_eq!(pinged, 9);

    tokio::time::timeout(std::time::Duration::from_secs(1), accepted.notified())
        .await
        .expect("server never used inbound virtual connection");

    let _server_root = server.await.expect("server task");
}

#[cfg(unix)]
#[tokio::test]
async fn serve_local_with_lock() {
    let dir = tempfile::tempdir().expect("tempdir");
    let sock_path = dir.path().join("echo.sock");
    let addr = format!("local://{}", sock_path.display());

    let server = {
        let addr = addr.clone();
        tokio::spawn(async move {
            vox::serve(&addr, EchoDispatcher::new(EchoService))
                .await
                .expect("serve");
        })
    };

    tokio::time::sleep(std::time::Duration::from_millis(50)).await;

    let client: EchoClient = vox::connect(&addr).await.expect("connect");
    let result = client.echo(99).await.expect("echo");
    assert_eq!(result, 99);

    // A second bind should fail with AddrInUse while the first is alive.
    let err = vox_stream::LocalLinkAcceptor::bind_with_lock(sock_path.to_str().unwrap())
        .err()
        .expect("second bind should fail");
    assert_eq!(err.kind(), std::io::ErrorKind::AddrInUse);

    server.abort();
}

#[cfg(feature = "transport-websocket")]
#[tokio::test]
async fn serve_websocket() {
    let listener = tokio::net::TcpListener::bind("127.0.0.1:0")
        .await
        .expect("bind");
    let addr = listener.local_addr().expect("local_addr");

    let server = tokio::spawn(async move {
        vox::serve_listener(
            vox::WsListener::from_tcp(listener),
            EchoDispatcher::new(EchoService),
        )
        .await
        .expect("serve");
    });

    tokio::time::sleep(std::time::Duration::from_millis(50)).await;

    let client: EchoClient = vox::connect(format!("ws://{addr}")).await.expect("connect");
    let result = client.echo(7).await.expect("echo");
    assert_eq!(result, 7);

    server.abort();
}

#[cfg(feature = "transport-websocket")]
#[tokio::test]
async fn serve_websocket_string() {
    let server = tokio::spawn(async move {
        vox::serve("ws://127.0.0.1:0", EchoDispatcher::new(EchoService))
            .await
            .expect("serve");
    });

    // Port 0 won't work with the string API since we can't discover the bound port.
    // This test just verifies the code path compiles and starts. Abort immediately.
    tokio::time::sleep(std::time::Duration::from_millis(50)).await;
    server.abort();
}

#[cfg(unix)]
#[tokio::test]
async fn serve_local_lock_released_after_drop() {
    let dir = tempfile::tempdir().expect("tempdir");
    let sock_path = dir.path().join("echo.sock");
    let path_str = sock_path.to_str().unwrap();

    // First bind succeeds.
    let (acceptor, lock) =
        vox_stream::LocalLinkAcceptor::bind_with_lock(path_str).expect("first bind");
    drop(acceptor);
    drop(lock);

    // After dropping the lock, a second bind should succeed.
    let (_acceptor2, _lock2) = vox_stream::LocalLinkAcceptor::bind_with_lock(path_str)
        .expect("second bind after lock release");
}