Use fault trait when determining exception status code (#3331)

* Use fault trait when determining exception status code

AWS-JSON services use the Fault trait to designate exceptions that are the
service's fault (i.e. 500), rather than HTTP status code bindings like REST
services. In cases where the response being unmarshalled does *NOT* have a
status code (e.g. because the response was constructed rather from some other
data rather than an actual HTTP response), the JSON unmarshaller will now also
check the metadata if it's marked as a fault.

* Move logic to codegen time

* Update changelog

Author: dagnir

.changes/next-release/bugfix-AWSSDKforJavav2-f966d44.json

@@ -0,0 +1,6 @@
+{
+    "type": "bugfix",
+    "category": "AWS SDK for Java v2",
+    "contributor": "",
+    "description": "AWS-JSON services use the Fault trait to designate exceptions that are the service's fault (i.e. 500), rather than HTTP status code bindings like REST services. In cases where the response being unmarshalled does *NOT* have a status code (e.g. because the response was constructed rather from some other data rather than an actual HTTP response), the status code will default to 500 for faults and 400 for non-faults."
+}

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

@@ -85,6 +85,7 @@ protected final ShapeModel generateShapeModel(String javaClassName, String shape
         shapeModel.withIsEvent(shape.isEvent());
         shapeModel.withXmlNamespace(shape.getXmlNamespace());
         shapeModel.withIsUnion(shape.isUnion());
+        shapeModel.withIsFault(shape.isFault());
 
         boolean hasHeaderMember = false;
         boolean hasStatusCodeMember = false;

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

@@ -61,6 +61,7 @@ public class ShapeModel extends DocumentationModel implements HasDeprecation {
 
     private String errorCode;
     private Integer httpStatusCode;
+    private boolean fault;
 
     private ShapeCustomizationInfo customization = new ShapeCustomizationInfo();
 
@@ -638,4 +639,13 @@ public boolean isUnion() {
     public void withIsUnion(boolean union) {
         this.union = union;
     }
+
+    public boolean isFault() {
+        return fault;
+    }
+
+    public ShapeModel withIsFault(boolean fault) {
+        this.fault = fault;
+        return this;
+    }
 }

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

@@ -28,6 +28,7 @@
 import software.amazon.awssdk.awscore.client.handler.AwsSyncClientHandler;
 import software.amazon.awssdk.codegen.model.intermediate.IntermediateModel;
 import software.amazon.awssdk.codegen.model.intermediate.OperationModel;
+import software.amazon.awssdk.codegen.model.intermediate.Protocol;
 import software.amazon.awssdk.codegen.model.intermediate.ShapeModel;
 import software.amazon.awssdk.codegen.model.intermediate.ShapeType;
 import software.amazon.awssdk.codegen.model.service.AuthType;
@@ -71,19 +72,30 @@ default List<CodeBlock> registerModeledExceptions(IntermediateModel model, PoetE
         return model.getShapes().values().stream()
                     .filter(s -> s.getShapeType() == ShapeType.Exception)
                     .map(e -> CodeBlock.builder()
-                                       .add(".registerModeledException($T.builder().errorCode($S)"
-                                            + ".exceptionBuilderSupplier($T::builder)$L.build())",
+                                       .add(".registerModeledException($T.builder()"
+                                            + ".errorCode($S)"
+                                            + ".exceptionBuilderSupplier($T::builder)"
+                                            + "$L" // populateHttpStatusCode
+                                            + ".build())",
                                             ExceptionMetadata.class,
                                             e.getErrorCode(),
                                             poetExtensions.getModelClass(e.getShapeName()),
-                                            populateHttpStatusCode(e))
+                                            populateHttpStatusCode(e, model))
                                        .build())
                     .collect(Collectors.toList());
     }
 
-    default String populateHttpStatusCode(ShapeModel shapeModel) {
-        return shapeModel.getHttpStatusCode() != null
-               ? String.format(".httpStatusCode(%d)", shapeModel.getHttpStatusCode()) : "";
+    default String populateHttpStatusCode(ShapeModel shapeModel, IntermediateModel model) {
+        Integer statusCode = shapeModel.getHttpStatusCode();
+
+        if (statusCode == null && model.getMetadata().getProtocol() == Protocol.AWS_JSON) {
+            if (shapeModel.isFault()) {
+                statusCode = 500;
+            } else {
+                statusCode = 400;
+            }
+        }
+        return statusCode != null ? String.format(".httpStatusCode(%d)", statusCode) : "";
     }
 
     default String hostPrefixExpression(OperationModel opModel) {

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

@@ -81,6 +81,9 @@
       "errors": [
         {
           "shape": "InvalidInputException"
+        },
+        {
+          "shape": "ServiceFaultException"
         }
       ],
       "documentation": "<p>Performs a post operation to the query service and has modelled output</p>"
@@ -259,13 +262,15 @@
         }
       },
       "documentation": "<p>The request was rejected because an invalid or out-of-range value was supplied for an input parameter.</p>",
-      "error": {
-        "code": "InvalidInput",
-        "httpStatusCode": 400,
-        "senderFault": true
-      },
       "exception": true
     },
+    "ServiceFaultException": {
+      "type": "structure",
+      "members": {
+      },
+      "exception": true,
+      "fault": true
+    },
     "nestedMember": {
       "type": "structure",
       "required": [

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

@@ -81,6 +81,7 @@
 import software.amazon.awssdk.services.json.model.PaginatedOperationWithResultKeyResponse;
 import software.amazon.awssdk.services.json.model.PaginatedOperationWithoutResultKeyRequest;
 import software.amazon.awssdk.services.json.model.PaginatedOperationWithoutResultKeyResponse;
+import software.amazon.awssdk.services.json.model.ServiceFaultException;
 import software.amazon.awssdk.services.json.model.StreamingInputOperationRequest;
 import software.amazon.awssdk.services.json.model.StreamingInputOperationResponse;
 import software.amazon.awssdk.services.json.model.StreamingInputOutputOperationRequest;
@@ -216,6 +217,7 @@ public CompletableFuture<APostOperationResponse> aPostOperation(APostOperationRe
      *         <ul>
      *         <li>InvalidInputException The request was rejected because an invalid or out-of-range value was supplied
      *         for an input parameter.</li>
+     *         <li>ServiceFaultException</li>
      *         <li>SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
      *         Can be used for catch all scenarios.</li>
      *         <li>SdkClientException If any client side error occurs such as an IO related failure, failure to get
@@ -641,31 +643,31 @@ public CompletableFuture<OperationWithChecksumRequiredResponse> operationWithChe
      */
     @Override
     public CompletableFuture<OperationWithNoneAuthTypeResponse> operationWithNoneAuthType(
-        OperationWithNoneAuthTypeRequest operationWithNoneAuthTypeRequest) {
+            OperationWithNoneAuthTypeRequest operationWithNoneAuthTypeRequest) {
         List<MetricPublisher> metricPublishers = resolveMetricPublishers(clientConfiguration, operationWithNoneAuthTypeRequest
-            .overrideConfiguration().orElse(null));
+                .overrideConfiguration().orElse(null));
         MetricCollector apiCallMetricCollector = metricPublishers.isEmpty() ? NoOpMetricCollector.create() : MetricCollector
-            .create("ApiCall");
+                .create("ApiCall");
         try {
             apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Json Service");
             apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "OperationWithNoneAuthType");
             JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(false)
-                                                                           .isPayloadJson(true).build();
+                    .isPayloadJson(true).build();
 
             HttpResponseHandler<OperationWithNoneAuthTypeResponse> responseHandler = protocolFactory.createResponseHandler(
-                operationMetadata, OperationWithNoneAuthTypeResponse::builder);
+                    operationMetadata, OperationWithNoneAuthTypeResponse::builder);
 
             HttpResponseHandler<AwsServiceException> errorResponseHandler = createErrorResponseHandler(protocolFactory,
-                                                                                                       operationMetadata);
+                    operationMetadata);
 
             CompletableFuture<OperationWithNoneAuthTypeResponse> executeFuture = clientHandler
-                .execute(new ClientExecutionParams<OperationWithNoneAuthTypeRequest, OperationWithNoneAuthTypeResponse>()
-                             .withOperationName("OperationWithNoneAuthType")
-                             .withMarshaller(new OperationWithNoneAuthTypeRequestMarshaller(protocolFactory))
-                             .withResponseHandler(responseHandler).withErrorResponseHandler(errorResponseHandler)
-                             .withMetricCollector(apiCallMetricCollector)
-                             .putExecutionAttribute(SdkInternalExecutionAttribute.IS_NONE_AUTH_TYPE_REQUEST, false)
-                             .withInput(operationWithNoneAuthTypeRequest));
+                    .execute(new ClientExecutionParams<OperationWithNoneAuthTypeRequest, OperationWithNoneAuthTypeResponse>()
+                            .withOperationName("OperationWithNoneAuthType")
+                            .withMarshaller(new OperationWithNoneAuthTypeRequestMarshaller(protocolFactory))
+                            .withResponseHandler(responseHandler).withErrorResponseHandler(errorResponseHandler)
+                            .withMetricCollector(apiCallMetricCollector)
+                            .putExecutionAttribute(SdkInternalExecutionAttribute.IS_NONE_AUTH_TYPE_REQUEST, false)
+                            .withInput(operationWithNoneAuthTypeRequest));
             CompletableFuture<OperationWithNoneAuthTypeResponse> whenCompleted = executeFuture.whenComplete((r, e) -> {
                 metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
             });
@@ -755,7 +757,7 @@ public CompletableFuture<PaginatedOperationWithResultKeyResponse> paginatedOpera
      * The following are few ways to use the response class:
      * </p>
      * 1) Using the subscribe helper method
-     *
+     * 
      * <pre>
      * {@code
      * software.amazon.awssdk.services.json.paginators.PaginatedOperationWithResultKeyPublisher publisher = client.paginatedOperationWithResultKeyPaginator(request);
@@ -765,19 +767,19 @@ public CompletableFuture<PaginatedOperationWithResultKeyResponse> paginatedOpera
      * </pre>
      *
      * 2) Using a custom subscriber
-     *
+     * 
      * <pre>
      * {@code
      * software.amazon.awssdk.services.json.paginators.PaginatedOperationWithResultKeyPublisher publisher = client.paginatedOperationWithResultKeyPaginator(request);
      * publisher.subscribe(new Subscriber<software.amazon.awssdk.services.json.model.PaginatedOperationWithResultKeyResponse>() {
-     *
+     * 
      * public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
-     *
-     *
+     * 
+     * 
      * public void onNext(software.amazon.awssdk.services.json.model.PaginatedOperationWithResultKeyResponse response) { //... };
      * });}
      * </pre>
-     *
+     * 
      * As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
      * <p>
      * <b>Please notice that the configuration of MaxResults won't limit the number of results you get with the
@@ -888,7 +890,7 @@ public CompletableFuture<PaginatedOperationWithoutResultKeyResponse> paginatedOp
      * The following are few ways to use the response class:
      * </p>
      * 1) Using the subscribe helper method
-     *
+     * 
      * <pre>
      * {@code
      * software.amazon.awssdk.services.json.paginators.PaginatedOperationWithoutResultKeyPublisher publisher = client.paginatedOperationWithoutResultKeyPaginator(request);
@@ -898,19 +900,19 @@ public CompletableFuture<PaginatedOperationWithoutResultKeyResponse> paginatedOp
      * </pre>
      *
      * 2) Using a custom subscriber
-     *
+     * 
      * <pre>
      * {@code
      * software.amazon.awssdk.services.json.paginators.PaginatedOperationWithoutResultKeyPublisher publisher = client.paginatedOperationWithoutResultKeyPaginator(request);
      * publisher.subscribe(new Subscriber<software.amazon.awssdk.services.json.model.PaginatedOperationWithoutResultKeyResponse>() {
-     *
+     * 
      * public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
-     *
-     *
+     * 
+     * 
      * public void onNext(software.amazon.awssdk.services.json.model.PaginatedOperationWithoutResultKeyResponse response) { //... };
      * });}
      * </pre>
-     *
+     * 
      * As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
      * <p>
      * <b>Please notice that the configuration of MaxResults won't limit the number of results you get with the
@@ -1050,8 +1052,8 @@ public <ReturnT> CompletableFuture<ReturnT> streamingInputOutputOperation(
         try {
             apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Json Service");
             apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "StreamingInputOutputOperation");
-            Pair<AsyncResponseTransformer<StreamingInputOutputOperationResponse, ReturnT>, CompletableFuture<Void>> pair =
-                AsyncResponseTransformerUtils.wrapWithEndOfStreamFuture(asyncResponseTransformer);
+            Pair<AsyncResponseTransformer<StreamingInputOutputOperationResponse, ReturnT>, CompletableFuture<Void>> pair = AsyncResponseTransformerUtils
+                    .wrapWithEndOfStreamFuture(asyncResponseTransformer);
             asyncResponseTransformer = pair.left();
             CompletableFuture<Void> endOfStreamFuture = pair.right();
             streamingInputOutputOperationRequest = applySignerOverride(streamingInputOutputOperationRequest,
@@ -1092,7 +1094,7 @@ public <ReturnT> CompletableFuture<ReturnT> streamingInputOutputOperation(
         } catch (Throwable t) {
             AsyncResponseTransformer<StreamingInputOutputOperationResponse, ReturnT> finalAsyncResponseTransformer = asyncResponseTransformer;
             runAndLogError(log, "Exception thrown in exceptionOccurred callback, ignoring",
-                           () -> finalAsyncResponseTransformer.exceptionOccurred(t));
+                    () -> finalAsyncResponseTransformer.exceptionOccurred(t));
             metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
             return CompletableFutureUtils.failedFuture(t);
         }
@@ -1133,8 +1135,8 @@ public <ReturnT> CompletableFuture<ReturnT> streamingOutputOperation(
         try {
             apiCallMetricCollector.reportMetric(CoreMetric.SERVICE_ID, "Json Service");
             apiCallMetricCollector.reportMetric(CoreMetric.OPERATION_NAME, "StreamingOutputOperation");
-            Pair<AsyncResponseTransformer<StreamingOutputOperationResponse, ReturnT>, CompletableFuture<Void>> pair =
-                AsyncResponseTransformerUtils.wrapWithEndOfStreamFuture(asyncResponseTransformer);
+            Pair<AsyncResponseTransformer<StreamingOutputOperationResponse, ReturnT>, CompletableFuture<Void>> pair = AsyncResponseTransformerUtils
+                    .wrapWithEndOfStreamFuture(asyncResponseTransformer);
             asyncResponseTransformer = pair.left();
             CompletableFuture<Void> endOfStreamFuture = pair.right();
             JsonOperationMetadata operationMetadata = JsonOperationMetadata.builder().hasStreamingSuccessResponse(true)
@@ -1168,7 +1170,7 @@ public <ReturnT> CompletableFuture<ReturnT> streamingOutputOperation(
         } catch (Throwable t) {
             AsyncResponseTransformer<StreamingOutputOperationResponse, ReturnT> finalAsyncResponseTransformer = asyncResponseTransformer;
             runAndLogError(log, "Exception thrown in exceptionOccurred callback, ignoring",
-                           () -> finalAsyncResponseTransformer.exceptionOccurred(t));
+                    () -> finalAsyncResponseTransformer.exceptionOccurred(t));
             metricPublishers.forEach(p -> p.publish(apiCallMetricCollector.collect()));
             return CompletableFutureUtils.failedFuture(t);
         }
@@ -1186,8 +1188,11 @@ private <T extends BaseAwsJsonProtocolFactory.Builder<T>> T init(T builder) {
                 .protocol(AwsJsonProtocol.AWS_JSON)
                 .protocolVersion("1.1")
                 .registerModeledException(
-                        ExceptionMetadata.builder().errorCode("InvalidInput")
-                                .exceptionBuilderSupplier(InvalidInputException::builder).httpStatusCode(400).build());
+                        ExceptionMetadata.builder().errorCode("InvalidInputException")
+                                .exceptionBuilderSupplier(InvalidInputException::builder).httpStatusCode(400).build())
+                .registerModeledException(
+                        ExceptionMetadata.builder().errorCode("ServiceFaultException")
+                                .exceptionBuilderSupplier(ServiceFaultException::builder).httpStatusCode(500).build());
     }
 
     private static List<MetricPublisher> resolveMetricPublishers(SdkClientConfiguration clientConfiguration,