Skip to content

A couple of minor refactoring on the S3TransferManager #2997

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 27, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changes/next-release/bugfix-S3TransferManager-2f34394.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"category": "S3 Transfer Manager",
"contributor": "",
"type": "bugfix",
"description": "A couple of minor refactoring on the S3TransferManager. 1. `CompletedDirectoryUpload#failedTransfers` now returns `List<FailedFileUpload>` instead of `Collection<FailedFileUpload>`. 2. `UploadDirectoryOverrideConfiguration#uploadFileRequestTransformer` now returns `Consumer<UploadFileRequest.Builder>` instead of `Optional<Consumer<UploadFileRequest.Builder>>` it will be no-op if no uploadFileRequestTransformer is provided"
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import software.amazon.awssdk.annotations.SdkPreviewApi;
import software.amazon.awssdk.annotations.SdkPublicApi;
Expand All @@ -38,15 +39,15 @@ public final class CompletedDirectoryDownload implements CompletedDirectoryTrans
ToCopyableBuilder<CompletedDirectoryDownload.Builder,
CompletedDirectoryDownload> {

private final Collection<FailedFileDownload> failedTransfers;
private final List<FailedFileDownload> failedTransfers;

private CompletedDirectoryDownload(DefaultBuilder builder) {
this.failedTransfers = Collections.unmodifiableCollection(
this.failedTransfers = Collections.unmodifiableList(
new ArrayList<>(Validate.paramNotNull(builder.failedTransfers, "failedTransfers")));
}

@Override
public Collection<FailedFileDownload> failedTransfers() {
public List<FailedFileDownload> failedTransfers() {
return failedTransfers;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

package software.amazon.awssdk.transfer.s3;

import java.util.Collection;
import java.util.List;
import software.amazon.awssdk.annotations.SdkPreviewApi;
import software.amazon.awssdk.annotations.SdkPublicApi;

Expand All @@ -34,5 +34,5 @@ public interface CompletedDirectoryTransfer extends CompletedTransfer {
*
* @return an immutable list of failed transfers
*/
Collection<? extends FailedObjectTransfer> failedTransfers();
List<? extends FailedObjectTransfer> failedTransfers();
}
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import software.amazon.awssdk.annotations.SdkPreviewApi;
import software.amazon.awssdk.annotations.SdkPublicApi;
Expand All @@ -38,15 +39,15 @@ public final class CompletedDirectoryUpload implements CompletedDirectoryTransfe
ToCopyableBuilder<CompletedDirectoryUpload.Builder,
CompletedDirectoryUpload> {

private final Collection<FailedFileUpload> failedTransfers;
private final List<FailedFileUpload> failedTransfers;

private CompletedDirectoryUpload(DefaultBuilder builder) {
this.failedTransfers = Collections.unmodifiableCollection(
this.failedTransfers = Collections.unmodifiableList(
new ArrayList<>(Validate.paramNotNull(builder.failedTransfers, "failedTransfers")));
}

@Override
public Collection<FailedFileUpload> failedTransfers() {
public List<FailedFileUpload> failedTransfers() {
return failedTransfers;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
package software.amazon.awssdk.transfer.s3;

import java.util.Objects;
import java.util.Optional;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.SdkPreviewApi;
import software.amazon.awssdk.annotations.SdkPublicApi;
Expand Down Expand Up @@ -45,11 +44,11 @@ private DownloadDirectoryOverrideConfiguration(DefaultBuilder builder) {
}

/**
* @return the optional download request transformer
* @return the download request transformer if not null, otherwise no-op
* @see DownloadDirectoryOverrideConfiguration.Builder#downloadFileRequestTransformer(Consumer)
*/
public Optional<Consumer<DownloadFileRequest.Builder>> downloadFileRequestTransformer() {
return Optional.ofNullable(downloadFileRequestTransformer);
public Consumer<DownloadFileRequest.Builder> downloadFileRequestTransformer() {
return downloadFileRequestTransformer == null ? ignore -> { } : downloadFileRequestTransformer;
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,11 +75,11 @@ public Optional<Boolean> recursive() {
}

/**
* @return the optional upload request transformer
* @return the upload request transformer if not null, otherwise no-op
* @see UploadDirectoryOverrideConfiguration.Builder#uploadFileRequestTransformer(Consumer)
*/
public Optional<Consumer<UploadFileRequest.Builder>> uploadFileRequestTransformer() {
return Optional.ofNullable(uploadFileRequestTransformer);
public Consumer<UploadFileRequest.Builder> uploadFileRequestTransformer() {
return uploadFileRequestTransformer == null ? ignore -> { } : uploadFileRequestTransformer;
}

@Override
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -237,7 +237,7 @@ private UploadFileRequest constructUploadRequest(UploadDirectoryRequest uploadDi
.putObjectRequest(putObjectRequest);

uploadDirectoryRequest.overrideConfiguration()
.flatMap(UploadDirectoryOverrideConfiguration::uploadFileRequestTransformer)
.map(UploadDirectoryOverrideConfiguration::uploadFileRequestTransformer)
.ifPresent(c -> c.accept(requestBuilder));

return requestBuilder.build();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,32 +15,11 @@

package software.amazon.awssdk.transfer.s3;


import static org.assertj.core.api.Assertions.assertThat;

import java.nio.file.Paths;
import nl.jqno.equalsverifier.EqualsVerifier;
import org.junit.jupiter.api.Test;

class DownloadDirectoryOverrideConfigurationTest {

@Test
void defaultBuilder() {
DownloadDirectoryOverrideConfiguration configuration =
DownloadDirectoryOverrideConfiguration.builder()
.build();
assertThat(configuration.downloadFileRequestTransformer()).isEmpty();
}

@Test
void defaultBuilderWithPropertySet() {
DownloadDirectoryOverrideConfiguration configuration =
DownloadDirectoryOverrideConfiguration.builder()
.downloadFileRequestTransformer((request -> request.destination(Paths.get("."))))
.build();
assertThat(configuration.downloadFileRequestTransformer()).isNotEmpty();
}

@Test
void equalsHashCode() {
EqualsVerifier.forClass(DownloadDirectoryOverrideConfiguration.class).verify();
Expand Down