feat(codegen): add query compatible header error code handling for JSON protocols (#3972)

Author: AndrewFossAWS

codegen/build.gradle.kts

@@ -31,7 +31,7 @@ allprojects {
     version = "0.12.0"
 }
 
-extra["smithyVersion"] = "[1.25.0,1.26.0["
+extra["smithyVersion"] = "[1.25.2,1.26.0["
 
 // The root project doesn't produce a JAR.
 tasks["jar"].enabled = false

codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/AwsProtocolUtils.java

@@ -43,6 +43,7 @@
 import software.amazon.smithy.typescript.codegen.integration.HttpProtocolGeneratorUtils;
 import software.amazon.smithy.typescript.codegen.integration.ProtocolGenerator;
 import software.amazon.smithy.typescript.codegen.integration.ProtocolGenerator.GenerationContext;
+import software.amazon.smithy.utils.IoUtils;
 import software.amazon.smithy.utils.SmithyInternalApi;
 
 /**
@@ -117,6 +118,13 @@ static void generateJsonParseBody(GenerationContext context) {
         writer.write("");
     }
 
+    static void generateJsonParseBodyWithQueryHeader(GenerationContext context) {
+        TypeScriptWriter writer = context.getWriter();
+        writer.addImport("HeaderBag", "__HeaderBag", "@aws-sdk/types");
+        writer.write(IoUtils.readUtf8Resource(
+                AwsProtocolUtils.class, "populate-body-with-query-compatibility-code-stub.ts"));
+    }
+
     /**
      * Writes a response body parser function for JSON errors. This
      * will populate message field in parsed object, if it's not present.

codegen/smithy-aws-typescript-codegen/src/main/java/software/amazon/smithy/aws/typescript/codegen/JsonRpcProtocolGenerator.java

@@ -16,6 +16,7 @@
 package software.amazon.smithy.aws.typescript.codegen;
 
 import java.util.Set;
+import software.amazon.smithy.aws.traits.protocols.AwsQueryCompatibleTrait;
 import software.amazon.smithy.model.shapes.OperationShape;
 import software.amazon.smithy.model.shapes.ServiceShape;
 import software.amazon.smithy.model.shapes.Shape;
@@ -86,6 +87,10 @@ public void generateSharedComponents(GenerationContext context) {
         TypeScriptWriter writer = context.getWriter();
         writer.addUseImports(getApplicationProtocol().getResponseType());
         writer.write(IoUtils.readUtf8Resource(getClass(), "load-json-error-code-stub.ts"));
+
+        if (context.getService().hasTrait(AwsQueryCompatibleTrait.class)) {
+            AwsProtocolUtils.generateJsonParseBodyWithQueryHeader(context);
+        }
     }
 
     @Override
@@ -128,6 +133,14 @@ protected boolean writeUndefinedInputBody(GenerationContext context, OperationSh
     protected void writeErrorCodeParser(GenerationContext context) {
         TypeScriptWriter writer = context.getWriter();
 
+        if (context.getService().hasTrait(AwsQueryCompatibleTrait.class)) {
+            // Populate parsedOutput.body with 'Code' and 'Type' fields
+            // "x-amzn-query-error" header is available when AwsQueryCompatibleTrait is applied to a service
+            // The header value contains query error Code and Type joined by ';'
+            // E.g. "MalformedInput;Sender" or "InternalFailure;Receiver"
+            writer.write("populateBodyWithQueryCompatibility(parsedOutput, output.headers);");
+        }
+
         // Outsource error code parsing since it's complex for this protocol.
         writer.write("const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);");
     }

codegen/smithy-aws-typescript-codegen/src/main/resources/software/amazon/smithy/aws/typescript/codegen/populate-body-with-query-compatibility-code-stub.ts

@@ -0,0 +1,8 @@
+const populateBodyWithQueryCompatibility = (parsedOutput: any, headers: __HeaderBag) => {
+  const queryErrorHeader = headers["x-amzn-query-error"];
+  if (parsedOutput.body !== undefined && queryErrorHeader != null) {
+    const codeAndType = queryErrorHeader.split(";");
+    parsedOutput.body.Code = codeAndType[0];
+    parsedOutput.body.Type = codeAndType[1];
+  }
+};