Skip to content
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

Convert ByteBuffer to SdkBytes #5798

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
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
@@ -0,0 +1,6 @@
{
"type": "bugfix",
"category": "AWS SDK for Java v2 Migration Tool",
"contributor": "",
"description": "Transform the setter methods on the service model classes that take SdkBytes to take ByteBuffer to be compatible with v1 style setters"
}
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,23 @@
package foo.bar;

import java.nio.ByteBuffer;
import java.nio.charset.StandardCharsets;
import software.amazon.awssdk.core.SdkBytes;
import software.amazon.awssdk.services.sqs.model.MessageAttributeValue;

public class SdkBytes {
public class SdkBytesGetterSetter {

void byteBufferSetter() {
ByteBuffer buffer = ByteBuffer.wrap("helloworld".getBytes(StandardCharsets.UTF_8));
MessageAttributeValue messageAttributeValue = MessageAttributeValue.builder()
.binaryValue(SdkBytes.fromByteBuffer(buffer))
.build();
}

void sdkBytesGetters() {
MessageAttributeValue messageAttributeValue = MessageAttributeValue.builder()
.build();

ByteBuffer binaryValue = messageAttributeValue.binaryValue().asByteBuffer();
String binaryString = new String(messageAttributeValue.binaryValue().asByteBuffer().array());
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,19 @@

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

public class SdkBytes {
public class SdkBytesGetterSetter {

void byteBufferSetter() {
ByteBuffer buffer = ByteBuffer.wrap("helloworld".getBytes(StandardCharsets.UTF_8));
MessageAttributeValue messageAttributeValue = new MessageAttributeValue()
.withBinaryValue(buffer);
}

void sdkBytesGetters() {
MessageAttributeValue messageAttributeValue = new MessageAttributeValue();

ByteBuffer binaryValue = messageAttributeValue.getBinaryValue();
String binaryString = new String(messageAttributeValue.getBinaryValue().array());
}
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
/*
* 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.List;
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;
import org.openrewrite.java.tree.JavaType.FullyQualified;
import org.openrewrite.java.tree.JavaType.Method;
import software.amazon.awssdk.annotations.SdkInternalApi;
import software.amazon.awssdk.core.SdkBytes;
import software.amazon.awssdk.v2migration.internal.utils.SdkTypeUtils;

@SdkInternalApi
Copy link
Contributor

@Fred1155 Fred1155 Jan 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This class should be in internal package 👀

Copy link
Contributor Author

@zoewangg zoewangg Jan 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't actually expect customers to consume those classes directly, and they are used indirectly when users run OpenRewrite command, so technically those SDK annotations are not needed (and those recipe classes are not part of the SDK). I can remove them in a separate PR to avoid confusion

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

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

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

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

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 (!isV2ModelSetterWithByteBufferParam(method)) {
return method;
}

JavaTemplate template = JavaTemplate
.builder("SdkBytes.fromByteBuffer(#{any()})")
.contextSensitive()
.imports(SdkBytes.class.getCanonicalName())
.build();

method = template.apply(
updateCursor(method),
method.getCoordinates().replaceArguments(),
method.getArguments().toArray()
);

maybeAddImport(SdkBytes.class.getCanonicalName(), false);
return method;
}

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

if (mt != null) {
FullyQualified declaringType = mt.getDeclaringType();
List<JavaType> parameterTypes = mt.getParameterTypes();
if (parameterTypes.size() != 1) {
return false;
}

JavaType javaType = parameterTypes.get(0);
if (javaType == null) {
return false;
}

boolean isByteBufferParam = javaType.isAssignableFrom(BYTE_BUFFER_PATTERN);
if (SdkTypeUtils.isV2ModelBuilder(declaringType) && isByteBufferParam) {
return true;
}
}
return false;
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,5 @@ recipeList:
- software.amazon.awssdk.v2migration.HttpSettingsToHttpClient
- software.amazon.awssdk.v2migration.WrapSdkClientBuilderRegionStr
- software.amazon.awssdk.v2migration.EnumCasingToV2
- software.amazon.awssdk.v2migration.SdkBytesToByteBuffer
- software.amazon.awssdk.v2migration.SdkBytesToByteBuffer
- software.amazon.awssdk.v2migration.ByteBufferToSdkBytes
Loading