rok-ui 0.9.2

shadcn/ui-style component system for GPUI desktop apps, with a React-like developer experience.
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
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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
//! `rok_ui::http` against a mock server on localhost: headers, bodies, query strings, empty
//! responses, the error envelope, session expiry, cancellation and network failures.

use std::{
    sync::{Arc, Mutex},
    time::Duration,
};

use rok_ui::http::{ApiError, CancelToken, HttpClient, Multipart, Options, Retry, Session};
use serde::Deserialize;
use tokio::{
    io::{AsyncReadExt, AsyncWriteExt},
    net::TcpListener,
};

/// A request the server received.
#[derive(Clone, Debug, Default)]
struct Received {
    method: String,
    target: String,
    headers: Vec<(String, String)>,
    body: Vec<u8>,
}

impl Received {
    fn header(&self, name: &str) -> Option<&str> {
        self.headers
            .iter()
            .find(|(header, _)| header.eq_ignore_ascii_case(name))
            .map(|(_, value)| value.as_str())
    }
}

/// What the server answers.
struct Reply {
    status: u16,
    reason: &'static str,
    body: Vec<u8>,
    delay: Duration,
}

impl Reply {
    fn json(status: u16, body: &str) -> Self {
        Self {
            status,
            reason: reason(status),
            body: body.as_bytes().to_vec(),
            delay: Duration::ZERO,
        }
    }

    fn delayed(mut self, delay: Duration) -> Self {
        self.delay = delay;
        self
    }
}

fn reason(status: u16) -> &'static str {
    match status {
        200 => "OK",
        204 => "No Content",
        401 => "Unauthorized",
        404 => "Not Found",
        413 => "Payload Too Large",
        422 => "Unprocessable Entity",
        500 => "Internal Server Error",
        _ => "",
    }
}

type Handler = Arc<dyn Fn(&Received) -> Reply + Send + Sync>;

/// Serve `handler` on a free port; returns the base URL and what the server received.
fn serve(
    handler: impl Fn(&Received) -> Reply + Send + Sync + 'static,
) -> (String, Arc<Mutex<Vec<Received>>>) {
    let handler: Handler = Arc::new(handler);
    let received = Arc::new(Mutex::new(Vec::new()));
    let listener = rok_ui::runtime::block_on(TcpListener::bind("127.0.0.1:0")).unwrap();
    let address = listener.local_addr().unwrap();
    let log = received.clone();
    rok_ui::runtime::spawn(async move {
        loop {
            let Ok((mut stream, _)) = listener.accept().await else {
                return;
            };
            let handler = handler.clone();
            let log = log.clone();
            rok_ui::runtime::spawn(async move {
                let mut buffer = Vec::new();
                let mut chunk = [0_u8; 4096];
                let header_end = loop {
                    let read = stream.read(&mut chunk).await.unwrap_or(0);
                    if read == 0 {
                        return;
                    }
                    buffer.extend_from_slice(&chunk[..read]);
                    if let Some(end) = buffer.windows(4).position(|window| window == b"\r\n\r\n") {
                        break end + 4;
                    }
                };
                let head = String::from_utf8_lossy(&buffer[..header_end]).into_owned();
                let mut lines = head.lines();
                let mut request_line = lines.next().unwrap_or_default().split(' ');
                let mut request = Received {
                    method: request_line.next().unwrap_or_default().to_string(),
                    target: request_line.next().unwrap_or_default().to_string(),
                    ..Received::default()
                };
                for line in lines {
                    if let Some((name, value)) = line.split_once(':') {
                        request
                            .headers
                            .push((name.trim().to_string(), value.trim().to_string()));
                    }
                }
                let length: usize = request
                    .header("content-length")
                    .and_then(|length| length.parse().ok())
                    .unwrap_or(0);
                let mut body = buffer[header_end..].to_vec();
                while body.len() < length {
                    let read = stream.read(&mut chunk).await.unwrap_or(0);
                    if read == 0 {
                        break;
                    }
                    body.extend_from_slice(&chunk[..read]);
                }
                request.body = body;
                let reply = handler(&request);
                log.lock().unwrap().push(request);
                tokio::time::sleep(reply.delay).await;
                let head = format!(
                    "HTTP/1.1 {} {}\r\nContent-Length: {}\r\nContent-Type: application/json\r\nConnection: close\r\n\r\n",
                    reply.status,
                    reply.reason,
                    reply.body.len()
                );
                stream.write_all(head.as_bytes()).await.ok();
                stream.write_all(&reply.body).await.ok();
                stream.shutdown().await.ok();
            });
        }
    });
    (format!("http://{address}"), received)
}

fn block_on<T>(future: impl std::future::Future<Output = T>) -> T {
    rok_ui::runtime::block_on(future)
}

#[derive(Debug, Deserialize, PartialEq)]
struct Note {
    id: u64,
    title: String,
}

#[test]
fn requests_send_headers_query_and_token() {
    let (url, received) = serve(|_| Reply::json(200, r#"[{"id": 1, "title": "Milk"}]"#));
    let session = Session::with_token("secret");
    let client = HttpClient::builder()
        .base_url(format!("{url}/v1/"))
        .header("X-App", "rok")
        .header("X-Override", "client")
        .session(session)
        .build();
    let notes: Vec<Note> = block_on(
        client.request(
            "/notes",
            Options::get()
                .query("search", "milk")
                .query("tag", None::<String>)
                .query("empty", "")
                .query("page", 2)
                .header("x-override", "request"),
        ),
    )
    .unwrap();
    assert_eq!(
        notes,
        [Note {
            id: 1,
            title: "Milk".into()
        }]
    );
    let request = received.lock().unwrap()[0].clone();
    assert_eq!(request.method, "GET");
    assert_eq!(request.target, "/v1/notes?search=milk&page=2");
    assert_eq!(request.header("accept"), Some("application/json"));
    assert_eq!(request.header("authorization"), Some("Bearer secret"));
    assert_eq!(request.header("x-app"), Some("rok"));
    assert_eq!(request.header("x-override"), Some("request"));
}

#[test]
fn bodies_are_json_or_raw() {
    let (url, received) = serve(|_| Reply::json(204, ""));
    let client = HttpClient::new(url);
    block_on(client.request_empty(
        "/a",
        Options::post().json(&serde_json::json!({"title": "x"})),
    ))
    .unwrap();
    block_on(client.request_empty("/b", Options::put().raw_body(b"\x00\x01".to_vec()))).unwrap();
    block_on(
        client.request_empty(
            "/c",
            Options::patch()
                .json(&1)
                .raw_body(b"png".to_vec())
                .content_type("image/png"),
        ),
    )
    .unwrap();
    let received = received.lock().unwrap();
    assert_eq!(received[0].header("content-type"), Some("application/json"));
    assert_eq!(received[0].body, br#"{"title":"x"}"#);
    assert_eq!(received[1].method, "PUT");
    assert_eq!(
        received[1].header("content-type"),
        Some("application/octet-stream")
    );
    assert_eq!(received[1].body, b"\x00\x01");
    assert_eq!(received[2].header("content-type"), Some("image/png"));
    assert_eq!(received[2].body, b"png");
}

#[test]
fn multipart_bodies_carry_text_and_files() {
    let (url, received_requests) = serve(|_| Reply::json(204, ""));
    let client = HttpClient::new(url);
    let form = Multipart::new().text("title", "Holiday").bytes(
        "photo",
        "beach.png",
        "image/png",
        b"\x89PNG".to_vec(),
    );
    block_on(client.request_empty("/upload", Options::post().multipart(form))).unwrap();
    let received = received_requests.lock().unwrap();
    let content_type = received[0].header("content-type").unwrap();
    let boundary = content_type
        .strip_prefix("multipart/form-data; boundary=")
        .expect("a multipart content type");
    let expected = format!(
        "--{boundary}\r\n\
         Content-Disposition: form-data; name=\"title\"\r\n\r\n\
         Holiday\r\n\
         --{boundary}\r\n\
         Content-Disposition: form-data; name=\"photo\"; filename=\"beach.png\"\r\n\
         Content-Type: image/png\r\n\r\n\
         \u{89}PNG\r\n\
         --{boundary}--\r\n"
    );
    let mut expected = expected.into_bytes();
    // `\u{89}` above is two bytes in UTF-8; the file holds the single byte 0x89.
    let at = expected
        .windows(2)
        .position(|pair| pair == [0xC2, 0x89])
        .unwrap();
    expected.splice(at..at + 2, [0x89]);
    assert_eq!(received[0].body, expected);
    drop(received);

    // A multipart body keeps its own content type and wins over JSON, like a raw body.
    let options = Options::post()
        .multipart(Multipart::new().text("a", "b"))
        .json(&1)
        .content_type("text/plain");
    block_on(client.request_empty("/upload", options)).unwrap();
    let received = received_requests.lock().unwrap();
    assert!(received[1]
        .header("content-type")
        .unwrap()
        .starts_with("multipart/form-data; boundary="));
}

#[test]
fn empty_responses_decode_as_null() {
    let (url, _) = serve(|request| match request.target.as_str() {
        "/no-content" => Reply::json(204, ""),
        _ => Reply::json(200, ""),
    });
    let client = HttpClient::new(url);
    let unit: () = block_on(client.request("/no-content", Options::delete())).unwrap();
    assert_eq!(unit, ());
    let missing: Option<Note> = block_on(client.request("/empty", Options::get())).unwrap();
    assert_eq!(missing, None);
    let error = block_on(client.request::<Note>("/empty", Options::get())).unwrap_err();
    assert_eq!((error.status, error.code.as_str()), (200, "empty_response"));
    assert!(error.message.contains("Note"), "{}", error.message);
    let bytes = block_on(client.request_bytes("/no-content", Options::get())).unwrap();
    assert!(bytes.is_empty());
}

#[test]
fn errors_come_from_the_envelope_or_the_status() {
    let (url, _) = serve(|request| match request.target.as_str() {
        "/invalid" => Reply::json(
            422,
            r#"{"error": {"code": "validation_failed", "message": "Check the form",
                "details": {"email": [{"code": "taken", "message": "Already registered"}]}}}"#,
        ),
        "/large" => Reply::json(413, ""),
        "/html" => Reply::json(500, "<html>oops</html>"),
        _ => Reply::json(200, "{not json"),
    });
    let client = HttpClient::new(url);
    let error = block_on(client.request::<Note>("/invalid", Options::post())).unwrap_err();
    assert_eq!(
        (error.status, error.code.as_str()),
        (422, "validation_failed")
    );
    assert_eq!(error.field_message("email"), Some("Already registered"));
    let error = block_on(client.request_empty("/large", Options::post())).unwrap_err();
    assert_eq!(
        (error.code.as_str(), error.message.as_str()),
        ("unknown", "The file is too large.")
    );
    let error = block_on(client.request_empty("/html", Options::get())).unwrap_err();
    assert_eq!(error.message, "Internal Server Error");
    let error = block_on(client.request::<Note>("/garbage", Options::get())).unwrap_err();
    assert_eq!(
        (error.status, error.code.as_str()),
        (200, "invalid_response")
    );
}

#[test]
fn a_401_expires_the_session_it_was_sent_with() {
    let session = Session::new();
    let changer = session.clone();
    let (url, _) = serve(move |request| {
        if request.target == "/race" {
            // The user signed in again while this request was in flight.
            changer.set_token("newer");
        }
        Reply::json(
            401,
            r#"{"error": {"code": "unauthorized", "message": "Sign in again"}}"#,
        )
    });
    let client = HttpClient::builder()
        .base_url(url)
        .session(session.clone())
        .build();

    let error = block_on(client.request_empty("/anonymous", Options::get())).unwrap_err();
    assert_eq!(error.status, 401);
    assert!(!session.is_expired(), "no token was sent");

    session.set_token("a");
    block_on(client.request_empty("/login", Options::post().skip_expire(true))).unwrap_err();
    assert!(
        session.is_signed_in() && !session.is_expired(),
        "skip_expire"
    );

    block_on(client.request_empty("/race", Options::get())).unwrap_err();
    assert_eq!(
        session.token().as_deref(),
        Some("newer"),
        "a newer token is kept"
    );

    block_on(client.request_empty("/me", Options::get())).unwrap_err();
    assert!(session.is_expired() && !session.is_signed_in());

    session.set_token("b");
    block_on(client.request_empty(
        "/custom",
        Options::get().header("Authorization", "Bearer other"),
    ))
    .unwrap_err();
    assert!(
        !session.is_expired(),
        "the session's token was not the one sent"
    );
}

#[test]
fn cancelled_requests_end_at_once_and_expire_nothing() {
    let (url, _) = serve(|_| Reply::json(401, "").delayed(Duration::from_secs(5)));
    let session = Session::with_token("t");
    let client = HttpClient::builder()
        .base_url(url)
        .session(session.clone())
        .build();
    let token = CancelToken::new();
    let canceller = token.clone();
    std::thread::spawn(move || {
        std::thread::sleep(Duration::from_millis(100));
        canceller.cancel();
    });
    let started = std::time::Instant::now();
    let error = block_on(client.request_empty("/slow", Options::get().cancel(&token))).unwrap_err();
    assert!(error.is_cancelled(), "{error:?}");
    assert!(started.elapsed() < Duration::from_secs(2));
    assert!(!session.is_expired());
    let error = block_on(client.request_empty("/slow", Options::get().cancel(&token))).unwrap_err();
    assert!(
        error.is_cancelled(),
        "an already cancelled token ends the request before it starts"
    );
}

#[test]
fn unreachable_servers_are_network_errors() {
    // Bind and drop to find a port nobody listens on.
    let port = std::net::TcpListener::bind("127.0.0.1:0")
        .unwrap()
        .local_addr()
        .unwrap()
        .port();
    let client = HttpClient::builder()
        .base_url(format!("http://127.0.0.1:{port}"))
        .timeout(Duration::from_secs(5))
        .build();
    let error = block_on(client.request_empty("/", Options::get())).unwrap_err();
    assert_eq!(error, ApiError::network());
    assert_eq!(
        (error.status, error.message.as_str()),
        (0, "Cannot reach the server")
    );
}

#[test]
fn requests_work_outside_a_tokio_runtime() {
    let (url, _) = serve(|_| Reply::json(200, r#"{"id": 7, "title": "Off runtime"}"#));
    let client = HttpClient::new(url);
    // Like a GPUI task: an executor without a tokio reactor.
    let note: Note = futures::executor::block_on(client.request("/note", Options::get())).unwrap();
    assert_eq!(note.id, 7);
}

#[test]
fn idempotent_requests_are_retried_and_posts_are_not() {
    let calls = Arc::new(Mutex::new(0_u32));
    let counter = calls.clone();
    let (url, received) = serve(move |_| {
        let mut calls = counter.lock().unwrap();
        *calls += 1;
        if *calls <= 2 {
            Reply::json(503, "")
        } else {
            Reply::json(200, r#"{"id": 1, "title": "Third time"}"#)
        }
    });
    let attempts = Arc::new(Mutex::new(Vec::new()));
    let seen = attempts.clone();
    let client = HttpClient::builder()
        .base_url(url)
        .retry(Retry::idempotent(3).backoff(Duration::from_millis(5)))
        .on_response(move |info| seen.lock().unwrap().push((info.attempt, info.status)))
        .build();
    let note: Note = block_on(client.request("/note", Options::get())).unwrap();
    assert_eq!(note.title, "Third time");
    assert_eq!(*attempts.lock().unwrap(), [(1, 503), (2, 503), (3, 200)]);

    *calls.lock().unwrap() = 0;
    received.lock().unwrap().clear();
    let error = block_on(client.request_empty("/notes", Options::post())).unwrap_err();
    assert_eq!(error.status, 503);
    assert_eq!(received.lock().unwrap().len(), 1, "a POST is sent once");
}

#[derive(Deserialize)]
struct TokenDto {
    token: String,
}

#[test]
fn a_401_refreshes_the_token_once_and_retries() {
    let refreshes = Arc::new(Mutex::new(0_u32));
    let refresh_count = refreshes.clone();
    let (url, _) = serve(move |request| {
        if request.target == "/sessions/refresh" {
            *refresh_count.lock().unwrap() += 1;
            return Reply::json(200, r#"{"token": "fresh"}"#).delayed(Duration::from_millis(50));
        }
        match request.header("authorization") {
            Some("Bearer fresh") => Reply::json(200, r#"{"id": 1, "title": "Fresh"}"#),
            _ => Reply::json(
                401,
                r#"{"error": {"code": "expired", "message": "Expired"}}"#,
            ),
        }
    });
    let session = Session::with_token("stale");
    let client = HttpClient::builder()
        .base_url(url)
        .session(session.clone())
        .refresh_token(|client| async move {
            let fresh: TokenDto = client
                .request("/sessions/refresh", Options::post().skip_expire(true))
                .await?;
            Ok(fresh.token)
        })
        .build();
    // Three requests fail together; they share one refresh.
    let notes: Vec<Result<Note, ApiError>> = block_on(async {
        let (a, b, c) = futures::join!(
            client.request::<Note>("/a", Options::get()),
            client.request::<Note>("/b", Options::get()),
            client.request::<Note>("/c", Options::get()),
        );
        vec![a, b, c]
    });
    assert!(notes
        .iter()
        .all(|note| note.as_ref().is_ok_and(|note| note.title == "Fresh")));
    assert_eq!(*refreshes.lock().unwrap(), 1);
    assert_eq!(session.token().as_deref(), Some("fresh"));
    assert!(!session.is_expired());
}

#[test]
fn a_failed_refresh_expires_the_session() {
    let (url, _) = serve(|_| Reply::json(401, ""));
    let session = Session::with_token("stale");
    let client = HttpClient::builder()
        .base_url(url)
        .session(session.clone())
        .refresh_token(|client| async move {
            client
                .request_empty("/sessions/refresh", Options::post())
                .await?;
            Ok("never".to_string())
        })
        .build();
    let error = block_on(client.request_empty("/me", Options::get())).unwrap_err();
    assert_eq!(error.status, 401);
    assert!(
        session.is_expired(),
        "the refresh failed, so the session ends"
    );
}

#[test]
fn concurrent_401s_share_one_failed_refresh() {
    let refreshes = Arc::new(Mutex::new(0_u32));
    let refresh_count = refreshes.clone();
    let (url, _) = serve(move |request| {
        if request.target == "/sessions/refresh" {
            *refresh_count.lock().unwrap() += 1;
            return Reply::json(401, "").delayed(Duration::from_millis(50));
        }
        Reply::json(401, "")
    });
    let session = Session::with_token("stale");
    let client = HttpClient::builder()
        .base_url(url)
        .session(session.clone())
        .refresh_token(|client| async move {
            client
                .request_empty("/sessions/refresh", Options::post().skip_expire(true))
                .await?;
            Ok("never".to_string())
        })
        .build();
    let errors: Vec<ApiError> = block_on(async {
        let (a, b, c) = futures::join!(
            client.request_empty("/a", Options::get()),
            client.request_empty("/b", Options::get()),
            client.request_empty("/c", Options::get()),
        );
        vec![a.unwrap_err(), b.unwrap_err(), c.unwrap_err()]
    });
    assert!(errors.iter().all(|error| error.status == 401));
    assert_eq!(
        *refreshes.lock().unwrap(),
        1,
        "requests waiting on a refresh that failed do not refresh again"
    );
    assert!(session.is_expired());
}

#[test]
fn a_refresh_does_not_use_up_the_retries() {
    let calls = Arc::new(Mutex::new(0_u32));
    let counter = calls.clone();
    let (url, _) = serve(move |request| {
        if request.target == "/sessions/refresh" {
            return Reply::json(200, r#"{"token": "fresh"}"#);
        }
        if request.header("authorization") != Some("Bearer fresh") {
            return Reply::json(401, "");
        }
        let mut calls = counter.lock().unwrap();
        *calls += 1;
        if *calls == 1 {
            Reply::json(503, "")
        } else {
            Reply::json(200, r#"{"id": 1, "title": "Fresh"}"#)
        }
    });
    let client = HttpClient::builder()
        .base_url(url)
        .session(Session::with_token("stale"))
        .retry(Retry::idempotent(1).backoff(Duration::from_millis(1)))
        .refresh_token(|client| async move {
            let fresh: TokenDto = client
                .request("/sessions/refresh", Options::post().skip_expire(true))
                .await?;
            Ok(fresh.token)
        })
        .build();
    // 401, refresh, then a 503 that the one retry still covers.
    let note: Note = block_on(client.request("/note", Options::get())).unwrap();
    assert_eq!(note.title, "Fresh");
}