rama-http 0.4.0

rama http layers, services and other utilities
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
use super::{
    RequestWriter, ResponseWriter, TrafficWriterId, WriterMode, ensure_traffic_writer_id,
    write_headers_body_flags,
};
use crate::{Request, Response, io::write_http_request_streaming};
use rama_core::error::BoxError;
use rama_core::extensions::ExtensionsRef as _;
use rama_core::telemetry::tracing;
use rama_utils::fs::{CreatedFilePermissions, OpenOptions, is_reserved_device_name};
use rama_utils::time::unix_timestamp_millis;
use std::{
    io,
    path::{Path, PathBuf},
    sync::Arc,
};
use tokio::io::{AsyncWriteExt as _, BufWriter};

const MAX_PREFIX_LEN: usize = 32;
const MAX_METHOD_LEN: usize = 16;
const MAX_FILE_NAME_LEN: usize = 160;
const CREATE_ATTEMPTS: usize = 8;

/// Writes every captured request and response to an independent file.
///
/// Independent files allow bodies to stream concurrently without frame
/// interleaving or cross-message backpressure. Generated filenames use only
/// portable ASCII characters and are bounded to 160 bytes, comfortably below
/// the commonly supported 255-byte component limit. The caller-provided
/// destination can still be rejected by the operating system when the complete
/// path exceeds a platform-specific path limit.
/// Raw URIs are never included because they can contain secrets, path
/// separators, platform-specific characters, or unbounded input.
/// Request and response files captured for the same HTTP exchange contain the
/// same UUID, regardless of request/response writer layer order.
///
/// Files are created without overwriting existing paths. On Unix, newly
/// created files receive owner-only read/write permissions before the process
/// umask is applied. The destination directory is canonicalized and every file
/// open is confined to it.
#[derive(Clone, Debug)]
pub struct PerMessageFileWriter {
    directory: Arc<PathBuf>,
    prefix: Arc<str>,
    request_mode: Option<WriterMode>,
    response_mode: Option<WriterMode>,
}

impl PerMessageFileWriter {
    /// Create a per-message file writer, creating `directory` when necessary.
    ///
    /// `prefix` must be 1 to 32 ASCII letters, digits, `-`, or `_`. This
    /// deliberately conservative alphabet is valid in filenames on Unix,
    /// Windows, and common removable filesystems.
    pub async fn try_new(
        directory: impl Into<PathBuf>,
        prefix: impl AsRef<str>,
    ) -> io::Result<Self> {
        let prefix = validate_prefix(prefix.as_ref())?;
        let directory = directory.into();
        tokio::fs::create_dir_all(&directory).await?;
        let directory = tokio::fs::canonicalize(directory).await?;
        Ok(Self {
            directory: Arc::new(directory),
            prefix: Arc::from(prefix),
            request_mode: Some(WriterMode::All),
            response_mode: Some(WriterMode::All),
        })
    }

    /// Set how request files are written.
    #[must_use]
    pub fn with_request_mode(mut self, mode: Option<WriterMode>) -> Self {
        self.request_mode = mode;
        self
    }

    /// Set how response files are written.
    #[must_use]
    pub fn with_response_mode(mut self, mode: Option<WriterMode>) -> Self {
        self.response_mode = mode;
        self
    }

    /// Return the canonical destination directory.
    #[must_use]
    pub fn directory(&self) -> &Path {
        self.directory.as_ref()
    }

    /// Return the portable filename prefix.
    #[must_use]
    pub fn prefix(&self) -> &str {
        &self.prefix
    }

    /// Return the configured request writer mode.
    #[must_use]
    pub const fn request_mode(&self) -> Option<WriterMode> {
        self.request_mode
    }

    /// Return the configured response writer mode.
    #[must_use]
    pub const fn response_mode(&self) -> Option<WriterMode> {
        self.response_mode
    }

    async fn open_unique(
        &self,
        name: impl Fn(usize) -> String,
    ) -> io::Result<(BufWriter<tokio::fs::File>, PathBuf)> {
        for attempt in 0..CREATE_ATTEMPTS {
            let filename = name(attempt);
            if !is_portable_filename(&filename) {
                return Err(io::Error::new(
                    io::ErrorKind::InvalidInput,
                    "generated traffic capture filename is not portable",
                ));
            }

            let result = OpenOptions::new()
                .write(true)
                .create_new(true)
                .created_file_permissions(CreatedFilePermissions::OwnerReadWrite)
                .jail(self.directory.as_ref())
                .open(&filename)
                .await;
            match result {
                Ok(file) => {
                    let path = self.directory.join(filename);
                    return Ok((BufWriter::new(file), path));
                }
                Err(error) if error.kind() == io::ErrorKind::AlreadyExists => {}
                Err(error) => return Err(error),
            }
        }

        Err(io::Error::new(
            io::ErrorKind::AlreadyExists,
            "failed to allocate a unique traffic capture filename",
        ))
    }
}

impl RequestWriter for PerMessageFileWriter {
    async fn write_request(&self, request: Request) {
        let (write_headers, write_body) = write_headers_body_flags(self.request_mode);
        if !write_headers && !write_body {
            return;
        }

        let method = portable_method(request.method().as_str());
        let traffic_writer_id = ensure_traffic_writer_id(request.extensions());
        let timestamp = unix_timestamp_millis();
        let opened = self
            .open_unique(|attempt| {
                request_filename(&self.prefix, timestamp, &method, traffic_writer_id, attempt)
            })
            .await;
        let (mut file, path) = match opened {
            Ok(value) => value,
            Err(error) => {
                tracing::error!(%error, "failed to create request capture file");
                return;
            }
        };

        let result =
            write_http_request_streaming(&mut file, request, write_headers, write_body).await;
        finish_file_write(&mut file, &path, "request", result).await;
    }
}

impl ResponseWriter for PerMessageFileWriter {
    async fn write_response(&self, response: Response) {
        let (write_headers, write_body) = write_headers_body_flags(self.response_mode);
        if !write_headers && !write_body {
            return;
        }

        let status = response.status().as_u16();
        let traffic_writer_id = ensure_traffic_writer_id(response.extensions());
        let timestamp = unix_timestamp_millis();
        let opened = self
            .open_unique(|attempt| {
                response_filename(&self.prefix, timestamp, status, traffic_writer_id, attempt)
            })
            .await;
        let (mut file, path) = match opened {
            Ok(value) => value,
            Err(error) => {
                tracing::error!(%error, "failed to create response capture file");
                return;
            }
        };

        let result = crate::io::write_http_response_streaming(
            &mut file,
            response,
            write_headers,
            write_body,
        )
        .await;
        finish_file_write(&mut file, &path, "response", result).await;
    }
}

async fn finish_file_write(
    file: &mut BufWriter<tokio::fs::File>,
    path: &Path,
    message_kind: &'static str,
    write_result: Result<(), BoxError>,
) {
    if let Err(error) = write_result {
        tracing::error!(
            %error,
            path = %path.display(),
            message_kind,
            "failed to write HTTP capture file"
        );
    }
    if let Err(error) = file.flush().await {
        tracing::error!(
            %error,
            path = %path.display(),
            message_kind,
            "failed to flush HTTP capture file"
        );
    }
}

fn validate_prefix(prefix: &str) -> io::Result<String> {
    if prefix.is_empty()
        || prefix.len() > MAX_PREFIX_LEN
        || !prefix
            .bytes()
            .all(|byte| byte.is_ascii_alphanumeric() || matches!(byte, b'-' | b'_'))
        || is_reserved_device_name(prefix)
    {
        return Err(io::Error::new(
            io::ErrorKind::InvalidInput,
            "traffic capture filename prefix must be 1 to 32 portable ASCII letters, digits, '-' or '_' and not a reserved device name",
        ));
    }
    Ok(prefix.to_owned())
}

fn portable_method(method: &str) -> String {
    method
        .bytes()
        .take(MAX_METHOD_LEN)
        .map(|byte| {
            if byte.is_ascii_alphanumeric() {
                char::from(byte.to_ascii_uppercase())
            } else {
                '_'
            }
        })
        .collect()
}

fn request_filename(
    prefix: &str,
    timestamp: i64,
    method: &str,
    traffic_writer_id: TrafficWriterId,
    attempt: usize,
) -> String {
    let id = traffic_writer_id.0.simple();
    if attempt == 0 {
        format!("{prefix}-{timestamp}-request-{method}-{id}.http")
    } else {
        format!("{prefix}-{timestamp}-request-{method}-{id}-{attempt}.http")
    }
}

fn response_filename(
    prefix: &str,
    timestamp: i64,
    status: u16,
    traffic_writer_id: TrafficWriterId,
    attempt: usize,
) -> String {
    let id = traffic_writer_id.0.simple();
    if attempt == 0 {
        format!("{prefix}-{timestamp}-response-{status}-{id}.http")
    } else {
        format!("{prefix}-{timestamp}-response-{status}-{id}-{attempt}.http")
    }
}

fn is_portable_filename(filename: &str) -> bool {
    !filename.is_empty()
        && filename.len() <= MAX_FILE_NAME_LEN
        && filename
            .bytes()
            .all(|byte| byte.is_ascii_alphanumeric() || matches!(byte, b'-' | b'_' | b'.'))
        && !filename.ends_with(['.', ' '])
        && !is_reserved_device_name(filename)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::{
        Body, Method, StatusCode,
        body::util::BodyExt as _,
        layer::traffic_writer::{RequestWriterLayer, ResponseWriterLayer},
    };
    use ahash::{HashSet, HashSetExt as _};
    use rama_core::{Layer as _, Service as _, rt::Executor, service::service_fn};
    use std::{convert::Infallible, time::Duration};
    use uuid::Uuid;

    async fn wait_for_exchange_files(directory: &Path) -> Vec<(String, Vec<u8>)> {
        tokio::time::timeout(Duration::from_secs(1), async {
            loop {
                let mut entries = tokio::fs::read_dir(directory).await.unwrap();
                let mut files = Vec::new();
                while let Some(entry) = entries.next_entry().await.unwrap() {
                    files.push((
                        entry.file_name().into_string().unwrap(),
                        tokio::fs::read(entry.path()).await.unwrap(),
                    ));
                }
                if files.len() == 2
                    && files
                        .iter()
                        .any(|(_, bytes)| bytes.ends_with(b"\r\nrequest-body"))
                    && files
                        .iter()
                        .any(|(_, bytes)| bytes.ends_with(b"\r\nresponse-body"))
                {
                    return files;
                }
                tokio::time::sleep(Duration::from_millis(1)).await;
            }
        })
        .await
        .expect("request and response capture files should finish")
    }

    fn assert_exchange_files_share_id(files: &[(String, Vec<u8>)]) {
        fn id(name: &str) -> &str {
            name.strip_suffix(".http")
                .unwrap()
                .rsplit('-')
                .next()
                .unwrap()
        }

        let request = files
            .iter()
            .find(|(name, _)| name.contains("-request-POST-"))
            .unwrap();
        let response = files
            .iter()
            .find(|(name, _)| name.contains("-response-200-"))
            .unwrap();
        let request_id = id(&request.0);
        let response_id = id(&response.0);
        assert_eq!(request_id.len(), 32);
        assert!(request_id.bytes().all(|byte| byte.is_ascii_hexdigit()));
        assert_eq!(request_id, response_id);
    }

    async fn consume_request(request: Request) -> Result<Response, Infallible> {
        assert_eq!(
            request.into_body().collect().await.unwrap().to_bytes(),
            "request-body"
        );
        Ok(Response::new(Body::from("response-body")))
    }

    #[test]
    fn generated_filenames_are_unique_portable_and_bounded() {
        let method = portable_method("CUSTOM/METHOD-THAT-IS-TOO-LONG");
        assert_eq!(method, "CUSTOM_METHOD_TH");
        let mut names = HashSet::new();

        for _ in 0..128 {
            let traffic_writer_id = TrafficWriterId(Uuid::new_v4());
            let request = request_filename(
                "portable_prefix-123456789012345",
                1_700_000_000_000,
                &method,
                traffic_writer_id,
                0,
            );
            let response = response_filename(
                "portable_prefix-123456789012345",
                1_700_000_000_001,
                599,
                traffic_writer_id,
                0,
            );
            let id = traffic_writer_id.0.simple().to_string();
            assert!(request.contains(&id));
            assert!(response.contains(&id));
            for filename in [request, response] {
                assert!(is_portable_filename(&filename));
                assert!(filename.len() <= MAX_FILE_NAME_LEN);
                assert_eq!(Path::new(&filename).components().count(), 1);
                assert!(!filename.contains("access_token"));
                assert!(names.insert(filename));
            }
        }

        let traffic_writer_id = TrafficWriterId(Uuid::new_v4());
        let base = request_filename("capture", 1, "GET", traffic_writer_id, 0);
        let retry = request_filename("capture", 1, "GET", traffic_writer_id, 1);
        assert_ne!(base, retry);
        assert!(retry.ends_with(&format!("-{}-1.http", traffic_writer_id.0.simple())));
        assert!(is_portable_filename(&retry));

        let base = response_filename("capture", 1, 200, traffic_writer_id, 0);
        let retry = response_filename("capture", 1, 200, traffic_writer_id, 1);
        assert_ne!(base, retry);
        assert!(retry.ends_with(&format!("-{}-1.http", traffic_writer_id.0.simple())));
        assert!(is_portable_filename(&retry));

        let longest = request_filename(
            "12345678901234567890123456789012",
            i64::MIN,
            &method,
            traffic_writer_id,
            CREATE_ATTEMPTS - 1,
        );
        assert!(longest.len() <= MAX_FILE_NAME_LEN);
        assert!(is_portable_filename(&longest));
    }

    #[tokio::test]
    async fn file_layers_share_exchange_id_with_request_layer_outermost() {
        let temp = tempfile::tempdir().unwrap();
        let executor = Executor::new();
        let request = RequestWriterLayer::file_per_request(
            &executor,
            temp.path(),
            "traffic",
            Some(WriterMode::All),
        )
        .await
        .unwrap();
        let response = ResponseWriterLayer::file_per_response(
            &executor,
            temp.path(),
            "traffic",
            Some(WriterMode::All),
        )
        .await
        .unwrap();
        let service = request.into_layer(response.into_layer(service_fn(consume_request)));

        let response = service
            .serve(
                Request::builder()
                    .method(Method::POST)
                    .uri("/capture")
                    .body(Body::from("request-body"))
                    .unwrap(),
            )
            .await
            .unwrap();
        assert_eq!(
            response.into_body().collect().await.unwrap().to_bytes(),
            "response-body"
        );
        drop(service);

        let files = wait_for_exchange_files(temp.path()).await;
        assert_exchange_files_share_id(&files);
    }

    #[tokio::test]
    async fn file_layers_share_exchange_id_with_response_layer_outermost() {
        let temp = tempfile::tempdir().unwrap();
        let executor = Executor::new();
        let request = RequestWriterLayer::file_per_request(
            &executor,
            temp.path(),
            "traffic",
            Some(WriterMode::All),
        )
        .await
        .unwrap();
        let response = ResponseWriterLayer::file_per_response(
            &executor,
            temp.path(),
            "traffic",
            Some(WriterMode::All),
        )
        .await
        .unwrap();
        let service = response.into_layer(request.into_layer(service_fn(consume_request)));

        let response = service
            .serve(
                Request::builder()
                    .method(Method::POST)
                    .uri("/capture")
                    .body(Body::from("request-body"))
                    .unwrap(),
            )
            .await
            .unwrap();
        assert_eq!(
            response.into_body().collect().await.unwrap().to_bytes(),
            "response-body"
        );
        drop(service);

        let files = wait_for_exchange_files(temp.path()).await;
        assert_exchange_files_share_id(&files);
    }

    #[tokio::test]
    async fn prefix_validation_is_platform_conservative() {
        let temp = tempfile::tempdir().unwrap();
        for prefix in [
            "",
            "contains space",
            "contains.dot",
            "../escape",
            r"back\slash",
            "unicode-λ",
            "CON",
            "nul",
            "123456789012345678901234567890123",
        ] {
            let error = PerMessageFileWriter::try_new(temp.path(), prefix)
                .await
                .unwrap_err();
            assert_eq!(error.kind(), io::ErrorKind::InvalidInput, "{prefix:?}");
        }

        let writer = PerMessageFileWriter::try_new(temp.path(), "Abc_123-xyz-12345678901234567890")
            .await
            .unwrap();
        assert_eq!(writer.prefix().len(), MAX_PREFIX_LEN);
        assert_eq!(writer.directory(), temp.path().canonicalize().unwrap());
    }

    #[tokio::test]
    async fn unique_creation_never_overwrites_an_existing_file() {
        let temp = tempfile::tempdir().unwrap();
        let writer = PerMessageFileWriter::try_new(temp.path(), "capture")
            .await
            .unwrap();
        let colliding = "capture-1-request-GET-00000000000000000000000000000000.http";
        let unique = "capture-2-request-GET-00000000000000000000000000000000.http";
        assert!(is_portable_filename(colliding));
        assert!(is_portable_filename(unique));
        let path = temp.path().join(colliding);
        tokio::fs::write(&path, b"existing").await.unwrap();

        let (_, created_path) = writer
            .open_unique(|attempt| {
                if attempt == 0 {
                    colliding.to_owned()
                } else {
                    unique.to_owned()
                }
            })
            .await
            .unwrap();
        assert_eq!(created_path, writer.directory().join(unique));
        assert_eq!(tokio::fs::read(path).await.unwrap(), b"existing");
    }

    #[tokio::test]
    async fn unique_creation_reports_exhausted_collisions() {
        let temp = tempfile::tempdir().unwrap();
        let writer = PerMessageFileWriter::try_new(temp.path(), "capture")
            .await
            .unwrap();
        let filename = "capture-1-request-GET-00000000000000000000000000000000.http";
        tokio::fs::write(temp.path().join(filename), b"existing")
            .await
            .unwrap();

        let attempts = std::sync::atomic::AtomicUsize::new(0);
        let error = writer
            .open_unique(|_| {
                attempts.fetch_add(1, std::sync::atomic::Ordering::Relaxed);
                filename.to_owned()
            })
            .await
            .unwrap_err();
        assert_eq!(error.kind(), io::ErrorKind::AlreadyExists);
        assert_eq!(
            attempts.load(std::sync::atomic::Ordering::Relaxed),
            CREATE_ATTEMPTS
        );
    }

    #[tokio::test]
    async fn unique_creation_propagates_non_collision_errors() {
        let temp = tempfile::tempdir().unwrap();
        let directory = temp.path().join("removed");
        let writer = PerMessageFileWriter::try_new(&directory, "capture")
            .await
            .unwrap();
        tokio::fs::remove_dir(directory).await.unwrap();

        let error = writer
            .open_unique(|_| "capture-unique.http".to_owned())
            .await
            .unwrap_err();
        assert_eq!(error.kind(), io::ErrorKind::NotFound);
    }

    #[tokio::test]
    async fn unique_creation_rejects_non_portable_generated_names() {
        let temp = tempfile::tempdir().unwrap();
        let writer = PerMessageFileWriter::try_new(temp.path(), "capture")
            .await
            .unwrap();

        let overly_long = "x".repeat(MAX_FILE_NAME_LEN + 1);
        for filename in ["../escape.http", "trailing.", overly_long.as_str()] {
            let error = writer
                .open_unique(|_| filename.to_owned())
                .await
                .unwrap_err();
            assert_eq!(error.kind(), io::ErrorKind::InvalidInput);
        }
        assert!(
            tokio::fs::read_dir(temp.path())
                .await
                .unwrap()
                .next_entry()
                .await
                .unwrap()
                .is_none()
        );
    }

    #[tokio::test]
    async fn request_and_response_files_stream_independently() {
        let temp = tempfile::tempdir().unwrap();
        let writer = PerMessageFileWriter::try_new(temp.path(), "traffic")
            .await
            .unwrap();
        let traffic_writer_id = TrafficWriterId(Uuid::new_v4());

        let (first_tx, first_rx) = tokio::sync::mpsc::unbounded_channel();
        let first_body = Body::from_stream(rama_core::futures::stream::unfold(
            first_rx,
            |mut receiver| async move { receiver.recv().await.map(|item| (item, receiver)) },
        ));
        let first_response = Response::builder()
            .status(StatusCode::OK)
            .body(first_body)
            .unwrap();
        first_response.extensions().insert(traffic_writer_id);
        let first_writer = writer.clone();
        let first = tokio::spawn(async move {
            first_writer.write_response(first_response).await;
        });
        let second_request = Request::builder()
            .method(Method::POST)
            .uri("https://example.com/upload?token=secret")
            .header("x-test", "yes")
            .body(Body::from("second"))
            .unwrap();
        second_request.extensions().insert(traffic_writer_id);
        let second = writer.write_request(second_request);
        first_tx
            .send(Ok::<_, std::convert::Infallible>(
                rama_core::bytes::Bytes::from_static(b"first"),
            ))
            .unwrap();

        tokio::time::timeout(std::time::Duration::from_secs(1), second)
            .await
            .expect("a separate request file must not wait for a live response");
        drop(first_tx);
        first.await.unwrap();

        let mut entries = tokio::fs::read_dir(temp.path()).await.unwrap();
        let mut files = Vec::new();
        while let Some(entry) = entries.next_entry().await.unwrap() {
            let name = entry.file_name().into_string().unwrap();
            assert!(is_portable_filename(&name));
            files.push((name, tokio::fs::read(entry.path()).await.unwrap()));
        }
        assert_eq!(files.len(), 2);
        assert!(files.iter().any(|(name, bytes)| {
            name.contains("-request-POST-")
                && bytes.starts_with(b"POST /upload?token=secret HTTP/1.1\r\n")
                && bytes.ends_with(b"\r\nsecond")
        }));
        assert!(files.iter().any(|(name, bytes)| {
            name.contains("-response-200-")
                && bytes.starts_with(b"HTTP/1.1 200 OK\r\n")
                && bytes.ends_with(b"\r\nfirst")
        }));
        assert!(files.iter().all(|(name, _)| !name.contains("secret")));
        let id = traffic_writer_id.0.simple().to_string();
        assert!(files.iter().all(|(name, _)| name.contains(&id)));
    }

    #[tokio::test]
    async fn body_error_flushes_partial_request_capture() {
        let temp = tempfile::tempdir().unwrap();
        let writer = PerMessageFileWriter::try_new(temp.path(), "traffic")
            .await
            .unwrap()
            .with_response_mode(None);
        let body = Body::from_stream(rama_core::futures::stream::iter([
            Ok::<_, io::Error>(rama_core::bytes::Bytes::from_static(b"first")),
            Err(io::Error::other("body failed")),
        ]));

        writer
            .write_request(
                Request::builder()
                    .method(Method::POST)
                    .uri("/broken")
                    .body(body)
                    .unwrap(),
            )
            .await;

        let entry = tokio::fs::read_dir(temp.path())
            .await
            .unwrap()
            .next_entry()
            .await
            .unwrap()
            .unwrap();
        assert_eq!(
            tokio::fs::read(entry.path()).await.unwrap(),
            b"POST /broken HTTP/1.1\r\n\r\nfirst"
        );
    }

    #[tokio::test]
    async fn disabled_request_does_not_create_a_file() {
        let temp = tempfile::tempdir().unwrap();
        let writer = PerMessageFileWriter::try_new(temp.path(), "traffic")
            .await
            .unwrap()
            .with_request_mode(None);
        writer
            .write_request(Request::new(Body::from("ignored")))
            .await;
        assert!(
            tokio::fs::read_dir(temp.path())
                .await
                .unwrap()
                .next_entry()
                .await
                .unwrap()
                .is_none()
        );
    }

    #[tokio::test]
    async fn disabled_response_does_not_create_a_file() {
        let temp = tempfile::tempdir().unwrap();
        let writer = PerMessageFileWriter::try_new(temp.path(), "traffic")
            .await
            .unwrap()
            .with_response_mode(None);
        writer
            .write_response(Response::new(Body::from("ignored")))
            .await;
        assert!(
            tokio::fs::read_dir(temp.path())
                .await
                .unwrap()
                .next_entry()
                .await
                .unwrap()
                .is_none()
        );
    }

    #[tokio::test]
    async fn response_headers_mode_creates_a_file() {
        let temp = tempfile::tempdir().unwrap();
        let writer = PerMessageFileWriter::try_new(temp.path(), "traffic")
            .await
            .unwrap()
            .with_request_mode(None)
            .with_response_mode(Some(WriterMode::Headers));
        writer
            .write_response(
                Response::builder()
                    .status(StatusCode::ACCEPTED)
                    .header("x-mode", "headers")
                    .body(Body::from("ignored"))
                    .unwrap(),
            )
            .await;

        let entry = tokio::fs::read_dir(temp.path())
            .await
            .unwrap()
            .next_entry()
            .await
            .unwrap()
            .unwrap();
        let bytes = tokio::fs::read(entry.path()).await.unwrap();
        assert!(bytes.starts_with(b"HTTP/1.1 202 Accepted\r\n"));
        assert!(bytes.ends_with(b"x-mode: headers\r\n"));
        assert!(!bytes.windows(7).any(|window| window == b"ignored"));
    }

    #[tokio::test]
    async fn request_and_response_modes_control_file_contents() {
        let temp = tempfile::tempdir().unwrap();
        let writer = PerMessageFileWriter::try_new(temp.path(), "modes")
            .await
            .unwrap()
            .with_request_mode(Some(WriterMode::Headers))
            .with_response_mode(Some(WriterMode::Body));

        writer
            .write_request(
                Request::builder()
                    .uri("/headers")
                    .header("x-mode", "headers")
                    .body(Body::from("not written"))
                    .unwrap(),
            )
            .await;
        writer
            .write_response(
                Response::builder()
                    .status(StatusCode::CREATED)
                    .header("x-mode", "not written")
                    .body(Body::from("body only"))
                    .unwrap(),
            )
            .await;

        let mut entries = tokio::fs::read_dir(temp.path()).await.unwrap();
        let mut files = Vec::new();
        while let Some(entry) = entries.next_entry().await.unwrap() {
            files.push((
                entry.file_name().into_string().unwrap(),
                tokio::fs::read(entry.path()).await.unwrap(),
            ));
        }
        assert_eq!(files.len(), 2);
        assert!(files.iter().any(|(name, bytes)| {
            name.contains("-request-GET-")
                && bytes.starts_with(b"GET /headers HTTP/1.1\r\n")
                && bytes.ends_with(b"x-mode: headers\r\n")
                && !bytes.windows(11).any(|window| window == b"not written")
        }));
        assert!(
            files.iter().any(|(name, bytes)| {
                name.contains("-response-201-") && bytes == b"\r\nbody only"
            })
        );
    }

    #[cfg(unix)]
    #[tokio::test]
    async fn capture_files_are_not_group_or_world_accessible() {
        use std::os::unix::fs::PermissionsExt as _;

        let temp = tempfile::tempdir().unwrap();
        let writer = PerMessageFileWriter::try_new(temp.path(), "traffic")
            .await
            .unwrap();
        writer
            .write_response(Response::new(Body::from("private")))
            .await;

        let entry = tokio::fs::read_dir(temp.path())
            .await
            .unwrap()
            .next_entry()
            .await
            .unwrap()
            .unwrap();
        let mode = entry.metadata().await.unwrap().permissions().mode();
        assert_eq!(mode & 0o077, 0);
    }
}