chore: support delegation of determining errors for an operation (smithy-lang#489)

Author: trivikr

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/HttpBindingProtocolGenerator.java

@@ -2060,7 +2060,7 @@ private void generateOperationResponseDeserializer(
         // Write out the error deserialization dispatcher.
         Set<StructureShape> errorShapes = HttpProtocolGeneratorUtils.generateErrorDispatcher(
                 context, operation, responseType, this::writeErrorCodeParser,
-                isErrorCodeInBody, this::getErrorBodyLocation);
+                isErrorCodeInBody, this::getErrorBodyLocation, this::getOperationErrors);
         deserializingErrorShapes.addAll(errorShapes);
     }
 

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/HttpProtocolGeneratorUtils.java

@@ -17,18 +17,21 @@
 
 import java.nio.file.Paths;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 import java.util.Set;
+import java.util.TreeMap;
 import java.util.TreeSet;
 import java.util.function.BiFunction;
 import java.util.function.Consumer;
+import java.util.function.Function;
 import java.util.logging.Logger;
+import java.util.stream.Collectors;
 import software.amazon.smithy.codegen.core.CodegenException;
 import software.amazon.smithy.codegen.core.Symbol;
 import software.amazon.smithy.codegen.core.SymbolProvider;
 import software.amazon.smithy.codegen.core.SymbolReference;
 import software.amazon.smithy.model.knowledge.HttpBinding.Location;
-import software.amazon.smithy.model.knowledge.OperationIndex;
 import software.amazon.smithy.model.pattern.SmithyPattern;
 import software.amazon.smithy.model.shapes.MemberShape;
 import software.amazon.smithy.model.shapes.OperationShape;
@@ -313,6 +316,7 @@ public static void writeRetryableTrait(TypeScriptWriter writer, StructureShape e
      * @param errorCodeGenerator A consumer
      * @param shouldParseErrorBody Flag indicating whether need to parse response body in this dispatcher function
      * @param bodyErrorLocationModifier A function that returns the location of an error in a body given a data source.
+     * @param operationErrorsToShapes A map of error names to their {@link ShapeId}.
      * @return A set of all error structure shapes for the operation that were dispatched to.
      */
     static Set<StructureShape> generateErrorDispatcher(
@@ -321,11 +325,11 @@ static Set<StructureShape> generateErrorDispatcher(
             SymbolReference responseType,
             Consumer<GenerationContext> errorCodeGenerator,
             boolean shouldParseErrorBody,
-            BiFunction<GenerationContext, String, String> bodyErrorLocationModifier
+            BiFunction<GenerationContext, String, String> bodyErrorLocationModifier,
+            BiFunction<GenerationContext, OperationShape, Map<String, ShapeId>> operationErrorsToShapes
     ) {
         TypeScriptWriter writer = context.getWriter();
         SymbolProvider symbolProvider = context.getSymbolProvider();
-        OperationIndex operationIndex = OperationIndex.of(context.getModel());
         Set<StructureShape> errorShapes = new TreeSet<>();
 
         Symbol symbol = symbolProvider.toSymbol(operation);
@@ -350,10 +354,6 @@ static Set<StructureShape> generateErrorDispatcher(
             SymbolReference baseExceptionReference = getClientBaseException(context);
             errorCodeGenerator.accept(context);
 
-            TreeSet<StructureShape> structureShapes = new TreeSet<>(
-                operationIndex.getErrors(operation, context.getService())
-            );
-
             Runnable defaultErrorHandler = () -> {
                 if (shouldParseErrorBody) {
                     // Body is already parsed above
@@ -379,20 +379,21 @@ static Set<StructureShape> generateErrorDispatcher(
                 });
             };
 
-            if (!structureShapes.isEmpty()) {
+            Map<String, ShapeId> operationNamesToShapes = operationErrorsToShapes.apply(context, operation);
+            if (!operationNamesToShapes.isEmpty()) {
                 writer.openBlock("switch (errorCode) {", "}", () -> {
                     // Generate the case statement for each error, invoking the specific deserializer.
 
-                    structureShapes.forEach(error -> {
-                        final ShapeId errorId = error.getId();
+                    operationNamesToShapes.forEach((name, errorId) -> {
+                        StructureShape error = context.getModel().expectShape(errorId).asStructureShape().get();
                         // Track errors bound to the operation so their deserializers may be generated.
                         errorShapes.add(error);
                         Symbol errorSymbol = symbolProvider.toSymbol(error);
                         String errorDeserMethodName = ProtocolGenerator.getDeserFunctionName(errorSymbol,
                             context.getProtocolName()) + "Response";
                         // Dispatch to the error deserialization function.
                         String outputParam = shouldParseErrorBody ? "parsedOutput" : "output";
-                        writer.write("case $S:", errorId.getName());
+                        writer.write("case $S:", name);
                         writer.write("case $S:", errorId.toString());
                         writer.indent()
                             .write("throw await $L($L, context);", errorDeserMethodName, outputParam)
@@ -468,4 +469,24 @@ private static SymbolReference getClientBaseException(GenerationContext context)
                 .symbol(serviceExceptionSymbol)
                 .build();
     }
+
+    /**
+     * Returns a map of error names to their {@link ShapeId}.
+     *
+     * @param context   the generation context
+     * @param operation the operation shape to retrieve errors for
+     * @return map of error names to {@link ShapeId}
+     */
+    public static Map<String, ShapeId> getOperationErrors(GenerationContext context, OperationShape operation) {
+        return operation.getErrors().stream()
+            .collect(Collectors.toMap(
+                shapeId -> shapeId.getName(context.getService()),
+                Function.identity(),
+                (x, y) -> {
+                    if (!x.equals(y)) {
+                        throw new CodegenException(String.format("conflicting error shape ids: %s, %s", x, y));
+                    }
+                    return x;
+                }, TreeMap::new));
+    }
 }

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/HttpRpcProtocolGenerator.java

@@ -412,7 +412,7 @@ private void generateOperationDeserializer(GenerationContext context, OperationS
         // Write out the error deserialization dispatcher.
         Set<StructureShape> errorShapes = HttpProtocolGeneratorUtils.generateErrorDispatcher(
                 context, operation, responseType, this::writeErrorCodeParser,
-                isErrorCodeInBody, this::getErrorBodyLocation);
+                isErrorCodeInBody, this::getErrorBodyLocation, this::getOperationErrors);
         deserializingErrorShapes.addAll(errorShapes);
     }
 

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/integration/ProtocolGenerator.java

@@ -16,6 +16,7 @@
 package software.amazon.smithy.typescript.codegen.integration;
 
 import java.util.Collection;
+import java.util.Map;
 import java.util.stream.Collectors;
 import software.amazon.smithy.codegen.core.CodegenException;
 import software.amazon.smithy.codegen.core.Symbol;
@@ -263,6 +264,17 @@ static String getSerdeFunctionSymbolComponent(Symbol symbol, Shape shape) {
         }
     }
 
+    /**
+     * Returns a map of error names to their {@link ShapeId}.
+     *
+     * @param context the generation context
+     * @param operation the operation shape to retrieve errors for
+     * @return map of error names to {@link ShapeId}
+     */
+    default Map<String, ShapeId> getOperationErrors(GenerationContext context, OperationShape operation) {
+        return HttpProtocolGeneratorUtils.getOperationErrors(context, operation);
+    }
+
     /**
      * Context object used for service serialization and deserialization.
      */