Endpoint discovery is now enabled by default for future services that will require it

Author: bmaizels

.changes/next-release/feature-AWSSDKforJavav2-534a8f5.json

@@ -0,0 +1,5 @@
+{
+    "type": "feature",
+    "category": "AWS SDK for Java v2",
+    "description": "Endpoint discovery is now enabled by default for future services that will require it. A new method 'endpointDiscoveryEnabled' has been added to client builders that support endpoint discovery allowing a true or false value to be set. 'enableEndpointDiscovery' has been deprecated on the client builders as it is now superseded by 'endpointDiscoveryEnabled'."
+}

codegen/src/main/java/software/amazon/awssdk/codegen/IntermediateModelBuilder.java

@@ -106,13 +106,25 @@ public IntermediateModel build() {
         Map<String, AuthorizerModel> authorizers =
             new HashMap<>(new AddCustomAuthorizers(this.service, getNamingStrategy()).constructAuthorizers());
 
+        // Iterate through every operation and build an 'endpointOperation' if at least one operation that supports
+        // endpoint discovery is found. If -any operations that require- endpoint discovery are found, then the flag
+        // 'endpointCacheRequired' will be set on the 'endpointOperation'. This 'endpointOperation' summary is then
+        // passed directly into the constructor of the intermediate model and is referred to by the codegen.
         OperationModel endpointOperation = null;
+        boolean endpointCacheRequired = false;
 
         for (OperationModel o : operations.values()) {
             if (o.isEndpointOperation()) {
                 endpointOperation = o;
-                break;
             }
+
+            if (o.getEndpointDiscovery() != null && o.getEndpointDiscovery().isRequired()) {
+                endpointCacheRequired = true;
+            }
+        }
+
+        if (endpointOperation != null) {
+            endpointOperation.setEndpointCacheRequired(endpointCacheRequired);
         }
 
         for (IntermediateModelShapeProcessor processor : shapeProcessors) {

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

@@ -159,6 +159,12 @@ public class CustomizationConfig {
      */
     private UtilitiesMethod utilitiesMethod;
 
+    /**
+     * Force generation of deprecated client builder method 'enableEndpointDiscovery'. Only services that already had
+     * this method when it was deprecated require this flag to be set.
+     */
+    private boolean enableEndpointDiscoveryMethodRequired = false;
+
     private CustomizationConfig() {
     }
 
@@ -406,4 +412,12 @@ public UtilitiesMethod getUtilitiesMethod() {
     public void setUtilitiesMethod(UtilitiesMethod utilitiesMethod) {
         this.utilitiesMethod = utilitiesMethod;
     }
+
+    public boolean isEnableEndpointDiscoveryMethodRequired() {
+        return enableEndpointDiscoveryMethodRequired;
+    }
+
+    public void setEnableEndpointDiscoveryMethodRequired(boolean enableEndpointDiscoveryMethodRequired) {
+        this.enableEndpointDiscoveryMethodRequired = enableEndpointDiscoveryMethodRequired;
+    }
 }

codegen/src/main/java/software/amazon/awssdk/codegen/model/intermediate/OperationModel.java

@@ -50,6 +50,8 @@ public class OperationModel extends DocumentationModel {
 
     private boolean endpointOperation;
 
+    private boolean endpointCacheRequired;
+
     private EndpointDiscovery endpointDiscovery;
 
     @JsonIgnore
@@ -207,6 +209,14 @@ public void setEndpointOperation(boolean endpointOperation) {
         this.endpointOperation = endpointOperation;
     }
 
+    public boolean isEndpointCacheRequired() {
+        return endpointCacheRequired;
+    }
+
+    public void setEndpointCacheRequired(boolean endpointCacheRequired) {
+        this.endpointCacheRequired = endpointCacheRequired;
+    }
+
     public boolean isPaginated() {
         return isPaginated;
     }

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

@@ -54,15 +54,32 @@ public TypeSpec poetSpec() {
                          .addJavadoc("Internal implementation of {@link $T}.", builderInterfaceName);
 
         if (model.getEndpointOperation().isPresent()) {
-            builder.addMethod(enableEndpointDiscovery());
+            builder.addMethod(endpointDiscoveryEnabled());
+
+            if (model.getCustomizationConfig().isEnableEndpointDiscoveryMethodRequired()) {
+                builder.addMethod(enableEndpointDiscovery());
+            }
         }
 
         return builder.addMethod(buildClientMethod()).build();
     }
 
+    private MethodSpec endpointDiscoveryEnabled() {
+        return MethodSpec.methodBuilder("endpointDiscoveryEnabled")
+                         .addAnnotation(Override.class)
+                         .addModifiers(Modifier.PUBLIC)
+                         .returns(builderClassName)
+                         .addParameter(boolean.class, "endpointDiscoveryEnabled")
+                         .addStatement("this.endpointDiscoveryEnabled = endpointDiscoveryEnabled")
+                         .addStatement("return this")
+                         .build();
+    }
+
     private MethodSpec enableEndpointDiscovery() {
         return MethodSpec.methodBuilder("enableEndpointDiscovery")
                          .addAnnotation(Override.class)
+                         .addAnnotation(Deprecated.class)
+                         .addJavadoc("@deprecated Use {@link #endpointDiscoveryEnabled($T)} instead.", boolean.class)
                          .addModifiers(Modifier.PUBLIC)
                          .returns(builderClassName)
                          .addStatement("endpointDiscoveryEnabled = true")

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

@@ -35,6 +35,7 @@
 import software.amazon.awssdk.awscore.client.builder.AwsDefaultClientBuilder;
 import software.amazon.awssdk.codegen.internal.Utils;
 import software.amazon.awssdk.codegen.model.intermediate.IntermediateModel;
+import software.amazon.awssdk.codegen.model.intermediate.OperationModel;
 import software.amazon.awssdk.codegen.model.service.AuthType;
 import software.amazon.awssdk.codegen.poet.ClassSpec;
 import software.amazon.awssdk.codegen.poet.PoetUtils;
@@ -78,10 +79,12 @@ public TypeSpec poetSpec() {
                                      ClassName.get(basePackage, model.getMetadata().getSyncBuilder()),
                                      ClassName.get(basePackage, model.getMetadata().getAsyncBuilder()));
 
+        // Only services that require endpoint discovery for at least one of their operations get a default value of
+        // 'true'
         if (model.getEndpointOperation().isPresent()) {
             builder.addField(FieldSpec.builder(boolean.class, "endpointDiscoveryEnabled")
                                       .addModifiers(PROTECTED)
-                                      .initializer("false")
+                                      .initializer(resolveDefaultEndpointDiscovery() ? "true" : "false")
                                       .build());
         }
 
@@ -102,6 +105,12 @@ public TypeSpec poetSpec() {
         return builder.build();
     }
 
+    private boolean resolveDefaultEndpointDiscovery() {
+        return model.getEndpointOperation()
+                    .map(OperationModel::isEndpointCacheRequired)
+                    .orElse(false);
+    }
+
     private MethodSpec signingNameMethod() {
         return MethodSpec.methodBuilder("signingName")
                          .addAnnotation(Override.class)

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

@@ -50,7 +50,11 @@ public TypeSpec poetSpec() {
                         .addJavadoc(getJavadoc());
 
         if (model.getEndpointOperation().isPresent()) {
-            builder.addMethod(enableEndpointDiscovery());
+            if (model.getCustomizationConfig().isEnableEndpointDiscoveryMethodRequired()) {
+                builder.addMethod(enableEndpointDiscovery());
+            }
+
+            builder.addMethod(endpointDiscovery());
         }
 
         if (model.getCustomizationConfig().getServiceSpecificClientConfigClass() != null) {
@@ -72,6 +76,16 @@ private MethodSpec enableEndpointDiscovery() {
         return MethodSpec.methodBuilder("enableEndpointDiscovery")
                          .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
                          .returns(TypeVariableName.get("B"))
+                         .addAnnotation(Deprecated.class)
+                         .addJavadoc("@deprecated Use {@link #endpointDiscoveryEnabled($T)} instead.", boolean.class)
+                         .build();
+    }
+
+    private MethodSpec endpointDiscovery() {
+        return MethodSpec.methodBuilder("endpointDiscoveryEnabled")
+                         .addModifiers(Modifier.PUBLIC, Modifier.ABSTRACT)
+                         .returns(TypeVariableName.get("B"))
+                         .addParameter(boolean.class, "endpointDiscovery")
                          .build();
     }
 

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

@@ -54,15 +54,32 @@ public TypeSpec poetSpec() {
                          .addJavadoc("Internal implementation of {@link $T}.", builderInterfaceName);
 
         if (model.getEndpointOperation().isPresent()) {
-            builder.addMethod(enableEndpointDiscovery());
+            builder.addMethod(endpointDiscoveryEnabled());
+
+            if (model.getCustomizationConfig().isEnableEndpointDiscoveryMethodRequired()) {
+                builder.addMethod(enableEndpointDiscovery());
+            }
         }
 
         return builder.addMethod(buildClientMethod()).build();
     }
 
+    private MethodSpec endpointDiscoveryEnabled() {
+        return MethodSpec.methodBuilder("endpointDiscoveryEnabled")
+                         .addAnnotation(Override.class)
+                         .addModifiers(Modifier.PUBLIC)
+                         .returns(builderClassName)
+                         .addParameter(boolean.class, "endpointDiscoveryEnabled")
+                         .addStatement("this.endpointDiscoveryEnabled = endpointDiscoveryEnabled")
+                         .addStatement("return this")
+                         .build();
+    }
+
     private MethodSpec enableEndpointDiscovery() {
         return MethodSpec.methodBuilder("enableEndpointDiscovery")
                          .addAnnotation(Override.class)
+                         .addAnnotation(Deprecated.class)
+                         .addJavadoc("@deprecated Use {@link #endpointDiscoveryEnabled($T)} instead.", boolean.class)
                          .addModifiers(Modifier.PUBLIC)
                          .returns(builderClassName)
                          .addStatement("endpointDiscoveryEnabled = true")

codegen/src/test/java/software/amazon/awssdk/codegen/IntermediateModelBuilderTest.java

@@ -17,6 +17,8 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
 
 import java.io.File;
 import org.junit.Test;
@@ -59,4 +61,32 @@ public void sharedOutputShapesLinkCorrectlyToOperationOutputs() {
         assertEquals("SecurePingResponse", testModel.getOperation("SecurePing").getOutputShape().getShapeName());
     }
 
+    @Test
+    public void defaultEndpointDiscovery_true() {
+        final File modelFile = new File(IntermediateModelBuilderTest.class
+                                            .getResource("poet/client/c2j/endpointdiscovery/service-2.json").getFile());
+        IntermediateModel testModel = new IntermediateModelBuilder(
+            C2jModels.builder()
+                     .serviceModel(ModelLoaderUtils.loadModel(ServiceModel.class, modelFile))
+                     .customizationConfig(CustomizationConfig.create())
+                     .build())
+            .build();
+
+        assertTrue(testModel.getEndpointOperation().get().isEndpointCacheRequired());
+    }
+
+    @Test
+    public void defaultEndpointDiscovery_false() {
+        final File modelFile = new File(IntermediateModelBuilderTest.class
+                                            .getResource("poet/client/c2j/endpointdiscoveryoptional/service-2.json").getFile());
+        IntermediateModel testModel = new IntermediateModelBuilder(
+            C2jModels.builder()
+                     .serviceModel(ModelLoaderUtils.loadModel(ServiceModel.class, modelFile))
+                     .customizationConfig(CustomizationConfig.create())
+                     .build())
+            .build();
+
+        assertFalse(testModel.getEndpointOperation().get().isEndpointCacheRequired());
+    }
+
 }

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/c2j/endpointdiscoveryoptional/customization.config

@@ -0,0 +1,2 @@
+{
+}

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/c2j/endpointdiscoveryoptional/service-2.json

@@ -0,0 +1,134 @@
+{
+  "version":"2.0",
+  "metadata":{
+    "apiVersion":"2018-08-31",
+    "endpointPrefix":"awsendpointdiscoverytestservice",
+    "jsonVersion":"1.1",
+    "protocol":"json",
+    "serviceAbbreviation":"AwsEndpointDiscoveryTest",
+    "serviceFullName":"AwsEndpointDiscoveryTest",
+    "serviceId":"AwsEndpointDiscoveryTest",
+    "signatureVersion":"v4",
+    "signingName":"awsendpointdiscoverytestservice",
+    "targetPrefix":"AwsEndpointDiscoveryTestService"
+  },
+  "operations":{
+    "DescribeEndpoints":{
+      "name":"DescribeEndpoints",
+      "http":{
+        "method":"POST",
+        "requestUri":"/"
+      },
+      "input":{"shape":"DescribeEndpointsRequest"},
+      "output":{"shape":"DescribeEndpointsResponse"},
+      "endpointoperation":true
+    },
+    "TestDiscoveryOptional":{
+      "name":"TestDiscoveryOptional",
+      "http":{
+        "method":"POST",
+        "requestUri":"/"
+      },
+      "input":{"shape":"TestDiscoveryOptionalRequest"},
+      "output":{"shape":"TestDiscoveryOptionalResponse"},
+      "endpointdiscovery":{
+      }
+    }
+  },
+  "shapes": {
+    "Boolean": {
+      "type": "boolean"
+    },
+    "DescribeEndpointsRequest": {
+      "type": "structure",
+      "members": {
+        "Operation": {
+          "shape": "String"
+        },
+        "Identifiers": {
+          "shape": "Identifiers"
+        }
+      }
+    },
+    "DescribeEndpointsResponse": {
+      "type": "structure",
+      "required": [
+        "Endpoints"
+      ],
+      "members": {
+        "Endpoints": {
+          "shape": "Endpoints"
+        }
+      }
+    },
+    "Endpoint": {
+      "type": "structure",
+      "required": [
+        "Address",
+        "CachePeriodInMinutes"
+      ],
+      "members": {
+        "Address": {
+          "shape": "String"
+        },
+        "CachePeriodInMinutes": {
+          "shape": "Long"
+        }
+      }
+    },
+    "Endpoints": {
+      "type": "list",
+      "member": {
+        "shape": "Endpoint"
+      }
+    },
+    "Identifiers": {
+      "type": "map",
+      "key": {
+        "shape": "String"
+      },
+      "value": {
+        "shape": "String"
+      }
+    },
+    "Long": {
+      "type": "long"
+    },
+    "String": {
+      "type": "string"
+    },
+    "TestDiscoveryIdentifiersRequiredRequest": {
+      "type": "structure",
+      "required": [
+        "Sdk"
+      ],
+      "members": {
+        "Sdk": {
+          "shape": "String",
+          "endpointdiscoveryid": true
+        }
+      }
+    },
+    "TestDiscoveryIdentifiersRequiredResponse": {
+      "type": "structure",
+      "members": {
+        "DiscoveredEndpoint": {
+          "shape": "Boolean"
+        }
+      }
+    },
+    "TestDiscoveryOptionalRequest": {
+      "type": "structure",
+      "members": {
+      }
+    },
+    "TestDiscoveryOptionalResponse": {
+      "type": "structure",
+      "members": {
+        "DiscoveredEndpoint": {
+          "shape": "Boolean"
+        }
+      }
+    }
+  }
+}