-
Notifications
You must be signed in to change notification settings - Fork 864
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
zoewangg
wants to merge
1
commit into
master
Choose a base branch
from
zoewang/ByteBufferToSdkBytes
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
6 changes: 6 additions & 0 deletions
6
.changes/next-release/bugfix-AWSSDKforJavav2MigrationTool-21fc092.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
103 changes: 103 additions & 0 deletions
103
v2-migration/src/main/java/software/amazon/awssdk/v2migration/ByteBufferToSdkBytes.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
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; | ||
} | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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 👀
There was a problem hiding this comment.
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