AWS Query protocol to Json Protcol migration compatibility, support for awsQueryError metadata trait (#3442)

* Parse custom error error for AwsJson support

Author: ziyanli-amazon

.changes/next-release/feature-core-cced62e.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "AWS SDK for Java v2",
+    "contributor": "ziyanli-amazon",
+    "description": "Support for clients with AWS Query protocol migrating towards AwsJson in order to support custom error codes."
+}

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

@@ -77,7 +77,8 @@ public static Metadata constructMetadata(ServiceModel serviceModel,
                 .withUid(serviceMetadata.getUid())
                 .withServiceId(serviceMetadata.getServiceId())
                 .withSupportsH2(supportsH2(serviceMetadata))
-                .withJsonVersion(getJsonVersion(metadata, serviceMetadata));
+                .withJsonVersion(getJsonVersion(metadata, serviceMetadata))
+                .withAwsQueryCompatible(serviceMetadata.getAwsQueryCompatible());
 
         return metadata;
     }

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

@@ -15,6 +15,7 @@
 
 package software.amazon.awssdk.codegen.model.intermediate;
 
+import java.util.Map;
 import software.amazon.awssdk.awscore.exception.AwsErrorDetails;
 import software.amazon.awssdk.codegen.model.service.AuthType;
 import software.amazon.awssdk.utils.StringUtils;
@@ -83,6 +84,8 @@ public class Metadata {
 
     private String jsonVersion;
 
+    private Map<String, String> awsQueryCompatible;
+
     private String endpointPrefix;
 
     private String signingName;
@@ -103,6 +106,7 @@ public class Metadata {
 
     private String serviceId;
 
+
     public String getApiVersion() {
         return apiVersion;
     }
@@ -505,6 +509,19 @@ public Metadata withJsonVersion(String jsonVersion) {
         return this;
     }
 
+    public Map<String, String> getAwsQueryCompatible() {
+        return awsQueryCompatible;
+    }
+
+    public void setAwsQueryCompatible(Map<String, String> awsQueryCompatible) {
+        this.awsQueryCompatible = awsQueryCompatible;
+    }
+
+    public Metadata withAwsQueryCompatible(Map<String, String> awsQueryCompatible) {
+        setAwsQueryCompatible(awsQueryCompatible);
+        return this;
+    }
+
     public boolean isCborProtocol() {
         return protocol == Protocol.CBOR;
     }

codegen/src/main/java/software/amazon/awssdk/codegen/model/service/ServiceMetadata.java

@@ -37,6 +37,8 @@ public class ServiceMetadata {
 
     private String jsonVersion;
 
+    private Map<String, String> awsQueryCompatible;
+
     private boolean resultWrapped;
 
     private String signatureVersion;
@@ -114,6 +116,14 @@ public void setJsonVersion(String jsonVersion) {
         this.jsonVersion = jsonVersion;
     }
 
+    public Map<String, String> getAwsQueryCompatible() {
+        return awsQueryCompatible;
+    }
+
+    public void setAwsQueryCompatible(Map<String, String> awsQueryCompatible) {
+        this.awsQueryCompatible = awsQueryCompatible;
+    }
+
     public boolean isResultWrapped() {
         return resultWrapped;
     }

codegen/src/main/java/software/amazon/awssdk/codegen/poet/client/specs/JsonProtocolSpec.java

@@ -96,7 +96,6 @@ public MethodSpec initProtocolFactory(IntermediateModel model) {
                       .addCode(".protocolVersion($S)\n", metadata.getJsonVersion())
                       .addCode("$L", customErrorCodeFieldName());
 
-
         String contentType = Optional.ofNullable(model.getCustomizationConfig().getCustomServiceMetadata())
                 .map(MetadataConfig::getContentType)
                 .orElse(metadata.getContentType());
@@ -105,6 +104,10 @@ public MethodSpec initProtocolFactory(IntermediateModel model) {
             methodSpec.addCode(".contentType($S)", contentType);
         }
 
+        if (metadata.getAwsQueryCompatible() != null) {
+            methodSpec.addCode("$L", hasAwsQueryCompatible());
+        }
+
         registerModeledExceptions(model, poetExtensions).forEach(methodSpec::addCode);
         methodSpec.addCode(";");
 
@@ -117,6 +120,10 @@ private CodeBlock customErrorCodeFieldName() {
                CodeBlock.of(".customErrorCodeFieldName($S)", model.getCustomizationConfig().getCustomErrorCodeFieldName());
     }
 
+    private CodeBlock hasAwsQueryCompatible() {
+        return CodeBlock.of(".hasAwsQueryCompatible($L)", model.getMetadata().getAwsQueryCompatible() != null);
+    }
+
     private Class<?> protocolFactoryClass() {
         if (model.getMetadata().isCborProtocol()) {
             return AwsCborProtocolFactory.class;

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

@@ -19,6 +19,7 @@
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertTrue;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
 
 import java.io.File;
 import org.junit.jupiter.api.Test;
@@ -89,4 +90,18 @@ public void defaultEndpointDiscovery_false() {
         assertFalse(testModel.getEndpointOperation().get().isEndpointCacheRequired());
     }
 
+    @Test
+    public void assertAwsQueryCompatibleTrait_notNull() {
+        final File modelFile = new File(IntermediateModelBuilderTest.class
+                                            .getResource("poet/client/c2j/query-to-json-errorcode/service-2.json").getFile());
+        IntermediateModel testModel = new IntermediateModelBuilder(
+            C2jModels.builder()
+                     .serviceModel(ModelLoaderUtils.loadModel(ServiceModel.class, modelFile))
+                     .customizationConfig(CustomizationConfig.create())
+                     .build())
+            .build();
+
+        assertNotNull(testModel.getMetadata().getAwsQueryCompatible());
+    }
+
 }

codegen/src/test/java/software/amazon/awssdk/codegen/poet/ClientTestModels.java

@@ -48,6 +48,19 @@ public static IntermediateModel awsJsonServiceModels() {
         return new IntermediateModelBuilder(models).build();
     }
 
+    public static IntermediateModel awsQueryCompatibleJsonServiceModels() {
+        File serviceModel = new File(ClientTestModels.class.getResource("client/c2j/query-to-json-errorcode/service-2.json").getFile());
+        File customizationModel = new File(ClientTestModels.class.getResource("client/c2j/query-to-json-errorcode/customization.config").getFile());
+        File paginatorsModel = new File(ClientTestModels.class.getResource("client/c2j/query-to-json-errorcode/paginators.json").getFile());
+        C2jModels models = C2jModels.builder()
+                                    .serviceModel(getServiceModel(serviceModel))
+                                    .customizationConfig(getCustomizationConfig(customizationModel))
+                                    .paginatorsModel(getPaginatorsModel(paginatorsModel))
+                                    .build();
+
+        return new IntermediateModelBuilder(models).build();
+    }
+
     public static IntermediateModel bearerAuthServiceModels() {
         File serviceModel = new File(ClientTestModels.class.getResource("client/c2j/json-bearer-auth/service-2.json").getFile());
         File customizationModel = new File(ClientTestModels.class.getResource("client/c2j/json-bearer-auth/customization.config").getFile());

codegen/src/test/java/software/amazon/awssdk/codegen/poet/client/PoetClientFunctionalTests.java

@@ -75,6 +75,18 @@ public void asyncClientClassAwsJson() throws Exception {
         assertThat(asyncClientClass, generatesTo("test-aws-json-async-client-class.java"));
     }
 
+    @Test
+    public void asyncClientClassAwsQueryCompatibleJson() throws Exception {
+        AsyncClientClass asyncClientClass = createAsyncClientClass(ClientTestModels.awsQueryCompatibleJsonServiceModels());
+        assertThat(asyncClientClass, generatesTo("test-aws-query-compatible-json-async-client-class.java"));
+    }
+
+    @Test
+    public void syncClientClassAwsQueryCompatibleJson() throws Exception {
+        SyncClientClass syncClientClass = createSyncClientClass(ClientTestModels.awsQueryCompatibleJsonServiceModels());
+        assertThat(syncClientClass, generatesTo("test-aws-query-compatible-json-sync-client-class.java"));
+    }
+
     @Test
     public void syncClientClassXml() throws Exception {
         SyncClientClass syncClientClass = createSyncClientClass(ClientTestModels.xmlServiceModels());

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/c2j/query-to-json-errorcode/customization.config

@@ -0,0 +1,5 @@
+{
+    "authPolicyActions" : {
+        "skip" : true
+    }
+}

codegen/src/test/resources/software/amazon/awssdk/codegen/poet/client/c2j/query-to-json-errorcode/paginators.json

@@ -0,0 +1,15 @@
+{
+  "pagination": {
+    "PaginatedOperationWithResultKey": {
+      "input_token": "NextToken",
+      "output_token": "NextToken",
+      "limit_key": "MaxResults",
+      "result_key": "Items"
+    },
+    "PaginatedOperationWithoutResultKey": {
+      "input_token": "NextToken",
+      "output_token": "NextToken",
+      "limit_key": "MaxResults"
+    }
+  }
+}