livekit 0.9.6

Rust Client SDK for LiveKit
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

// Copyright 2025 LiveKit, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#[cfg(feature = "__lk-e2e-test")]
use {
    anyhow::{Context, Result},
    common::test_rooms,
    livekit::{prelude::PerformRpcData, RoomEvent},
    std::time::Duration,
    tokio::sync::mpsc::UnboundedReceiver,
};

mod common;

#[cfg(feature = "__lk-e2e-test")]
#[test_log::test(tokio::test)]
pub async fn test_rpc_invocation() -> Result<()> {
    let mut rooms = test_rooms(2).await?;
    let (caller_room, _) = rooms.pop().unwrap();
    let (callee_room, _) = rooms.pop().unwrap();
    let callee_identity = callee_room.local_participant().identity();

    const METHOD_NAME: &str = "test-method";
    const PAYLOAD: &str = "test-payload";

    callee_room.local_participant().register_rpc_method(METHOD_NAME.to_string(), |data| {
        // Echo caller payload as return value
        Box::pin(async move { Ok(data.payload.to_string()) })
    });

    let perform_data = PerformRpcData::new(callee_identity.clone(), METHOD_NAME)
        .with_payload(PAYLOAD)
        .with_response_timeout(Duration::from_millis(500));
    let return_payload = caller_room
        .local_participant()
        .perform_rpc(perform_data)
        .await
        .context("Invocation failed")?;
    assert_eq!(return_payload, PAYLOAD, "Unexpected return value");
    Ok(())
}

#[cfg(feature = "__lk-e2e-test")]
#[test_log::test(tokio::test)]
pub async fn test_rpc_unregistered() -> Result<()> {
    let mut rooms = test_rooms(2).await?;
    let (caller_room, _) = rooms.pop().unwrap();
    let (callee_room, _) = rooms.pop().unwrap();
    let callee_identity = callee_room.local_participant().identity();

    const METHOD_NAME: &str = "unregistered-method";
    const PAYLOAD: &str = "test-payload";

    let perform_data = PerformRpcData::new(callee_identity.clone(), METHOD_NAME)
        .with_payload(PAYLOAD)
        .with_response_timeout(Duration::from_millis(500));
    let result = caller_room.local_participant().perform_rpc(perform_data).await;
    assert!(result.is_err(), "Expected error");
    Ok(())
}

#[cfg(feature = "__lk-e2e-test")]
#[test_log::test(tokio::test)]
pub async fn test_rpc_large_payload() -> Result<()> {
    let mut rooms = test_rooms(2).await?;
    let (caller_room, _) = rooms.pop().unwrap();
    let (callee_room, _) = rooms.pop().unwrap();
    let callee_identity = callee_room.local_participant().identity();

    const METHOD_NAME: &str = "large-payload-method";
    // 20KB payload - exceeds 15KB v1 limit but works with v2 data streams
    let large_payload: String = "x".repeat(20_000);

    callee_room.local_participant().register_rpc_method(METHOD_NAME.to_string(), |data| {
        Box::pin(async move { Ok(data.payload.to_string()) })
    });

    let perform_data = PerformRpcData::new(callee_identity.clone(), METHOD_NAME)
        .with_payload(large_payload.clone())
        .with_response_timeout(Duration::from_secs(5));
    let return_payload = caller_room
        .local_participant()
        .perform_rpc(perform_data)
        .await
        .context("Large payload invocation failed")?;
    assert_eq!(return_payload, large_payload, "Large payload mismatch");
    Ok(())
}

#[cfg(feature = "__lk-e2e-test")]
#[test_log::test(tokio::test)]
pub async fn test_rpc_error_response() -> Result<()> {
    use livekit::prelude::{RpcError, RpcErrorCode};

    let mut rooms = test_rooms(2).await?;
    let (caller_room, _) = rooms.pop().unwrap();
    let (callee_room, _) = rooms.pop().unwrap();
    let callee_identity = callee_room.local_participant().identity();

    const METHOD_NAME: &str = "error-method";

    callee_room.local_participant().register_rpc_method(METHOD_NAME.to_string(), |_data| {
        Box::pin(async move {
            Err(RpcError::new(42, "custom error".to_string(), Some("error data".to_string())))
        })
    });

    let perform_data = PerformRpcData::new(callee_identity.clone(), METHOD_NAME)
        .with_payload("test")
        .with_response_timeout(Duration::from_secs(5));
    let result = caller_room.local_participant().perform_rpc(perform_data).await;
    assert!(result.is_err(), "Expected error response");
    let err = result.unwrap_err();
    assert_eq!(err.code, 42, "Error code mismatch");
    assert_eq!(err.message, "custom error", "Error message mismatch");
    Ok(())
}

#[cfg(feature = "__lk-e2e-test")]
#[test_log::test(tokio::test)]
pub async fn test_rpc_unknown_destination() -> Result<()> {
    let mut rooms = test_rooms(1).await?;
    let (caller_room, _) = rooms.pop().unwrap();

    let perform_data = PerformRpcData::new("unknown-participant", "unregistered-method")
        .with_payload("test-payload")
        .with_response_timeout(Duration::from_millis(500));
    let result = caller_room.local_participant().perform_rpc(perform_data).await;
    assert!(result.is_err(), "Expected error");
    Ok(())
}

/// A recipient that leaves without replying must fail its caller promptly, rather than
/// stranding it until the response timeout expires.
///
/// The caller gives a departed recipient a brief grace period, because a reply sent just
/// before it left may still be in flight on the data channel while the departure itself
/// arrives on the signalling connection. That grace period shortens the wait; it must not
/// turn back into waiting out the full response timeout.
#[cfg(feature = "__lk-e2e-test")]
#[test_log::test(tokio::test)]
pub async fn test_rpc_recipient_leaving_without_replying_fails_promptly() -> Result<()> {
    use livekit::prelude::RpcErrorCode;

    let mut rooms = test_rooms(2).await?;
    let (caller_room, _) = rooms.pop().unwrap();
    let (callee_room, _) = rooms.pop().unwrap();
    let callee_identity = callee_room.local_participant().identity();

    const METHOD_NAME: &str = "never-replies";

    // Acks the request, then never produces a response.
    callee_room.local_participant().register_rpc_method(METHOD_NAME.to_string(), |_data| {
        Box::pin(async move {
            std::future::pending::<()>().await;
            unreachable!("handler is never allowed to complete")
        })
    });

    let caller = caller_room.local_participant();
    let perform = tokio::spawn(async move {
        caller
            .perform_rpc(
                PerformRpcData::new(callee_identity, METHOD_NAME)
                    .with_payload("{}")
                    // Long enough that expiry could not explain a prompt failure.
                    .with_response_timeout(Duration::from_secs(60)),
            )
            .await
    });

    // Let the request arrive and be acked, so the call is parked on the response.
    tokio::time::sleep(Duration::from_millis(500)).await;
    callee_room.close().await.context("Failed to close callee room")?;

    let result = tokio::time::timeout(Duration::from_secs(15), perform)
        .await
        .context("Caller was stranded well past the disconnect grace period")?
        .context("perform_rpc task panicked")?;

    let err = result.expect_err("Expected the departure to fail the call");
    assert_eq!(
        err.code,
        RpcErrorCode::RecipientDisconnected as u32,
        "Expected RECIPIENT_DISCONNECTED, got: {err}",
    );
    Ok(())
}

#[cfg(feature = "__lk-e2e-test")]
#[test_log::test(tokio::test)]
pub async fn test_rpc_v2_does_not_emit_data_stream_events() -> Result<()> {
    let mut rooms = test_rooms(2).await?;
    let (caller_room, caller_events) = rooms.pop().unwrap();
    let (callee_room, callee_events) = rooms.pop().unwrap();
    let callee_identity = callee_room.local_participant().identity();

    callee_room
        .local_participant()
        .register_rpc_method("echo".to_string(), |data| Box::pin(async move { Ok(data.payload) }));

    async fn collect(mut rx: UnboundedReceiver<RoomEvent>) -> Vec<RoomEvent> {
        let mut events = Vec::new();
        while let Ok(Some(ev)) = tokio::time::timeout(Duration::from_millis(250), rx.recv()).await {
            events.push(ev);
        }
        events
    }
    let caller_handle = tokio::spawn(collect(caller_events));
    let callee_handle = tokio::spawn(collect(callee_events));

    let perform_data = PerformRpcData::new(callee_identity.clone(), "echo")
        .with_payload("hi")
        .with_response_timeout(Duration::from_millis(500));
    let resp = caller_room
        .local_participant()
        .perform_rpc(perform_data)
        .await
        .context("Invocation failed")?;
    assert_eq!(resp, "hi");

    let caller = caller_handle.await?;
    let callee = callee_handle.await?;
    for ev in caller.iter().chain(callee.iter()) {
        assert!(
            !matches!(
                ev,
                RoomEvent::TextStreamOpened { .. }
                    | RoomEvent::ByteStreamOpened { .. }
                    | RoomEvent::StreamHeaderReceived { .. }
                    | RoomEvent::StreamChunkReceived { .. }
                    | RoomEvent::StreamTrailerReceived { .. }
            ),
            "unexpected data-stream event leaked from internal RPC traffic: {:?}",
            ev,
        );
    }
    Ok(())
}