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
/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

use super::UploadInput;
use crate::model::{ChecksumAlgorithm, ChecksumType};
use aws_sdk_s3::operation::{
    complete_multipart_upload::builders::CompleteMultipartUploadFluentBuilder,
    create_multipart_upload::builders::CreateMultipartUploadFluentBuilder,
    put_object::builders::PutObjectFluentBuilder, upload_part::builders::UploadPartFluentBuilder,
};

/// Assemble ordinary modeled fields and the upload checksum policy.
pub(crate) fn copy_fields_to_put_object_request(
    upload_input: &UploadInput,
    put_object_builder: PutObjectFluentBuilder,
) -> PutObjectFluentBuilder {
    let mut put_object_builder =
        crate::sdk_v1::copy_upload_input_fields_to_put_object(upload_input, put_object_builder);

    if let Some(checksum_strategy) = &upload_input.checksum_strategy {
        if let Some(value) = checksum_strategy.expected_value() {
            // A single-request upload's checksum is a full object checksum for either type, so an
            // expected value is sent in its algorithm's header.
            put_object_builder = match checksum_strategy.algorithm() {
                ChecksumAlgorithm::Crc32 => put_object_builder.checksum_crc32(value),
                ChecksumAlgorithm::Crc32C => put_object_builder.checksum_crc32_c(value),
                ChecksumAlgorithm::Crc64Nvme => put_object_builder.checksum_crc64_nvme(value),
                ChecksumAlgorithm::Sha1 => put_object_builder.checksum_sha1(value),
                ChecksumAlgorithm::Sha256 => put_object_builder.checksum_sha256(value),
                algo => unreachable!("unexpected algorithm `{algo}` for an expected value"),
            }
        } else {
            // Set checksum algorithm, which tells SDK to calculate and add checksum value
            put_object_builder = put_object_builder.checksum_algorithm(
                crate::sdk_v1::checksum_algorithm_to_sdk(checksum_strategy.algorithm()),
            )
        }
    }

    put_object_builder
}

// Copy fields from `UploadInput` to `CreateMultipartUploadFluentBuilder`
pub(crate) fn copy_fields_to_mpu_request(
    upload_input: &UploadInput,
    mpu_builder: CreateMultipartUploadFluentBuilder,
) -> CreateMultipartUploadFluentBuilder {
    let mut mpu_builder = crate::sdk_v1::copy_upload_input_fields_to_create_multipart_upload(
        upload_input,
        mpu_builder,
    );

    if let Some(checksum_strategy) = &upload_input.checksum_strategy {
        mpu_builder = mpu_builder
            .checksum_algorithm(crate::sdk_v1::checksum_algorithm_to_sdk(
                checksum_strategy.algorithm(),
            ))
            .checksum_type(crate::sdk_v1::checksum_type_to_sdk(
                checksum_strategy.multipart_checksum_type(),
            ));
    }

    mpu_builder
}

// Copy fields from UploadInput to `UploadPartFluentBuilder`
//
// Takes an optional checksum value passed by user via `PartStream`. A checksum value
// requires a checksum strategy to name its algorithm, so `checksum_value` must be
// `None` when `upload_input` has none. `validate_part_checksum_has_strategy` rejects
// that combination before a part is sent.
pub(crate) fn copy_fields_to_upload_part_request(
    upload_input: &UploadInput,
    upload_part_builder: UploadPartFluentBuilder,
    checksum_value: Option<&String>,
) -> UploadPartFluentBuilder {
    let mut upload_part_builder =
        crate::sdk_v1::copy_upload_input_fields_to_upload_part(upload_input, upload_part_builder);

    if let Some(checksum_strategy) = &upload_input.checksum_strategy {
        // If user passed checksum value via PartStream, add it to request
        if let Some(checksum_value) = checksum_value {
            upload_part_builder = match checksum_strategy.algorithm() {
                ChecksumAlgorithm::Crc32 => upload_part_builder.checksum_crc32(checksum_value),
                ChecksumAlgorithm::Crc32C => upload_part_builder.checksum_crc32_c(checksum_value),
                ChecksumAlgorithm::Crc64Nvme => {
                    upload_part_builder.checksum_crc64_nvme(checksum_value)
                }
                ChecksumAlgorithm::Sha1 => upload_part_builder.checksum_sha1(checksum_value),
                ChecksumAlgorithm::Sha256 => upload_part_builder.checksum_sha256(checksum_value),
                algo => unreachable!("unexpected checksum algorithm `{algo}`"),
            };
        } else {
            // Otherwise, set checksum algorithm, which tells SDK to calculate and add checksum value
            upload_part_builder = upload_part_builder.checksum_algorithm(
                crate::sdk_v1::checksum_algorithm_to_sdk(checksum_strategy.algorithm()),
            );
        }
    } else {
        debug_assert!(
            checksum_value.is_none(),
            "a part checksum without a ChecksumStrategy is rejected before the part is sent"
        );
    }

    upload_part_builder
}

// Copy fields from UploadInput to `CompleteMultipartUploadFluentBuilder`
//
// Takes a closure that produces the full object checksum via `PartStream` as a fallback,
// which makes this function asynchronous.
pub(crate) async fn copy_fields_to_complete_mpu_request<F, Fut>(
    upload_input: &UploadInput,
    complete_mpu_builder: CompleteMultipartUploadFluentBuilder,
    part_stream_full_object_checksum: F,
) -> CompleteMultipartUploadFluentBuilder
where
    F: Fn() -> Fut,
    Fut: std::future::Future<Output = Option<String>>,
{
    let mut complete_mpu_builder =
        crate::sdk_v1::copy_upload_input_fields_to_complete_multipart_upload(
            upload_input,
            complete_mpu_builder,
        );

    if let Some(checksum_strategy) = &upload_input.checksum_strategy {
        complete_mpu_builder = complete_mpu_builder.checksum_type(
            crate::sdk_v1::checksum_type_to_sdk(checksum_strategy.multipart_checksum_type()),
        );

        // A composite upload's object checksum is derived by S3 from the part checksums, so only a
        // full object strategy sends an object-level value: the strategy's expected value, or
        // else the one the `PartStream` returns.
        if checksum_strategy.multipart_checksum_type() == &ChecksumType::FullObject {
            let full_object_checksum = match checksum_strategy.expected_value() {
                Some(checksum) => Some(checksum.into()),
                None => part_stream_full_object_checksum().await,
            };

            // if we got one, set the proper request field
            if let Some(value) = full_object_checksum {
                complete_mpu_builder = match checksum_strategy.algorithm() {
                    ChecksumAlgorithm::Crc32 => complete_mpu_builder.checksum_crc32(value),
                    ChecksumAlgorithm::Crc32C => complete_mpu_builder.checksum_crc32_c(value),
                    ChecksumAlgorithm::Crc64Nvme => complete_mpu_builder.checksum_crc64_nvme(value),
                    algo => {
                        unreachable!("unexpected algorithm `{algo}` for full object checksum")
                    }
                };
            }
        }
    }

    complete_mpu_builder
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::io::InputStream;
    use crate::model::{
        ObjectCannedAcl, ObjectLockLegalHoldStatus, ObjectLockMode, RequestPayer,
        ServerSideEncryption, StorageClass,
    };
    use crate::types::checksum::Crc32;
    use crate::types::ChecksumStrategy;
    use aws_sdk_s3::operation::put_object::PutObjectOutput;
    use aws_sdk_s3::operation::upload_part::UploadPartOutput;
    use aws_sdk_s3::{Client, Config};
    use aws_smithy_mocks::{mock, mock_client, RuleMode};
    use aws_smithy_types::DateTime;
    use std::sync::Arc;

    fn upload_request_for_tests() -> UploadInput {
        UploadInput::builder()
            .acl(ObjectCannedAcl::PublicRead)
            .body(InputStream::from_static(b"test body"))
            .bucket("test-bucket")
            .bucket_key_enabled(true)
            .cache_control("max-age=3600")
            .checksum_strategy(
                ChecksumStrategy::full_object(Crc32).with_expected_value("0xebe6c6e6"),
            )
            .content_disposition("attachment; filename=test.txt")
            .content_encoding("gzip")
            .content_language("en-US")
            .content_type("text/plain")
            .expected_bucket_owner("owner123")
            .expires(DateTime::from_secs(1234567890))
            .grant_full_control("test-full-control")
            .grant_read("test-read")
            .grant_read_acp("test-read-acp")
            .grant_write_acp("test-write-acp")
            .if_match("\"some-etag\"")
            .if_none_match("*")
            .key("test-key")
            .metadata("key", "value")
            .object_lock_legal_hold_status(ObjectLockLegalHoldStatus::On)
            .object_lock_mode(ObjectLockMode::Governance)
            .object_lock_retain_until_date(DateTime::from_secs(1234567890))
            .request_payer(RequestPayer::Requester)
            .server_side_encryption(ServerSideEncryption::Aes256)
            .sse_customer_algorithm("AES256")
            .sse_customer_key("test-key")
            .sse_customer_key_md5("test-md5")
            .sse_kms_encryption_context("test-context")
            .sse_kms_key_id("test-kms-key")
            .storage_class(StorageClass::StandardIa)
            .tagging("key1=value1")
            .website_redirect_location("https://example.com")
            .build()
            .unwrap()
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_all_fields_copied_to_put_object_request() {
        let upload_req = Arc::new(upload_request_for_tests());

        // Using a mock client to verify field value copying,
        // since `PutObjectInputBuilder` does not implement `Clone`.
        // This prevents us from doing:
        // `put_object_builder.as_input().clone().build().unwrap();`
        let put_object_mock = mock!(aws_sdk_s3::Client::put_object)
            .match_requests({
                let upload_req = upload_req.clone();
                move |put_object_req| {
                    assert_eq!(upload_req.bucket(), put_object_req.bucket());
                    assert_eq!(None, put_object_req.checksum_algorithm());
                    assert_eq!(Some("0xebe6c6e6"), put_object_req.checksum_crc32(),);
                    assert_eq!(None, put_object_req.checksum_crc32_c());
                    assert_eq!(None, put_object_req.checksum_crc64_nvme(),);
                    assert_eq!(None, put_object_req.checksum_sha1());
                    assert_eq!(None, put_object_req.checksum_sha256(),);
                    assert_eq!(
                        upload_req.expected_bucket_owner(),
                        put_object_req.expected_bucket_owner()
                    );
                    assert_eq!(upload_req.if_match(), put_object_req.if_match());
                    assert_eq!(upload_req.if_none_match(), put_object_req.if_none_match());
                    assert_eq!(upload_req.key(), put_object_req.key());
                    assert_eq!(
                        upload_req.request_payer().map(|v| v.as_str()),
                        put_object_req.request_payer().map(|v| v.as_str())
                    );
                    assert_eq!(
                        upload_req.sse_customer_algorithm(),
                        put_object_req.sse_customer_algorithm()
                    );
                    assert_eq!(
                        upload_req.sse_customer_key(),
                        put_object_req.sse_customer_key()
                    );
                    assert_eq!(
                        upload_req.sse_customer_key_md5(),
                        put_object_req.sse_customer_key_md5()
                    );
                    true
                }
            })
            .then_output(|| PutObjectOutput::builder().build());

        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&put_object_mock]);

        let put_object_builder = client
            .put_object()
            .body(aws_sdk_s3::primitives::ByteStream::from(
                bytes::Bytes::from("test"),
            ))
            .content_length(4);

        let put_object_builder =
            copy_fields_to_put_object_request(upload_req.as_ref(), put_object_builder);

        let _ = put_object_builder.send().await.unwrap();
    }

    #[test]
    fn test_all_fields_copied_to_mpu_request() {
        let upload_req = upload_request_for_tests();

        let client = aws_smithy_mocks::mock_client!(aws_sdk_s3, []);
        let mpu_builder = copy_fields_to_mpu_request(&upload_req, client.create_multipart_upload());
        let mpu_req = mpu_builder.as_input().clone().build().unwrap();

        assert_eq!(
            upload_req.acl().map(|v| v.as_str()),
            mpu_req.acl().map(|v| v.as_str())
        );
        assert_eq!(upload_req.bucket(), mpu_req.bucket());
        assert_eq!(
            upload_req.bucket_key_enabled(),
            mpu_req.bucket_key_enabled()
        );
        assert_eq!(upload_req.cache_control(), mpu_req.cache_control());
        assert_eq!(
            upload_req
                .checksum_strategy()
                .map(|c| c.algorithm().as_str()),
            mpu_req.checksum_algorithm().map(|v| v.as_str())
        );
        assert_eq!(
            upload_req.content_disposition(),
            mpu_req.content_disposition()
        );
        assert_eq!(upload_req.content_encoding(), mpu_req.content_encoding());
        assert_eq!(upload_req.content_language(), mpu_req.content_language());
        assert_eq!(upload_req.content_type(), mpu_req.content_type());
        assert_eq!(
            upload_req.expected_bucket_owner(),
            mpu_req.expected_bucket_owner()
        );
        assert_eq!(upload_req.expires(), mpu_req.expires());
        assert_eq!(
            upload_req.grant_full_control(),
            mpu_req.grant_full_control()
        );
        assert_eq!(upload_req.grant_read(), mpu_req.grant_read());
        assert_eq!(upload_req.grant_read_acp(), mpu_req.grant_read_acp());
        assert_eq!(upload_req.grant_write_acp(), mpu_req.grant_write_acp());
        assert_eq!(upload_req.key(), mpu_req.key());
        assert_eq!(upload_req.metadata(), mpu_req.metadata());
        assert_eq!(
            upload_req
                .object_lock_legal_hold_status()
                .map(|v| v.as_str()),
            mpu_req.object_lock_legal_hold_status().map(|v| v.as_str())
        );
        assert_eq!(
            upload_req.object_lock_mode().map(|v| v.as_str()),
            mpu_req.object_lock_mode().map(|v| v.as_str())
        );
        assert_eq!(
            upload_req.object_lock_retain_until_date(),
            mpu_req.object_lock_retain_until_date()
        );
        assert_eq!(
            upload_req.request_payer().map(|v| v.as_str()),
            mpu_req.request_payer().map(|v| v.as_str())
        );
        assert_eq!(
            upload_req.sse_customer_algorithm(),
            mpu_req.sse_customer_algorithm()
        );
        assert_eq!(upload_req.sse_customer_key(), mpu_req.sse_customer_key());
        assert_eq!(
            upload_req.sse_customer_key_md5(),
            mpu_req.sse_customer_key_md5()
        );
        assert_eq!(
            upload_req.sse_kms_encryption_context(),
            mpu_req.ssekms_encryption_context()
        );
        assert_eq!(upload_req.sse_kms_key_id(), mpu_req.ssekms_key_id());
        assert_eq!(
            upload_req.server_side_encryption().map(|v| v.as_str()),
            mpu_req.server_side_encryption().map(|v| v.as_str())
        );
        assert_eq!(
            upload_req.storage_class().map(|v| v.as_str()),
            mpu_req.storage_class().map(|v| v.as_str())
        );
        assert_eq!(upload_req.tagging(), mpu_req.tagging());
        assert_eq!(
            upload_req.website_redirect_location(),
            mpu_req.website_redirect_location()
        );
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_all_fields_copied_to_upload_part_request() {
        let upload_req = Arc::new(upload_request_for_tests());

        // Using a mock client to verify field value copying,
        // since `UploadPartInputBuilder` does not implement `Clone`.
        // This prevents us from doing:
        // `upload_part_builder.as_input().clone().build().unwrap();`
        let upload_part_mock = mock!(aws_sdk_s3::Client::upload_part)
            .match_requests({
                let upload_req = upload_req.clone();
                move |upload_part_req| {
                    assert_eq!(upload_req.bucket(), upload_part_req.bucket());
                    assert_eq!(
                        Some(&aws_sdk_s3::types::ChecksumAlgorithm::Crc32),
                        upload_part_req.checksum_algorithm()
                    );
                    assert_eq!(
                        upload_req.expected_bucket_owner(),
                        upload_part_req.expected_bucket_owner()
                    );
                    assert_eq!(upload_req.key(), upload_part_req.key());
                    assert_eq!(
                        upload_req.request_payer().map(|v| v.as_str()),
                        upload_part_req.request_payer().map(|v| v.as_str())
                    );
                    assert_eq!(
                        upload_req.sse_customer_algorithm(),
                        upload_part_req.sse_customer_algorithm()
                    );
                    assert_eq!(
                        upload_req.sse_customer_key(),
                        upload_part_req.sse_customer_key()
                    );
                    assert_eq!(
                        upload_req.sse_customer_key_md5(),
                        upload_part_req.sse_customer_key_md5()
                    );
                    true
                }
            })
            .then_output(|| UploadPartOutput::builder().e_tag("test-etag").build());

        let client = mock_client!(aws_sdk_s3, RuleMode::Sequential, &[&upload_part_mock]);
        let upload_part_builder = client.upload_part().upload_id("test-id").part_number(1);
        let upload_part_builder =
            copy_fields_to_upload_part_request(upload_req.as_ref(), upload_part_builder, None);
        let _ = upload_part_builder.send().await.unwrap();
    }

    #[cfg_attr(miri, ignore)]
    #[tokio::test]
    async fn test_copy_fields_to_complete_mpu_request() {
        let config = Config::builder().build();
        let client = Client::from_conf(config);

        let upload_req = upload_request_for_tests();

        let complete_mpu_builder = copy_fields_to_complete_mpu_request(
            &upload_req,
            client.complete_multipart_upload(),
            || async move { None },
        )
        .await;
        let complete_mpu_req = complete_mpu_builder.as_input().clone().build().unwrap();

        assert_eq!(upload_req.bucket(), complete_mpu_req.bucket());
        assert_eq!(Some("0xebe6c6e6"), complete_mpu_req.checksum_crc32());
        assert_eq!(None, complete_mpu_req.checksum_crc32_c());
        assert_eq!(None, complete_mpu_req.checksum_crc64_nvme());
        assert_eq!(None, complete_mpu_req.checksum_sha1());
        assert_eq!(None, complete_mpu_req.checksum_sha256());
        assert_eq!(
            upload_req.expected_bucket_owner(),
            complete_mpu_req.expected_bucket_owner()
        );
        assert_eq!(upload_req.if_match(), complete_mpu_req.if_match());
        assert_eq!(upload_req.if_none_match(), complete_mpu_req.if_none_match());
        assert_eq!(upload_req.key(), complete_mpu_req.key());
        assert_eq!(
            upload_req.request_payer().map(|v| v.as_str()),
            complete_mpu_req.request_payer().map(|v| v.as_str())
        );
        assert_eq!(
            upload_req.sse_customer_algorithm(),
            complete_mpu_req.sse_customer_algorithm()
        );
        assert_eq!(
            upload_req.sse_customer_key(),
            complete_mpu_req.sse_customer_key()
        );
        assert_eq!(
            upload_req.sse_customer_key_md5(),
            complete_mpu_req.sse_customer_key_md5()
        );
    }

    #[test]
    fn test_copy_fields_to_abort_multipart_upload() {
        let client = aws_smithy_mocks::mock_client!(aws_sdk_s3, []);

        let upload_req = upload_request_for_tests();

        let abort_mpu_builder = crate::sdk_v1::copy_upload_input_fields_to_abort_multipart_upload(
            &upload_req,
            client.abort_multipart_upload(),
        );
        let abort_mpu_req = abort_mpu_builder.as_input().clone().build().unwrap();

        assert_eq!(upload_req.bucket(), abort_mpu_req.bucket());
        assert_eq!(
            upload_req.expected_bucket_owner(),
            abort_mpu_req.expected_bucket_owner()
        );
        assert_eq!(upload_req.key(), abort_mpu_req.key());
        assert_eq!(
            upload_req.request_payer().map(|v| v.as_str()),
            abort_mpu_req.request_payer().map(|v| v.as_str())
        );
    }
}