Skip to content

Iterate SdkFields to convert requests #4177

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 3 commits into from
Jul 12, 2023
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
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.services.s3.S3AsyncClient;
import software.amazon.awssdk.services.s3.internal.multipart.GenericMultipartHelper;
import software.amazon.awssdk.services.s3.internal.multipart.SdkPojoConversionUtils;
import software.amazon.awssdk.services.s3.model.CompleteMultipartUploadRequest;
import software.amazon.awssdk.services.s3.model.CompleteMultipartUploadResponse;
import software.amazon.awssdk.services.s3.model.CompletedMultipartUpload;
Expand Down Expand Up @@ -54,8 +55,8 @@ public CopyObjectHelper(S3AsyncClient s3AsyncClient, long partSizeInBytes) {
this.s3AsyncClient = s3AsyncClient;
this.partSizeInBytes = partSizeInBytes;
this.genericMultipartHelper = new GenericMultipartHelper<>(s3AsyncClient,
RequestConversionUtils::toAbortMultipartUploadRequest,
RequestConversionUtils::toCopyObjectResponse);
SdkPojoConversionUtils::toAbortMultipartUploadRequest,
SdkPojoConversionUtils::toCopyObjectResponse);
}

public CompletableFuture<CopyObjectResponse> copyObject(CopyObjectRequest copyObjectRequest) {
Expand All @@ -64,7 +65,7 @@ public CompletableFuture<CopyObjectResponse> copyObject(CopyObjectRequest copyOb

try {
CompletableFuture<HeadObjectResponse> headFuture =
s3AsyncClient.headObject(RequestConversionUtils.toHeadObjectRequest(copyObjectRequest));
s3AsyncClient.headObject(SdkPojoConversionUtils.toHeadObjectRequest(copyObjectRequest));

// Ensure cancellations are forwarded to the head future
CompletableFutureUtils.forwardExceptionTo(returnFuture, headFuture);
Expand Down Expand Up @@ -101,7 +102,7 @@ private void copyInParts(CopyObjectRequest copyObjectRequest,
Long contentLength,
CompletableFuture<CopyObjectResponse> returnFuture) {

CreateMultipartUploadRequest request = RequestConversionUtils.toCreateMultipartUploadRequest(copyObjectRequest);
CreateMultipartUploadRequest request = SdkPojoConversionUtils.toCreateMultipartUploadRequest(copyObjectRequest);
CompletableFuture<CreateMultipartUploadResponse> createMultipartUploadFuture =
s3AsyncClient.createMultipartUpload(request);

Expand Down Expand Up @@ -212,7 +213,7 @@ private static CompletedPart convertUploadPartCopyResponse(AtomicReferenceArray<
UploadPartCopyResponse uploadPartCopyResponse) {
CopyPartResult copyPartResult = uploadPartCopyResponse.copyPartResult();
CompletedPart completedPart =
RequestConversionUtils.toCompletedPart(copyPartResult,
SdkPojoConversionUtils.toCompletedPart(copyPartResult,
partNumber);

completedParts.set(partNumber - 1, completedPart);
Expand Down

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import java.util.NoSuchElementException;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.core.pagination.sync.SdkIterable;
import software.amazon.awssdk.services.s3.internal.multipart.SdkPojoConversionUtils;
import software.amazon.awssdk.services.s3.model.CopyObjectRequest;
import software.amazon.awssdk.services.s3.model.UploadPartCopyRequest;

Expand Down Expand Up @@ -65,7 +66,7 @@ public UploadPartCopyRequest next() {
long partSize = Math.min(optimalPartSize, remainingBytes);
String range = range(partSize);
UploadPartCopyRequest uploadPartCopyRequest =
RequestConversionUtils.toUploadPartCopyRequest(copyObjectRequest,
SdkPojoConversionUtils.toUploadPartCopyRequest(copyObjectRequest,
partNumber,
uploadId,
range);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
package software.amazon.awssdk.services.s3.internal.multipart;


import static software.amazon.awssdk.services.s3.internal.crt.RequestConversionUtils.toAbortMultipartUploadRequest;
import static software.amazon.awssdk.services.s3.internal.multipart.SdkPojoConversionUtils.toAbortMultipartUploadRequest;

import java.util.Collection;
import java.util.concurrent.CompletableFuture;
Expand All @@ -27,7 +27,6 @@
import software.amazon.awssdk.core.async.AsyncRequestBody;
import software.amazon.awssdk.core.internal.async.SplittingPublisher;
import software.amazon.awssdk.services.s3.S3AsyncClient;
import software.amazon.awssdk.services.s3.internal.crt.RequestConversionUtils;
import software.amazon.awssdk.services.s3.model.CompletedPart;
import software.amazon.awssdk.services.s3.model.CreateMultipartUploadRequest;
import software.amazon.awssdk.services.s3.model.CreateMultipartUploadResponse;
Expand Down Expand Up @@ -60,8 +59,8 @@ public MultipartUploadHelper(S3AsyncClient s3AsyncClient,
this.s3AsyncClient = s3AsyncClient;
this.partSizeInBytes = partSizeInBytes;
this.genericMultipartHelper = new GenericMultipartHelper<>(s3AsyncClient,
RequestConversionUtils::toAbortMultipartUploadRequest,
RequestConversionUtils::toPutObjectResponse);
SdkPojoConversionUtils::toAbortMultipartUploadRequest,
SdkPojoConversionUtils::toPutObjectResponse);
this.maxMemoryUsageInBytes = maxMemoryUsageInBytes;
this.multipartUploadThresholdInBytes = multipartUploadThresholdInBytes;
}
Expand Down Expand Up @@ -96,7 +95,7 @@ public CompletableFuture<PutObjectResponse> uploadObject(PutObjectRequest putObj
private void uploadInParts(PutObjectRequest putObjectRequest, long contentLength, AsyncRequestBody asyncRequestBody,
CompletableFuture<PutObjectResponse> returnFuture) {

CreateMultipartUploadRequest request = RequestConversionUtils.toCreateMultipartUploadRequest(putObjectRequest);
CreateMultipartUploadRequest request = SdkPojoConversionUtils.toCreateMultipartUploadRequest(putObjectRequest);
CompletableFuture<CreateMultipartUploadResponse> createMultipartUploadFuture =
s3AsyncClient.createMultipartUpload(request);

Expand Down Expand Up @@ -215,7 +214,7 @@ private void sendIndividualUploadPartRequest(String uploadId,
private static CompletedPart convertUploadPartResponse(AtomicReferenceArray<CompletedPart> completedParts,
Integer partNumber,
UploadPartResponse uploadPartResponse) {
CompletedPart completedPart = RequestConversionUtils.toCompletedPart(uploadPartResponse, partNumber);
CompletedPart completedPart = SdkPojoConversionUtils.toCompletedPart(uploadPartResponse, partNumber);

completedParts.set(partNumber - 1, completedPart);
return completedPart;
Expand Down Expand Up @@ -245,7 +244,7 @@ private static final class BodyToRequestConverter implements Function<AsyncReque
public Pair<UploadPartRequest, AsyncRequestBody> apply(AsyncRequestBody asyncRequestBody) {
log.trace(() -> "Generating uploadPartRequest for partNumber " + partNumber);
UploadPartRequest uploadRequest =
RequestConversionUtils.toUploadPartRequest(putObjectRequest,
SdkPojoConversionUtils.toUploadPartRequest(putObjectRequest,
partNumber,
uploadId);
++partNumber;
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/

package software.amazon.awssdk.services.s3.internal.multipart;

import java.util.Arrays;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.services.s3.model.AbortMultipartUploadRequest;
import software.amazon.awssdk.services.s3.model.CompleteMultipartUploadResponse;
import software.amazon.awssdk.services.s3.model.CompletedPart;
import software.amazon.awssdk.services.s3.model.CopyObjectRequest;
import software.amazon.awssdk.services.s3.model.CopyObjectResponse;
import software.amazon.awssdk.services.s3.model.CopyObjectResult;
import software.amazon.awssdk.services.s3.model.CopyPartResult;
import software.amazon.awssdk.services.s3.model.CreateMultipartUploadRequest;
import software.amazon.awssdk.services.s3.model.HeadObjectRequest;
import software.amazon.awssdk.services.s3.model.PutObjectRequest;
import software.amazon.awssdk.services.s3.model.PutObjectResponse;
import software.amazon.awssdk.services.s3.model.UploadPartCopyRequest;
import software.amazon.awssdk.services.s3.model.UploadPartRequest;
import software.amazon.awssdk.services.s3.model.UploadPartResponse;

/**
* Request conversion utility method for POJO classes associated with multipart feature.
*/
@SdkInternalApi
public final class SdkPojoConversionUtils {

private static final HashSet<String> PUT_OBJECT_REQUEST_TO_UPLOAD_PART_FIELDS_TO_IGNORE =
new HashSet<>(Arrays.asList("ChecksumSHA1", "ChecksumSHA256", "ContentMD5", "ChecksumCRC32C", "ChecksumCRC32"));

private SdkPojoConversionUtils() {
}

public static UploadPartRequest toUploadPartRequest(PutObjectRequest putObjectRequest, int partNumber, String uploadId) {

UploadPartRequest.Builder builder = UploadPartRequest.builder();

setSdkFields(builder, putObjectRequest, PUT_OBJECT_REQUEST_TO_UPLOAD_PART_FIELDS_TO_IGNORE);

return builder.uploadId(uploadId).partNumber(partNumber).build();
}

public static CreateMultipartUploadRequest toCreateMultipartUploadRequest(PutObjectRequest putObjectRequest) {

CreateMultipartUploadRequest.Builder builder = CreateMultipartUploadRequest.builder();
setSdkFields(builder, putObjectRequest);
return builder.build();
}

public static HeadObjectRequest toHeadObjectRequest(CopyObjectRequest copyObjectRequest) {
HeadObjectRequest.Builder builder = HeadObjectRequest.builder();
setSdkFields(builder, copyObjectRequest);
return builder.build();
}

public static CompletedPart toCompletedPart(CopyPartResult copyPartResult, int partNumber) {
CompletedPart.Builder builder = CompletedPart.builder();

setSdkFields(builder, copyPartResult);
return builder.partNumber(partNumber).build();
}

public static CompletedPart toCompletedPart(UploadPartResponse partResponse, int partNumber) {
CompletedPart.Builder builder = CompletedPart.builder();
setSdkFields(builder, partResponse);
return builder.partNumber(partNumber).build();
}

private static void setSdkFields(SdkPojo targetBuilder, SdkPojo sourceObject) {
setSdkFields(targetBuilder, sourceObject, new HashSet<>());
}

private static void setSdkFields(SdkPojo targetBuilder, SdkPojo sourceObject, Set<String> fieldsToIgnore) {
Map<String, Object> sourceFields = retrieveSdkFields(sourceObject, sourceObject.sdkFields());
List<SdkField<?>> targetSdkFields = targetBuilder.sdkFields();

for (SdkField<?> field : targetSdkFields) {
if (fieldsToIgnore.contains(field.memberName())) {
continue;
}
field.set(targetBuilder, sourceFields.getOrDefault(field.memberName(), null));
}
}

public static CreateMultipartUploadRequest toCreateMultipartUploadRequest(CopyObjectRequest copyObjectRequest) {
CreateMultipartUploadRequest.Builder builder = CreateMultipartUploadRequest.builder();

setSdkFields(builder, copyObjectRequest);
return builder.build();
}

public static CopyObjectResponse toCopyObjectResponse(CompleteMultipartUploadResponse response) {
CopyObjectResponse.Builder builder = CopyObjectResponse.builder();

setSdkFields(builder, response);

if (response.responseMetadata() != null) {
builder.responseMetadata(response.responseMetadata());
}

if (response.sdkHttpResponse() != null) {
builder.sdkHttpResponse(response.sdkHttpResponse());
}

return builder.copyObjectResult(toCopyObjectResult(response))
.build();
}

private static CopyObjectResult toCopyObjectResult(CompleteMultipartUploadResponse response) {
CopyObjectResult.Builder builder = CopyObjectResult.builder();

setSdkFields(builder, response);
return builder.build();
}

public static AbortMultipartUploadRequest.Builder toAbortMultipartUploadRequest(CopyObjectRequest copyObjectRequest) {
AbortMultipartUploadRequest.Builder builder = AbortMultipartUploadRequest.builder();
setSdkFields(builder, copyObjectRequest);
return builder;
}

public static AbortMultipartUploadRequest.Builder toAbortMultipartUploadRequest(PutObjectRequest putObjectRequest) {
AbortMultipartUploadRequest.Builder builder = AbortMultipartUploadRequest.builder();
setSdkFields(builder, putObjectRequest);
return builder;
}

public static UploadPartCopyRequest toUploadPartCopyRequest(CopyObjectRequest copyObjectRequest,
int partNumber,
String uploadId,
String range) {
UploadPartCopyRequest.Builder builder = UploadPartCopyRequest.builder();
setSdkFields(builder, copyObjectRequest);
return builder.copySourceRange(range)
.partNumber(partNumber)
.uploadId(uploadId)
.build();
}

public static PutObjectResponse toPutObjectResponse(CompleteMultipartUploadResponse response) {

PutObjectResponse.Builder builder = PutObjectResponse.builder();

setSdkFields(builder, response);

// TODO: check why we have to do null check
if (response.responseMetadata() != null) {
builder.responseMetadata(response.responseMetadata());
}

if (response.sdkHttpResponse() != null) {
builder.sdkHttpResponse(response.sdkHttpResponse());
}

return builder.build();
}

private static Map<String, Object> retrieveSdkFields(SdkPojo sourceObject, List<SdkField<?>> sdkFields) {
return sdkFields.stream().collect(
HashMap::new,
(map, field) -> map.put(field.memberName(),
field.getValueOrDefault(sourceObject)),
Map::putAll);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@

import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatThrownBy;
import static org.assertj.core.api.Assertions.fail;
import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.never;
import static org.mockito.Mockito.times;
Expand All @@ -27,6 +28,9 @@
import java.io.IOException;
import java.util.List;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.TimeoutException;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
Expand Down Expand Up @@ -164,7 +168,12 @@ void mpu_onePartFailed_shouldFailOtherPartsAndAbort() {
AbortMultipartUploadRequest actualRequest = argumentCaptor.getValue();
assertThat(actualRequest.uploadId()).isEqualTo(UPLOAD_ID);

assertThat(ongoingRequest).isCompletedExceptionally();
try {
ongoingRequest.get(1, TimeUnit.MILLISECONDS);
fail("no exception thrown");
} catch (Exception e) {
assertThat(e.getCause()).hasMessageContaining("request failed");
}
}

@Test
Expand Down
Loading