aws-s3-transfer 1.0.0

Transfer Manager for Amazon S3 - a high-performance data plane client for uploading and downloading objects and directories.
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
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

use std::collections::VecDeque;
use std::sync::Arc;

use super::error::{WalkError, WalkErrorKind};
use crate::model::Object;
use crate::types::BucketType;

type FilterFn = Arc<dyn Fn(&Object) -> bool + Send + Sync>;

/// Service client backing a listing, including the runtime ownership it needs.
#[derive(Debug)]
enum S3WalkServiceClient {
    /// Standalone walks retain the transfer manager and its managed runtime.
    TransferManager(crate::Client),
    /// SDK client without a transfer manager owner. Internal transfers use this to avoid a
    /// cycle through the scheduler; SDK interoperability callers own any
    /// custom transport's runtime separately.
    Provided(aws_sdk_s3::Client),
}

impl S3WalkServiceClient {
    fn sdk_client(&self) -> &aws_sdk_s3::Client {
        match self {
            Self::TransferManager(client) => &client.handle.s3_client,
            Self::Provided(client) => client,
        }
    }
}

/// Result of listing a single page of S3 objects.
///
/// Contains the objects in the page (after filter application), any common
/// prefixes when a delimiter is set, and a continuation token for the next
/// page.
pub(crate) struct ListPageResult {
    /// Objects returned in this page, after filter application.
    pub(crate) objects: Vec<Object>,
    /// Common prefixes from the response (populated when a delimiter is set).
    pub(crate) common_prefixes: Vec<String>,
    /// Continuation token for the next page, or `None` if this is the last.
    pub(crate) next_token: Option<String>,
}

/// Configuration for walking an S3 bucket by listing objects under a prefix.
///
/// Describes what to list and how (prefix, delimiter, filter, pagination).
/// The transfer manager client and bucket name are supplied separately via
/// [`S3WalkContext`] when starting a walk.
///
/// Use [`S3Walker::builder`] to construct an instance.
///
/// # Traversal model
///
/// The walker issues `ListObjectsV2` requests under a configured prefix.
/// Each response contributes objects and (when a delimiter is set) common
/// prefixes representing subdirectories. The walker paginates through the
/// full object set of each prefix before recursing into common prefixes.
///
/// # Error handling
///
/// Service errors from `ListObjectsV2` terminate the walk. There are no
/// non-fatal errors; either the page succeeds or the entire walk fails.
// TODO(walker): bucket-kind refuse/warn policy — we detect directory buckets
//   but don't yet have a configurable refuse policy for sync operations.
// TODO(walker): resume token persistence — save/restore continuation state
//   across process restarts.
#[derive(Clone)]
pub struct S3Walker {
    prefix: Option<String>,
    delimiter: Option<String>,
    expected_bucket_owner: Option<String>,
    request_payer: Option<crate::model::RequestPayer>,
    filter: Option<FilterFn>,
    start_after: Option<String>,
    continuation_token: Option<String>,
    page_size: Option<i32>,
}

impl std::fmt::Debug for S3Walker {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("S3Walker")
            .field("prefix", &self.prefix)
            .field("delimiter", &self.delimiter)
            .field("expected_bucket_owner", &self.expected_bucket_owner)
            .field("request_payer", &self.request_payer)
            .field("start_after", &self.start_after)
            .field("continuation_token", &self.continuation_token)
            .field("page_size", &self.page_size)
            .finish()
    }
}

impl Default for S3Walker {
    /// A default walker that filters out 0-byte folder markers (keys ending in '/').
    fn default() -> Self {
        S3Walker::builder().build()
    }
}

/// Exclude 0-byte objects whose key ends with `/`. These are "folder markers"
/// created by the S3 console and have no meaningful content to download.
fn exclude_s3_folder_markers(obj: &Object) -> bool {
    let dominated_by_slash = obj.key().unwrap_or("").ends_with('/');
    let is_zero_byte = obj.size().unwrap_or(1) == 0;
    !(dominated_by_slash && is_zero_byte)
}

impl S3Walker {
    /// Create a builder for configuring an `S3Walker`.
    #[must_use]
    pub fn builder() -> S3WalkerBuilder {
        S3WalkerBuilder::default()
    }

    /// Start a walk with the given execution context.
    ///
    /// Returns an [`S3Walk`] that yields objects via [`next`](S3Walk::next).
    /// Directory buckets (S3 Express) are detected and logged as a warning
    /// since they may not return lexicographically sorted listing results.
    #[must_use]
    pub fn walk(self, ctx: S3WalkContext) -> S3Walk {
        if ctx.bucket.kind() == BucketType::Express {
            tracing::warn!(
                target: crate::telemetry::TARGET_TRANSFER,
                bucket = %ctx.bucket.name(),
                kind = ?ctx.bucket.kind(),
                "directory bucket detected; listing results may not be lexicographically sorted"
            );
        }

        let initial_prefix = self.prefix.clone().unwrap_or_default();

        tracing::debug!(
            target: crate::telemetry::TARGET_TRANSFER,
            bucket = %ctx.bucket.name(),
            kind = ?ctx.bucket.kind(),
            prefix = %initial_prefix,
            delimiter = ?self.delimiter,
            "s3 walk started",
        );
        let mut pending_prefixes = VecDeque::new();
        pending_prefixes.push_back(initial_prefix);

        S3Walk {
            config: self,
            client: ctx.client,
            bucket: ctx.bucket,
            pending_prefixes,
            ready_objects: VecDeque::new(),
            current_prefix: None,
            next_token: None,
            done: false,
            initial_first_page_pending: true,
        }
    }
}

/// Builder for [`S3Walker`].
///
/// All fields are optional with sensible defaults: no prefix, no delimiter,
/// no filter, no pagination overrides. Every walker skips 0-byte folder
/// markers (keys ending in `/`), whether or not a filter is set.
#[derive(Default)]
pub struct S3WalkerBuilder {
    prefix: Option<String>,
    delimiter: Option<String>,
    expected_bucket_owner: Option<String>,
    request_payer: Option<crate::model::RequestPayer>,
    filter: Option<FilterFn>,
    start_after: Option<String>,
    continuation_token: Option<String>,
    page_size: Option<i32>,
}

impl std::fmt::Debug for S3WalkerBuilder {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("S3WalkerBuilder")
            .field("prefix", &self.prefix)
            .field("delimiter", &self.delimiter)
            .finish()
    }
}

impl S3WalkerBuilder {
    /// Restrict listing to keys beginning with the given prefix.
    ///
    /// The prefix only selects objects; the walk yields each selected object
    /// with its full key. It is matched against keys as a string, so `photos`
    /// selects both `photos/a.txt` and `photos-old/b.txt`.
    ///
    /// When unset, the walker lists all objects in the bucket.
    #[must_use]
    pub fn prefix(mut self, prefix: impl Into<String>) -> Self {
        self.prefix = Some(prefix.into());
        self
    }

    /// Group keys by a delimiter, enabling recursive traversal.
    ///
    /// Typically set to `/` to traverse S3 as if it were a directory tree.
    /// When unset (default), all objects are returned in a flat list.
    #[must_use]
    pub fn delimiter(mut self, delimiter: impl Into<String>) -> Self {
        self.delimiter = Some(delimiter.into());
        self
    }

    /// Set the expected bucket owner account ID.
    ///
    /// When set, `ListObjectsV2` requests fail with `AccessDenied` if the
    /// bucket's actual owner doesn't match.
    #[must_use]
    pub fn expected_bucket_owner(mut self, owner: impl Into<String>) -> Self {
        self.expected_bucket_owner = Some(owner.into());
        self
    }

    /// Set the request-payer preference for Requester-Pays buckets.
    #[must_use]
    pub fn request_payer(mut self, payer: crate::model::RequestPayer) -> Self {
        self.request_payer = Some(payer);
        self
    }

    /// Set a filter predicate applied to each discovered object.
    ///
    /// The predicate receives an [`Object`] containing the metadata returned
    /// by `ListObjectsV2`. Returning `false` drops the object silently.
    ///
    /// The filter applies only to objects; with a delimiter set, the walker
    /// still lists every common prefix.
    ///
    /// Each call replaces any previously set filter. 0-byte folder markers
    /// (keys ending in `/`) are skipped before the filter runs.
    #[must_use]
    pub fn filter(mut self, f: impl Fn(&Object) -> bool + Send + Sync + 'static) -> Self {
        self.filter = Some(Arc::new(f));
        self
    }

    /// Resume listing after the given key.
    ///
    /// Maps to the `StartAfter` parameter of `ListObjectsV2`. Only applied
    /// to the initial prefix listing (not to recursed common prefixes).
    #[must_use]
    pub fn start_after(mut self, key: impl Into<String>) -> Self {
        self.start_after = Some(key.into());
        self
    }

    /// Resume listing from a specific continuation token.
    ///
    /// Maps to the `ContinuationToken` parameter of `ListObjectsV2`. Only
    /// applied to the first request of the initial prefix.
    #[must_use]
    pub fn continuation_token(mut self, token: impl Into<String>) -> Self {
        self.continuation_token = Some(token.into());
        self
    }

    /// Override the server default page size (max keys per response).
    ///
    /// Maps to the `MaxKeys` parameter of `ListObjectsV2`. Useful for
    /// tuning small-object workloads. Default is the server default (1000).
    #[must_use]
    pub fn page_size(mut self, n: i32) -> Self {
        self.page_size = Some(n);
        self
    }

    /// Build the [`S3Walker`] configuration.
    #[must_use]
    pub fn build(self) -> S3Walker {
        S3Walker {
            prefix: self.prefix,
            delimiter: self.delimiter,
            expected_bucket_owner: self.expected_bucket_owner,
            request_payer: self.request_payer,
            filter: self.filter,
            start_after: self.start_after,
            continuation_token: self.continuation_token,
            page_size: self.page_size,
        }
    }
}

/// The transfer manager client and bucket for an S3 walk.
pub struct S3WalkContext {
    client: S3WalkServiceClient,
    bucket: crate::types::Bucket,
}

impl std::fmt::Debug for S3WalkContext {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("S3WalkContext")
            .field("bucket", &self.bucket)
            .finish()
    }
}

impl S3WalkContext {
    /// Create a builder for an `S3WalkContext`.
    #[must_use]
    pub fn builder() -> S3WalkContextBuilder {
        S3WalkContextBuilder {
            client: None,
            bucket: None,
        }
    }
}

/// Builder for [`S3WalkContext`].
#[derive(Debug, Default)]
pub struct S3WalkContextBuilder {
    client: Option<S3WalkServiceClient>,
    bucket: Option<String>,
}

impl S3WalkContextBuilder {
    /// Set the transfer manager client to use for listing.
    ///
    /// This field is required. The context and resulting walk retain a clone
    /// of the client, keeping its runtime alive until the walk is dropped.
    #[must_use]
    pub fn client(mut self, client: &crate::Client) -> Self {
        self.client = Some(S3WalkServiceClient::TransferManager(client.clone()));
        self
    }

    /// Set an AWS SDK for Rust S3 v1 client to use for listing.
    ///
    /// Unlike [`client`](Self::client), this does not retain a transfer manager
    /// runtime. The caller must keep any custom HTTP transport's runtime alive.
    #[cfg(feature = "sdk-v1")]
    #[must_use]
    pub fn sdk_v1_client(self, client: aws_sdk_s3::Client) -> Self {
        self.sdk_client(client)
    }

    // Directory transfers already belong to a transfer manager handle. Retaining that handle
    // here would form a cycle through the scheduler and transfer.
    pub(crate) fn sdk_client(mut self, client: aws_sdk_s3::Client) -> Self {
        self.client = Some(S3WalkServiceClient::Provided(client));
        self
    }

    /// Set the bucket to list.
    ///
    /// This field is required.
    #[must_use]
    pub fn bucket(mut self, bucket: impl Into<String>) -> Self {
        self.bucket = Some(bucket.into());
        self
    }

    /// Build the [`S3WalkContext`].
    ///
    /// # Panics
    ///
    /// Panics if `client` or `bucket` has not been set.
    #[must_use]
    pub fn build(self) -> S3WalkContext {
        let bucket_name = self.bucket.expect("required field `bucket` should be set");
        S3WalkContext {
            client: self.client.expect("required field `client` should be set"),
            bucket: crate::types::Bucket::new(bucket_name),
        }
    }
}

/// A running S3 walk, yielding objects from a bucket listing.
///
/// Created by [`S3Walker::walk`]. The walk pages through the bucket,
/// buffering [`Object`] values and yielding them via
/// [`next`](Self::next).
pub struct S3Walk {
    config: S3Walker,
    client: S3WalkServiceClient,
    bucket: crate::types::Bucket,
    pending_prefixes: VecDeque<String>,
    ready_objects: VecDeque<Object>,
    current_prefix: Option<String>,
    next_token: Option<String>,
    done: bool,
    /// Whether the next `list_page` call is the first request of the initial
    /// prefix. Used to gate `continuation_token` and `start_after` config
    /// (which only apply to the very first request).
    initial_first_page_pending: bool,
}

impl std::fmt::Debug for S3Walk {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("S3Walk")
            .field("bucket", &self.bucket)
            .field("done", &self.done)
            .finish()
    }
}

impl S3Walk {
    /// Return the next [`Object`] from the walk.
    ///
    /// Returns:
    /// - `Some(Ok(object))` for an object that passed the filter.
    /// - `Some(Err(err))` when a `ListObjectsV2` request fails. The walk
    ///   terminates after an error; subsequent calls return `None`.
    /// - `None` when the walk is complete.
    pub async fn next(&mut self) -> Option<Result<Object, WalkError>> {
        loop {
            if let Some(obj) = self.ready_objects.pop_front() {
                return Some(Ok(obj));
            }
            if self.done {
                return None;
            }

            if let Some(prefix) = &self.current_prefix {
                let prefix = prefix.clone();
                let token = self.next_token.take();
                let first_page = self.initial_first_page_pending;
                match self.list_page(&prefix, token.as_deref(), first_page).await {
                    Ok(page) => {
                        self.initial_first_page_pending = false;

                        tracing::trace!(
                            target: crate::telemetry::TARGET_TRANSFER,
                            %prefix,
                            objects = page.objects.len(),
                            common_prefixes = page.common_prefixes.len(),
                            has_next = page.next_token.is_some(),
                            "page listed",
                        );

                        self.ready_objects.extend(page.objects);
                        for cp in page.common_prefixes {
                            self.pending_prefixes.push_back(cp);
                        }
                        if page.next_token.is_some() {
                            self.next_token = page.next_token;
                            self.current_prefix = Some(prefix);
                        } else {
                            self.current_prefix = None;
                        }
                    }
                    Err(e) => {
                        self.done = true;
                        return Some(Err(e));
                    }
                }
                continue;
            }

            match self.pending_prefixes.pop_front() {
                Some(prefix) => {
                    self.current_prefix = Some(prefix);
                }
                None => {
                    self.done = true;
                    return None;
                }
            }
        }
    }

    /// Whether the walk has finished (no more objects will be produced).
    pub fn is_done(&self) -> bool {
        self.done
    }

    /// Whether the target bucket is a directory bucket (S3 Express).
    ///
    /// Directory buckets may not return lexicographically sorted listing
    /// results, which can affect sync operations that depend on key ordering.
    pub fn is_directory_bucket(&self) -> bool {
        self.bucket.kind() == BucketType::Express
    }

    async fn list_page(
        &self,
        prefix: &str,
        token: Option<&str>,
        first_page_of_initial_prefix: bool,
    ) -> Result<ListPageResult, WalkError> {
        let mut req = self
            .client
            .sdk_client()
            .list_objects_v2()
            .bucket(self.bucket.name())
            .prefix(prefix);

        // Runtime pagination token for this page. When a caller-supplied
        // continuation_token is configured AND this is the first request
        // of the initial prefix, the configured token takes precedence
        // (resume use case). Otherwise, use the pagination token from the
        // previous page response.
        let effective_token = if first_page_of_initial_prefix {
            self.config.continuation_token.as_deref().or(token)
        } else {
            token
        };
        if let Some(t) = effective_token {
            req = req.continuation_token(t);
        }

        // start_after is only meaningful on the very first request of the
        // initial prefix and is ignored by S3 whenever a continuation token
        // is present.
        if first_page_of_initial_prefix {
            if let Some(start_after) = &self.config.start_after {
                if effective_token.is_none() {
                    req = req.start_after(start_after);
                }
            }
        }

        if let Some(delimiter) = &self.config.delimiter {
            req = req.delimiter(delimiter);
        }
        if let Some(owner) = &self.config.expected_bucket_owner {
            req = req.expected_bucket_owner(owner);
        }
        if let Some(payer) = &self.config.request_payer {
            req = req.request_payer(crate::sdk_v1::request_payer_to_sdk(payer));
        }
        if let Some(page_size) = self.config.page_size {
            req = req.max_keys(page_size);
        }

        let output = req
            .send()
            .await
            .map_err(|e| WalkError::new(None, WalkErrorKind::Service, Box::new(e)))?;

        let mut objects: Vec<Object> = output
            .contents
            .unwrap_or_default()
            .into_iter()
            .map(|object| crate::sdk_v1::object_from_sdk(&object))
            .collect();
        // Folder markers are always skipped; the caller's filter only sees
        // the objects that remain.
        objects.retain(|obj| {
            exclude_s3_folder_markers(obj) && self.config.filter.as_ref().is_none_or(|f| f(obj))
        });

        let common_prefixes = output
            .common_prefixes
            .unwrap_or_default()
            .into_iter()
            .filter_map(|cp| cp.prefix)
            .collect();

        Ok(ListPageResult {
            objects,
            common_prefixes,
            next_token: output.next_continuation_token,
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use aws_sdk_s3::operation::list_objects_v2::ListObjectsV2Output;
    use aws_sdk_s3::types::{CommonPrefix, Object};
    use aws_smithy_mocks::{mock, mock_client, RuleMode};

    fn walker() -> S3WalkerBuilder {
        S3Walker::builder()
    }

    fn s3ctx(client: aws_sdk_s3::Client, bucket: impl Into<String>) -> S3WalkContext {
        let builder = S3WalkContext::builder();
        #[cfg(feature = "sdk-v1")]
        let builder = builder.sdk_v1_client(client);
        #[cfg(not(feature = "sdk-v1"))]
        let builder = builder.sdk_client(client);
        builder.bucket(bucket).build()
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn standalone_walk_retains_transfer_manager_until_dropped() {
        let list = mock!(aws_sdk_s3::Client::list_objects_v2).then_output(|| {
            ListObjectsV2Output::builder()
                .contents(Object::builder().key("object").build())
                .build()
        });
        let sdk = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&list]);
        let tm = crate::Client::new(
            crate::Config::builder()
                .sdk_client(sdk)
                .build()
                .expect("valid config"),
        );
        let handle = Arc::downgrade(&tm.handle);
        let context = S3WalkContext::builder()
            .client(&tm)
            .bucket("bucket")
            .build();
        drop(tm);
        assert!(handle.upgrade().is_some());

        let mut walk = S3Walker::default().walk(context);
        assert_eq!(walk.next().await.unwrap().unwrap().key(), Some("object"));
        assert!(walk.next().await.is_none());
        assert!(handle.upgrade().is_some());
        drop(walk);
        assert!(handle.upgrade().is_none());
        assert_eq!(list.num_calls(), 1);
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn shared_config_loopback_endpoint_uses_path_style_without_sdk_settings() {
        use aws_sdk_s3::config::{Credentials, SharedCredentialsProvider};
        use aws_smithy_http_client::test_util::capture_request;

        let (http_client, captured) = capture_request(None);
        let shared = aws_types::SdkConfig::builder()
            .behavior_version(aws_config::BehaviorVersion::latest())
            .region(aws_config::Region::new("us-east-1"))
            .credentials_provider(SharedCredentialsProvider::new(Credentials::for_tests()))
            .endpoint_url("http://127.0.0.1:12345")
            .http_client(http_client)
            .build();
        let tm = crate::Client::new(
            crate::Config::builder()
                .s3_config(crate::config::S3ClientConfig::new(&shared))
                .build()
                .expect("valid config"),
        );
        let context = S3WalkContext::builder()
            .client(&tm)
            .bucket("bucket")
            .build();
        let mut walk = S3Walker::default().walk(context);
        // The capture client returns an error response; only addressing is under test.
        assert!(walk.next().await.unwrap().is_err());
        let request = captured.expect_request();
        assert_eq!(
            request.uri().to_string(),
            "http://127.0.0.1:12345/bucket/?list-type=2&prefix="
        );
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_list_single_page() {
        let rule = mock!(aws_sdk_s3::Client::list_objects_v2).then_output(|| {
            ListObjectsV2Output::builder()
                .set_contents(Some(vec![
                    Object::builder().key("a.txt").build(),
                    Object::builder().key("b.txt").build(),
                    Object::builder().key("c.txt").build(),
                ]))
                .build()
        });
        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&rule]);

        let mut walk = walker()
            .prefix("prefix/")
            .build()
            .walk(s3ctx(client, "test-bucket"));

        let mut keys = Vec::new();
        while let Some(result) = walk.next().await {
            keys.push(result.unwrap().key.unwrap());
        }
        assert_eq!(keys, vec!["a.txt", "b.txt", "c.txt"]);
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_list_with_pagination() {
        let page1 = mock!(aws_sdk_s3::Client::list_objects_v2).then_output(|| {
            ListObjectsV2Output::builder()
                .is_truncated(true)
                .next_continuation_token("token1")
                .set_contents(Some(vec![
                    Object::builder().key("a.txt").build(),
                    Object::builder().key("b.txt").build(),
                ]))
                .build()
        });
        let page2 = mock!(aws_sdk_s3::Client::list_objects_v2).then_output(|| {
            ListObjectsV2Output::builder()
                .set_contents(Some(vec![Object::builder().key("c.txt").build()]))
                .build()
        });
        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&page1, &page2]);

        let mut walk = walker().build().walk(s3ctx(client, "test-bucket"));

        let mut keys = Vec::new();
        while let Some(result) = walk.next().await {
            keys.push(result.unwrap().key.unwrap());
        }
        assert_eq!(keys, vec!["a.txt", "b.txt", "c.txt"]);
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_list_with_filter() {
        let rule = mock!(aws_sdk_s3::Client::list_objects_v2).then_output(|| {
            ListObjectsV2Output::builder()
                .set_contents(Some(vec![
                    Object::builder().key("file.txt").build(),
                    Object::builder().key("folder/").build(),
                    Object::builder().key("other.txt").build(),
                ]))
                .build()
        });
        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&rule]);

        let mut walk = walker()
            .filter(|obj: &crate::model::Object| !obj.key().unwrap_or("").ends_with('/'))
            .build()
            .walk(s3ctx(client, "test-bucket"));

        let mut keys = Vec::new();
        while let Some(result) = walk.next().await {
            let object: crate::model::Object = result.unwrap();
            keys.push(object.key.unwrap());
        }
        assert_eq!(keys, vec!["file.txt", "other.txt"]);
    }

    /// Helper function to test walker filter . Lists one page of a folder marker,
    /// a file and a non-empty key ending in `/`, and returns the keys the walker yields.
    async fn walk_marker_page(builder: S3WalkerBuilder) -> Vec<String> {
        let rule = mock!(aws_sdk_s3::Client::list_objects_v2).then_output(|| {
            ListObjectsV2Output::builder()
                .set_contents(Some(vec![
                    Object::builder().key("dir/").size(0).build(),
                    Object::builder().key("dir/file.txt").size(4).build(),
                    Object::builder().key("data/").size(4).build(),
                ]))
                .build()
        });
        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&rule]);

        let mut walk = builder.build().walk(s3ctx(client, "test-bucket"));
        let mut keys = Vec::new();
        while let Some(result) = walk.next().await {
            keys.push(result.unwrap().key.unwrap());
        }
        keys
    }

    /// Only 0-byte keys ending in `/` are skipped; a non-empty one is kept.
    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_folder_markers_skipped_without_filter() {
        assert_eq!(
            walk_marker_page(walker()).await,
            vec!["dir/file.txt", "data/"]
        );
    }

    /// A filter that accepts everything does not bring folder markers back,
    /// and the filter never sees them.
    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_folder_markers_skipped_with_filter() {
        let seen = Arc::new(std::sync::Mutex::new(Vec::new()));
        let recorder = seen.clone();
        let builder = walker().filter(move |obj: &crate::model::Object| {
            recorder
                .lock()
                .unwrap()
                .push(obj.key().unwrap_or_default().to_owned());
            true
        });
        assert_eq!(
            walk_marker_page(builder).await,
            vec!["dir/file.txt", "data/"]
        );
        assert_eq!(*seen.lock().unwrap(), vec!["dir/file.txt", "data/"]);
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_list_empty_prefix() {
        let rule = mock!(aws_sdk_s3::Client::list_objects_v2)
            .then_output(|| ListObjectsV2Output::builder().build());
        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&rule]);

        let mut walk = walker()
            .prefix("empty/")
            .build()
            .walk(s3ctx(client, "test-bucket"));
        assert!(walk.next().await.is_none());
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_list_with_common_prefixes() {
        let root_page = mock!(aws_sdk_s3::Client::list_objects_v2).then_output(|| {
            ListObjectsV2Output::builder()
                .set_contents(Some(vec![Object::builder().key("root.txt").build()]))
                .set_common_prefixes(Some(vec![
                    CommonPrefix::builder().prefix("sub1/").build(),
                    CommonPrefix::builder().prefix("sub2/").build(),
                ]))
                .build()
        });
        let sub1_page = mock!(aws_sdk_s3::Client::list_objects_v2).then_output(|| {
            ListObjectsV2Output::builder()
                .set_contents(Some(vec![Object::builder().key("sub1/a.txt").build()]))
                .build()
        });
        let sub2_page = mock!(aws_sdk_s3::Client::list_objects_v2).then_output(|| {
            ListObjectsV2Output::builder()
                .set_contents(Some(vec![Object::builder().key("sub2/b.txt").build()]))
                .build()
        });
        let client = mock_client!(
            aws_sdk_s3,
            RuleMode::Sequential,
            &[&root_page, &sub1_page, &sub2_page]
        );

        let mut walk = walker()
            .delimiter("/")
            .build()
            .walk(s3ctx(client, "test-bucket"));

        let mut keys = Vec::new();
        while let Some(result) = walk.next().await {
            keys.push(result.unwrap().key.unwrap());
        }
        assert_eq!(keys, vec!["root.txt", "sub1/a.txt", "sub2/b.txt"]);
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_list_service_error_terminates_walk() {
        use aws_sdk_s3::operation::list_objects_v2::ListObjectsV2Error;
        use aws_smithy_types::error::metadata::ErrorMetadata;

        let rule = mock!(aws_sdk_s3::Client::list_objects_v2).then_error(|| {
            ListObjectsV2Error::generic(ErrorMetadata::builder().code("NoSuchBucket").build())
        });
        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&rule]);

        let mut walk = walker().build().walk(s3ctx(client, "missing-bucket"));

        let first = walk.next().await;
        assert!(matches!(first, Some(Err(_))), "expected service error");
        assert!(walk.next().await.is_none());
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_list_pagination_across_common_prefix() {
        let root_page = mock!(aws_sdk_s3::Client::list_objects_v2).then_output(|| {
            ListObjectsV2Output::builder()
                .set_contents(Some(vec![Object::builder().key("root.txt").build()]))
                .set_common_prefixes(Some(vec![CommonPrefix::builder().prefix("sub/").build()]))
                .build()
        });
        let sub_page1 = mock!(aws_sdk_s3::Client::list_objects_v2).then_output(|| {
            ListObjectsV2Output::builder()
                .is_truncated(true)
                .next_continuation_token("tok")
                .set_contents(Some(vec![
                    Object::builder().key("sub/a.txt").build(),
                    Object::builder().key("sub/b.txt").build(),
                ]))
                .build()
        });
        let sub_page2 = mock!(aws_sdk_s3::Client::list_objects_v2).then_output(|| {
            ListObjectsV2Output::builder()
                .set_contents(Some(vec![Object::builder().key("sub/c.txt").build()]))
                .build()
        });
        let client = mock_client!(
            aws_sdk_s3,
            RuleMode::Sequential,
            &[&root_page, &sub_page1, &sub_page2]
        );

        let mut walk = walker()
            .delimiter("/")
            .build()
            .walk(s3ctx(client, "test-bucket"));

        let mut keys = Vec::new();
        while let Some(result) = walk.next().await {
            keys.push(result.unwrap().key.unwrap());
        }
        assert_eq!(
            keys,
            vec!["root.txt", "sub/a.txt", "sub/b.txt", "sub/c.txt"]
        );
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_list_delimiter_without_common_prefixes() {
        let rule = mock!(aws_sdk_s3::Client::list_objects_v2).then_output(|| {
            ListObjectsV2Output::builder()
                .set_contents(Some(vec![
                    Object::builder().key("a.txt").build(),
                    Object::builder().key("b.txt").build(),
                ]))
                .build()
        });
        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&rule]);

        let mut walk = walker()
            .delimiter("/")
            .build()
            .walk(s3ctx(client, "test-bucket"));

        let mut keys = Vec::new();
        while let Some(result) = walk.next().await {
            keys.push(result.unwrap().key.unwrap());
        }
        assert_eq!(keys, vec!["a.txt", "b.txt"]);
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_list_no_delimiter_no_recursion() {
        let rule = mock!(aws_sdk_s3::Client::list_objects_v2).then_output(|| {
            ListObjectsV2Output::builder()
                .set_contents(Some(vec![
                    Object::builder().key("a.txt").build(),
                    Object::builder().key("sub/b.txt").build(),
                    Object::builder().key("sub/c.txt").build(),
                ]))
                .build()
        });
        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&rule]);

        let mut walk = walker().build().walk(s3ctx(client, "test-bucket"));

        let mut keys = Vec::new();
        while let Some(result) = walk.next().await {
            keys.push(result.unwrap().key.unwrap());
        }
        assert_eq!(keys, vec!["a.txt", "sub/b.txt", "sub/c.txt"]);
    }

    // --- NEW TESTS ---

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_s3walker_start_after() {
        // start_after should propagate to ListObjectsV2; the mock returns
        // only objects "after" the start key.
        let rule = mock!(aws_sdk_s3::Client::list_objects_v2).then_output(|| {
            ListObjectsV2Output::builder()
                .set_contents(Some(vec![
                    Object::builder().key("c.txt").build(),
                    Object::builder().key("d.txt").build(),
                ]))
                .build()
        });
        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&rule]);

        let mut walk = walker()
            .start_after("b.txt")
            .build()
            .walk(s3ctx(client, "test-bucket"));

        let mut keys = Vec::new();
        while let Some(result) = walk.next().await {
            keys.push(result.unwrap().key.unwrap());
        }
        assert_eq!(keys, vec!["c.txt", "d.txt"]);
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_s3walker_page_size() {
        // page_size propagates as max_keys; mock returns a single-item page
        let rule = mock!(aws_sdk_s3::Client::list_objects_v2)
            .match_requests(|req| req.max_keys() == Some(1))
            .then_output(|| {
                ListObjectsV2Output::builder()
                    .set_contents(Some(vec![Object::builder().key("only.txt").build()]))
                    .build()
            });
        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&rule]);

        let mut walk = walker()
            .page_size(1)
            .build()
            .walk(s3ctx(client, "test-bucket"));

        let mut keys = Vec::new();
        while let Some(result) = walk.next().await {
            keys.push(result.unwrap().key.unwrap());
        }
        assert_eq!(keys, vec!["only.txt"]);
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_s3walker_expected_bucket_owner() {
        // expected_bucket_owner propagates; mock just returns success
        let rule = mock!(aws_sdk_s3::Client::list_objects_v2).then_output(|| {
            ListObjectsV2Output::builder()
                .set_contents(Some(vec![Object::builder().key("a.txt").build()]))
                .build()
        });
        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&rule]);

        let mut walk = walker()
            .expected_bucket_owner("123456789012")
            .build()
            .walk(s3ctx(client, "test-bucket"));

        let mut keys = Vec::new();
        while let Some(result) = walk.next().await {
            keys.push(result.unwrap().key.unwrap());
        }
        assert_eq!(keys, vec!["a.txt"]);
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_s3walker_is_directory_bucket() {
        let rule = mock!(aws_sdk_s3::Client::list_objects_v2)
            .then_output(|| ListObjectsV2Output::builder().build());
        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&rule, &rule]);

        // Express bucket name ends with --x-s3
        let walk_express = walker()
            .build()
            .walk(s3ctx(client.clone(), "my-bucket--usw2-az1--x-s3"));
        assert!(walk_express.is_directory_bucket());

        // Standard bucket
        let walk_standard = walker().build().walk(s3ctx(client, "my-normal-bucket"));
        assert!(!walk_standard.is_directory_bucket());
    }

    /// Regression test: configured `continuation_token` must only apply to
    /// the first request. On pagination, subsequent requests must use the
    /// server's continuation token, not the original one (which would cause
    /// an infinite loop).
    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_s3walker_continuation_token_only_on_first_page() {
        // First call: expect the configured token "resume-here"; return a page
        // with server continuation token "server-next".
        let first = mock!(aws_sdk_s3::Client::list_objects_v2)
            .match_requests(|req| req.continuation_token() == Some("resume-here"))
            .then_output(|| {
                ListObjectsV2Output::builder()
                    .is_truncated(true)
                    .next_continuation_token("server-next")
                    .set_contents(Some(vec![Object::builder().key("a.txt").build()]))
                    .build()
            });
        // Second call: must use "server-next", NOT "resume-here".
        let second = mock!(aws_sdk_s3::Client::list_objects_v2)
            .match_requests(|req| req.continuation_token() == Some("server-next"))
            .then_output(|| {
                ListObjectsV2Output::builder()
                    .set_contents(Some(vec![Object::builder().key("b.txt").build()]))
                    .build()
            });
        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&first, &second]);

        let mut walk = walker()
            .continuation_token("resume-here")
            .build()
            .walk(s3ctx(client, "test-bucket"));

        let mut keys = Vec::new();
        while let Some(result) = walk.next().await {
            keys.push(result.unwrap().key.unwrap());
        }
        assert_eq!(keys, vec!["a.txt", "b.txt"]);
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_s3walker_prefix_propagates() {
        let rule = mock!(aws_sdk_s3::Client::list_objects_v2)
            .match_requests(|req| req.prefix() == Some("my-prefix/"))
            .then_output(|| {
                ListObjectsV2Output::builder()
                    .set_contents(Some(vec![Object::builder().key("my-prefix/a.txt").build()]))
                    .build()
            });
        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&rule]);

        let mut walk = walker()
            .prefix("my-prefix/")
            .build()
            .walk(s3ctx(client, "test-bucket"));

        let mut keys = Vec::new();
        while let Some(result) = walk.next().await {
            keys.push(result.unwrap().key.unwrap());
        }
        assert_eq!(keys, vec!["my-prefix/a.txt"]);
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_s3walker_request_payer_propagates() {
        let rule = mock!(aws_sdk_s3::Client::list_objects_v2)
            .match_requests(|req| {
                req.request_payer() == Some(&aws_sdk_s3::types::RequestPayer::Requester)
            })
            .then_output(|| {
                ListObjectsV2Output::builder()
                    .set_contents(Some(vec![Object::builder().key("a.txt").build()]))
                    .build()
            });
        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&rule]);

        let mut walk = walker()
            .request_payer(crate::model::RequestPayer::Requester)
            .build()
            .walk(s3ctx(client, "test-bucket"));

        let mut keys = Vec::new();
        while let Some(result) = walk.next().await {
            keys.push(result.unwrap().key.unwrap());
        }
        assert_eq!(keys, vec!["a.txt"]);
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_s3walker_delimiter_propagates_on_recursed_prefixes() {
        let root = mock!(aws_sdk_s3::Client::list_objects_v2)
            .match_requests(|req| req.delimiter() == Some("/") && req.prefix() == Some(""))
            .then_output(|| {
                ListObjectsV2Output::builder()
                    .set_common_prefixes(Some(vec![CommonPrefix::builder().prefix("a/").build()]))
                    .build()
            });
        let a_page = mock!(aws_sdk_s3::Client::list_objects_v2)
            .match_requests(|req| req.delimiter() == Some("/") && req.prefix() == Some("a/"))
            .then_output(|| {
                ListObjectsV2Output::builder()
                    .set_contents(Some(vec![Object::builder().key("a/file.txt").build()]))
                    .set_common_prefixes(Some(vec![CommonPrefix::builder().prefix("a/b/").build()]))
                    .build()
            });
        let ab_page = mock!(aws_sdk_s3::Client::list_objects_v2)
            .match_requests(|req| req.delimiter() == Some("/") && req.prefix() == Some("a/b/"))
            .then_output(|| {
                ListObjectsV2Output::builder()
                    .set_contents(Some(vec![Object::builder().key("a/b/file.txt").build()]))
                    .set_common_prefixes(Some(vec![CommonPrefix::builder()
                        .prefix("a/b/c/")
                        .build()]))
                    .build()
            });
        let abc_page = mock!(aws_sdk_s3::Client::list_objects_v2)
            .match_requests(|req| req.delimiter() == Some("/") && req.prefix() == Some("a/b/c/"))
            .then_output(|| {
                ListObjectsV2Output::builder()
                    .set_contents(Some(vec![Object::builder().key("a/b/c/file.txt").build()]))
                    .build()
            });
        let client = mock_client!(
            aws_sdk_s3,
            RuleMode::Sequential,
            &[&root, &a_page, &ab_page, &abc_page]
        );

        let mut walk = walker()
            .delimiter("/")
            .build()
            .walk(s3ctx(client, "test-bucket"));

        let mut keys = Vec::new();
        while let Some(result) = walk.next().await {
            keys.push(result.unwrap().key.unwrap());
        }
        assert_eq!(keys, vec!["a/file.txt", "a/b/file.txt", "a/b/c/file.txt"]);
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_s3walker_empty_contents_none() {
        let rule = mock!(aws_sdk_s3::Client::list_objects_v2).then_output(|| {
            ListObjectsV2Output::builder()
                // contents is None, not Some(vec![])
                .build()
        });
        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&rule]);

        let mut walk = walker().build().walk(s3ctx(client, "test-bucket"));

        let mut count = 0;
        while let Some(result) = walk.next().await {
            result.unwrap();
            count += 1;
        }
        assert_eq!(count, 0, "None contents should yield zero objects");
    }

    #[test]
    fn test_s3walker_is_send_sync() {
        fn assert_send_sync<T: Send + Sync>() {}
        assert_send_sync::<S3Walker>();
        assert_send_sync::<S3Walk>();
        assert_send_sync::<S3WalkContext>();
        assert_send_sync::<S3WalkerBuilder>();
        assert_send_sync::<S3WalkContextBuilder>();
    }
}