diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/HttpBindingProtocolGenerator.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/HttpBindingProtocolGenerator.java index 63a2de31efd..cbe39693682 100644 --- a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/HttpBindingProtocolGenerator.java +++ b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/HttpBindingProtocolGenerator.java @@ -48,7 +48,6 @@ import software.amazon.smithy.model.shapes.NumberShape; import software.amazon.smithy.model.shapes.OperationShape; import software.amazon.smithy.model.shapes.Shape; -import software.amazon.smithy.model.shapes.ShapeType; import software.amazon.smithy.model.shapes.StringShape; import software.amazon.smithy.model.shapes.StructureShape; import software.amazon.smithy.model.shapes.TimestampShape; @@ -72,6 +71,17 @@ public abstract class HttpBindingProtocolGenerator implements ProtocolGenerator private final Set serializingDocumentShapes = new TreeSet<>(); private final Set deserializingDocumentShapes = new TreeSet<>(); private final Set deserializingErrorShapes = new TreeSet<>(); + private final boolean isErrorCodeInBody; + + /** + * Creates a Http binding protocol generator. + * + * @param isErrorCodeInBody A boolean that indicates if the error code for the implementing protocol is located in + * the error response body, meaning this generator will parse the body before attempting to load an error code. + */ + public HttpBindingProtocolGenerator(boolean isErrorCodeInBody) { + this.isErrorCodeInBody = isErrorCodeInBody; + } @Override public ApplicationProtocol getApplicationProtocol() { @@ -120,6 +130,8 @@ public void generateSharedComponents(GenerationContext context) { generateDocumentBodyShapeSerializers(context, serializingDocumentShapes); generateDocumentBodyShapeDeserializers(context, deserializingDocumentShapes); HttpProtocolGeneratorUtils.generateMetadataDeserializer(context, getApplicationProtocol().getResponseType()); + HttpProtocolGeneratorUtils.generateCollectBody(context); + HttpProtocolGeneratorUtils.generateCollectBodyString(context); } /** @@ -594,7 +606,7 @@ private void generateOperationDeserializer( // Write out the error deserialization dispatcher. Set errorShapes = HttpProtocolGeneratorUtils.generateErrorDispatcher( - context, operation, responseType, this::writeErrorCodeParser); + context, operation, responseType, this::writeErrorCodeParser, isErrorCodeInBody); deserializingErrorShapes.addAll(errorShapes); } @@ -608,9 +620,10 @@ private void generateErrorDeserializer(GenerationContext context, StructureShape context.getProtocolName()) + "Response"; writer.openBlock("const $L = async (\n" - + " output: any,\n" + + " $L: any,\n" + " context: __SerdeContext\n" - + "): Promise<$T> => {", "};", errorDeserMethodName, errorSymbol, () -> { + + "): Promise<$T> => {", "};", + errorDeserMethodName, isErrorCodeInBody ? "parsedOutput" : "output", errorSymbol, () -> { writer.openBlock("const contents: $T = {", "};", errorSymbol, () -> { writer.write("__type: $S,", error.getId().getName()); writer.write("$$fault: $S,", error.getTrait(ErrorTrait.class).get().getValue()); @@ -621,7 +634,7 @@ private void generateErrorDeserializer(GenerationContext context, StructureShape }); readHeaders(context, error, bindingIndex); - List documentBindings = readResponseBody(context, error, bindingIndex); + List documentBindings = readErrorResponseBody(context, error, bindingIndex); // Track all shapes bound to the document so their deserializers may be generated. documentBindings.forEach(binding -> { Shape target = model.expectShape(binding.getMember().getTarget()); @@ -633,6 +646,24 @@ private void generateErrorDeserializer(GenerationContext context, StructureShape writer.write(""); } + private List readErrorResponseBody( + GenerationContext context, + Shape error, + HttpBindingIndex bindingIndex + ) { + TypeScriptWriter writer = context.getWriter(); + if (isErrorCodeInBody) { + // Body is already parsed in error dispatcher, simply assign body to data. + writer.write("const data: any = output.body;"); + List responseBindings = bindingIndex.getResponseBindings(error, Location.DOCUMENT); + responseBindings.sort(Comparator.comparing(HttpBinding::getMemberName)); + return responseBindings; + } else { + // Deserialize response body just like in normal response. + return readResponseBody(context, error, bindingIndex); + } + } + private void readHeaders( GenerationContext context, Shape operationOrError, @@ -691,16 +722,41 @@ private List readResponseBody( documentBindings.sort(Comparator.comparing(HttpBinding::getMemberName)); List payloadBindings = bindingIndex.getResponseBindings(operationOrError, Location.PAYLOAD); + // Detect if operation output or error shape contains a streaming member. + OperationIndex operationIndex = context.getModel().getKnowledge(OperationIndex.class); + StructureShape operationOutputOrError = operationOrError.asStructureShape() + .orElseGet(() -> operationIndex.getOutput(operationOrError).orElse(null)); + boolean hasStreamingComponent = Optional.ofNullable(operationOutputOrError) + .map(structure -> structure.getAllMembers().values().stream() + .anyMatch(memberShape -> memberShape.hasTrait(StreamingTrait.class))) + .orElse(false); + if (!documentBindings.isEmpty()) { - readReponseBodyData(context, operationOrError); + // If response has document binding, the body can be parsed to JavaScript object. + writer.write("const data: any = await parseBody(output.body, context);"); deserializeOutputDocument(context, operationOrError, documentBindings); return documentBindings; } if (!payloadBindings.isEmpty()) { - readReponseBodyData(context, operationOrError); // There can only be one payload binding. HttpBinding binding = payloadBindings.get(0); Shape target = context.getModel().expectShape(binding.getMember().getTarget()); + if (hasStreamingComponent) { + // If payload is streaming, return raw low-level stream directly. + writer.write("const data: any = output.body;"); + } else if (target instanceof BlobShape) { + // If payload is non-streaming blob, only need to collect stream to binary data(Uint8Array). + writer.write("const data: any = await collectBody(output.body, context);"); + } else if (target instanceof StructureShape || target instanceof UnionShape) { + // If body is Structure or Union, they we need to parse the string into JavaScript object. + writer.write("const data: any = await parseBody(output.body, context);"); + } else if (target instanceof StringShape) { + // If payload is string, we need to collect body and encode binary to string. + writer.write("const data: any = await collectBodyString(output.body, context);"); + } else { + throw new CodegenException(String.format("Unexpected shape type bound to payload: `%s`", + target.getType())); + } writer.write("contents.$L = $L;", binding.getMemberName(), getOutputValue(context, Location.PAYLOAD, "data", binding.getMember(), target)); return payloadBindings; @@ -708,25 +764,6 @@ private List readResponseBody( return ListUtils.of(); } - private void readReponseBodyData(GenerationContext context, Shape operationOrError) { - TypeScriptWriter writer = context.getWriter(); - // Prepare response body for deserializing. - OperationIndex operationIndex = context.getModel().getKnowledge(OperationIndex.class); - StructureShape operationOutputOrError = operationOrError.asStructureShape() - .orElseGet(() -> operationIndex.getOutput(operationOrError).orElse(null)); - boolean hasStreamingComponent = Optional.ofNullable(operationOutputOrError) - .map(structure -> structure.getAllMembers().values().stream() - .anyMatch(memberShape -> memberShape.hasTrait(StreamingTrait.class))) - .orElse(false); - if (hasStreamingComponent || operationOrError.getType().equals(ShapeType.STRUCTURE)) { - // For operations with streaming output or errors with streaming body we keep the body intact. - writer.write("const data: any = output.body;"); - } else { - // Otherwise, we collect the response body to structured object with parseBody(). - writer.write("const data: any = await parseBody(output.body, context);"); - } - } - /** * Given context and a source of data, generate an output value provider for the * shape. This may use native types (like generating a Date for timestamps,) @@ -890,10 +927,16 @@ private String getNumberOutputParam(Location bindingType, String dataSource, Sha * Writes the code that loads an {@code errorCode} String with the content used * to dispatch errors to specific serializers. * - *

Three variables will be in scope: + *

Two variables will be in scope: *

    - *
  • {@code output}: a value of the HttpResponse type.
    • - *
  • {@code data}: the contents of the response body.
    • + *
  • {@code output} or {@code parsedOutput}: a value of the HttpResponse type. + *
      + *
    • {@code output} is a raw HttpResponse, available when {@code isErrorCodeInBody} is set to + * {@code false}
      • + *
    • {@code parsedOutput} is a HttpResponse type with body parsed to JavaScript object, available + * when {@code isErrorCodeInBody} is set to {@code true}
      • + *
    + *
    • *
  • {@code context}: the SerdeContext.
    • *
* diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/HttpProtocolGeneratorUtils.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/HttpProtocolGeneratorUtils.java index 348b0c36d5e..ef18734866f 100644 --- a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/HttpProtocolGeneratorUtils.java +++ b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/HttpProtocolGeneratorUtils.java @@ -108,6 +108,44 @@ static void generateMetadataDeserializer(GenerationContext context, SymbolRefere writer.write(""); } + /** + * Writes a response body stream collector. This function converts the low-level response body stream to + * Uint8Array binary data. + * + * @param context The generation context. + */ + static void generateCollectBody(GenerationContext context) { + TypeScriptWriter writer = context.getWriter(); + + writer.addImport("SerdeContext", "__SerdeContext", "@aws-sdk/types"); + writer.write("// Collect low-level response body stream to Uint8Array."); + writer.openBlock("const collectBody = (streamBody: any, context: __SerdeContext): Promise => {", + "};", () -> { + writer.write("return context.streamCollector(streamBody) || new Uint8Array();"); + }); + + writer.write(""); + } + + /** + * Writes a function converting the low-level response body stream to utf-8 encoded string. It depends on + * response body stream collector {@link #generateCollectBody(GenerationContext)}. + * + * @param context The generation context + */ + static void generateCollectBodyString(GenerationContext context) { + TypeScriptWriter writer = context.getWriter(); + + writer.addImport("SerdeContext", "__SerdeContext", "@aws-sdk/types"); + writer.write("// Encode Uint8Array data into string with utf-8."); + writer.openBlock("const collectBodyString = (streamBody: any, context: __SerdeContext): Promise => {", + "};", () -> { + writer.write("return collectBody(streamBody, context).then(body => context.utf8Encoder(body));"); + }); + + writer.write(""); + } + /** * Writes a function used to dispatch to the proper error deserializer * for each error that the operation can return. The generated function @@ -118,13 +156,15 @@ static void generateMetadataDeserializer(GenerationContext context, SymbolRefere * @param operation The operation to generate for. * @param responseType The response type for the HTTP protocol. * @param errorCodeGenerator A consumer + * @param shouldParseErrorBody Flag indicating whether need to parse response body in this dispatcher function * @return A set of all error structure shapes for the operation that were dispatched to. */ static Set generateErrorDispatcher( GenerationContext context, OperationShape operation, SymbolReference responseType, - Consumer errorCodeGenerator + Consumer errorCodeGenerator, + boolean shouldParseErrorBody ) { TypeScriptWriter writer = context.getWriter(); SymbolProvider symbolProvider = context.getSymbolProvider(); @@ -138,14 +178,14 @@ static Set generateErrorDispatcher( + " output: $T,\n" + " context: __SerdeContext,\n" + "): Promise<$T> {", "}", errorMethodName, responseType, outputType, () -> { - writer.write("const data: any = await parseBody(output.body, context);"); - // We only consume the parsedOutput if we're dispatching, so only generate if we will. - if (!operation.getErrors().isEmpty()) { - // Create a holding object since we have already parsed the body, but retain the rest of the output. - writer.openBlock("const parsedOutput: any = {", "};", () -> { - writer.write("...output,"); - writer.write("body: data,"); - }); + // Prepare error response for parsing error code. If error code needs to be parsed from response body + // then we collect body and parse it to JS object, otherwise leave the response body as is. + if (shouldParseErrorBody) { + writer.openBlock("const parsedOutput: any = {", "};", + () -> { + writer.write("...output,"); + writer.write("body: await parseBody(output.body, context)"); + }); } // Error responses must be at least SmithyException and MetadataBearer implementations. @@ -167,7 +207,8 @@ static Set generateErrorDispatcher( context.getProtocolName()) + "Response"; writer.openBlock("case $S:\ncase $S:", " break;", errorId.getName(), errorId.toString(), () -> { // Dispatch to the error deserialization function. - writer.write("response = await $L(parsedOutput, context);", errorDeserMethodName); + writer.write("response = await $L($L, context);", + errorDeserMethodName, shouldParseErrorBody ? "parsedOutput" : "output"); }); }); diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/HttpRpcProtocolGenerator.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/HttpRpcProtocolGenerator.java index 9e538534f9a..745b467459b 100644 --- a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/HttpRpcProtocolGenerator.java +++ b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/HttpRpcProtocolGenerator.java @@ -37,6 +37,17 @@ public abstract class HttpRpcProtocolGenerator implements ProtocolGenerator { private final Set serializingDocumentShapes = new TreeSet<>(); private final Set deserializingDocumentShapes = new TreeSet<>(); private final Set deserializingErrorShapes = new TreeSet<>(); + private final boolean isErrorCodeInBody; + + /** + * Creates a Http RPC protocol generator. + * + * @param isErrorCodeInBody A boolean that indicates if the error code for the implementing protocol is located in + * the error response body, meaning this generator will parse the body before attempting to load an error code. + */ + public HttpRpcProtocolGenerator(boolean isErrorCodeInBody) { + this.isErrorCodeInBody = isErrorCodeInBody; + } @Override public ApplicationProtocol getApplicationProtocol() { @@ -78,6 +89,8 @@ public void generateSharedComponents(GenerationContext context) { generateDocumentBodyShapeSerializers(context, serializingDocumentShapes); generateDocumentBodyShapeDeserializers(context, deserializingDocumentShapes); HttpProtocolGeneratorUtils.generateMetadataDeserializer(context, getApplicationProtocol().getResponseType()); + HttpProtocolGeneratorUtils.generateCollectBody(context); + HttpProtocolGeneratorUtils.generateCollectBodyString(context); } @Override @@ -254,7 +267,7 @@ private void generateOperationDeserializer(GenerationContext context, OperationS // Write out the error deserialization dispatcher. Set errorShapes = HttpProtocolGeneratorUtils.generateErrorDispatcher( - context, operation, responseType, this::writeErrorCodeParser); + context, operation, responseType, this::writeErrorCodeParser, isErrorCodeInBody); deserializingErrorShapes.addAll(errorShapes); } @@ -267,20 +280,27 @@ private void generateErrorDeserializer(GenerationContext context, StructureShape // Add the error shape to the list to generate functions for, since we'll use that. deserializingDocumentShapes.add(error); - + String outputReference = isErrorCodeInBody ? "parsedOutput" : "output"; writer.openBlock("const $L = async (\n" - + " output: any,\n" + + " $L: any,\n" + " context: __SerdeContext\n" - + "): Promise<$T> => {", "};", errorDeserMethodName, errorSymbol, () -> { + + "): Promise<$T> => {", "};", errorDeserMethodName, outputReference, errorSymbol, () -> { // First deserialize the body properly. - writer.write("const deserialized: any = $L(output.body, context);", + if (isErrorCodeInBody) { + // Body is already parsed in error dispatcher, simply assign body to data. + writer.write("const body = $L.body", outputReference); + } else { + // If error node not in body, error body is not parsed in dispatcher. + writer.write("const body = parseBody($L.body, context);", outputReference); + } + writer.write("const deserialized: any = $L(body, context);", ProtocolGenerator.getDeserFunctionName(errorSymbol, context.getProtocolName())); // Then load it into the object with additional error and response properties. writer.openBlock("const contents: $T = {", "};", errorSymbol, () -> { writer.write("__type: $S,", error.getId().getName()); writer.write("$$fault: $S,", error.getTrait(ErrorTrait.class).get().getValue()); - writer.write("$$metadata: deserializeMetadata(output),"); + writer.write("$$metadata: deserializeMetadata($L),", outputReference); writer.write("...deserialized,"); }); @@ -311,10 +331,16 @@ private void readResponseBody(GenerationContext context, OperationShape operatio * Writes the code that loads an {@code errorCode} String with the content used * to dispatch errors to specific serializers. * - *

Three variables will be in scope: + *

Two variables will be in scope: *

    - *
  • {@code output}: a value of the HttpResponse type.
    • - *
  • {@code data}: the contents of the response body.
    • + *
  • {@code output} or {@code parsedOutput}: a value of the HttpResponse type. + *
      + *
    • {@code output} is a raw HttpResponse, available when {@code isErrorCodeInBody} is set to + * {@code false}
      • + *
    • {@code parsedOutput} is a HttpResponse type with body parsed to JavaScript object, available + * when {@code isErrorCodeInBody} is set to {@code true}
      • + *
    + *
    • *
  • {@code context}: the SerdeContext.
    • *
*