litchee 0.1.5

Async, builder-pattern Rust client for the Lichess API: full endpoint coverage, NDJSON streaming, and OAuth2 PKCE ('Log in with Lichess').
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

//! Resilience behaviour: the read timeout aborts a stalled connection but does
//! not cut off a healthy stream whose keep-alives arrive within the window.

use std::time::Duration;

use futures_util::StreamExt;
use litchee::LichessClient;
use litchee::error::{LichessError, StreamError};
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::net::TcpListener;
use wiremock::matchers::{method, path};
use wiremock::{Mock, MockServer, ResponseTemplate};

#[tokio::test]
async fn read_timeout_aborts_a_stalled_response() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/api/account"))
        .respond_with(
            ResponseTemplate::new(200)
                .set_body_string(r#"{"id":"me","username":"Me"}"#)
                .set_delay(Duration::from_secs(3)),
        )
        .mount(&server)
        .await;

    let client = LichessClient::builder()
        .base_url(&server.uri().parse().unwrap())
        .token("t")
        .read_timeout(Duration::from_millis(150))
        .build()
        .unwrap();

    let err = client.account().profile().await.unwrap_err();

    match err {
        // Assert it is specifically a timeout, not just any transport failure.
        LichessError::Transport(source) => {
            assert!(source.is_timeout(), "expected a timeout, got {source:?}");
        }
        other => panic!("expected a transport timeout, got {other:?}"),
    }
}

#[tokio::test]
async fn keepalives_within_the_window_keep_a_stream_alive() {
    // A raw server: send a keep-alive blank line, pause for less than the read
    // timeout, then send a data line. The read timeout resets on each read, so
    // the gap must NOT abort the stream. (wiremock can't dribble bytes over time.)
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let addr = listener.local_addr().unwrap();
    tokio::spawn(async move {
        let (mut sock, _) = listener.accept().await.unwrap();
        let mut scratch = [0u8; 1024];
        let _ = sock.read(&mut scratch).await; // consume the request
        sock.write_all(
            b"HTTP/1.1 200 OK\r\nContent-Type: application/x-ndjson\r\nTransfer-Encoding: chunked\r\n\r\n",
        )
        .await
        .unwrap();
        sock.write_all(b"1\r\n\n\r\n").await.unwrap(); // keep-alive (blank line)
        sock.flush().await.unwrap();
        tokio::time::sleep(Duration::from_millis(250)).await; // gap < read timeout
        sock.write_all(b"c\r\n{\"id\":\"g1\"}\n\r\n").await.unwrap();
        sock.write_all(b"0\r\n\r\n").await.unwrap();
        sock.flush().await.unwrap();
    });

    let client = LichessClient::builder()
        .base_url(&format!("http://{addr}").parse().unwrap())
        .token("t")
        .read_timeout(Duration::from_millis(600))
        .build()
        .unwrap();

    let games: Vec<_> = client
        .swiss()
        .games("g1")
        .stream()
        .await
        .unwrap()
        .collect()
        .await;

    assert_eq!(games.len(), 1);
    assert_eq!(games[0].as_ref().unwrap().id, "g1");
}

#[tokio::test]
async fn line_exceeding_max_line_bytes_errors() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/api/swiss/g1/games"))
        // One long line with no newline, larger than the configured cap.
        .respond_with(ResponseTemplate::new(200).set_body_string("a".repeat(64)))
        .mount(&server)
        .await;

    let client = LichessClient::builder()
        .base_url(&server.uri().parse().unwrap())
        .token("t")
        .max_line_bytes(16)
        .build()
        .unwrap();

    let first = client
        .swiss()
        .games("g1")
        .stream()
        .await
        .unwrap()
        .next()
        .await
        .unwrap();

    assert!(
        matches!(
            first,
            Err(LichessError::Stream(StreamError::LineTooLong { max: 16 }))
        ),
        "expected LineTooLong, got {first:?}"
    );
}