Changed extension naming to strict names instead of inference (#3069)

cenedhryn · web-flow · commit 61e51b05d3e1 · 2022-03-02T12:45:56.000-08:00
diff --git a/codegen/src/main/java/software/amazon/awssdk/codegen/model/config/customization/ClientExtensions.java b/codegen/src/main/java/software/amazon/awssdk/codegen/model/config/customization/ClientExtensions.java
@@ -0,0 +1,42 @@
+/*
+ * 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.codegen.model.config.customization;
+
+/**
+ * Whether the service has API extensions defined apart from the service model.
+ */
+public class ClientExtensions {
+
+    private boolean sync = false;
+    private boolean async = false;
+
+    public boolean getSync() {
+        return sync;
+    }
+
+    public void setSync(boolean sync) {
+        this.sync = sync;
+    }
+
+    public boolean getAsync() {
+        return async;
+    }
+
+    public void setAsync(boolean async) {
+        this.async = async;
+    }
+
+}
diff --git a/codegen/src/main/java/software/amazon/awssdk/codegen/model/config/customization/CustomizationConfig.java b/codegen/src/main/java/software/amazon/awssdk/codegen/model/config/customization/CustomizationConfig.java
@@ -197,10 +197,9 @@ public class CustomizationConfig {
     private RetryMode defaultRetryMode;
 
     /**
-     * The name of the interface that the client interface should extend.
+     * If the client has API extensions to include.
      */
-    private String extensionInterface;
-
+    private ClientExtensions clientExtensions;
 
     private CustomizationConfig() {
     }
@@ -507,11 +506,11 @@ public void setServiceConfig(ServiceConfig serviceConfig) {
         this.serviceConfig = serviceConfig;
     }
 
-    public String getExtensionInterface() {
-        return extensionInterface;
+    public ClientExtensions getClientExtensions() {
+        return clientExtensions;
     }
 
-    public void setExtensionInterface(String extensionInterface) {
-        this.extensionInterface = extensionInterface;
+    public void setClientExtensions(ClientExtensions clientExtensions) {
+        this.clientExtensions = clientExtensions;
     }
 }
diff --git a/codegen/src/main/java/software/amazon/awssdk/codegen/poet/PoetUtils.java b/codegen/src/main/java/software/amazon/awssdk/codegen/poet/PoetUtils.java
@@ -15,7 +15,6 @@
 
 package software.amazon.awssdk.codegen.poet;
 
-import static software.amazon.awssdk.utils.StringUtils.isEmpty;
 import static software.amazon.awssdk.utils.StringUtils.isNotBlank;
 
 import com.squareup.javapoet.AnnotationSpec;
@@ -27,24 +26,21 @@
 import com.squareup.javapoet.TypeSpec;
 import com.squareup.javapoet.TypeVariableName;
 import java.util.Arrays;
-import java.util.Optional;
 import java.util.function.Consumer;
 import javax.lang.model.element.Modifier;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import software.amazon.awssdk.annotations.Generated;
-import software.amazon.awssdk.codegen.model.config.customization.CustomizationConfig;
 import software.amazon.awssdk.codegen.model.intermediate.DocumentationModel;
 import software.amazon.awssdk.codegen.model.intermediate.HasDeprecation;
 
 public final class PoetUtils {
 
-    private static final Logger log = LoggerFactory.getLogger(PoetUtils.class);
-
     private static final AnnotationSpec GENERATED = AnnotationSpec.builder(Generated.class)
                                                                   .addMember("value", "$S", "software.amazon.awssdk:codegen")
                                                                   .build();
 
+    private static final String EXTENSION_PACKAGE = ".extensions";
+    private static final String EXTENSION_INTERFACE_SUFFIX = "SdkExtension";
+
     private PoetUtils() {
     }
 
@@ -117,21 +113,9 @@ public static JavaFile buildJavaFile(ClassSpec spec) {
         return builder.build();
     }
 
-    public static Optional<ClassName> findExtensionInterface(ClassName clientInterfaceName,
-                                                             CustomizationConfig customizationConfig) {
-        String extensionInterfaceFqcn = customizationConfig.getExtensionInterface();
-
-        if (!isEmpty(extensionInterfaceFqcn)) {
-            ClassName interfaceName = classNameFromFqcn(extensionInterfaceFqcn);
-            log.info(String.format("Found client extension interface %s.", interfaceName));
-            if (!interfaceName.packageName().contains(clientInterfaceName.packageName())) {
-                throw new IllegalArgumentException(
-                    String.format("Extension interface package is not part of service client package. "
-                                  + "Client package: %s. Extension interface package: %s",
-                                  clientInterfaceName.packageName(), interfaceName.packageName()));
-            }
-            return Optional.of(interfaceName);
-        }
-        return Optional.empty();
+    public static ClassName extensionInterfaceClassName(ClassName clientInterfaceName) {
+        String packageName = clientInterfaceName.packageName() + EXTENSION_PACKAGE;
+        String className = clientInterfaceName.simpleName() + EXTENSION_INTERFACE_SUFFIX;
+        return ClassName.get(packageName, className);
     }
 }
diff --git a/codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/SyncClientInterface.java b/codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/SyncClientInterface.java
@@ -19,6 +19,7 @@
 import static java.util.stream.Collectors.toList;
 import static software.amazon.awssdk.codegen.internal.Constant.SYNC_CLIENT_DESTINATION_PATH_PARAM_NAME;
 import static software.amazon.awssdk.codegen.internal.Constant.SYNC_CLIENT_SOURCE_PATH_PARAM_NAME;
+import static software.amazon.awssdk.codegen.poet.PoetUtils.extensionInterfaceClassName;
 import static software.amazon.awssdk.codegen.poet.client.AsyncClientInterface.STREAMING_TYPE_VARIABLE;
 
 import com.squareup.javapoet.ClassName;
@@ -43,6 +44,8 @@
 import software.amazon.awssdk.codegen.docs.DocConfiguration;
 import software.amazon.awssdk.codegen.docs.SimpleMethodOverload;
 import software.amazon.awssdk.codegen.docs.WaiterDocs;
+import software.amazon.awssdk.codegen.model.config.customization.ClientExtensions;
+import software.amazon.awssdk.codegen.model.config.customization.CustomizationConfig;
 import software.amazon.awssdk.codegen.model.config.customization.UtilitiesMethod;
 import software.amazon.awssdk.codegen.model.intermediate.IntermediateModel;
 import software.amazon.awssdk.codegen.model.intermediate.OperationModel;
@@ -94,7 +97,7 @@ public TypeSpec poetSpec() {
                                               ServiceMetadataProvider.class)
                                   .build());
 
-        Optional<ClassName> extensionClass = PoetUtils.findExtensionInterface(className, model.getCustomizationConfig());
+        Optional<ClassName> extensionClass = findExtensionInterface(className, model.getCustomizationConfig());
         extensionClass.ifPresent(result::addSuperinterface);
 
         PoetUtils.addJavadoc(result::addJavadoc, getJavadoc());
@@ -506,4 +509,14 @@ private MethodSpec waiterMethod() {
                          .addJavadoc(WaiterDocs.waiterMethodInClient(poetExtensions.getSyncWaiterInterface()))
                          .build();
     }
+
+    private static Optional<ClassName> findExtensionInterface(ClassName clientInterfaceName,
+                                                              CustomizationConfig customizationConfig) {
+        ClientExtensions clientExtensions = customizationConfig.getClientExtensions();
+
+        if (clientExtensions != null && clientExtensions.getSync()) {
+            return Optional.of(extensionInterfaceClassName(clientInterfaceName));
+        }
+        return Optional.empty();
+    }
 }
diff --git a/codegen/src/test/java/software/amazon/awssdk/codegen/poet/utils/PoetUtilsTest.java b/codegen/src/test/java/software/amazon/awssdk/codegen/poet/utils/PoetUtilsTest.java
@@ -23,7 +23,6 @@
 import org.junit.jupiter.api.Test;
 import software.amazon.awssdk.codegen.model.config.customization.CustomizationConfig;
 import software.amazon.awssdk.codegen.poet.PoetUtils;
-import software.amazon.awssdk.codegen.poet.client.SyncClientInterface;
 
 /**
  * Validate functionality of {@link PoetUtils} methods.
@@ -32,29 +31,11 @@ public class PoetUtilsTest {
 
     @Test
     public void findExtensionInterface_whenNotExists_returnEmpty() {
-        ClassName cl = ClassName.get("software.amazon.awssdk.sdkservice", "SdkServiceClient");
-        CustomizationConfig customizationConfig = CustomizationConfig.create();
-        Optional<ClassName> extensionClass = PoetUtils.findExtensionInterface(cl, customizationConfig);
-        assertThat(extensionClass).isEmpty();
+        ClassName clientName = ClassName.get("software.amazon.awssdk.sdkservice", "SdkServiceClient");
+        ClassName extensionClass = PoetUtils.extensionInterfaceClassName(clientName);
+        assertThat(extensionClass).isNotNull();
+        assertThat(extensionClass.canonicalName())
+            .isEqualTo("software.amazon.awssdk.sdkservice.extensions.SdkServiceClientSdkExtension");
     }
 
-    @Test
-    public void findExtensionInterface_whenExists_returnClass() {
-        ClassName cl = ClassName.get("software.amazon.awssdk.sdkservice","SdkServiceClient");
-        CustomizationConfig customizationConfig = CustomizationConfig.create();
-        customizationConfig.setExtensionInterface("software.amazon.awssdk.sdkservice.SdkServiceClientExtensionMethods");
-        Optional<ClassName> extensionClass = PoetUtils.findExtensionInterface(cl, customizationConfig);
-        assertThat(extensionClass).isPresent();
-        assertThat(extensionClass.get().canonicalName()).isEqualTo("software.amazon.awssdk.sdkservice.SdkServiceClientExtensionMethods");
-    }
-
-    @Test
-    public void findExtensionInterface_differentPackages_throwsException() {
-        ClassName cl = ClassName.get("software.amazon.awssdk.sdkservice","SdkServiceClient");
-        CustomizationConfig customizationConfig = CustomizationConfig.create();
-        customizationConfig.setExtensionInterface("software.amazon.awssdk.someotherpackage.SdkServiceClientExtensionMethods");
-        assertThatThrownBy(() -> PoetUtils.findExtensionInterface(cl, customizationConfig))
-            .isInstanceOf(IllegalArgumentException.class)
-            .hasMessageContaining("package");
-    }
 }
diff --git a/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/c2j/clientextensions/customization.config b/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/c2j/clientextensions/customization.config
@@ -1,3 +1,5 @@
 {
-  "extensionInterface": "software.amazon.awssdk.services.sdkextensions.extensions.SdkExtensionsClientExtensionMethods"
+    "clientExtensions": {
+      "sync": true
+    }
 }
diff --git a/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-clientextensions-sync-interface.java b/codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/test-clientextensions-sync-interface.java
@@ -8,7 +8,7 @@
 import software.amazon.awssdk.core.SdkClient;
 import software.amazon.awssdk.core.exception.SdkClientException;
 import software.amazon.awssdk.regions.ServiceMetadata;
-import software.amazon.awssdk.services.sdkextensions.extensions.SdkExtensionsClientExtensionMethods;
+import software.amazon.awssdk.services.sdkextensions.extensions.SdkExtensionsClientSdkExtension;
 import software.amazon.awssdk.services.sdkextensions.model.OneOperationRequest;
 import software.amazon.awssdk.services.sdkextensions.model.OneOperationResponse;
 import software.amazon.awssdk.services.sdkextensions.model.SdkExtensionsException;
@@ -21,7 +21,7 @@
 @Generated("software.amazon.awssdk:codegen")
 @SdkPublicApi
 @ThreadSafe
-public interface SdkExtensionsClient extends SdkClient, SdkExtensionsClientExtensionMethods {
+public interface SdkExtensionsClient extends SdkClient, SdkExtensionsClientSdkExtension {
     String SERVICE_NAME = "clientextensions";
 
     /**
diff --git a/services/s3/src/main/resources/codegen-resources/customization.config b/services/s3/src/main/resources/codegen-resources/customization.config
@@ -160,5 +160,7 @@
       "clientConfiguration"
     ]
   },
-  "extensionInterface": "software.amazon.awssdk.services.s3.extensions.S3ClientExtensionMethods"
+  "clientExtensions": {
+    "sync": true
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -197,10 +197,9 @@ public class CustomizationConfig {`
`197`	`197`	`private RetryMode defaultRetryMode;`
`198`	`198`
`199`	`199`	`/**`
`200`		`- * The name of the interface that the client interface should extend.`
	`200`	`+ * If the client has API extensions to include.`
`201`	`201`	`*/`
`202`		`- private String extensionInterface;`
`203`		`-`
	`202`	`+ private ClientExtensions clientExtensions;`
`204`	`203`
`205`	`204`	`private CustomizationConfig() {`
`206`	`205`	`}`
`@@ -507,11 +506,11 @@ public void setServiceConfig(ServiceConfig serviceConfig) {`
`507`	`506`	`this.serviceConfig = serviceConfig;`
`508`	`507`	`}`
`509`	`508`
`510`		`- public String getExtensionInterface() {`
`511`		`- return extensionInterface;`
	`509`	`+ public ClientExtensions getClientExtensions() {`
	`510`	`+ return clientExtensions;`
`512`	`511`	`}`
`513`	`512`
`514`		`- public void setExtensionInterface(String extensionInterface) {`
`515`		`- this.extensionInterface = extensionInterface;`
	`513`	`+ public void setClientExtensions(ClientExtensions clientExtensions) {`
	`514`	`+ this.clientExtensions = clientExtensions;`
`516`	`515`	`}`
`517`	`516`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
`1`	`1`	`{`
`2`		`- "extensionInterface": "software.amazon.awssdk.services.sdkextensions.extensions.SdkExtensionsClientExtensionMethods"`
	`2`	`+ "clientExtensions": {`
	`3`	`+ "sync": true`
	`4`	`+ }`
`3`	`5`	`}`
Original file line number	Diff line number	Diff line change
`@@ -160,5 +160,7 @@`
`160`	`160`	`"clientConfiguration"`
`161`	`161`	`]`
`162`	`162`	`},`
`163`		`- "extensionInterface": "software.amazon.awssdk.services.s3.extensions.S3ClientExtensionMethods"`
	`163`	`+ "clientExtensions": {`
	`164`	`+ "sync": true`
	`165`	`+ }`
`164`	`166`	`}`