Implement Asynchronous EC2 Metadata Client #3523

L-Applin · 2022-10-27T14:30:13Z

Implementation of the Asynchronous Ec2 Metadata Client.

Motivation and Context

This is part of the required features before release of the EC2Metadata Service Client

Modifications

Add interface Ec2MetadataAsyncClient and one default implementation.
Slight refactoring of the sync client to keep both client aligned.

Testing

Unit tests added for the implementation.

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)

Checklist

I have read the CONTRIBUTING document
Local run of mvn install succeeds
My code follows the code style of this project
My change requires a change to the Javadoc documentation
I have updated the Javadoc documentation accordingly
I have added tests to cover my changes
All new and existing tests passed
I have added a changelog entry. Adding a new entry must be accomplished by running the scripts/new-change script and following the instructions. Commit the new file created by the script in .changes/next-release with your changes.
My change is to implement 1.11 parity feature and I have updated LaunchChangelog

License

I confirm that this pull request can be released under the Apache 2 license

core/imds/src/main/java/software/amazon/awssdk/imds/MetadataResponse.java

core/imds/src/main/java/software/amazon/awssdk/imds/Ec2MetadataAsyncClient.java

core/imds/src/main/java/software/amazon/awssdk/imds/internal/Ec2MetadataEndpointProvider.java

core/imds/src/main/java/software/amazon/awssdk/imds/internal/DefaultEc2MetadataClient.java

core/imds/src/main/java/software/amazon/awssdk/imds/internal/DefaultEc2MetadataAsyncClient.java

core/imds/pom.xml

core/imds/src/main/java/software/amazon/awssdk/imds/Ec2MetadataAsyncClient.java

...ds/src/test/java/software/amazon/awssdk/imds/internal/DefaultEc2MetadataAsyncClientTest.java

core/imds/src/main/java/software/amazon/awssdk/imds/internal/DefaultEc2MetadataAsyncClient.java

...ds/src/test/java/software/amazon/awssdk/imds/internal/DefaultEc2MetadataAsyncClientTest.java

core/imds/src/main/java/software/amazon/awssdk/imds/internal/DefaultEc2MetadataAsyncClient.java

- Create a common builder Ec2MetadataClientBuilder - Create a common test class BaseEc2MetadataClientTest - Refactor common initialization logic for both sync and async client in BaseEc2MetadataClient class - Use netty async client in unit tests - fix Async error logic

core/imds/src/main/java/software/amazon/awssdk/imds/Ec2MetadataClientBuilder.java

core/imds/src/main/java/software/amazon/awssdk/imds/Ec2MetadataClient.java

core/imds/src/main/java/software/amazon/awssdk/imds/Ec2MetadataClientBuilder.java

core/imds/src/main/java/software/amazon/awssdk/imds/internal/DefaultEc2MetadataAsyncClient.java

core/imds/src/test/java/software/amazon/awssdk/imds/internal/BaseEc2MetadataClientTest.java

- fix one failing unit test

sonarqubecloud · 2022-11-08T17:32:07Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
70 Code Smells

84.2% Coverage
1.5% Duplication

core/imds/pom.xml

core/imds/src/main/java/software/amazon/awssdk/imds/Ec2MetadataAsyncClient.java

zoewangg · 2022-11-03T18:09:45Z

core/imds/src/main/java/software/amazon/awssdk/imds/internal/DefaultEc2MetadataAsyncClient.java

+    private DefaultEc2MetadataAsyncClient(Ec2MetadataAsyncBuilder builder) {
+        super(builder);
+        this.httpClient = Validate.getOrDefault(builder.httpClient,
+            () -> new DefaultSdkAsyncHttpClientBuilder().buildWithDefaults(AttributeMap.empty()));


We should create a default attribute map for IMDS, something like the following. I think connection timeout and read timeout are both 1 second.

private static final AttributeMap IMDS_HTTP_DEFAULTS = AttributeMap.builder() .put(SdkHttpConfigurationOption.CONNECTION_TIMEOUT, Duration.ofSeconds(1)) .... .build();

aws-sdk-java-v2/core/regions/src/main/java/software/amazon/awssdk/regions/internal/util/ConnectionUtils.java

Lines 39 to 41 in d1a23e2

connection.setConnectTimeout(1000);

connection.setReadTimeout(1000);

connection.setRequestMethod(method);

Fixed in 3543

zoewangg · 2022-11-03T18:17:01Z

core/imds/src/main/java/software/amazon/awssdk/imds/internal/DefaultEc2MetadataAsyncClient.java

+            httpClient.close();
+        }
+        if (isRetryExecutorManaged) {
+            asyncRetryScheduler.shutdown();


It seems an exception thrown from httpClient#close will prevent asyncRetryScheduler from being closed. Should we try catch here?

https://github.com/aws/aws-sdk-java-v2/blob/master/http-clients/netty-nio-client/src/main/java/software/amazon/awssdk/http/nio/netty/NettyNioAsyncHttpClient.java#L197

Fixed in 3543

zoewangg · 2022-11-03T18:19:38Z

core/imds/src/main/java/software/amazon/awssdk/imds/internal/Ec2MetadataEndpointProvider.java

@@ -36,6 +36,8 @@
 @SdkInternalApi
 public final class Ec2MetadataEndpointProvider {

+    public static final Ec2MetadataEndpointProvider DEFAULT_ENDPOINT_PROVIDER = builder().build();


Should we make this private and create a static method to return this singleton?

Fixed in 3543

…3b6158226 Pull request: release <- staging/9c9d802f-6722-42b6-ae9d-8cc3b6158226

L-Applin added 13 commits October 17, 2022 10:40

IMDS Ec2 Metada refactoring

c81a347

IMDS Ec2 Metada refactoring

2eb31a1

IMDS Ec2 Metada refactoring

c4bfaf0

IMDS Ec2 Metada refactoring

6a6bb3b

IMDS Ec2 Metada refactoring

ce7e5cf

IMDS Ec2 Metada refactoring

38486f5

IMDS Ec2 Metada refactoring

d5a44a7

IMDS Async

80f6c2f

IMDS Async client

7eb6f00

IMDS Async client

1b25ae1

IMDS Async client

3d14c96

IMDS Async client

e0c31c4

IMDS Async client

cdb801c

L-Applin requested a review from a team as a code owner October 27, 2022 14:30

L-Applin added 6 commits October 27, 2022 10:54

IMDS Async

884d552

IMDS Async client

a130632

IMDS Async client

30be64c

IMDS Async client

9981b14

IMDS Async client

73eeefa

IMDS Async client

c5991e9

cenedhryn reviewed Oct 28, 2022

View reviewed changes

L-Applin added 5 commits October 28, 2022 16:40

IMDS Async client

d50c0be

IMDS Async client

58c589a

IMDS Async client

d59b4b8

Fix test classes

0db213f

JavaDoc

2c04edb

zoewangg reviewed Nov 1, 2022

View reviewed changes

cenedhryn reviewed Nov 8, 2022

View reviewed changes

Improve JavaDoc and rename some variables

71b0ab3

- fix one failing unit test

cenedhryn approved these changes Nov 8, 2022

View reviewed changes

L-Applin merged commit a5a40da into feature/master/imds Nov 8, 2022

L-Applin deleted the olapplin/imds-async branch November 8, 2022 18:51

zoewangg reviewed Nov 14, 2022

View reviewed changes

aws-sdk-java-automation added a commit that referenced this pull request Dec 17, 2024

Merge pull request #3523 from aws/staging/9c9d802f-6722-42b6-ae9d-8cc…

6401b0d

…3b6158226 Pull request: release <- staging/9c9d802f-6722-42b6-ae9d-8cc3b6158226

	connection.setConnectTimeout(1000);
	connection.setReadTimeout(1000);
	connection.setRequestMethod(method);

Implement Asynchronous EC2 Metadata Client #3523

Implement Asynchronous EC2 Metadata Client #3523

Uh oh!

Conversation

L-Applin commented Oct 27, 2022

Motivation and Context

Modifications

Testing

Types of changes

Checklist

License

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Nov 8, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

zoewangg Nov 3, 2022

Choose a reason for hiding this comment

Uh oh!

L-Applin Nov 15, 2022

Choose a reason for hiding this comment

Uh oh!

zoewangg Nov 3, 2022

Choose a reason for hiding this comment

Uh oh!

L-Applin Nov 15, 2022

Choose a reason for hiding this comment

Uh oh!

zoewangg Nov 3, 2022

Choose a reason for hiding this comment

Uh oh!

L-Applin Nov 15, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!