apprtc 0.1.0

AppRTC P2P/SFU Signaling Server in Rust
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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
//! Black-box compatibility tests against a separately running AppRTC server.
//!
//! Start the server before running this test target:
//!
//! ```text
//! cargo run -p apprtc -- --host 127.0.0.1 --port 8080 --web-root appweb --tls &
//! cargo test -p apprtc --test '*'
//! ```

mod common;

use anyhow::{Context, Result};
use common::{
    http, join, unique_room, wait_for_server, ws_connect, ws_connect_path, ws_expect_close,
    ws_receive_binary, ws_receive_json, ws_register, ws_send, ws_send_binary,
};
use serde_json::{Value, json};
use signaling_proto::v1::response::{Result as ControlResult, ok::Payload as ControlPayload};
use signaling_proto::{Request as ControlRequest, Response as ControlResponse};

#[tokio::test]
async fn serves_pages_configuration_static_assets_and_status() -> Result<()> {
    wait_for_server().await?;

    let root = http("GET", "/", &[]).await?;
    assert_eq!(root.status, 200);
    assert!(root.text()?.contains("AppRTC"));
    assert!(
        root.headers
            .get("content-type")
            .is_some_and(|value| value.starts_with("text/html"))
    );

    let params = http("GET", "/params", &[]).await?;
    assert_eq!(params.status, 200);
    let params = params.json()?;
    assert_eq!(params["wss_url"], "wss://127.0.0.1:8081/ws");
    assert_eq!(params["wss_post_url"], "https://127.0.0.1:8080");

    let ice = http("POST", "/v1alpha/iceconfig", &[]).await?;
    assert_eq!(ice.status, 200);
    assert!(ice.json()?["iceServers"].is_array());

    let script = http("GET", "/js/call.js", &[]).await?;
    assert_eq!(script.status, 200);
    assert!(script.text()?.contains("Call.prototype"));

    let status = http("GET", "/status", &[]).await?;
    assert_eq!(status.status, 200);
    let status = status.json()?;
    for field in ["upsec", "openws", "totalws", "wserrors", "httperrors"] {
        assert!(status.get(field).is_some(), "missing status field {field}");
    }
    Ok(())
}

#[tokio::test]
async fn preserves_appweb_signaling_status_contract() -> Result<()> {
    wait_for_server().await?;
    let mut socket = ws_connect_path("/app").await?;
    ws_send_binary(
        &mut socket,
        ControlRequest::register(500, "contract-test".into(), String::new()).encode_wire(),
    )
    .await?;
    let registered = ControlResponse::decode_wire(&ws_receive_binary(&mut socket).await?)
        .map_err(anyhow::Error::msg)?;
    assert_eq!(registered.request_id, 500);
    assert!(registered.is_ok());

    ws_send_binary(&mut socket, ControlRequest::status(1).encode_wire()).await?;
    let status = ControlResponse::decode_wire(&ws_receive_binary(&mut socket).await?)
        .map_err(anyhow::Error::msg)?;
    assert_eq!(status.request_id, 1);
    assert!(matches!(
        status.result,
        Some(ControlResult::Ok(signaling_proto::v1::response::Ok {
            payload: Some(ControlPayload::Status(_))
        }))
    ));
    socket.close(None).await?;
    Ok(())
}

#[tokio::test]
async fn separates_browser_json_and_appweb_protobuf_endpoints() -> Result<()> {
    wait_for_server().await?;

    let mut control = ws_connect_path("/app").await?;
    ws_send(&mut control, json!({"cmd":"register"})).await?;
    ws_expect_close(&mut control).await?;

    let mut browser = ws_connect().await?;
    ws_send_binary(&mut browser, ControlRequest::status(1).encode_wire()).await?;
    ws_expect_close(&mut browser).await?;

    let mut malformed = ws_connect_path("/app").await?;
    ws_send_binary(
        &mut malformed,
        ControlRequest {
            request_id: 1,
            command: None,
        }
        .encode_wire(),
    )
    .await?;
    ws_expect_close(&mut malformed).await?;
    Ok(())
}

#[tokio::test]
async fn serves_room_page_and_full_room_page_like_legacy_apprtc() -> Result<()> {
    wait_for_server().await?;
    let room = unique_room("room-page");

    let page = http("GET", &format!("/r/{room}"), &[]).await?;
    assert_eq!(page.status, 200);
    assert!(page.text()?.contains("AppRTC"));

    let first = join(&room).await?;
    let second = join(&room).await?;
    let full = http("GET", &format!("/r/{room}"), &[]).await?;
    assert_eq!(full.status, 200);
    assert!(full.text()?.contains("this room is full"));

    cleanup(&room, client_id(&first)?).await?;
    cleanup(&room, client_id(&second)?).await?;
    Ok(())
}

#[tokio::test]
async fn accepts_opaque_string_room_and_client_ids_in_v1_websocket_protocol() -> Result<()> {
    wait_for_server().await?;
    let room = format!("opaque-room-{}", rand::random::<u64>());
    let client_a = "client-alpha";
    let client_b = "client-beta";
    let mut socket_a = ws_register(&room, client_a).await?;
    let mut socket_b = ws_register(&room, client_b).await?;

    let offer = r#"{"type":"offer","sdp":"opaque-client-offer"}"#;
    ws_send(&mut socket_a, json!({"cmd": "send", "msg": offer})).await?;
    assert_eq!(
        ws_receive_json(&mut socket_b).await?,
        json!({"msg": offer, "error": ""})
    );

    let answer = r#"{"type":"answer","sdp":"opaque-client-answer"}"#;
    ws_send(&mut socket_b, json!({"cmd": "send", "msg": answer})).await?;
    assert_eq!(
        ws_receive_json(&mut socket_a).await?,
        json!({"msg": answer, "error": ""})
    );

    let _ = http("POST", &format!("/leave/{room}/{client_a}"), &[]).await?;
    let _ = http("POST", &format!("/leave/{room}/{client_b}"), &[]).await?;
    ws_expect_close(&mut socket_a).await?;
    ws_expect_close(&mut socket_b).await?;
    Ok(())
}

#[tokio::test]
async fn reports_websocket_lifecycle_counters() -> Result<()> {
    wait_for_server().await?;
    let before = http("GET", "/status", &[]).await?.json()?;
    let closed_before = before["totalws"]
        .as_u64()
        .unwrap_or(0)
        .saturating_sub(before["openws"].as_u64().unwrap_or(0));
    let room = unique_room("status");
    let first = join(&room).await?;
    let first_id = client_id(&first)?;
    let mut socket = ws_register(&room, first_id).await?;
    let during = http("GET", "/status", &[]).await?.json()?;
    assert!(during["totalws"].as_u64().unwrap_or(0) > before["totalws"].as_u64().unwrap_or(0));
    socket.close(None).await?;
    tokio::time::sleep(std::time::Duration::from_millis(100)).await;
    let after = http("GET", "/status", &[]).await?.json()?;
    let closed_after = after["totalws"]
        .as_u64()
        .unwrap_or(0)
        .saturating_sub(after["openws"].as_u64().unwrap_or(0));
    assert!(closed_after > closed_before);
    cleanup(&room, first_id).await?;
    Ok(())
}

#[tokio::test]
async fn internal_bridge_rejects_empty_body_and_invalid_method() -> Result<()> {
    wait_for_server().await?;
    let empty = http("POST", "/_internal/edge-room/edge-client", &[]).await?;
    assert_eq!(empty.status, 500);
    let invalid = http("GET", "/_internal/edge-room/edge-client", &[]).await?;
    assert_eq!(invalid.status, 405);
    Ok(())
}

#[tokio::test]
async fn preserves_v1_debug_loopback_join_behavior() -> Result<()> {
    wait_for_server().await?;
    let room = unique_room("loopback");
    let first = http("POST", &format!("/join/{room}?debug=loopback"), &[]).await?;
    assert_eq!(first.status, 200);
    let first_body = first.json()?;
    assert_eq!(first_body["result"], "SUCCESS");
    let second = join(&room).await?;
    assert_eq!(second["result"], "FULL");
    let first_id = client_id(&first_body)?.to_owned();
    cleanup(&room, &first_id).await?;
    Ok(())
}

#[tokio::test]
async fn preserves_v1_reregister_and_unregistered_client_timeout() -> Result<()> {
    wait_for_server().await?;

    let room = unique_room("reregister");
    let first = join(&room).await?;
    let first_id = client_id(&first)?.to_owned();
    let mut socket = ws_register(&room, &first_id).await?;
    socket.close(None).await?;

    // Re-registering before the ten-second timeout keeps the same client alive.
    let mut replacement = ws_register(&room, &first_id).await?;
    let second = join(&room).await?;
    assert_eq!(second["result"], "SUCCESS");
    replacement.close(None).await?;
    cleanup(&room, &first_id).await?;
    cleanup(&room, client_id(&second)?).await?;

    // A joined client that never registers must expire and stop consuming capacity.
    let expiring_room = unique_room("register-timeout");
    let _unregistered = join(&expiring_room).await?;
    for elapsed in 1..=11 {
        tokio::time::sleep(std::time::Duration::from_secs(1)).await;
        println!("registration-timeout test: waited {elapsed}/11 seconds");
    }
    let admitted = join(&expiring_room).await?;
    assert_eq!(admitted["result"], "SUCCESS");
    let admitted_id = client_id(&admitted)?.to_owned();
    let third = join(&expiring_room).await?;
    assert_eq!(third["result"], "SUCCESS");
    cleanup(&expiring_room, &admitted_id).await?;
    cleanup(&expiring_room, client_id(&third)?).await?;
    Ok(())
}

#[tokio::test]
async fn completes_the_stock_v1_join_queue_and_websocket_relay_flow() -> Result<()> {
    wait_for_server().await?;
    let room = unique_room("stock-flow");

    let first = join(&room).await?;
    assert_eq!(first["result"], "SUCCESS");
    assert_eq!(first["params"]["room_id"], room);
    assert_eq!(first["params"]["is_initiator"], "true");
    let first_id = client_id(&first)?;
    assert_eq!(first_id.len(), 8);
    assert!(first_id.bytes().all(|byte| byte.is_ascii_digit()));
    let mut first_ws = ws_register(&room, first_id).await?;

    let offer = r#"{"type":"offer","sdp":"v=0\\r\\n"}"#;
    let candidate = r#"{"type":"candidate","label":0,"id":"0","candidate":"candidate:1"}"#;
    for payload in [offer, candidate] {
        let response = http(
            "POST",
            &format!("/message/{room}/{first_id}"),
            payload.as_bytes(),
        )
        .await?;
        assert_eq!(response.status, 200);
        assert_eq!(response.json()?["result"], "SUCCESS");
    }

    let second = join(&room).await?;
    assert_eq!(second["result"], "SUCCESS");
    assert_eq!(second["params"]["is_initiator"], "false");
    assert_eq!(second["params"]["messages"], json!([offer, candidate]));
    let second_id = client_id(&second)?;
    let mut second_ws = ws_register(&room, second_id).await?;

    let answer = r#"{"type":"answer","sdp":"v=0\\r\\n"}"#;
    ws_send(&mut second_ws, json!({ "cmd": "send", "msg": answer })).await?;
    assert_eq!(
        ws_receive_json(&mut first_ws).await?,
        json!({ "msg": answer, "error": "" })
    );

    let return_candidate = r#"{"type":"candidate","label":0,"id":"0","candidate":"candidate:2"}"#;
    ws_send(
        &mut first_ws,
        json!({ "cmd": "send", "msg": return_candidate }),
    )
    .await?;
    assert_eq!(
        ws_receive_json(&mut second_ws).await?,
        json!({ "msg": return_candidate, "error": "" })
    );

    let third = join(&room).await?;
    assert_eq!(third["result"], "FULL");

    let leave = http("POST", &format!("/leave/{room}/{first_id}"), &[]).await?;
    assert_eq!(leave.status, 200);
    assert!(leave.body.is_empty());
    ws_expect_close(&mut first_ws).await?;

    let replacement = join(&room).await?;
    assert_eq!(replacement["result"], "SUCCESS");
    assert_eq!(replacement["params"]["is_initiator"], "false");
    let replacement_id = client_id(&replacement)?;

    cleanup(&room, second_id).await?;
    cleanup(&room, replacement_id).await?;
    second_ws.close(None).await?;
    Ok(())
}

#[tokio::test]
async fn supports_root_and_internal_fallback_routes() -> Result<()> {
    wait_for_server().await?;
    let room = unique_room("fallback");
    let first = join(&room).await?;
    let first_id = client_id(&first)?;
    let second = join(&room).await?;
    let second_id = client_id(&second)?;
    let mut first_ws = ws_register(&room, first_id).await?;
    let mut second_ws = ws_register(&room, second_id).await?;

    let fallback = r#"{"type":"candidate","candidate":"fallback"}"#;
    let response = http("POST", &format!("/{room}/{first_id}"), fallback.as_bytes()).await?;
    assert_eq!(response.status, 200);
    assert_eq!(response.text()?, "OK\n");
    assert_eq!(
        ws_receive_json(&mut second_ws).await?,
        json!({ "msg": fallback, "error": "" })
    );

    let deleted = http("DELETE", &format!("/{room}/{first_id}"), &[]).await?;
    assert_eq!(deleted.status, 200);
    assert_eq!(deleted.text()?, "OK\n");
    ws_expect_close(&mut first_ws).await?;

    let queued = r#"{"type":"offer","sdp":"internal-alias"}"#;
    let response = http(
        "POST",
        &format!("/_internal/{room}/{second_id}"),
        queued.as_bytes(),
    )
    .await?;
    assert_eq!(response.status, 200);
    let replacement = join(&room).await?;
    assert_eq!(replacement["params"]["messages"], json!([queued]));
    let replacement_id = client_id(&replacement)?;

    let empty = http("POST", &format!("/{room}/{second_id}"), &[]).await?;
    assert_eq!(empty.status, 500);

    cleanup(&room, second_id).await?;
    cleanup(&room, replacement_id).await?;
    second_ws.close(None).await?;
    Ok(())
}

#[tokio::test]
async fn preserves_v1_websocket_errors_and_duplicate_registration_rules() -> Result<()> {
    wait_for_server().await?;

    let mut unregistered = ws_connect().await?;
    ws_send(&mut unregistered, json!({ "cmd": "send", "msg": "offer" })).await?;
    assert_eq!(
        ws_receive_json(&mut unregistered).await?,
        json!({ "msg": "", "error": "Client not registered" })
    );
    ws_expect_close(&mut unregistered).await?;

    let room = unique_room("duplicate");
    let first = join(&room).await?;
    let first_id = client_id(&first)?;
    let mut original = ws_register(&room, first_id).await?;
    let mut duplicate = ws_connect().await?;
    ws_send(
        &mut duplicate,
        json!({ "cmd": "register", "roomid": room, "clientid": first_id }),
    )
    .await?;
    assert_eq!(
        ws_receive_json(&mut duplicate).await?,
        json!({ "msg": "", "error": "Duplicated registration" })
    );
    ws_expect_close(&mut duplicate).await?;

    let second = join(&room).await?;
    let second_id = client_id(&second)?;
    let mut second_ws = ws_register(&room, second_id).await?;
    ws_send(
        &mut second_ws,
        json!({ "cmd": "send", "msg": "still-bound" }),
    )
    .await?;
    assert_eq!(
        ws_receive_json(&mut original).await?,
        json!({ "msg": "still-bound", "error": "" })
    );

    cleanup(&room, first_id).await?;
    cleanup(&room, second_id).await?;
    original.close(None).await?;
    second_ws.close(None).await?;
    Ok(())
}

#[tokio::test]
async fn rejects_malformed_v1_requests_without_corrupting_other_rooms() -> Result<()> {
    wait_for_server().await?;

    let missing_join = http("POST", "/join", &[]).await?;
    // Axum reports a method-matched path with missing parameters as 405; the
    // legacy Go mux reported 404 for the same malformed request.
    assert_eq!(missing_join.status, 405);
    let missing_message = http("POST", "/message/no-such-room/no-such-client", b"offer").await?;
    // V1 preserves messages posted before the matching client joins, so an
    // unknown room/client pair is created and the message is queued.
    assert_eq!(missing_message.status, 200);
    assert_eq!(missing_message.json()?["result"], "SUCCESS");
    let missing_leave = http("POST", "/leave/no-such-room/no-such-client", &[]).await?;
    assert_eq!(missing_leave.status, 200);

    let mut socket = ws_connect().await?;
    ws_send(
        &mut socket,
        json!({"cmd": "register", "roomid": "", "clientid": "client"}),
    )
    .await?;
    assert_eq!(
        ws_receive_json(&mut socket).await?,
        json!({
            "msg": "",
            "error": "Invalid register request: missing 'clientid' or 'roomid'"
        })
    );
    ws_expect_close(&mut socket).await?;

    let room = unique_room("malformed-isolation");
    let first = join(&room).await?;
    assert_eq!(first["result"], "SUCCESS");
    let second = join(&room).await?;
    assert_eq!(second["result"], "SUCCESS");
    let third = join(&room).await?;
    assert_eq!(third["result"], "FULL");
    cleanup(&room, client_id(&first)?).await?;
    cleanup(&room, client_id(&second)?).await?;
    Ok(())
}

fn client_id(response: &Value) -> Result<&str> {
    response["params"]["client_id"]
        .as_str()
        .context("join response has no client_id")
}

async fn cleanup(room_id: &str, client_id: &str) -> Result<()> {
    let response = http("POST", &format!("/leave/{room_id}/{client_id}"), &[]).await?;
    if response.status != 200 {
        anyhow::bail!("cleanup leave returned HTTP {}", response.status);
    }
    Ok(())
}