Skip to content

Commit

Permalink
Convert SdkBytes to ByteBuffer for POJO getters (#5791)
Browse files Browse the repository at this point in the history
* Convert SdkBytes to ByteBuffer for POJO getters

* Update v2-migration/src/main/java/software/amazon/awssdk/v2migration/SdkBytesToByteBuffer.java

* Update v2-migration/src/main/java/software/amazon/awssdk/v2migration/SdkBytesToByteBuffer.java

* Update v2-migration/src/main/java/software/amazon/awssdk/v2migration/SdkBytesToByteBuffer.java

* Fix build failure

---------

Co-authored-by: David Ho <[email protected]>
  • Loading branch information
zoewangg and davidh44 authored Jan 14, 2025
1 parent 5a6d4b5 commit 3b0ddf1
Show file tree
Hide file tree
Showing 5 changed files with 153 additions and 1 deletion.
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"type": "bugfix",
"category": "AWS SDK for Java v2 Migration Tool",
"contributor": "",
"description": "Transform the getter methods on the service model classes that return SdkBytes to return ByteBuffer to be compatible with v1 style getters"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
/*
* 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 foo.bar;

import java.nio.ByteBuffer;
import software.amazon.awssdk.services.sqs.model.MessageAttributeValue;

public class SdkBytes {

void sdkBytesGetters() {
MessageAttributeValue messageAttributeValue = MessageAttributeValue.builder()
.build();
ByteBuffer binaryValue = messageAttributeValue.binaryValue().asByteBuffer();
String binaryString = new String(messageAttributeValue.binaryValue().asByteBuffer().array());
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* 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 foo.bar;

import com.amazonaws.services.sqs.model.MessageAttributeValue;
import java.nio.ByteBuffer;

public class SdkBytes {

void sdkBytesGetters() {
MessageAttributeValue messageAttributeValue = new MessageAttributeValue();
ByteBuffer binaryValue = messageAttributeValue.getBinaryValue();
String binaryString = new String(messageAttributeValue.getBinaryValue().array());
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
/*
* 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.v2migration;

import java.nio.ByteBuffer;
import java.util.regex.Pattern;
import org.openrewrite.ExecutionContext;
import org.openrewrite.NlsRewrite;
import org.openrewrite.Recipe;
import org.openrewrite.TreeVisitor;
import org.openrewrite.java.JavaIsoVisitor;
import org.openrewrite.java.JavaTemplate;
import org.openrewrite.java.tree.J;
import org.openrewrite.java.tree.JavaType.FullyQualified;
import org.openrewrite.java.tree.JavaType.Method;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.v2migration.internal.utils.SdkTypeUtils;

@SdkInternalApi
public class SdkBytesToByteBuffer extends Recipe {
private static final Pattern BYTE_BUFFER_PATTERN = Pattern.compile(ByteBuffer.class.getCanonicalName());

@Override
public @NlsRewrite.DisplayName String getDisplayName() {
return "Convert SdkBytes to ByteBuffer";
}

@Override
public @NlsRewrite.Description String getDescription() {
return "Convert SdkBytes to ByteBuffer by calling SdkBytes#asByteBuffer()";
}

@Override
public TreeVisitor<?, ExecutionContext> getVisitor() {
return new SdkBytesToBufferVisitor();
}

private static boolean isV2ModelGetterReturningByteBuffer(J.MethodInvocation method) {
Method mt = method.getMethodType();

if (mt != null) {
FullyQualified declaringType = mt.getDeclaringType();
boolean isByteBuffer = mt.getReturnType().isAssignableFrom(BYTE_BUFFER_PATTERN);
if (SdkTypeUtils.isV2ModelClass(declaringType) && isByteBuffer) {
return true;
}
}
return false;
}

private static final class SdkBytesToBufferVisitor extends JavaIsoVisitor<ExecutionContext> {
@Override
public J.MethodInvocation visitMethodInvocation(J.MethodInvocation originalMethod,
ExecutionContext executionContext) {
J.MethodInvocation method =
super.visitMethodInvocation(originalMethod, executionContext);
if (!isV2ModelGetterReturningByteBuffer(method)) {
return method;
}

String methodName = method.getSimpleName();
JavaTemplate template = JavaTemplate
.builder(method.getSelect() + "." + methodName + "()." + "asByteBuffer()")
.contextSensitive()
.build();

method = template.apply(
updateCursor(method),
method.getCoordinates().replace()
);

return method;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,5 @@ recipeList:
- software.amazon.awssdk.v2migration.V1GetterToV2
- software.amazon.awssdk.v2migration.HttpSettingsToHttpClient
- software.amazon.awssdk.v2migration.WrapSdkClientBuilderRegionStr
- software.amazon.awssdk.v2migration.EnumCasingToV2
- software.amazon.awssdk.v2migration.EnumCasingToV2
- software.amazon.awssdk.v2migration.SdkBytesToByteBuffer

0 comments on commit 3b0ddf1

Please sign in to comment.