Skip rules based endpoints for most services (#3520)

* Skip rules based endpoints for most services

We are only enabling rules based endpoints for S3, S3Control, and EventBridge
for now in order to roll back incorrect hostprefix handling in the Java SDK. S3,
S3Control, and EventBridge are unaffected by this issue because their rules are
handwritten, and in the case of S3Control which has a host prefix in the model,
it is handled by the rule set.


Co-authored-by: John Viegas <[email protected]>
Co-authored-by: Zoe Wang <[email protected]>

Author: 3 people

.changes/next-release/bugfix-AWsSDKforJavav2-ddeebe8.json

@@ -0,0 +1,6 @@
+{
+    "type": "bugfix",
+    "category": "AWs SDK for Java v2",
+    "contributor": "",
+    "description": "We are only enabling rules based endpoints for S3, S3Control, and EventBridge for now in order to roll back incorrect hostprefix handling in the Java SDK. EventBridge are unaffected by this issue because it does not have a `hostPrefix` in its service model. S3 and S3Control have `hostPrefix` in the model, it is handled by the rule set."
+}

codegen/src/main/java/software/amazon/awssdk/codegen/emitters/tasks/EndpointProviderTasks.java

@@ -18,6 +18,7 @@
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.List;
 import java.util.Map;
 import software.amazon.awssdk.codegen.emitters.GeneratorTask;
@@ -45,6 +46,10 @@ public EndpointProviderTasks(GeneratorTaskParams dependencies) {
 
     @Override
     protected List<GeneratorTask> createTasks() throws Exception {
+        if (!generatorTaskParams.getModel().getCustomizationConfig().useRuleBasedEndpoints()) {
+            return Collections.emptyList();
+        }
+
         List<GeneratorTask> tasks = new ArrayList<>();
         tasks.add(generateInterface());
         tasks.add(generateParams());

codegen/src/main/java/software/amazon/awssdk/codegen/model/config/customization/CustomizationConfig.java

@@ -213,6 +213,11 @@ public class CustomizationConfig {
 
     private boolean useGlobalEndpoint;
 
+    /**
+     * Whether Endpoints 2.0/rule based endpoints should be used for endpoint resolution.
+     */
+    private boolean useRuleBasedEndpoints = false;
+
     private CustomizationConfig() {
     }
 
@@ -550,4 +555,11 @@ public void setSkipEndpointTests(Map<String, String> skipEndpointTests) {
         this.skipEndpointTests = skipEndpointTests;
     }
 
+    public boolean useRuleBasedEndpoints() {
+        return useRuleBasedEndpoints;
+    }
+
+    public void setUseRuleBasedEndpoints(boolean useRuleBasedEndpoints) {
+        this.useRuleBasedEndpoints = useRuleBasedEndpoints;
+    }
 }

codegen/src/main/java/software/amazon/awssdk/codegen/poet/builder/AsyncClientBuilderClass.java

@@ -68,7 +68,9 @@ public TypeSpec poetSpec() {
             }
         }
 
-        builder.addMethod(endpointProviderMethod());
+        if (endpointRulesSpecUtils.isEndpointRulesEnabled()) {
+            builder.addMethod(endpointProviderMethod());
+        }
 
         if (BearerAuthUtils.usesBearerAuth(model)) {
             builder.addMethod(bearerTokenProviderMethod());

codegen/src/main/java/software/amazon/awssdk/codegen/poet/builder/BaseClientBuilderClass.java

@@ -110,9 +110,11 @@ public TypeSpec poetSpec() {
         builder.addMethod(finalizeServiceConfigurationMethod());
         defaultAwsAuthSignerMethod().ifPresent(builder::addMethod);
         builder.addMethod(signingNameMethod());
-        builder.addMethod(defaultEndpointProviderMethod());
+        if (endpointRulesSpecUtils.isEndpointRulesEnabled()) {
+            builder.addMethod(defaultEndpointProviderMethod());
+        }
 
-        if (hasClientContextParams()) {
+        if (hasClientContextParams() && endpointRulesSpecUtils.isEndpointRulesEnabled()) {
             model.getClientContextParams().forEach((n, m) -> {
                 builder.addMethod(clientContextParamSetter(n, m));
             });
@@ -184,9 +186,11 @@ private MethodSpec mergeServiceDefaultsMethod() {
                                                .addModifiers(PROTECTED, FINAL)
                                                .returns(SdkClientConfiguration.class)
                                                .addParameter(SdkClientConfiguration.class, "config")
-                                               .addCode("return config.merge(c -> c")
-                                               .addCode(".option($T.ENDPOINT_PROVIDER, defaultEndpointProvider())",
-                                                        SdkClientOption.class);
+                                               .addCode("return config.merge(c -> c");
+
+        if (endpointRulesSpecUtils.isEndpointRulesEnabled()) {
+            builder.addCode(".option($T.ENDPOINT_PROVIDER, defaultEndpointProvider())", SdkClientOption.class);
+        }
 
         if (defaultAwsAuthSignerMethod().isPresent()) {
             builder.addCode(".option($T.SIGNER, defaultSigner())\n", SdkAdvancedClientOption.class);
@@ -252,9 +256,11 @@ private MethodSpec finalizeServiceConfigurationMethod() {
                              ParameterizedTypeName.get(List.class, ExecutionInterceptor.class),
                              ArrayList.class);
 
-        builder.addStatement("endpointInterceptors.add(new $T())", endpointRulesSpecUtils.resolverInterceptorName());
-        builder.addStatement("endpointInterceptors.add(new $T())", endpointRulesSpecUtils.authSchemesInterceptorName());
-        builder.addStatement("endpointInterceptors.add(new $T())", endpointRulesSpecUtils.requestModifierInterceptorName());
+        if (endpointRulesSpecUtils.isEndpointRulesEnabled()) {
+            builder.addStatement("endpointInterceptors.add(new $T())", endpointRulesSpecUtils.resolverInterceptorName());
+            builder.addStatement("endpointInterceptors.add(new $T())", endpointRulesSpecUtils.authSchemesInterceptorName());
+            builder.addStatement("endpointInterceptors.add(new $T())", endpointRulesSpecUtils.requestModifierInterceptorName());
+        }
 
         builder.addCode("$1T interceptorFactory = new $1T();\n", ClasspathInterceptorChainFactory.class)
                .addCode("$T<$T> interceptors = interceptorFactory.getInterceptors($S);\n",

codegen/src/main/java/software/amazon/awssdk/codegen/poet/builder/BaseClientBuilderInterface.java

@@ -73,12 +73,14 @@ public TypeSpec poetSpec() {
             builder.addMethod(serviceConfigurationConsumerBuilderMethod());
         }
 
-        builder.addMethod(endpointProviderMethod());
+        if (endpointRulesSpecUtils.isEndpointRulesEnabled()) {
+            builder.addMethod(endpointProviderMethod());
 
-        if (hasClientContextParams()) {
-            model.getClientContextParams().forEach((n, m) -> {
-                builder.addMethod(clientContextParamSetter(n, m));
-            });
+            if (hasClientContextParams()) {
+                model.getClientContextParams().forEach((n, m) -> {
+                    builder.addMethod(clientContextParamSetter(n, m));
+                });
+            }
         }
 
         if (generateTokenProviderMethod()) {

codegen/src/main/java/software/amazon/awssdk/codegen/poet/builder/SyncClientBuilderClass.java

@@ -68,7 +68,9 @@ public TypeSpec poetSpec() {
             }
         }
 
-        builder.addMethod(endpointProviderMethod());
+        if (endpointRulesSpecUtils.isEndpointRulesEnabled()) {
+            builder.addMethod(endpointProviderMethod());
+        }
 
         if (BearerAuthUtils.usesBearerAuth(model)) {
             builder.addMethod(tokenProviderMethodImpl());

codegen/src/main/java/software/amazon/awssdk/codegen/poet/rules/EndpointRulesSpecUtils.java

@@ -182,4 +182,8 @@ public boolean isS3Control() {
     public TypeName resolverReturnType() {
         return ParameterizedTypeName.get(CompletableFuture.class, Endpoint.class);
     }
+
+    public boolean isEndpointRulesEnabled() {
+        return intermediateModel.getCustomizationConfig().useRuleBasedEndpoints();
+    }
 }

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/builder/test-async-client-builder-class.java

@@ -4,8 +4,6 @@
 import software.amazon.awssdk.annotations.SdkInternalApi;
 import software.amazon.awssdk.auth.token.credentials.SdkTokenProvider;
 import software.amazon.awssdk.awscore.client.config.AwsClientOption;
-import software.amazon.awssdk.core.client.config.SdkClientOption;
-import software.amazon.awssdk.services.json.endpoints.JsonEndpointProvider;
 
 /**
  * Internal implementation of {@link JsonAsyncClientBuilder}.
@@ -14,12 +12,6 @@
 @SdkInternalApi
 final class DefaultJsonAsyncClientBuilder extends DefaultJsonBaseClientBuilder<JsonAsyncClientBuilder, JsonAsyncClient> implements
                                                                                                                         JsonAsyncClientBuilder {
-    @Override
-    public DefaultJsonAsyncClientBuilder endpointProvider(JsonEndpointProvider endpointProvider) {
-        clientConfiguration.option(SdkClientOption.ENDPOINT_PROVIDER, endpointProvider);
-        return this;
-    }
-
     @Override
     public DefaultJsonAsyncClientBuilder tokenProvider(SdkTokenProvider tokenProvider) {
         clientConfiguration.option(AwsClientOption.TOKEN_PROVIDER, tokenProvider);

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/builder/test-bearer-auth-client-builder-class.java

@@ -15,10 +15,6 @@
 import software.amazon.awssdk.core.interceptor.ClasspathInterceptorChainFactory;
 import software.amazon.awssdk.core.interceptor.ExecutionInterceptor;
 import software.amazon.awssdk.core.signer.Signer;
-import software.amazon.awssdk.services.json.endpoints.JsonEndpointProvider;
-import software.amazon.awssdk.services.json.endpoints.internal.JsonEndpointAuthSchemeInterceptor;
-import software.amazon.awssdk.services.json.endpoints.internal.JsonRequestSetEndpointInterceptor;
-import software.amazon.awssdk.services.json.endpoints.internal.JsonResolveEndpointInterceptor;
 import software.amazon.awssdk.utils.CollectionUtils;
 
 /**
@@ -39,18 +35,14 @@ protected final String serviceName() {
 
     @Override
     protected final SdkClientConfiguration mergeServiceDefaults(SdkClientConfiguration config) {
-        return config.merge(c -> c.option(SdkClientOption.ENDPOINT_PROVIDER, defaultEndpointProvider())
-                                  .option(SdkClientOption.CRC32_FROM_COMPRESSED_DATA_ENABLED, false)
+        return config.merge(c -> c.option(SdkClientOption.CRC32_FROM_COMPRESSED_DATA_ENABLED, false)
                                   .option(AwsClientOption.TOKEN_PROVIDER, defaultTokenProvider())
                                   .option(SdkAdvancedClientOption.TOKEN_SIGNER, defaultTokenSigner()));
     }
 
     @Override
     protected final SdkClientConfiguration finalizeServiceConfiguration(SdkClientConfiguration config) {
         List<ExecutionInterceptor> endpointInterceptors = new ArrayList<>();
-        endpointInterceptors.add(new JsonResolveEndpointInterceptor());
-        endpointInterceptors.add(new JsonEndpointAuthSchemeInterceptor());
-        endpointInterceptors.add(new JsonRequestSetEndpointInterceptor());
         ClasspathInterceptorChainFactory interceptorFactory = new ClasspathInterceptorChainFactory();
         List<ExecutionInterceptor> interceptors = interceptorFactory
             .getInterceptors("software/amazon/awssdk/services/json/execution.interceptors");
@@ -66,15 +58,11 @@ protected final String signingName() {
         return "json-service";
     }
 
-    private JsonEndpointProvider defaultEndpointProvider() {
-        return JsonEndpointProvider.defaultProvider();
-    }
-
     private SdkTokenProvider defaultTokenProvider() {
         return DefaultAwsTokenProvider.create();
     }
 
     private Signer defaultTokenSigner() {
         return BearerTokenSigner.create();
     }
-}
+}

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/builder/test-bearer-auth-client-builder-interface.java

@@ -3,20 +3,13 @@
 import software.amazon.awssdk.annotations.Generated;
 import software.amazon.awssdk.auth.token.credentials.SdkTokenProvider;
 import software.amazon.awssdk.awscore.client.builder.AwsClientBuilder;
-import software.amazon.awssdk.services.json.endpoints.JsonEndpointProvider;
 
 /**
  * This includes configuration specific to Json Service that is supported by both {@link JsonClientBuilder} and
  * {@link JsonAsyncClientBuilder}.
  */
 @Generated("software.amazon.awssdk:codegen")
 public interface JsonBaseClientBuilder<B extends JsonBaseClientBuilder<B, C>, C> extends AwsClientBuilder<B, C> {
-    /**
-     * Set the {@link JsonEndpointProvider} implementation that will be used by the client to determine the endpoint for
-     * each request. This is optional; if none is provided a default implementation will be used the SDK.
-     */
-    B endpointProvider(JsonEndpointProvider endpointProvider);
-
     /**
      * Set the token provider to use for bearer token authorization. This is optional, if none is provided, the SDK will
      * use {@link software.amazon.awssdk.auth.token.credentials.aws.DefaultAwsTokenProvider}.
@@ -29,4 +22,4 @@ public interface JsonBaseClientBuilder<B extends JsonBaseClientBuilder<B, C>, C>
      * default it is {@link software.amazon.awssdk.auth.token.signer.aws.BearerTokenSigner}.
      */
     B tokenProvider(SdkTokenProvider tokenProvider);
-}
+}

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/builder/test-client-builder-class.java

@@ -19,10 +19,6 @@
 import software.amazon.awssdk.core.interceptor.ExecutionInterceptor;
 import software.amazon.awssdk.core.signer.Signer;
 import software.amazon.awssdk.services.json.endpoints.JsonClientContextParams;
-import software.amazon.awssdk.services.json.endpoints.JsonEndpointProvider;
-import software.amazon.awssdk.services.json.endpoints.internal.JsonEndpointAuthSchemeInterceptor;
-import software.amazon.awssdk.services.json.endpoints.internal.JsonRequestSetEndpointInterceptor;
-import software.amazon.awssdk.services.json.endpoints.internal.JsonResolveEndpointInterceptor;
 import software.amazon.awssdk.utils.AttributeMap;
 import software.amazon.awssdk.utils.CollectionUtils;
 import software.amazon.awssdk.utils.Validate;
@@ -45,8 +41,7 @@ protected final String serviceName() {
 
     @Override
     protected final SdkClientConfiguration mergeServiceDefaults(SdkClientConfiguration config) {
-        return config.merge(c -> c.option(SdkClientOption.ENDPOINT_PROVIDER, defaultEndpointProvider())
-                                  .option(SdkAdvancedClientOption.SIGNER, defaultSigner())
+        return config.merge(c -> c.option(SdkAdvancedClientOption.SIGNER, defaultSigner())
                                   .option(SdkClientOption.CRC32_FROM_COMPRESSED_DATA_ENABLED, false)
                                   .option(SdkClientOption.SERVICE_CONFIGURATION, ServiceConfiguration.builder().build())
                                   .option(AwsClientOption.TOKEN_PROVIDER, defaultTokenProvider())
@@ -56,9 +51,6 @@ protected final SdkClientConfiguration mergeServiceDefaults(SdkClientConfigurati
     @Override
     protected final SdkClientConfiguration finalizeServiceConfiguration(SdkClientConfiguration config) {
         List<ExecutionInterceptor> endpointInterceptors = new ArrayList<>();
-        endpointInterceptors.add(new JsonResolveEndpointInterceptor());
-        endpointInterceptors.add(new JsonEndpointAuthSchemeInterceptor());
-        endpointInterceptors.add(new JsonRequestSetEndpointInterceptor());
         ClasspathInterceptorChainFactory interceptorFactory = new ClasspathInterceptorChainFactory();
         List<ExecutionInterceptor> interceptors = interceptorFactory
             .getInterceptors("software/amazon/awssdk/services/json/execution.interceptors");
@@ -137,10 +129,6 @@ protected final String signingName() {
         return "json-service";
     }
 
-    private JsonEndpointProvider defaultEndpointProvider() {
-        return JsonEndpointProvider.defaultProvider();
-    }
-
     public B serviceConfiguration(ServiceConfiguration serviceConfiguration) {
         clientConfiguration.option(SdkClientOption.SERVICE_CONFIGURATION, serviceConfiguration);
         return thisBuilder();

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/builder/test-client-builder-interface.java

@@ -4,7 +4,6 @@
 import software.amazon.awssdk.annotations.Generated;
 import software.amazon.awssdk.auth.token.credentials.SdkTokenProvider;
 import software.amazon.awssdk.awscore.client.builder.AwsClientBuilder;
-import software.amazon.awssdk.services.json.endpoints.JsonEndpointProvider;
 
 /**
  * This includes configuration specific to Json Service that is supported by both {@link JsonClientBuilder} and
@@ -18,12 +17,6 @@ default B serviceConfiguration(Consumer<ServiceConfiguration.Builder> serviceCon
         return serviceConfiguration(ServiceConfiguration.builder().applyMutation(serviceConfiguration).build());
     }
 
-    /**
-     * Set the {@link JsonEndpointProvider} implementation that will be used by the client to determine the endpoint for
-     * each request. This is optional; if none is provided a default implementation will be used the SDK.
-     */
-    B endpointProvider(JsonEndpointProvider endpointProvider);
-
     /**
      * Set the token provider to use for bearer token authorization. This is optional, if none is provided, the SDK will
      * use {@link software.amazon.awssdk.auth.token.credentials.aws.DefaultAwsTokenProvider}.

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/builder/test-client-builder-internal-defaults-class.java

@@ -13,10 +13,6 @@
 import software.amazon.awssdk.core.interceptor.ExecutionInterceptor;
 import software.amazon.awssdk.core.retry.RetryMode;
 import software.amazon.awssdk.core.signer.Signer;
-import software.amazon.awssdk.services.json.endpoints.JsonEndpointProvider;
-import software.amazon.awssdk.services.json.endpoints.internal.JsonEndpointAuthSchemeInterceptor;
-import software.amazon.awssdk.services.json.endpoints.internal.JsonRequestSetEndpointInterceptor;
-import software.amazon.awssdk.services.json.endpoints.internal.JsonResolveEndpointInterceptor;
 import software.amazon.awssdk.utils.CollectionUtils;
 
 /**
@@ -37,9 +33,8 @@ protected final String serviceName() {
 
     @Override
     protected final SdkClientConfiguration mergeServiceDefaults(SdkClientConfiguration config) {
-        return config.merge(c -> c.option(SdkClientOption.ENDPOINT_PROVIDER, defaultEndpointProvider())
-                                  .option(SdkAdvancedClientOption.SIGNER, defaultSigner())
-                                  .option(SdkClientOption.CRC32_FROM_COMPRESSED_DATA_ENABLED, false));
+        return config.merge(c -> c.option(SdkAdvancedClientOption.SIGNER, defaultSigner()).option(
+            SdkClientOption.CRC32_FROM_COMPRESSED_DATA_ENABLED, false));
     }
 
     @Override
@@ -53,9 +48,6 @@ protected final SdkClientConfiguration mergeInternalDefaults(SdkClientConfigurat
     @Override
     protected final SdkClientConfiguration finalizeServiceConfiguration(SdkClientConfiguration config) {
         List<ExecutionInterceptor> endpointInterceptors = new ArrayList<>();
-        endpointInterceptors.add(new JsonResolveEndpointInterceptor());
-        endpointInterceptors.add(new JsonEndpointAuthSchemeInterceptor());
-        endpointInterceptors.add(new JsonRequestSetEndpointInterceptor());
         ClasspathInterceptorChainFactory interceptorFactory = new ClasspathInterceptorChainFactory();
         List<ExecutionInterceptor> interceptors = interceptorFactory
             .getInterceptors("software/amazon/awssdk/services/json/execution.interceptors");
@@ -74,8 +66,4 @@ private Signer defaultSigner() {
     protected final String signingName() {
         return "json-service";
     }
-
-    private JsonEndpointProvider defaultEndpointProvider() {
-        return JsonEndpointProvider.defaultProvider();
-    }
 }