tea-coding-tools 0.1.0

Workspace-scoped native coding tool adapters for tea-rs
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
use std::collections::VecDeque;
use std::net::{IpAddr, Ipv4Addr};
use std::sync::{Arc, Mutex};
use std::time::Duration;

use tea_coding_tools::{
    FetchDnsResolver, FetchHttpConfig, FetchHttpLimits, FetchHttpTimeouts, FetchHttpTransport,
    FetchProviderError, FetchProviderErrorCode, FetchResolveFuture,
};
use tea_control::CancellationScope;
use tea_provider_http::ProviderHttpConfig;
use tokio::io::{AsyncReadExt as _, AsyncWriteExt as _};
use tokio::net::{TcpListener, TcpStream};

#[derive(Debug)]
struct FakeResolver {
    answers: Mutex<VecDeque<Result<Vec<IpAddr>, FetchProviderError>>>,
    hosts: Mutex<Vec<String>>,
}

impl FakeResolver {
    fn repeated(answer: &[IpAddr], count: usize) -> Self {
        Self {
            answers: Mutex::new((0..count).map(|_| Ok(answer.to_vec())).collect()),
            hosts: Mutex::new(Vec::new()),
        }
    }

    fn hosts(&self) -> Vec<String> {
        self.hosts.lock().unwrap().clone()
    }
}

impl FetchDnsResolver for FakeResolver {
    fn resolve(&self, host: &str, cancellation: CancellationScope) -> FetchResolveFuture<'_> {
        self.hosts.lock().unwrap().push(host.to_owned());
        let answer = self.answers.lock().unwrap().pop_front().unwrap_or_else(|| {
            Err(FetchProviderError::new(
                FetchProviderErrorCode::DnsResolution,
            ))
        });
        Box::pin(async move {
            if cancellation.is_cancelled() {
                Err(FetchProviderError::cancelled())
            } else {
                answer
            }
        })
    }
}

fn loopback() -> IpAddr {
    IpAddr::V4(Ipv4Addr::LOCALHOST)
}

fn config(max_redirects: usize, max_bytes: usize) -> FetchHttpConfig {
    let timeouts = FetchHttpTimeouts::new(
        Duration::from_millis(250),
        Duration::from_millis(250),
        Duration::from_millis(500),
        Duration::from_secs(2),
        Duration::from_millis(500),
        1,
    )
    .unwrap();
    config_with_timeouts(timeouts, max_redirects, max_bytes)
}

fn config_with_timeouts(
    timeouts: FetchHttpTimeouts,
    max_redirects: usize,
    max_bytes: usize,
) -> FetchHttpConfig {
    let limits = FetchHttpLimits::new(max_redirects, max_bytes).unwrap();
    FetchHttpConfig::loopback_tests(timeouts, limits)
}

fn transport(
    resolver: Arc<dyn FetchDnsResolver>,
    max_redirects: usize,
    max_bytes: usize,
) -> FetchHttpTransport {
    FetchHttpTransport::new(
        config(max_redirects, max_bytes),
        resolver,
        ProviderHttpConfig::new(),
    )
}

async fn read_request(stream: &mut TcpStream) -> String {
    let mut request = Vec::new();
    let mut buffer = [0_u8; 1024];
    loop {
        let read = stream.read(&mut buffer).await.unwrap();
        if read == 0 {
            break;
        }
        request.extend_from_slice(&buffer[..read]);
        if request.windows(4).any(|window| window == b"\r\n\r\n") {
            break;
        }
    }
    String::from_utf8(request).unwrap()
}

async fn write_response(stream: &mut TcpStream, response: &str) {
    stream.write_all(response.as_bytes()).await.unwrap();
    stream.shutdown().await.unwrap();
}

#[tokio::test(flavor = "current_thread")]
async fn transport_pins_dns_preserves_host_and_bounds_response_metadata() {
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let address = listener.local_addr().unwrap();
    let server = tokio::spawn(async move {
        let (mut stream, _) = listener.accept().await.unwrap();
        let request = read_request(&mut stream).await;
        write_response(
            &mut stream,
            "HTTP/1.1 200 OK\r\nContent-Type: text/plain; charset=utf-8\r\nContent-Length: 5\r\nConnection: close\r\n\r\nhello",
        )
        .await;
        request
    });
    let resolver = Arc::new(FakeResolver::repeated(&[loopback()], 1));
    let response = transport(resolver.clone(), 5, 1024)
        .get(
            &format!("http://localhost:{}/path?token=secret", address.port()),
            CancellationScope::new(),
        )
        .await
        .unwrap();
    assert_eq!(response.status(), 200);
    assert_eq!(response.body(), b"hello");
    assert_eq!(
        response.headers().content_type(),
        Some("text/plain; charset=utf-8")
    );
    assert_eq!(response.headers().content_length(), Some(5));
    assert_eq!(resolver.hosts(), ["localhost"]);
    let request = server.await.unwrap();
    assert!(request.starts_with("GET /path?token=secret HTTP/1.1\r\n"));
    assert!(
        request
            .to_ascii_lowercase()
            .contains(&format!("host: localhost:{}", address.port()))
    );
    assert!(
        request
            .to_ascii_lowercase()
            .contains("accept-encoding: identity")
    );
    let debug = format!("{response:?}");
    assert!(debug.contains("body_bytes: 5"));
    assert!(!debug.contains("hello"));
    assert!(!debug.contains("secret"));
}

#[tokio::test(flavor = "current_thread")]
async fn redirect_is_resolved_revalidated_and_recorded_per_hop() {
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let address = listener.local_addr().unwrap();
    let server = tokio::spawn(async move {
        let (mut first, _) = listener.accept().await.unwrap();
        let first_request = read_request(&mut first).await;
        write_response(
            &mut first,
            "HTTP/1.1 302 Found\r\nLocation: /final\r\nContent-Length: 0\r\nConnection: close\r\n\r\n",
        )
        .await;
        let (mut second, _) = listener.accept().await.unwrap();
        let second_request = read_request(&mut second).await;
        write_response(
            &mut second,
            "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 4\r\nConnection: close\r\n\r\ndone",
        )
        .await;
        (first_request, second_request)
    });
    let resolver = Arc::new(FakeResolver::repeated(&[loopback()], 2));
    let response = transport(resolver.clone(), 5, 1024)
        .get(
            &format!("http://localhost:{}/start", address.port()),
            CancellationScope::new(),
        )
        .await
        .unwrap();
    assert_eq!(
        response.final_url(),
        format!("http://localhost:{}/final", address.port())
    );
    assert_eq!(response.body(), b"done");
    assert_eq!(response.redirects().len(), 1);
    assert_eq!(response.redirects()[0].status(), 302);
    assert_eq!(resolver.hosts(), ["localhost", "localhost"]);
    let (first, second) = server.await.unwrap();
    assert!(first.starts_with("GET /start HTTP/1.1"));
    assert!(second.starts_with("GET /final HTTP/1.1"));
}

#[tokio::test(flavor = "current_thread")]
async fn mixed_dns_answers_are_rejected_before_connection() {
    let resolver = Arc::new(FakeResolver::repeated(
        &[loopback(), "10.0.0.1".parse().unwrap()],
        1,
    ));
    let error = transport(resolver, 5, 1024)
        .get("http://localhost:8080/", CancellationScope::new())
        .await
        .unwrap_err();
    assert_eq!(error.code(), FetchProviderErrorCode::DnsResolution);
}

#[tokio::test(flavor = "current_thread")]
async fn redirect_loop_is_rejected_without_a_second_connection() {
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let address = listener.local_addr().unwrap();
    let server = tokio::spawn(async move {
        let (mut stream, _) = listener.accept().await.unwrap();
        let request = read_request(&mut stream).await;
        write_response(
            &mut stream,
            "HTTP/1.1 302 Found\r\nLocation: /loop\r\nContent-Length: 0\r\nConnection: close\r\n\r\n",
        )
        .await;
        request
    });
    let resolver = Arc::new(FakeResolver::repeated(&[loopback()], 1));
    let error = transport(resolver, 5, 1024)
        .get(
            &format!("http://localhost:{}/loop", address.port()),
            CancellationScope::new(),
        )
        .await
        .unwrap_err();
    assert_eq!(error.code(), FetchProviderErrorCode::RedirectRejected);
    assert!(server.await.unwrap().starts_with("GET /loop HTTP/1.1"));
}

#[tokio::test(flavor = "current_thread")]
async fn redirect_to_private_target_is_rejected_before_new_dns_resolution() {
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let address = listener.local_addr().unwrap();
    let server = tokio::spawn(async move {
        let (mut stream, _) = listener.accept().await.unwrap();
        let request = read_request(&mut stream).await;
        write_response(
            &mut stream,
            "HTTP/1.1 302 Found\r\nLocation: http://192.168.1.1:8080/private\r\nContent-Length: 0\r\nConnection: close\r\n\r\n",
        )
        .await;
        request
    });
    let resolver = Arc::new(FakeResolver::repeated(&[loopback()], 1));
    let error = transport(resolver.clone(), 5, 1024)
        .get(
            &format!("http://localhost:{}/start", address.port()),
            CancellationScope::new(),
        )
        .await
        .unwrap_err();
    assert_eq!(error.code(), FetchProviderErrorCode::RedirectRejected);
    assert_eq!(resolver.hosts(), ["localhost"]);
    server.await.unwrap();
}

#[tokio::test(flavor = "current_thread")]
async fn redirect_dns_rebinding_to_private_address_is_rejected_before_connection() {
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let address = listener.local_addr().unwrap();
    let server = tokio::spawn(async move {
        let (mut stream, _) = listener.accept().await.unwrap();
        read_request(&mut stream).await;
        write_response(
            &mut stream,
            "HTTP/1.1 302 Found\r\nLocation: /final\r\nContent-Length: 0\r\nConnection: close\r\n\r\n",
        )
        .await;
    });
    let resolver = Arc::new(FakeResolver {
        answers: Mutex::new(VecDeque::from([
            Ok(vec![loopback()]),
            Ok(vec!["10.0.0.1".parse().unwrap()]),
        ])),
        hosts: Mutex::new(Vec::new()),
    });
    let error = transport(resolver.clone(), 5, 1024)
        .get(
            &format!("http://localhost:{}/start", address.port()),
            CancellationScope::new(),
        )
        .await
        .unwrap_err();
    assert_eq!(error.code(), FetchProviderErrorCode::DnsResolution);
    assert_eq!(resolver.hosts(), ["localhost", "localhost"]);
    server.await.unwrap();
}

#[tokio::test(flavor = "current_thread")]
async fn content_length_above_the_raw_body_limit_fails_before_reading_body() {
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let address = listener.local_addr().unwrap();
    let server = tokio::spawn(async move {
        let (mut stream, _) = listener.accept().await.unwrap();
        read_request(&mut stream).await;
        write_response(
            &mut stream,
            "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 100\r\nConnection: close\r\n\r\n",
        )
        .await;
    });
    let resolver = Arc::new(FakeResolver::repeated(&[loopback()], 1));
    let error = transport(resolver, 5, 8)
        .get(
            &format!("http://localhost:{}/large", address.port()),
            CancellationScope::new(),
        )
        .await
        .unwrap_err();
    assert_eq!(error.code(), FetchProviderErrorCode::ResponseTooLarge);
    server.await.unwrap();
}

#[tokio::test(flavor = "current_thread")]
async fn first_byte_timeout_is_bounded_without_waiting_for_server_shutdown() {
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let address = listener.local_addr().unwrap();
    let server = tokio::spawn(async move {
        let (mut stream, _) = listener.accept().await.unwrap();
        read_request(&mut stream).await;
        tokio::time::sleep(Duration::from_secs(1)).await;
    });
    let timeouts = FetchHttpTimeouts::new(
        Duration::from_millis(100),
        Duration::from_millis(100),
        Duration::from_millis(40),
        Duration::from_millis(250),
        Duration::from_millis(100),
        1,
    )
    .unwrap();
    let resolver = Arc::new(FakeResolver::repeated(&[loopback()], 1));
    let transport = FetchHttpTransport::new(
        config_with_timeouts(timeouts, 5, 1024),
        resolver,
        ProviderHttpConfig::new(),
    );
    let error = transport
        .get(
            &format!("http://localhost:{}/slow-headers", address.port()),
            CancellationScope::new(),
        )
        .await
        .unwrap_err();
    assert_eq!(error.code(), FetchProviderErrorCode::Timeout);
    server.abort();
}

#[tokio::test(flavor = "current_thread")]
async fn low_speed_body_timeout_is_bounded_by_window_and_byte_threshold() {
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let address = listener.local_addr().unwrap();
    let server = tokio::spawn(async move {
        let (mut stream, _) = listener.accept().await.unwrap();
        read_request(&mut stream).await;
        stream
            .write_all(
                b"HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\nContent-Length: 2\r\nConnection: close\r\n\r\na",
            )
            .await
            .unwrap();
        stream.flush().await.unwrap();
        tokio::time::sleep(Duration::from_secs(1)).await;
    });
    let timeouts = FetchHttpTimeouts::new(
        Duration::from_millis(100),
        Duration::from_millis(100),
        Duration::from_millis(100),
        Duration::from_millis(250),
        Duration::from_millis(40),
        10,
    )
    .unwrap();
    let resolver = Arc::new(FakeResolver::repeated(&[loopback()], 1));
    let transport = FetchHttpTransport::new(
        config_with_timeouts(timeouts, 5, 1024),
        resolver,
        ProviderHttpConfig::new(),
    );
    let error = transport
        .get(
            &format!("http://localhost:{}/slow-body", address.port()),
            CancellationScope::new(),
        )
        .await
        .unwrap_err();
    assert_eq!(error.code(), FetchProviderErrorCode::Timeout);
    server.abort();
}

#[tokio::test(flavor = "current_thread")]
async fn cancellation_interrupts_a_waiting_first_byte() {
    let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
    let address = listener.local_addr().unwrap();
    let server = tokio::spawn(async move {
        let (mut stream, _) = listener.accept().await.unwrap();
        read_request(&mut stream).await;
        tokio::time::sleep(Duration::from_secs(1)).await;
    });
    let resolver = Arc::new(FakeResolver::repeated(&[loopback()], 1));
    let cancellation = CancellationScope::new();
    let canceller = cancellation.clone();
    let task = tokio::spawn(async move {
        transport(resolver, 5, 1024)
            .get(
                &format!("http://localhost:{}/slow", address.port()),
                cancellation,
            )
            .await
    });
    tokio::time::sleep(Duration::from_millis(20)).await;
    canceller.cancel();
    let error = task.await.unwrap().unwrap_err();
    assert_eq!(error.code(), FetchProviderErrorCode::Cancelled);
    server.abort();
}