Added support for endpoint variants in endpoint metadata: FIPS and DUALSTACK. #2808

millems · 2021-10-29T20:55:24Z

This adds the ability to resolve fips and dualstack endpoints with a "fips enabled" or "dualstack enabled" flag.

E.g.

URI fipsEndpoint =
    ServiceMetadata.of(S3Client.SERVICE_METADATA_ID)
                   .endpointFor(ServiceEndpointKey.builder()
                                                  .region(Region.US_WEST_2)
                                                  .tags(EndpointTag.FIPS)
                                                  .build());

The following public API changes were made:

Added ServiceMetadata.endpointFor(ServiceEndpointKey)
Added ServiceMetadata.signingRegion(ServiceEndpointKey)
Added PartitionMetadata.hostname(PartitionEndpointKey)
Added PartitionMetadata.dnsSuffix(PartitionEndpointKey)
Added a generated EndpointTag class, which currently contains FIPS and DUALSTACK.
Removed ServiceMetadata.computeEndpoint, because it shouldn't have ever been public, and no one should be using it.

The following module changes were made:

Added regions-testing for verifying region resolution behavior that doesn't currently exist in the endpoints.json

zoewangg · 2021-10-29T21:55:49Z

core/regions/src/main/java/software/amazon/awssdk/regions/ServiceMetadata.java

+    default String endpointPrefix() {
+        throw new UnsupportedOperationException();
+    }


Can we add Javadoc for this method?

Good catch, meant to delete this.

zoewangg · 2021-10-29T21:57:26Z

...gions/src/main/java/software/amazon/awssdk/regions/internal/DefaultPartitionEndpointKey.java

+
+    @Override
+    public Set<EndpointTag> tags() {
+        return Collections.unmodifiableSet(tags);


nit, might consider wrapping it in the ctor

zoewangg · 2021-10-29T21:58:14Z

...gions/src/main/java/software/amazon/awssdk/regions/internal/DefaultPartitionEndpointKey.java

+    }
+
+    @Override
+    public boolean equals(Object o) {


Can we add a test for hashcode and equals?

zoewangg · 2021-10-29T22:01:19Z

...regions/src/main/java/software/amazon/awssdk/regions/internal/DefaultServiceEndpointKey.java

+
+    @Override
+    public Set<EndpointTag> tags() {
+        return Collections.unmodifiableSet(tags);


Same here, might be better to wrap it in the ctor

zoewangg · 2021-10-29T22:03:26Z

core/regions/src/main/java/software/amazon/awssdk/regions/ServiceEndpointKey.java

+ */
+@SdkPublicApi
+@Immutable
+public interface ServiceEndpointKey {


Do we need an interface since this looks like a data class? Same comment for PartitionEndpointKey

zoewangg · 2021-10-29T22:06:24Z

test/region-testing/pom.xml

@@ -0,0 +1,102 @@
+<?xml version="1.0" encoding="UTF-8"?>


We probably need to exclude this module from mvn release command and add it to the excluded import list.

zoewangg · 2021-10-29T22:11:52Z

...gen-lite/src/main/java/software/amazon/awssdk/codegen/lite/regions/EndpointTagGenerator.java

+import software.amazon.awssdk.utils.StringUtils;
+import software.amazon.awssdk.utils.internal.CodegenNamingUtils;
+
+public class EndpointTagGenerator implements PoetClass {


Can we add a test to generate EndpointTag? It's hard to tell what EndpointTag looks like from codegen code

zoewangg

Can we add a changelog entry?

zoewangg · 2021-11-02T19:52:51Z

pom.xml

+                            <exclude>software.amazon.awssdk.regions.ServiceMetadata</exclude>
+                            <exclude>software.amazon.awssdk.regions.servicemetadata.*ServiceMetadata</exclude>
+                            <exclude>software.amazon.awssdk.regions.DefaultServiceMetadata</exclude>


Do we still need to exclude them after METHOD_ABSTRACT_NOW_DEFAULT override is added?

It's being too picky about backwards-compatible. There weren't any actual breaking changes in these classes, since we added the implementation in the parent interface.

zoewangg · 2021-11-02T19:55:13Z

...lite/src/test/java/software/amazon/awssdk/codegen/lite/regions/EndpointTagGeneratorTest.java

+
+import static org.junit.Assert.*;
+
+public class EndpointTagGeneratorTest {


Meant to delete this?

zoewangg · 2021-11-02T20:05:26Z

core/regions/src/main/java/software/amazon/awssdk/regions/ServiceMetadata.java

@@ -78,25 +107,6 @@ static ServiceMetadata of(String serviceEndpointPrefix) {
        return metadata == null ? new DefaultServiceMetadata(serviceEndpointPrefix) : metadata;
    }

-    default String computeEndpoint(String endpointPrefix,


This seems like a breaking change. Should we deprecate it instead?

Nvm, saw it in the description. Can we mention it in the change log entry?

I am almost certain that no one is using it. I'd much rather just delete it, because anyone using it is almost certainly doing it wrong.

millems · 2021-11-02T20:23:54Z

I'll add a changelog entry when this is finalized. It won't be merged to master until the fips and dualstack changes are in place (actually using the tags).

…ALSTACK. This adds the ability to resolve fips and dualstack endpoints with a "fips enabled" or "dualstack enabled" flag. E.g. ```java URI fipsEndpoint = ServiceMetadata.of(S3Client.SERVICE_METADATA_ID) .endpointFor(ServiceEndpointKey.builder() .region(Region.US_WEST_2) .tags(EndpointTag.FIPS) .build()); ``` The following public API changes were made: 1. Added `ServiceMetadata.endpointFor(ServiceEndpointKey)` 2. Added `ServiceMetadata.signingRegion(ServiceEndpointKey)` 3. Added `PartitionMetadata.hostname(PartitionEndpointKey)` 4. Added `PartitionMetadata.dnsSuffix(PartitionEndpointKey)` 5. Added a generated `EndpointTag` class, which currently contains FIPS and DUALSTACK. 6. Removed `ServiceMetadata.computeEndpoint`, because it shouldn't have ever been public, and no one should be using it. The following module changes were made: 1. Added `regions-testing` for verifying region resolution behavior that doesn't currently exist in the endpoints.json

sonarqubecloud · 2021-11-02T21:20:44Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
20 Code Smells

88.3% Coverage
2.7% Duplication

millems · 2021-11-02T22:09:15Z

Merged to branch endpoint-tag-staging.

This option can be used to make calls be invoked against AWS endpoints which return IPv6 records. This can also be enabled via the `AWS_USE_DUALSTACK_ENDPOINT` environment variable, `aws.useDualstackEndpoint` system property, or the `use_dualstack_endpoint` profile file property: 1. This PR builds on top of the 'endpoint variants' #2808, by specifying the DUALSTACK endpoint variant whenever the customer requests dualstack to be enabled. 2. The bulk of the files in this PR are addressing the fact that we already have service configuration for enabling dualstack for S3 and S3 control. These existing options have been deprecated in favor of the new option that works for all services.

* Added support for endpoint variants in endpoint metadata: FIPS and DUALSTACK. This adds the ability to resolve fips and dualstack endpoints with a "fips enabled" or "dualstack enabled" flag. E.g. ```java URI fipsEndpoint = ServiceMetadata.of(S3Client.SERVICE_METADATA_ID) .endpointFor(ServiceEndpointKey.builder() .region(Region.US_WEST_2) .tags(EndpointTag.FIPS) .build()); ``` The following public API changes were made: 1. Added `ServiceMetadata.endpointFor(ServiceEndpointKey)` 2. Added `ServiceMetadata.signingRegion(ServiceEndpointKey)` 3. Added `PartitionMetadata.hostname(PartitionEndpointKey)` 4. Added `PartitionMetadata.dnsSuffix(PartitionEndpointKey)` 5. Added a generated `EndpointTag` class, which currently contains FIPS and DUALSTACK. 6. Removed `ServiceMetadata.computeEndpoint`, because it shouldn't have ever been public, and no one should be using it. The following module changes were made: 1. Added `regions-testing` for verifying region resolution behavior that doesn't currently exist in the endpoints.json * Added a new `dualstackEnabled` property to every client builder. (#2818) This option can be used to make calls be invoked against AWS endpoints which return IPv6 records. This can also be enabled via the `AWS_USE_DUALSTACK_ENDPOINT` environment variable, `aws.useDualstackEndpoint` system property, or the `use_dualstack_endpoint` profile file property: 1. This PR builds on top of the 'endpoint variants' #2808, by specifying the DUALSTACK endpoint variant whenever the customer requests dualstack to be enabled. 2. The bulk of the files in this PR are addressing the fact that we already have service configuration for enabling dualstack for S3 and S3 control. These existing options have been deprecated in favor of the new option that works for all services. * Added support for enabling FIPS endpoints. (#2826) This option can be used to make calls be invoked against FIPS-compliant AWS endpoints. This can also be enabled via the AWS_USE_FIPS_ENDPOINT environment variable, aws.useFipsEndpoint system property, or the use_fips_endpoint profile file property:

…034aaea97 Pull request: release <- staging/b49e4374-53b8-4a8d-8ee6-fbc034aaea97

zoewangg reviewed Oct 29, 2021

View reviewed changes

millems force-pushed the millem/endpoint-tag-support branch 2 times, most recently from 7ee3e3b to 13b47a6 Compare November 2, 2021 19:58

zoewangg reviewed Nov 2, 2021

View reviewed changes

millems force-pushed the millem/endpoint-tag-support branch from 13b47a6 to 3f28c17 Compare November 2, 2021 20:38

zoewangg approved these changes Nov 2, 2021

View reviewed changes

millems closed this Nov 3, 2021

millems mentioned this pull request Nov 3, 2021

Added a new dualstackEnabled property to every client builder. #2818

Merged

millems mentioned this pull request Nov 4, 2021

Added support for enabling FIPS endpoints. #2826

Merged

millems mentioned this pull request Nov 8, 2021

Release endpoint variants: dualstack and fips for all services. #2830

Merged

millems deleted the millem/endpoint-tag-support branch October 19, 2022 19:38

aws-sdk-java-automation added a commit that referenced this pull request Nov 22, 2023

Merge pull request #2808 from aws/staging/b49e4374-53b8-4a8d-8ee6-fbc…

f6570dc

…034aaea97 Pull request: release <- staging/b49e4374-53b8-4a8d-8ee6-fbc034aaea97


		import static org.junit.Assert.*;

		public class EndpointTagGeneratorTest {

Added support for endpoint variants in endpoint metadata: FIPS and DUALSTACK. #2808

Added support for endpoint variants in endpoint metadata: FIPS and DUALSTACK. #2808

Uh oh!

Conversation

millems commented Oct 29, 2021

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

zoewangg left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

millems commented Nov 2, 2021

Uh oh!

sonarqubecloud bot commented Nov 2, 2021

Uh oh!

millems commented Nov 2, 2021

Uh oh!

Uh oh!