videosdk-server-sdk 0.1.0

Rust server SDK for the VideoSDK v2 REST APIs
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
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
//! End-to-end tests for the request executor, against a mock HTTP server.
//!
//! These live inside the crate so they can drive the internal typed executors
//! (`json`, `data`, `wrapped`, `message`, `text`, `none`) that the resource
//! modules use, rather than only the public escape hatch.

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

use futures_util::StreamExt;
use reqwest::Method;
use serde::Deserialize;
use serde_json::{json, Value};
use wiremock::matchers::{body_json, method, path, query_param};
use wiremock::{Mock, MockServer, Request, ResponseTemplate};

use crate::client::{CallOptions, Client};
use crate::error::{Error, Result};
use crate::pagination::{paginate, ListParams, PageFetcher};
use crate::query::QueryBuilder;
use crate::test_support::{client, header, requests};

/// The first request the mock server received.
async fn only_request(server: &MockServer) -> Request {
    requests(server)
        .await
        .into_iter()
        .next()
        .expect("one request was received")
}

/* ---------------------------------- auth ---------------------------------- */

#[tokio::test]
async fn sends_a_raw_jwt_with_no_bearer_prefix() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/v2/rooms"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({})))
        .mount(&server)
        .await;

    let _: Value = client(&server)
        .json(Method::GET, "/v2/rooms", CallOptions::new())
        .await
        .unwrap();

    let request = only_request(&server).await;
    let authorization = header(&request, "authorization").expect("authorization header");
    assert!(
        !authorization.to_lowercase().starts_with("bearer"),
        "the API expects a bare JWT, got {authorization:?}"
    );
    // A compact JWS always begins with the base64url of `{"alg":...`.
    assert!(authorization.starts_with("eyJ"), "{authorization:?}");
    assert_eq!(authorization.split('.').count(), 3);

    assert_eq!(
        header(&request, "accept").as_deref(),
        Some("application/json")
    );
    assert!(header(&request, "user-agent")
        .unwrap()
        .starts_with("videosdk-rs/"));
}

#[tokio::test]
async fn a_static_token_is_sent_verbatim() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({})))
        .mount(&server)
        .await;

    let client = Client::builder()
        .token("a-static-token")
        .base_url(server.uri())
        .build()
        .unwrap();
    let _: Value = client
        .json(Method::GET, "/x", CallOptions::new())
        .await
        .unwrap();

    let request = only_request(&server).await;
    assert_eq!(
        header(&request, "authorization").as_deref(),
        Some("a-static-token")
    );
}

/// Regression: `RequestBuilder::header` appends, so chaining it would send a
/// caller's header *alongside* the SDK's rather than in place of it.
#[tokio::test]
async fn a_client_header_replaces_the_sdk_default_rather_than_duplicating_it() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({})))
        .mount(&server)
        .await;

    let client = Client::builder()
        .token("sdk-token")
        .base_url(server.uri())
        .header("user-agent", "my-app/1.0")
        .header("accept", "application/vnd.custom+json")
        // Opting out of the SDK's own auth is the caller's prerogative.
        .header("authorization", "Bearer mine")
        .build()
        .unwrap();
    let _: Value = client
        .json(Method::GET, "/x", CallOptions::new())
        .await
        .unwrap();

    let request = only_request(&server).await;
    for (name, expected) in [
        ("user-agent", "my-app/1.0"),
        ("accept", "application/vnd.custom+json"),
        ("authorization", "Bearer mine"),
    ] {
        let values: Vec<_> = request.headers.get_all(name).iter().collect();
        assert_eq!(values.len(), 1, "{name} was sent {} times", values.len());
        assert_eq!(values[0], expected, "{name}");
    }
}

#[tokio::test]
async fn a_per_call_header_wins_over_a_client_header() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({})))
        .mount(&server)
        .await;

    let client = Client::builder()
        .token("t")
        .base_url(server.uri())
        .header("x-tenant", "client-level")
        .build()
        .unwrap();
    let _ = client
        .api()
        .get(
            "/x",
            crate::RawRequest::new().header("x-tenant", "call-level"),
        )
        .await
        .unwrap();

    let request = only_request(&server).await;
    let values: Vec<_> = request.headers.get_all("x-tenant").iter().collect();
    assert_eq!(values.len(), 1);
    assert_eq!(values[0], "call-level");
}

#[tokio::test]
async fn an_invalid_header_is_a_validation_error() {
    let server = MockServer::start().await;
    let err = client(&server)
        .api()
        .get("/x", crate::RawRequest::new().header("bad header", "v"))
        .await
        .unwrap_err();
    assert!(err.is_validation(), "got {err:?}");
    assert!(requests(&server).await.is_empty());
}

/// A CSV export must not advertise that it wants JSON.
#[tokio::test]
async fn a_text_response_asks_for_any_content_type() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_string("a,b\n1,2\n"))
        .mount(&server)
        .await;

    let csv = client(&server)
        .text(Method::GET, "/export", CallOptions::new())
        .await
        .unwrap();
    assert_eq!(csv, "a,b\n1,2\n");
    assert_eq!(
        header(&only_request(&server).await, "accept").as_deref(),
        Some("*/*")
    );
}

/// The escape hatch can send a body the SDK does not encode for you.
#[tokio::test]
async fn a_raw_body_is_sent_verbatim_with_the_caller_s_content_type() {
    let server = MockServer::start().await;
    Mock::given(method("POST"))
        .respond_with(ResponseTemplate::new(200).set_body_string("v=0\r\n"))
        .mount(&server)
        .await;

    let answer = client(&server)
        .api()
        .post(
            "/v2/whip",
            crate::RawRequest::new()
                .raw_body(b"v=0\r\no=- 0 0 IN IP4 0.0.0.0\r\n".to_vec())
                .header("content-type", "application/sdp")
                .expect(crate::Expect::Text),
        )
        .await
        .unwrap();

    // A text response comes back as a JSON string, not a parse failure.
    assert_eq!(answer, json!("v=0\r\n"));

    let request = only_request(&server).await;
    assert_eq!(
        header(&request, "content-type").as_deref(),
        Some("application/sdp")
    );
    assert_eq!(request.body, b"v=0\r\no=- 0 0 IN IP4 0.0.0.0\r\n");
}

#[tokio::test]
async fn builder_requires_credentials() {
    // Guard against ambient env vars, and against parallel tests mutating them.
    static ENV_LOCK: StdMutex<()> = StdMutex::new(());
    let _guard = ENV_LOCK.lock().unwrap_or_else(|e| e.into_inner());

    let saved: Vec<_> = ["VIDEOSDK_API_KEY", "VIDEOSDK_SECRET"]
        .iter()
        .map(|name| (*name, std::env::var(name).ok()))
        .collect();
    for (name, _) in &saved {
        std::env::remove_var(name);
    }

    let err = Client::builder().build().unwrap_err();
    assert!(matches!(err, Error::Configuration(_)));
    assert!(err.to_string().contains("VIDEOSDK_API_KEY"));

    // An API key alone is not enough.
    assert!(Client::builder().api_key("k").build().is_err());
    // A token alone is.
    assert!(Client::builder().token("t").build().is_ok());

    std::env::set_var("VIDEOSDK_API_KEY", "from-env");
    std::env::set_var("VIDEOSDK_SECRET", "from-env");
    assert!(
        Client::new().is_ok(),
        "credentials come from the environment"
    );

    for (name, value) in saved {
        match value {
            Some(value) => std::env::set_var(name, value),
            None => std::env::remove_var(name),
        }
    }
}

#[tokio::test]
async fn base_url_trailing_slashes_are_trimmed() {
    let client = Client::builder()
        .token("t")
        .base_url("https://example.com///")
        .build()
        .unwrap();
    assert_eq!(client.base_url(), "https://example.com");
}

/* --------------------------------- retries -------------------------------- */

#[tokio::test]
async fn retries_a_rate_limit_for_a_non_idempotent_method() {
    let server = MockServer::start().await;
    Mock::given(method("POST"))
        .respond_with(ResponseTemplate::new(429))
        .up_to_n_times(1)
        .expect(1)
        .mount(&server)
        .await;
    Mock::given(method("POST"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({"ok": true})))
        .expect(1)
        .mount(&server)
        .await;

    let value: Value = client(&server)
        .json(Method::POST, "/x", CallOptions::new())
        .await
        .unwrap();
    assert_eq!(value["ok"], json!(true));
}

#[tokio::test]
async fn retries_a_server_error_only_for_idempotent_methods() {
    // GET retries and eventually succeeds.
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(503))
        .up_to_n_times(2)
        .expect(2)
        .mount(&server)
        .await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({})))
        .expect(1)
        .mount(&server)
        .await;
    let _: Value = client(&server)
        .json(Method::GET, "/x", CallOptions::new())
        .await
        .unwrap();
    drop(server);

    // POST does not retry: a 5xx may already have applied server-side.
    let server = MockServer::start().await;
    Mock::given(method("POST"))
        .respond_with(ResponseTemplate::new(503))
        .expect(1)
        .mount(&server)
        .await;
    let err = client(&server)
        .json::<Value>(Method::POST, "/x", CallOptions::new())
        .await
        .unwrap_err();
    assert_eq!(err.status(), Some(503));
}

#[tokio::test]
async fn stops_after_max_retries_and_honors_a_per_call_override() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(500))
        // 1 initial attempt + 2 default retries, then 1 attempt with retries off.
        .expect(4)
        .mount(&server)
        .await;

    let client = client(&server);
    assert!(client
        .json::<Value>(Method::GET, "/x", CallOptions::new())
        .await
        .is_err());
    assert!(client
        .with_max_retries(0)
        .json::<Value>(Method::GET, "/x", CallOptions::new())
        .await
        .is_err());
}

#[tokio::test]
async fn never_retries_client_errors() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(404).set_body_json(json!({"message": "gone"})))
        .expect(1)
        .mount(&server)
        .await;

    let err = client(&server)
        .json::<Value>(Method::GET, "/x", CallOptions::new())
        .await
        .unwrap_err();
    assert!(err.is_not_found());
}

#[tokio::test]
async fn honors_retry_after_on_a_rate_limit() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(429).insert_header("retry-after", "1"))
        .up_to_n_times(1)
        .mount(&server)
        .await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({})))
        .mount(&server)
        .await;

    // Backoff is zeroed, so any delay must have come from `Retry-After`.
    let started = Instant::now();
    let _: Value = client(&server)
        .json(Method::GET, "/x", CallOptions::new())
        .await
        .unwrap();
    assert!(
        started.elapsed() >= Duration::from_millis(900),
        "expected to wait for Retry-After, waited {:?}",
        started.elapsed()
    );
}

/* ---------------------------------- errors --------------------------------- */

#[tokio::test]
async fn normalizes_an_error_response() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(
            ResponseTemplate::new(409)
                .insert_header("x-request-id", "req-123")
                .set_body_json(json!({"message": "already exists", "code": "duplicate"})),
        )
        .mount(&server)
        .await;

    let err = client(&server)
        .json::<Value>(Method::GET, "/v2/rooms", CallOptions::new())
        .await
        .unwrap_err();

    assert!(err.is_conflict());
    assert_eq!(err.status(), Some(409));
    assert_eq!(err.code(), Some("duplicate"));
    assert_eq!(err.request_id(), Some("req-123"));
    let api = err.as_api().unwrap();
    assert_eq!(api.message, "already exists");
    assert_eq!(api.method, "GET");
    assert_eq!(api.path, "/v2/rooms");
    assert!(api.details.is_some());
}

#[tokio::test]
async fn a_payment_required_response_is_a_not_found() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(402))
        .mount(&server)
        .await;

    let err = client(&server)
        .json::<Value>(Method::GET, "/x", CallOptions::new())
        .await
        .unwrap_err();
    assert!(
        err.is_not_found(),
        "the API overloads 402 to mean not-found"
    );
}

#[tokio::test]
async fn a_non_json_error_body_still_yields_a_message() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(502).set_body_string("<html>bad gateway</html>"))
        .mount(&server)
        .await;

    let err = client(&server)
        .with_max_retries(0)
        .json::<Value>(Method::GET, "/x", CallOptions::new())
        .await
        .unwrap_err();
    assert_eq!(err.as_api().unwrap().message, "<html>bad gateway</html>");
}

#[tokio::test]
async fn a_client_timeout_is_reported_as_a_timeout() {
    let server = MockServer::start().await;
    Mock::given(method("POST"))
        .respond_with(ResponseTemplate::new(200).set_delay(Duration::from_secs(5)))
        .mount(&server)
        .await;

    let err = client(&server)
        .with_request_timeout(Duration::from_millis(50))
        .json::<Value>(Method::POST, "/x", CallOptions::new())
        .await
        .unwrap_err();
    assert!(err.is_timeout(), "got {err:?}");
}

/* --------------------------- typed decode helpers -------------------------- */

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

#[tokio::test]
async fn json_decodes_a_flat_body() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({"id": "room-1"})))
        .mount(&server)
        .await;

    let room: Room = client(&server)
        .json(Method::GET, "/x", CallOptions::new())
        .await
        .unwrap();
    assert_eq!(room.id, "room-1");
}

#[tokio::test]
async fn data_unwraps_a_data_envelope() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({"data": {"id": "room-1"}})))
        .mount(&server)
        .await;

    let room: Room = client(&server)
        .data(Method::GET, "/x", CallOptions::new())
        .await
        .unwrap();
    assert_eq!(room.id, "room-1");
}

#[tokio::test]
async fn wrapped_unwraps_a_named_envelope_and_tolerates_a_missing_key() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(path("/present"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({"alertRule": {"id": "r-1"}})))
        .mount(&server)
        .await;
    Mock::given(method("GET"))
        .and(path("/absent"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({"other": 1})))
        .mount(&server)
        .await;

    let client = client(&server);
    let room: Room = client
        .wrapped(Method::GET, "/present", "alertRule", CallOptions::new())
        .await
        .unwrap();
    assert_eq!(room.id, "r-1");

    let missing: Option<Room> = client
        .wrapped(Method::GET, "/absent", "alertRule", CallOptions::new())
        .await
        .unwrap();
    assert_eq!(missing, None);
}

#[tokio::test]
async fn message_unquotes_a_json_string_and_passes_through_text() {
    let server = MockServer::start().await;
    Mock::given(method("POST"))
        .and(path("/quoted"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!("Room ended")))
        .mount(&server)
        .await;
    Mock::given(method("POST"))
        .and(path("/plain"))
        .respond_with(ResponseTemplate::new(200).set_body_string("  Room ended  "))
        .mount(&server)
        .await;

    let client = client(&server);
    assert_eq!(
        client
            .message(Method::POST, "/quoted", CallOptions::new())
            .await
            .unwrap(),
        "Room ended"
    );
    assert_eq!(
        client
            .message(Method::POST, "/plain", CallOptions::new())
            .await
            .unwrap(),
        "Room ended"
    );
}

#[tokio::test]
async fn text_returns_the_raw_body() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_string("a,b\n1,2\n"))
        .mount(&server)
        .await;

    let csv = client(&server)
        .text(Method::GET, "/export", CallOptions::new())
        .await
        .unwrap();
    assert_eq!(csv, "a,b\n1,2\n");
}

#[tokio::test]
async fn none_discards_the_body_and_a_204_decodes_as_null() {
    let server = MockServer::start().await;
    Mock::given(method("DELETE"))
        .respond_with(ResponseTemplate::new(204))
        .mount(&server)
        .await;

    let client = client(&server);
    client
        .none(Method::DELETE, "/x", CallOptions::new())
        .await
        .unwrap();

    // An empty success body decodes as `null`, so only nullable types absorb it.
    let nothing: Option<Room> = client
        .json(Method::DELETE, "/x", CallOptions::new())
        .await
        .unwrap();
    assert_eq!(nothing, None);

    let err = client
        .json::<Room>(Method::DELETE, "/x", CallOptions::new())
        .await
        .unwrap_err();
    assert!(matches!(err, Error::Decode { .. }));
}

#[tokio::test]
async fn a_malformed_body_is_a_decode_error() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_string("not json"))
        .mount(&server)
        .await;

    let err = client(&server)
        .json::<Room>(Method::GET, "/v2/rooms", CallOptions::new())
        .await
        .unwrap_err();
    assert!(matches!(err, Error::Decode { .. }));
    assert!(err.to_string().contains("GET /v2/rooms"));
}

/* ---------------------------- bodies and queries ---------------------------- */

#[tokio::test]
async fn sends_a_json_body_with_a_content_type() {
    let server = MockServer::start().await;
    Mock::given(method("POST"))
        .and(body_json(json!({"name": "standup"})))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({})))
        .expect(1)
        .mount(&server)
        .await;

    let options = CallOptions::json(json!({"name": "standup"})).unwrap();
    let _: Value = client(&server)
        .json(Method::POST, "/v2/rooms", options)
        .await
        .unwrap();

    let request = only_request(&server).await;
    assert_eq!(
        header(&request, "content-type").as_deref(),
        Some("application/json")
    );
}

#[tokio::test]
async fn sends_query_parameters_omitting_absent_ones() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(query_param("page", "2"))
        .and(query_param("kinds", "audio,video"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({})))
        .expect(1)
        .mount(&server)
        .await;

    let query = QueryBuilder::new()
        .opt("page", Some(2))
        .opt_str("search", None::<&str>)
        .csv("kinds", &["audio", "video"])
        .into_pairs();
    let _: Value = client(&server)
        .json(Method::GET, "/v2/rooms", CallOptions::new().query(query))
        .await
        .unwrap();

    let request = only_request(&server).await;
    assert!(!request.url.query().unwrap().contains("search"));
}

/* -------------------------------- put_binary ------------------------------- */

#[tokio::test]
async fn put_binary_omits_auth_and_retries() {
    let server = MockServer::start().await;
    Mock::given(method("PUT"))
        .respond_with(ResponseTemplate::new(500))
        .up_to_n_times(1)
        .expect(1)
        .mount(&server)
        .await;
    Mock::given(method("PUT"))
        .respond_with(ResponseTemplate::new(200))
        .expect(1)
        .mount(&server)
        .await;

    // A presigned URL carries its own signature in the query string.
    let url = format!("{}/bucket/key?X-Amz-Signature=secret", server.uri());
    client(&server)
        .put_binary(&url, b"a,b\n", "text/csv")
        .await
        .unwrap();

    let request = only_request(&server).await;
    assert!(
        header(&request, "authorization").is_none(),
        "sending auth would invalidate the presigned signature"
    );
    assert_eq!(
        header(&request, "content-type").as_deref(),
        Some("text/csv")
    );
}

#[tokio::test]
async fn put_binary_keeps_the_signature_out_of_errors() {
    let server = MockServer::start().await;
    Mock::given(method("PUT"))
        .respond_with(ResponseTemplate::new(403))
        .mount(&server)
        .await;

    let url = format!("{}/bucket/key?X-Amz-Signature=secret", server.uri());
    let err = client(&server)
        .put_binary(&url, b"x", "text/csv")
        .await
        .unwrap_err();

    assert_eq!(err.code(), Some("upload_failed"));
    let rendered = err.to_string();
    assert!(
        !rendered.contains("secret"),
        "leaked the signature: {rendered}"
    );
    assert!(!err.as_api().unwrap().path.contains('?'));
}

/* ------------------------------- escape hatch ------------------------------ */

#[tokio::test]
async fn the_raw_api_facade_applies_auth() {
    let server = MockServer::start().await;
    Mock::given(method("PATCH"))
        .and(path("/v2/anything"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({"ok": 1})))
        .mount(&server)
        .await;

    let client = client(&server);
    let value = client
        .api()
        .patch(
            "/v2/anything",
            crate::RawRequest::new().body(json!({"a": 1})),
        )
        .await
        .unwrap();
    assert_eq!(value["ok"], json!(1));

    assert!(header(&only_request(&server).await, "authorization").is_some());
}

/* -------------------------------- pagination ------------------------------- */

#[derive(Debug, Deserialize)]
struct Item {
    id: u32,
}

/// Builds a fetcher that pages through `GET /items`.
fn item_fetcher(client: Client) -> PageFetcher {
    Arc::new(move |page, per_page| {
        let client = client.clone();
        Box::pin(async move {
            let query = QueryBuilder::new()
                .opt("page", page)
                .opt("perPage", per_page)
                .into_pairs();
            client
                .json::<Value>(Method::GET, "/items", CallOptions::new().query(query))
                .await
        })
    })
}

#[tokio::test]
async fn a_page_walks_to_the_next_page() {
    let server = MockServer::start().await;
    let body = |page: u32, id: u32| {
        json!({
            "pageInfo": {"currentPage": page, "perPage": 1, "lastPage": 2, "total": 2},
            "data": [{"id": id}],
        })
    };
    Mock::given(method("GET"))
        .and(query_param("page", "2"))
        .respond_with(ResponseTemplate::new(200).set_body_json(body(2, 2)))
        .mount(&server)
        .await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_json(body(1, 1)))
        .mount(&server)
        .await;

    let first: crate::Page<Item> = paginate(
        item_fetcher(client(&server)),
        &ListParams::default(),
        "data",
        None,
    )
    .await
    .unwrap();

    assert_eq!(first.data[0].id, 1);
    assert_eq!(first.total(), 2);
    assert!(first.has_next_page());

    let second = first.next_page().await.unwrap().expect("a second page");
    assert_eq!(second.data[0].id, 2);
    assert!(!second.has_next_page());
    assert!(second.next_page().await.unwrap().is_none());
}

#[tokio::test]
async fn a_page_streams_every_item_across_pages() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(query_param("page", "2"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "pageInfo": {"currentPage": 2, "perPage": 2, "lastPage": 2, "total": 3},
            "data": [{"id": 3}],
        })))
        .mount(&server)
        .await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "pageInfo": {"currentPage": 1, "perPage": 2, "lastPage": 2, "total": 3},
            "data": [{"id": 1}, {"id": 2}],
        })))
        .mount(&server)
        .await;

    let page: crate::Page<Item> = paginate(
        item_fetcher(client(&server)),
        &ListParams::default(),
        "data",
        None,
    )
    .await
    .unwrap();

    let ids: Vec<u32> = page
        .into_stream()
        .map(|item| item.unwrap().id)
        .collect()
        .await;
    assert_eq!(ids, [1, 2, 3]);
}

#[tokio::test]
async fn a_stream_surfaces_a_fetch_error_once_and_stops() {
    let server = MockServer::start().await;
    Mock::given(method("GET"))
        .and(query_param("page", "2"))
        .respond_with(ResponseTemplate::new(500))
        .mount(&server)
        .await;
    Mock::given(method("GET"))
        .respond_with(ResponseTemplate::new(200).set_body_json(json!({
            "pageInfo": {"currentPage": 1, "perPage": 1, "lastPage": 2, "total": 2},
            "data": [{"id": 1}],
        })))
        .mount(&server)
        .await;

    let page: crate::Page<Item> = paginate(
        item_fetcher(client(&server).with_max_retries(0)),
        &ListParams::default(),
        "data",
        None,
    )
    .await
    .unwrap();

    let results: Vec<Result<Item>> = page.into_stream().collect().await;
    assert_eq!(results.len(), 2);
    assert!(results[0].is_ok());
    assert_eq!(results[1].as_ref().unwrap_err().status(), Some(500));
}