wyrd-client 0.3.0

Shared Wyrd client: transport, authentication, and composed client capabilities.
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
//! Façade tests for the real storage-client transfer boundary.

use std::fmt::Write as _;
use std::path::Path;
use std::sync::{Arc, Mutex as StdMutex};

use base64::Engine;
use sha2::{Digest, Sha256};
use std::io::Result;
use tempfile::NamedTempFile;
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::net::TcpListener;
use tokio::net::TcpStream;
use tokio::sync::Mutex;
use tokio::task::JoinHandle;
use wyrd_client::WyrdClient;
use wyrd_client::auth::AuthMiddleware;
use wyrd_client::config::ClientConfig;
use wyrd_client::storage::{DownloadProgressSink, StorageClientError, WyrdStorageClient};
use wyrd_client::transport::HttpTransport;
use wyrd_client::transport::config::HttpConfig;
use wyrd_client::transport::credential::ResolvedCredential;
use wyrd_spec::storage::{HeaderPair, UploadId, UploadPlan};

/// One HTTP request captured by [`TestServer`], including headers, for protocol assertions.
#[derive(Clone, Debug)]
struct Request {
    method: String,
    target: String,
    headers: Vec<(String, String)>,
    body: Vec<u8>,
}

/// One canned HTTP response with optional headers that [`TestServer`] returns in order.
#[derive(Clone, Debug)]
struct Response {
    status: u16,
    body: Vec<u8>,
    headers: Vec<(String, String)>,
}

/// Minimal single-connection HTTP server standing in for both the Wyrd API and a storage backend.
///
/// Each accepted connection consumes one response; the listener task is aborted on drop.
struct TestServer {
    uri: String,
    requests: Arc<Mutex<Vec<Request>>>,
    task: JoinHandle<()>,
}

/// Base64 SHA-256 digest in the form the storage protocols send as integrity headers.
fn sha256_b64(bytes: &[u8]) -> String {
    base64::engine::general_purpose::STANDARD.encode(Sha256::digest(bytes))
}

impl TestServer {
    /// Start with a fixed response list that does not depend on the bound address.
    async fn start(responses: Vec<Response>) -> Self {
        Self::start_with(|_| responses).await
    }

    /// Bind an ephemeral loopback listener, let `build` produce responses that may embed the
    /// bound URI (presigned URLs), then spawn the replay task.
    async fn start_with(build: impl FnOnce(&str) -> Vec<Response>) -> Self {
        let listener = TcpListener::bind(("127.0.0.1", 0))
            .await
            .expect("test listener binds");
        let uri = format!(
            "http://{}",
            listener.local_addr().expect("listener address")
        );
        let responses = build(&uri);
        let requests = Arc::new(Mutex::new(Vec::new()));
        let captured = Arc::clone(&requests);
        let task = tokio::spawn(async move {
            for response in responses {
                let (mut stream, _) = listener.accept().await.expect("test request connects");
                let request = read_request(&mut stream).await;
                captured.lock().await.push(request);
                write_response(&mut stream, response)
                    .await
                    .expect("test response writes");
            }
        });
        Self {
            uri,
            requests,
            task,
        }
    }

    /// Snapshot every request received so far, in arrival order.
    async fn requests(&self) -> Vec<Request> {
        self.requests.lock().await.clone()
    }

    /// Base URI clients should use to reach this server.
    fn uri(&self) -> &str {
        &self.uri
    }
}

impl Drop for TestServer {
    /// Abort the replay task so the test does not leak a listener.
    fn drop(&mut self) {
        self.task.abort();
    }
}

/// Read one HTTP/1.1 request head, headers, and body (content-length or chunked) from `stream`.
///
/// # Panics
/// Panics when the request is malformed; this is a test helper.
async fn read_request(stream: &mut TcpStream) -> Request {
    let mut bytes = Vec::new();
    let mut chunk = [0_u8; 4096];
    let header_end = loop {
        let read = stream.read(&mut chunk).await.expect("test request reads");
        assert!(read > 0, "request ended before headers");
        bytes.extend_from_slice(&chunk[..read]);
        if let Some(end) = bytes.windows(4).position(|window| window == b"\r\n\r\n") {
            break end + 4;
        }
    };
    let header_text = String::from_utf8_lossy(&bytes[..header_end]).into_owned();
    let mut lines = header_text.lines();
    let request_line = lines.next().expect("request line exists");
    let mut parts = request_line.split_whitespace();
    let method = parts.next().expect("request method exists").to_owned();
    let target = parts.next().expect("request target exists").to_owned();
    let headers: Vec<_> = lines
        .filter_map(|line| line.split_once(':'))
        .map(|(name, value)| (name.to_ascii_lowercase(), value.trim().to_owned()))
        .collect();
    let content_length = headers
        .iter()
        .find(|(name, _)| name == "content-length")
        .and_then(|(_, value)| value.parse::<usize>().ok())
        .unwrap_or(0);
    let chunked = headers
        .iter()
        .any(|(name, value)| name == "transfer-encoding" && value.eq_ignore_ascii_case("chunked"));
    let body = read_body(
        stream,
        &mut bytes,
        &mut chunk,
        header_end,
        content_length,
        chunked,
    )
    .await;
    Request {
        method,
        target,
        headers,
        body,
    }
}

/// Finish reading a request body into `bytes` once the header block ending at `header_end`
/// has been parsed, honoring `content_length` or chunked framing.
async fn read_body(
    stream: &mut TcpStream,
    bytes: &mut Vec<u8>,
    chunk: &mut [u8; 4096],
    header_end: usize,
    content_length: usize,
    chunked: bool,
) -> Vec<u8> {
    if !chunked {
        while bytes.len() < header_end + content_length {
            let read = stream.read(chunk).await.expect("test body reads");
            assert!(read > 0, "request ended before body");
            bytes.extend_from_slice(&chunk[..read]);
        }
        return bytes[header_end..header_end + content_length].to_vec();
    }

    let mut cursor = header_end;
    let mut body = Vec::new();
    loop {
        let line_end = loop {
            if let Some(offset) = bytes[cursor..]
                .windows(2)
                .position(|window| window == b"\r\n")
            {
                break cursor + offset;
            }
            let read = stream.read(chunk).await.expect("test chunk header reads");
            assert!(read > 0, "request ended before chunk header");
            bytes.extend_from_slice(&chunk[..read]);
        };
        let size = usize::from_str_radix(
            std::str::from_utf8(&bytes[cursor..line_end])
                .expect("chunk size is UTF-8")
                .split(';')
                .next()
                .expect("chunk size exists"),
            16,
        )
        .expect("chunk size is hexadecimal");
        cursor = line_end + 2;
        while bytes.len() < cursor + size + 2 {
            let read = stream.read(chunk).await.expect("test chunk reads");
            assert!(read > 0, "request ended before chunk body");
            bytes.extend_from_slice(&chunk[..read]);
        }
        if size == 0 {
            return body;
        }
        body.extend_from_slice(&bytes[cursor..cursor + size]);
        cursor += size + 2;
    }
}

/// Write `response` as a minimal HTTP/1.1 response with its extra headers and close the connection.
///
/// # Errors
/// Returns the socket write error.
async fn write_response(stream: &mut TcpStream, response: Response) -> Result<()> {
    let reason = match response.status {
        200 => "OK",
        201 => "Created",
        _ => "Test",
    };
    let head = format!(
        "HTTP/1.1 {} {}\r\ncontent-length: {}\r\ncontent-type: application/json\r\n{}connection: close\r\n\r\n",
        response.status,
        reason,
        response.body.len(),
        response
            .headers
            .iter()
            .fold(String::new(), |mut headers, (name, value)| {
                let _ = writeln!(headers, "{name}: {value}\r");
                headers
            })
    );
    stream.write_all(head.as_bytes()).await?;
    stream.write_all(&response.body).await
}

/// An empty-bodied [`Response`] with the given status.
fn response(status: u16) -> Response {
    Response {
        status,
        body: Vec::new(),
        headers: Vec::new(),
    }
}

/// An empty-bodied [`Response`] carrying the given headers, e.g. an `ETag`.
fn response_with_headers(status: u16, headers: Vec<(&str, &str)>) -> Response {
    Response {
        status,
        body: Vec::new(),
        headers: headers
            .into_iter()
            .map(|(name, value)| (name.to_owned(), value.to_owned()))
            .collect(),
    }
}

/// The Wyrd API `stored` confirmation body returned after an upload completes.
fn stored_response() -> Response {
    Response {
        status: 200,
        body: serde_json::to_vec(&serde_json::json!({
            "stored": {
                "storage_path": "tenant/card/object",
                "size_bytes": 4,
                "sha256": "digest",
                "content_type": null,
                "sse_marker": null,
                "created_at": "2026-01-01T00:00:00Z"
            }
        }))
        .expect("test JSON serializes"),
        headers: Vec::new(),
    }
}

/// Build a bearer-authenticated [`WyrdClient`] pointed at `base_url` without network IO.
fn client(base_url: impl Into<String>) -> WyrdClient {
    let base_url = base_url.into();
    let config = ClientConfig {
        http: HttpConfig {
            base_url: base_url.clone(),
            ..HttpConfig::default()
        },
        ..ClientConfig::default()
    };
    let auth = AuthMiddleware::new(
        &config,
        ResolvedCredential::BearerToken("test-bearer".to_owned().into()),
    )
    .expect("test auth builds");
    let transport = HttpTransport::new(&config.http, Arc::clone(&auth)).expect("transport builds");
    WyrdClient::from_parts(auth, transport, config.grpc)
}

/// Single-PUT and local-filesystem plans upload through the facade with exact-length bodies.
#[tokio::test]
async fn high_level_upload_dispatches_single_put_and_localfs() {
    let server = TestServer::start(vec![
        response(200),
        stored_response(),
        response(200),
        stored_response(),
    ])
    .await;
    let storage = WyrdStorageClient::new(&client(server.uri()));
    for plan in [
        UploadPlan::SinglePut {
            put_url: format!("{}/single", server.uri()),
            ttl_secs: 60,
            required_headers: vec![HeaderPair {
                name: "x-plan-header".to_owned(),
                value: "required".to_owned(),
            }],
        },
        UploadPlan::LocalFs {
            put_url: format!("{}/v1/cards/upload/local", server.uri()),
            ttl_secs: 0,
        },
    ] {
        let upload_id = UploadId::new();
        storage
            .upload_artifact(&upload_id, &plan, b"data".to_vec(), "key")
            .await
            .expect("single-plan upload succeeds");
    }
    let requests = server.requests().await;
    assert_eq!(requests.len(), 4);
    assert_eq!(requests[0].method, "PUT");
    assert_eq!(requests[0].target, "/single");
    assert_eq!(requests[0].body, b"data");
    assert_eq!(requests[1].method, "POST");
    assert!(requests[1].target.starts_with("/v1/cards/upload/"));
    assert!(
        requests[1]
            .headers
            .iter()
            .any(|(name, value)| name == "idempotency-key" && value == "key")
    );
    assert_eq!(requests[2].method, "PUT");
    assert_eq!(requests[2].target, "/v1/cards/upload/local");
}

/// A traced upload carries the caller's trace to the Wyrd API but never to the
/// presigned storage backend, which is a foreign origin.
#[tokio::test]
async fn traced_upload_keeps_trace_headers_off_the_presigned_backend() {
    use opentelemetry::trace::TracerProvider as _;
    use tracing::Instrument as _;
    use tracing::instrument::WithSubscriber as _;
    use tracing_subscriber::layer::SubscriberExt as _;

    let server = TestServer::start(vec![response(200), stored_response()]).await;
    let storage = WyrdStorageClient::new(&client(server.uri()));
    let traced = tracing::Dispatch::new(
        tracing_subscriber::registry().with(
            tracing_opentelemetry::layer().with_tracer(
                opentelemetry_sdk::trace::SdkTracerProvider::builder()
                    .build()
                    .tracer("storage-dispatch"),
            ),
        ),
    );
    let ambient = tracing::dispatcher::with_default(&traced, || tracing::info_span!("caller"));
    let plan = UploadPlan::SinglePut {
        put_url: format!("{}/single", server.uri()),
        ttl_secs: 60,
        required_headers: Vec::new(),
    };
    storage
        .upload_artifact(&UploadId::new(), &plan, b"data".to_vec(), "key")
        .instrument(ambient)
        .with_subscriber(traced)
        .await
        .expect("traced upload succeeds");
    let requests = server.requests().await;
    assert_eq!(requests.len(), 2);
    let has =
        |request: &Request, header: &str| request.headers.iter().any(|(name, _)| name == header);
    assert_eq!(requests[0].target, "/single");
    for header in ["traceparent", "tracestate", "authorization"] {
        assert!(!has(&requests[0], header), "presigned PUT sent {header}");
    }
    assert!(
        has(&requests[1], "traceparent"),
        "the Wyrd API call is traced"
    );
}

/// multipart plans mint part URLs, upload parts, and complete through the server.
#[tokio::test]
async fn high_level_upload_dispatches_s3_and_completes_server_upload() {
    let server = TestServer::start_with(|uri| {
        vec![
            Response {
                status: 200,
                body: serde_json::to_vec(&serde_json::json!({
                    "url": format!("{uri}/part-1"),
                    "ttl_secs": 60
                }))
                .expect("test JSON serializes"),
                headers: Vec::new(),
            },
            response_with_headers(200, vec![("ETag", "etag")]),
            stored_response(),
        ]
    })
    .await;
    let storage = WyrdStorageClient::new(&client(server.uri()));
    let upload_id = UploadId::new();

    let plan = UploadPlan::Multipart {
        part_count: 1,
        part_size_bytes: 4,
        part_url_ttl_secs: 60,
        required_headers: Vec::new(),
    };
    storage
        .upload_artifact(&upload_id, &plan, b"data".to_vec(), "key")
        .await
        .expect("multipart upload succeeds through façade");
    let requests = server.requests().await;
    assert_eq!(requests[0].method, "POST");
    assert!(requests[0].target.starts_with("/v1/cards/upload/"));
    assert!(requests[0].target.ends_with("/part-url?part_number=1"));
    assert_eq!(requests[1].method, "PUT");
    assert_eq!(requests[1].body, b"data");
    assert_eq!(requests[2].method, "POST");
    assert!(requests[2].target.ends_with("/complete"));
}

/// Azure block-blob plans dispatch to their protocol driver.
#[tokio::test]
async fn high_level_upload_dispatches_azure_protocol() {
    let server = TestServer::start(vec![response(201), response(201), stored_response()]).await;
    let storage = WyrdStorageClient::new(&client(server.uri()));
    let upload_id = UploadId::new();
    storage
        .upload_artifact(
            &upload_id,
            &UploadPlan::AzureBlockBlob {
                sas_url: format!("{}/azure?sig=redacted", server.uri()),
                block_size_bytes: 3,
                block_count_planned: 2,
            },
            b"azure".to_vec(),
            "key",
        )
        .await
        .expect("Azure upload succeeds through façade");
    let requests = server.requests().await;
    assert_eq!(requests[0].method, "PUT");
    assert!(
        requests[0]
            .target
            .starts_with("/azure?sig=redacted&comp=block&blockid=")
    );
    assert_eq!(requests[0].body, b"azu");
    assert_eq!(requests[1].body, b"re");
    assert_eq!(requests[2].method, "POST");
}

/// Verifies streamed download bytes, digest checks, and monotonic progress reports.
#[tokio::test]
async fn download_and_download_verified_stream_bytes_and_check_digest_and_size() {
    let content = vec![b'x'; 256 * 1024];
    let server = TestServer::start(vec![Response {
        status: 200,
        body: content.clone(),
        headers: Vec::new(),
    }])
    .await;
    let storage = WyrdStorageClient::new(&client(server.uri()));
    let destination = NamedTempFile::new().expect("destination");
    let digest = base64::engine::general_purpose::STANDARD.encode(Sha256::digest(&content));
    let positions = Arc::new(StdMutex::new(Vec::new()));
    let observed_positions = Arc::clone(&positions);
    let progress: DownloadProgressSink = Arc::new(move |written, total| {
        observed_positions
            .lock()
            .expect("test progress mutex is not poisoned")
            .push((written, total));
    });
    storage
        .download_verified_with_progress(
            &wyrd_spec::storage::DownloadPlan {
                get_url: format!("{}/download", server.uri()),
                ttl_secs: 60,
            },
            Path::new(destination.path()),
            &digest,
            content.len() as u64,
            progress,
        )
        .await
        .expect("verified download succeeds");
    assert_eq!(
        tokio::fs::read(destination.path())
            .await
            .expect("read destination"),
        content.as_slice()
    );
    let requests = server.requests().await;
    assert_eq!(requests[0].method, "GET");
    assert_eq!(requests[0].target, "/download");
    let positions = positions
        .lock()
        .expect("test progress mutex is not poisoned");
    assert_eq!(
        positions.last(),
        Some(&(content.len() as u64, Some(content.len() as u64)))
    );
    assert!(
        positions.len() > 1,
        "response must stream in multiple chunks"
    );
    assert!(positions.windows(2).all(|window| window[0].0 < window[1].0));
}

/// Malformed provider plans are refused before any byte is sent.
#[tokio::test]
async fn façade_rejects_invalid_provider_plans_before_transfer() {
    let server = TestServer::start(Vec::new()).await;
    let storage = WyrdStorageClient::new(&client(server.uri()));
    for plan in [
        UploadPlan::Multipart {
            part_count: 0,
            part_size_bytes: 1,
            part_url_ttl_secs: 60,
            required_headers: Vec::new(),
        },
        UploadPlan::AzureBlockBlob {
            sas_url: format!("{}/azure", server.uri()),
            block_size_bytes: 1,
            block_count_planned: 0,
        },
    ] {
        let error = storage
            .upload_artifact(&UploadId::new(), &plan, b"data".to_vec(), "key")
            .await
            .expect_err("invalid provider plan is rejected");
        assert!(matches!(error, StorageClientError::PlanInvalid(_)));
    }
    assert!(server.requests().await.is_empty());
}

/// Preserves backend and verification errors without reporting false completion.
#[tokio::test]
async fn façade_preserves_backend_failure_and_download_verification_errors() {
    let server = TestServer::start(vec![
        response(503),
        Response {
            status: 200,
            body: b"wrong".to_vec(),
            headers: Vec::new(),
        },
    ])
    .await;
    let storage = WyrdStorageClient::new(&client(server.uri()));
    let error = storage
        .upload_artifact(
            &UploadId::new(),
            &UploadPlan::SinglePut {
                put_url: format!("{}/single", server.uri()),
                ttl_secs: 60,
                required_headers: Vec::new(),
            },
            b"data".to_vec(),
            "key",
        )
        .await
        .expect_err("backend failure is returned");
    let error: wyrd_spec::error::WyrdError = error.into();
    assert_eq!(error.code(), "WYRD_STORAGE_503_BACKEND_UNAVAILABLE");

    let destination = NamedTempFile::new().expect("destination");
    let positions = Arc::new(StdMutex::new(Vec::new()));
    let observed_positions = Arc::clone(&positions);
    let error = storage
        .download_verified_with_progress(
            &wyrd_spec::storage::DownloadPlan {
                get_url: format!("{}/download", server.uri()),
                ttl_secs: 60,
            },
            destination.path(),
            &sha256_b64(b"expected"),
            8,
            Arc::new(move |written, total| {
                observed_positions
                    .lock()
                    .expect("test progress mutex is not poisoned")
                    .push((written, total));
            }),
        )
        .await
        .expect_err("download verification failure is returned");
    assert!(matches!(error, StorageClientError::VerifyFailed { .. }));
    assert_eq!(
        positions
            .lock()
            .expect("test progress mutex is not poisoned")
            .last(),
        Some(&(b"wrong".len() as u64, Some(8)))
    );
}