xwt-web 0.22.0

An implementation of the xwt that runs in the browser. Powered by wasm-bindgen and web-sys.
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
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
//! Integration tests.

#![cfg(target_family = "wasm")]

use wasm_bindgen_test::*;
use xwt_web::{CertificateHash, HashAlgorithm, WebTransportOptions};

wasm_bindgen_test::wasm_bindgen_test_configure!(run_in_browser);

static_assertions::assert_impl_all!(xwt_web::Endpoint: xwt_core::endpoint::Connect);
static_assertions::assert_impl_all!(xwt_web::Session: xwt_core::base::Session);

fn setup() {
    static INIT: std::sync::Once = std::sync::Once::new();
    INIT.call_once(|| {
        tracing_wasm::set_as_global_default();
    });
}

/// Obtain the user agent string.
fn user_agent() -> String {
    js_sys::Reflect::get(&js_sys::global(), &"navigator".into())
        .and_then(|navigator| js_sys::Reflect::get(&navigator, &"userAgent".into()))
        .ok()
        .and_then(|user_agent| user_agent.as_string())
        .unwrap_or_default()
}

/// Detect Firefox from the user agent string.
///
/// Used to skip the tests that exercise the WebTransport behaviors that
/// Firefox does not implement properly yet.
fn is_firefox() -> bool {
    user_agent().contains("Firefox")
}

/// Detect Safari from the user agent string.
///
/// Used to skip the tests that exercise the WebTransport behaviors that
/// Safari does not implement properly yet.
fn is_safari() -> bool {
    // The Chrome user agent contains "Safari" too, so rule it out.
    let user_agent = user_agent();
    user_agent.contains("Safari") && !user_agent.contains("Chrome")
}

fn test_endpoint() -> xwt_web::Endpoint {
    let digest = xwt_cert_fingerprint::Sha256::compute_for_der(xwt_test_assets::CERT);
    console_log!("certificate sha256 digest: {digest}");

    let options = WebTransportOptions {
        server_certificate_hashes: vec![CertificateHash {
            algorithm: HashAlgorithm::Sha256,
            value: digest.into_inner().to_vec(),
        }],
        ..Default::default()
    };

    xwt_web::Endpoint {
        options: options.to_js(),
    }
}

#[wasm_bindgen_test]
async fn streams() {
    setup();

    let endpoint = test_endpoint();

    xwt_tests::tests::streams::run(endpoint, xwt_tests::consts::ECHO_SERVER_URL)
        .await
        .unwrap();
}

#[wasm_bindgen_test]
async fn datagrams() {
    setup();

    let endpoint = test_endpoint();

    xwt_tests::tests::datagrams::run(endpoint, xwt_tests::consts::ECHO_SERVER_URL)
        .await
        .unwrap();
}

#[wasm_bindgen_test]
async fn datagrams_read_into() {
    setup();

    let endpoint = test_endpoint();

    xwt_tests::tests::datagrams_read_into::run(endpoint, xwt_tests::consts::ECHO_SERVER_URL)
        .await
        .unwrap();
}

#[wasm_bindgen_test]
async fn read_small_buf() {
    setup();

    let endpoint = test_endpoint();

    xwt_tests::tests::read_small_buf::run(endpoint, xwt_tests::consts::ECHO_SERVER_URL)
        .await
        .unwrap();
}

#[wasm_bindgen_test]
async fn read_resize_buf() {
    setup();

    let endpoint = test_endpoint();

    xwt_tests::tests::read_resize_buf::run(endpoint, xwt_tests::consts::ECHO_SERVER_URL)
        .await
        .unwrap();
}

#[wasm_bindgen_test]
async fn tokio_io() {
    setup();

    let endpoint = test_endpoint();

    xwt_tests::tests::tokio_io::run(endpoint, xwt_tests::consts::ECHO_SERVER_URL)
        .await
        .unwrap();
}

#[wasm_bindgen_test]
async fn tokio_io_read_small_buf() {
    setup();

    let endpoint = test_endpoint();

    xwt_tests::tests::tokio_io_read_small_buf::run(endpoint, xwt_tests::consts::ECHO_SERVER_URL)
        .await
        .unwrap();
}

#[wasm_bindgen_test]
async fn tokio_io_read_shrink_buf() {
    setup();

    let endpoint = test_endpoint();

    xwt_tests::tests::tokio_io_read_shrink_buf::run(endpoint, xwt_tests::consts::ECHO_SERVER_URL)
        .await
        .unwrap();
}

#[wasm_bindgen_test]
async fn tokio_io_read_partial_buf() {
    setup();

    let endpoint = test_endpoint();

    xwt_tests::tests::tokio_io_read_partial_buf::run(endpoint, xwt_tests::consts::ECHO_SERVER_URL)
        .await
        .unwrap();
}

#[wasm_bindgen_test]
async fn tokio_io_read_buf_resize() {
    setup();

    let endpoint = test_endpoint();

    xwt_tests::tests::tokio_io_read_buf_resize::run(endpoint, xwt_tests::consts::ECHO_SERVER_URL)
        .await
        .unwrap();
}

#[wasm_bindgen_test]
async fn session_drop() {
    setup();

    let endpoint = test_endpoint();

    xwt_tests::tests::session_drop::run(endpoint, xwt_tests::consts::ECHO_SERVER_URL, |error| {
        let known_bad_errors = ["Connection lost."];
        let known_good_errors = [
            // Chrome.
            "WebTransportError: The session is closed.",
            // Firefox reports the reads canceled by the session closure with
            // the name of the operation that caused the cancellation.
            "WebTransportError: close()",
            // Safari reports the reads canceled by the session closure with
            // a generic abort error.
            "AbortError: The operation was aborted.",
        ];
        let actual_error = error.to_string();

        let is_bad_error = known_bad_errors
            .into_iter()
            .any(|known_bad_error| actual_error.contains(known_bad_error));
        if is_bad_error {
            return false;
        }

        known_good_errors
            .into_iter()
            .any(|is_good_error| actual_error.contains(is_good_error))
    })
    .await
    .unwrap();
}

#[wasm_bindgen_test]
async fn accept_bi_stream() {
    setup();

    let endpoint = test_endpoint();

    xwt_tests::tests::accept_bi_stream::run(endpoint, xwt_tests::consts::ECHO_OPEN_BI_SERVER_URL)
        .await
        .unwrap();
}

#[wasm_bindgen_test]
async fn closed_uni_stream() {
    setup();

    if is_firefox() {
        // Firefox does not reject the writer `closed` promise when the peer
        // sends a `STOP_SENDING`, so waiting for the send stream abortion
        // hangs forever.
        // See:
        // - <https://bugzilla.mozilla.org/show_bug.cgi?id=1986138>
        // - <https://bugzilla.mozilla.org/show_bug.cgi?id=2009530>
        console_log!(
            "skipping this test on Firefox: STOP_SENDING is not propagated to the send stream"
        );
        return;
    }

    if is_safari() {
        // Safari has the same issue as Firefox: the writer `closed` promise
        // is not rejected when the peer sends a `STOP_SENDING` (as required
        // by <https://w3c.github.io/webtransport/#webtransportsendstream>),
        // so waiting for the send stream abortion hangs forever.
        // No dedicated WebKit bug is filed for this as of 2026-08; the spec
        // compliance umbrella issue:
        // - <https://bugs.webkit.org/show_bug.cgi?id=297534>
        console_log!(
            "skipping this test on Safari: STOP_SENDING is not propagated to the send stream"
        );
        return;
    }

    let endpoint = test_endpoint();

    xwt_tests::tests::closed_uni_stream::run(
        endpoint,
        xwt_tests::concat!(xwt_tests::consts::ECHO_CLOSE_SERVER_URL, "/uni"),
        0,
    )
    .await
    .unwrap();
}

#[wasm_bindgen_test]
async fn closed_uni_stream_with_error() {
    setup();

    if is_firefox() {
        // Firefox does not reject the writer `closed` promise when the peer
        // sends a `STOP_SENDING`, so waiting for the send stream abortion
        // hangs forever.
        // See:
        // - <https://bugzilla.mozilla.org/show_bug.cgi?id=1986138>
        // - <https://bugzilla.mozilla.org/show_bug.cgi?id=2009530>
        console_log!(
            "skipping this test on Firefox: STOP_SENDING is not propagated to the send stream"
        );
        return;
    }

    if is_safari() {
        // Safari has the same issue as Firefox: the writer `closed` promise
        // is not rejected when the peer sends a `STOP_SENDING` (as required
        // by <https://w3c.github.io/webtransport/#webtransportsendstream>),
        // so waiting for the send stream abortion hangs forever.
        // No dedicated WebKit bug is filed for this as of 2026-08; the spec
        // compliance umbrella issue:
        // - <https://bugs.webkit.org/show_bug.cgi?id=297534>
        console_log!(
            "skipping this test on Safari: STOP_SENDING is not propagated to the send stream"
        );
        return;
    }

    let endpoint = test_endpoint();

    xwt_tests::tests::closed_uni_stream::run(
        endpoint,
        xwt_tests::concat!(xwt_tests::consts::ECHO_CLOSE_SERVER_URL, "/uni/error"),
        123,
    )
    .await
    .unwrap();
}

#[wasm_bindgen_test]
async fn closed_bi_read_stream() {
    setup();

    if is_safari() {
        // Safari does not reject the writer `closed` promise when the peer
        // sends a `STOP_SENDING` (as required by
        // <https://w3c.github.io/webtransport/#webtransportsendstream>),
        // so waiting for the send stream abortion hangs forever.
        // No dedicated WebKit bug is filed for this as of 2026-08; the spec
        // compliance umbrella issue:
        // - <https://bugs.webkit.org/show_bug.cgi?id=297534>
        console_log!(
            "skipping this test on Safari: STOP_SENDING is not propagated to the send stream"
        );
        return;
    }

    let endpoint = test_endpoint();

    xwt_tests::tests::closed_bi_read_stream::run(
        endpoint,
        xwt_tests::concat!(xwt_tests::consts::ECHO_CLOSE_SERVER_URL, "/bi/recv"),
        0,
    )
    .await
    .unwrap();
}

#[wasm_bindgen_test]
async fn closed_bi_read_stream_with_error() {
    setup();

    if is_safari() {
        // Safari does not reject the writer `closed` promise when the peer
        // sends a `STOP_SENDING` (as required by
        // <https://w3c.github.io/webtransport/#webtransportsendstream>),
        // so waiting for the send stream abortion hangs forever.
        // No dedicated WebKit bug is filed for this as of 2026-08; the spec
        // compliance umbrella issue:
        // - <https://bugs.webkit.org/show_bug.cgi?id=297534>
        console_log!(
            "skipping this test on Safari: STOP_SENDING is not propagated to the send stream"
        );
        return;
    }

    let endpoint = test_endpoint();

    xwt_tests::tests::closed_bi_read_stream::run(
        endpoint,
        xwt_tests::concat!(xwt_tests::consts::ECHO_CLOSE_SERVER_URL, "/bi/recv/error"),
        123,
    )
    .await
    .unwrap();
}

#[wasm_bindgen_test]
async fn closed_bi_send_stream() {
    setup();

    if is_safari() {
        // Safari does not settle the reads on a stream that was cleanly
        // closed by the peer: the end of stream is never signaled to
        // the reader, so the read hangs forever.
        // No dedicated WebKit bug is filed for this as of 2026-08; the spec
        // compliance umbrella issue:
        // - <https://bugs.webkit.org/show_bug.cgi?id=297534>
        console_log!("skipping this test on Safari: stream FIN is not propagated to the reads");
        return;
    }

    let endpoint = test_endpoint();

    xwt_tests::tests::closed_bi_send_stream::run(
        endpoint,
        xwt_tests::concat!(xwt_tests::consts::ECHO_CLOSE_SERVER_URL, "/bi/send"),
        0,
    )
    .await
    .unwrap();
}

#[wasm_bindgen_test]
async fn closed_bi_send_stream_with_error() {
    setup();

    if is_firefox() {
        // Firefox rejects the reads on a stream that got a `RESET_STREAM`
        // with a generic `TypeError: Error in input stream` instead of
        // a `WebTransportError` carrying the `streamErrorCode`, so there is
        // no error code to observe.
        // See:
        // - <https://bugzilla.mozilla.org/show_bug.cgi?id=2009530>
        // - <https://bugzilla.mozilla.org/show_bug.cgi?id=2009593>
        console_log!(
            "skipping this test on Firefox: RESET_STREAM error code is not exposed to reads"
        );
        return;
    }

    if is_safari() {
        // Safari does not settle the reads on a stream that got
        // a `RESET_STREAM` at all (as required by
        // <https://w3c.github.io/webtransport/#webtransportreceivestream>),
        // so the read hangs forever.
        // No dedicated WebKit bug is filed for this as of 2026-08; the spec
        // compliance umbrella issue:
        // - <https://bugs.webkit.org/show_bug.cgi?id=297534>
        console_log!("skipping this test on Safari: RESET_STREAM is not propagated to the reads");
        return;
    }

    let endpoint = test_endpoint();

    xwt_tests::tests::closed_bi_send_stream::run(
        endpoint,
        xwt_tests::concat!(xwt_tests::consts::ECHO_CLOSE_SERVER_URL, "/bi/send/error"),
        123.try_into().unwrap(),
    )
    .await
    .unwrap();
}