use serde helper function & serde shortcuts

smithy-lang · Apr 13, 2023 · 968ad7b · 968ad7b
1 parent 918a54d
commit 968ad7b
Show file tree

Hide file tree

Showing 11 changed files with 544 additions and 26 deletions.
diff --git a/...ava/software/amazon/smithy/typescript/codegen/integration/DocumentMemberDeserVisitor.java b/...ava/software/amazon/smithy/typescript/codegen/integration/DocumentMemberDeserVisitor.java
@@ -45,6 +45,7 @@
 import software.amazon.smithy.model.shapes.UnionShape;
 import software.amazon.smithy.model.traits.TimestampFormatTrait.Format;
 import software.amazon.smithy.typescript.codegen.integration.ProtocolGenerator.GenerationContext;
+import software.amazon.smithy.typescript.codegen.validation.SerdeElision;
 import software.amazon.smithy.utils.SmithyUnstableApi;
 
 /**
@@ -66,6 +67,7 @@
  */
 @SmithyUnstableApi
 public class DocumentMemberDeserVisitor implements ShapeVisitor<String> {
+    protected final SerdeElision serdeElision;
     private final GenerationContext context;
     private final String dataSource;
     private final Format defaultTimestampFormat;
@@ -87,6 +89,8 @@ public DocumentMemberDeserVisitor(
         this.context = context;
         this.dataSource = dataSource;
         this.defaultTimestampFormat = defaultTimestampFormat;
+        this.serdeElision = SerdeElision.forModel(context.getModel())
+            .setEnabledForModel(false);
     }
 
     /**
@@ -283,6 +287,11 @@ private String getDelegateDeserializer(Shape shape) {
     private String getDelegateDeserializer(Shape shape, String customDataSource) {
         // Use the shape for the function name.
         Symbol symbol = context.getSymbolProvider().toSymbol(shape);
+
+        if (serdeElision.mayElide(shape)) {
+            return "_json(" + customDataSource + ")";
+        }
+
         return ProtocolGenerator.getDeserFunctionShortName(symbol)
                 + "(" + customDataSource + ", context)";
     }

diff --git a/.../java/software/amazon/smithy/typescript/codegen/integration/DocumentMemberSerVisitor.java b/.../java/software/amazon/smithy/typescript/codegen/integration/DocumentMemberSerVisitor.java
@@ -45,6 +45,7 @@
 import software.amazon.smithy.model.shapes.UnionShape;
 import software.amazon.smithy.model.traits.TimestampFormatTrait.Format;
 import software.amazon.smithy.typescript.codegen.integration.ProtocolGenerator.GenerationContext;
+import software.amazon.smithy.typescript.codegen.validation.SerdeElision;
 import software.amazon.smithy.utils.SmithyUnstableApi;
 
 /**
@@ -65,6 +66,7 @@
  */
 @SmithyUnstableApi
 public class DocumentMemberSerVisitor implements ShapeVisitor<String> {
+    protected final SerdeElision serdeElision;
     private final GenerationContext context;
     private final String dataSource;
     private final Format defaultTimestampFormat;
@@ -86,6 +88,8 @@ public DocumentMemberSerVisitor(
         this.context = context;
         this.dataSource = dataSource;
         this.defaultTimestampFormat = defaultTimestampFormat;
+        this.serdeElision = SerdeElision.forModel(context.getModel())
+            .setEnabledForModel(false);
     }
 
     /**
@@ -252,6 +256,11 @@ public final String unionShape(UnionShape shape) {
     private String getDelegateSerializer(Shape shape) {
         // Use the shape for the function name.
         Symbol symbol = context.getSymbolProvider().toSymbol(shape);
+
+        if (serdeElision.mayElide(shape)) {
+            return "_json(" + dataSource + ")";
+        }
+
         return ProtocolGenerator.getSerFunctionShortName(symbol)
                 + "(" + dataSource + ", context)";
     }

diff --git a/...java/software/amazon/smithy/typescript/codegen/integration/DocumentShapeDeserVisitor.java b/...java/software/amazon/smithy/typescript/codegen/integration/DocumentShapeDeserVisitor.java
@@ -34,6 +34,7 @@
 import software.amazon.smithy.model.shapes.UnionShape;
 import software.amazon.smithy.typescript.codegen.TypeScriptWriter;
 import software.amazon.smithy.typescript.codegen.integration.ProtocolGenerator.GenerationContext;
+import software.amazon.smithy.typescript.codegen.validation.SerdeElision;
 import software.amazon.smithy.utils.SmithyUnstableApi;
 
 /**
@@ -305,13 +306,19 @@ protected final void generateDeserFunction(
         String methodLongName =
                 ProtocolGenerator.getDeserFunctionName(symbol, context.getProtocolName());
 
-        writer.addImport(symbol, symbol.getName());
-        writer.writeDocs(methodLongName);
-        writer.openBlock("const $L = (\n"
-                       + "  output: any,\n"
-                       + "  context: __SerdeContext\n"
-                       + "): $T => {", "}", methodName, symbol, () -> functionBody.accept(context, shape));
-        writer.write("");
+        boolean mayElide = SerdeElision.forModel(context.getModel()).mayElide(shape);
+        if (mayElide) {
+            writer.write("// " + methodName + " omitted.");
+            writer.write("");
+        } else {
+            writer.addImport(symbol, symbol.getName());
+            writer.writeDocs(methodLongName);
+            writer.openBlock("const $L = (\n"
+                           + "  output: any,\n"
+                           + "  context: __SerdeContext\n"
+                           + "): $T => {", "}", methodName, symbol, () -> functionBody.accept(context, shape));
+            writer.write("");
+        }
     }
 
     @Override

diff --git a/...n/java/software/amazon/smithy/typescript/codegen/integration/DocumentShapeSerVisitor.java b/...n/java/software/amazon/smithy/typescript/codegen/integration/DocumentShapeSerVisitor.java
@@ -34,6 +34,7 @@
 import software.amazon.smithy.model.shapes.UnionShape;
 import software.amazon.smithy.typescript.codegen.TypeScriptWriter;
 import software.amazon.smithy.typescript.codegen.integration.ProtocolGenerator.GenerationContext;
+import software.amazon.smithy.typescript.codegen.validation.SerdeElision;
 import software.amazon.smithy.utils.SmithyUnstableApi;
 
 /**
@@ -302,12 +303,18 @@ private void generateSerFunction(
 
         writer.addImport(symbol, symbol.getName());
 
-        writer.writeDocs(methodLongName);
-        writer.openBlock("const $L = (\n"
-                       + "  input: $T,\n"
-                       + "  context: __SerdeContext\n"
-                       + "): any => {", "}", methodName, symbol, () -> functionBody.accept(context, shape));
-        writer.write("");
+        boolean mayElide = SerdeElision.forModel(context.getModel()).mayElide(shape);
+        if (mayElide) {
+            writer.write("// " + methodName + " omitted.");
+            writer.write("");
+        } else {
+            writer.writeDocs(methodLongName);
+            writer.openBlock("const $L = (\n"
+                        + "  input: $T,\n"
+                        + "  context: __SerdeContext\n"
+                        + "): any => {", "}", methodName, symbol, () -> functionBody.accept(context, shape));
+            writer.write("");
+        }
     }
 
     @Override

diff --git a/...a/software/amazon/smithy/typescript/codegen/integration/HttpBindingProtocolGenerator.java b/...a/software/amazon/smithy/typescript/codegen/integration/HttpBindingProtocolGenerator.java
@@ -75,6 +75,7 @@
 import software.amazon.smithy.typescript.codegen.TypeScriptDependency;
 import software.amazon.smithy.typescript.codegen.TypeScriptWriter;
 import software.amazon.smithy.typescript.codegen.endpointsV2.RuleSetParameterFinder;
+import software.amazon.smithy.typescript.codegen.validation.SerdeElision;
 import software.amazon.smithy.utils.ListUtils;
 import software.amazon.smithy.utils.OptionalUtils;
 import software.amazon.smithy.utils.SetUtils;
@@ -162,8 +163,13 @@ public final ApplicationProtocol getApplicationProtocol() {
     @Override
     public void generateSharedComponents(GenerationContext context) {
         TypeScriptWriter writer = context.getWriter();
-        writer.addImport("map", "__map", "@aws-sdk/smithy-client");
-        writer.write("const map = __map");
+        writer.addImport("map", null, "@aws-sdk/smithy-client");
+
+        if (context.getSettings().generateClient()) {
+            writer.addImport("withBaseException", null, "@aws-sdk/smithy-client");
+            SymbolReference exception = HttpProtocolGeneratorUtils.getClientBaseException(context);
+            writer.write("const throwDefaultError = withBaseException($T);", exception);
+        }
 
         deserializingErrorShapes.forEach(error -> generateErrorDeserializer(context, error));
         serializingErrorShapes.forEach(error -> generateErrorSerializer(context, error));
@@ -1348,6 +1354,15 @@ private String getNamedMembersInputParam(
         switch (bindingType) {
             case PAYLOAD:
                 Symbol symbol = context.getSymbolProvider().toSymbol(target);
+
+                boolean mayElideInput = SerdeElision.forModel(context.getModel())
+                    .setEnabledForModel(enableSerdeElision() && !context.getSettings().generateServerSdk())
+                    .mayElide(target);
+
+                if (mayElideInput) {
+                    return "_json(" + dataSource + ")";
+                }
+
                 return ProtocolGenerator.getSerFunctionShortName(symbol)
                         + "(" + dataSource + ", context)";
             default:
@@ -2088,7 +2103,6 @@ private void generateOperationResponseDeserializer(
             });
 
             List<HttpBinding> documentBindings = readResponseBody(context, operation, bindingIndex);
-
             // Track all shapes bound to the document so their deserializers may be generated.
             documentBindings.forEach(binding -> {
                 Shape target = model.expectShape(binding.getMember().getTarget());
@@ -2674,6 +2688,15 @@ private String getNamedMembersOutputParam(
             case PAYLOAD:
                 // Redirect to a deserialization function.
                 Symbol symbol = context.getSymbolProvider().toSymbol(target);
+
+                boolean mayElideOutput = SerdeElision.forModel(context.getModel())
+                    .setEnabledForModel(enableSerdeElision() && !context.getSettings().generateServerSdk())
+                    .mayElide(target);
+
+                if (mayElideOutput) {
+                    return "_json(" + dataSource + ")";
+                }
+
                 return ProtocolGenerator.getDeserFunctionShortName(symbol)
                         + "(" + dataSource + ", context)";
             default:
@@ -2858,4 +2881,14 @@ protected abstract void deserializeErrorDocumentBody(
      * @return true if this protocol disallows string epoch timestamps in payloads.
      */
     protected abstract boolean requiresNumericEpochSecondsInPayload();
+
+    /**
+     * Implement a return true if the protocol allows elision of serde functions
+     * as defined in {@link SerdeElision}.
+     *
+     * @return whether protocol implementation is compatible with serde elision.
+     */
+    protected boolean enableSerdeElision() {
+        return false;
+    }
 }
diff --git a/...ava/software/amazon/smithy/typescript/codegen/integration/HttpProtocolGeneratorUtils.java b/...ava/software/amazon/smithy/typescript/codegen/integration/HttpProtocolGeneratorUtils.java
@@ -364,7 +364,6 @@ static Set<StructureShape> generateErrorDispatcher(
             }
 
             // Error responses must be at least BaseException interface
-            SymbolReference baseExceptionReference = getClientBaseException(context);
             errorCodeGenerator.accept(context);
 
             Runnable defaultErrorHandler = () -> {
@@ -376,18 +375,15 @@ static Set<StructureShape> generateErrorDispatcher(
                     writer.write("const parsedBody = await parseBody(output.body, context);");
                 }
 
-                writer.addImport("throwDefaultError", "throwDefaultError", "@aws-sdk/smithy-client");
-
                 // Get the protocol specific error location for retrieving contents.
                 String errorLocation = bodyErrorLocationModifier.apply(context, "parsedBody");
-                writer.openBlock("throwDefaultError({", "})", () -> {
+                writer.openBlock("return throwDefaultError({", "})", () -> {
                     writer.write("output,");
                     if (errorLocation.equals("parsedBody")) {
                         writer.write("parsedBody,");
                     } else {
                         writer.write("parsedBody: $L,", errorLocation);
                     }
-                    writer.write("exceptionCtor: $T,", baseExceptionReference);
                     writer.write("errorCode");
                 });
             };
@@ -465,7 +461,7 @@ static void writeHostPrefix(GenerationContext context, OperationShape operation)
     /**
      * Construct a symbol reference of client's base exception class.
      */
-    private static SymbolReference getClientBaseException(GenerationContext context) {
+    public static SymbolReference getClientBaseException(GenerationContext context) {
         ServiceShape service = context.getService();
         SymbolProvider symbolProvider = context.getSymbolProvider();
         String serviceExceptionName = symbolProvider.toSymbol(service).getName()

diff --git a/.../java/software/amazon/smithy/typescript/codegen/integration/HttpRpcProtocolGenerator.java b/.../java/software/amazon/smithy/typescript/codegen/integration/HttpRpcProtocolGenerator.java
@@ -33,6 +33,7 @@
 import software.amazon.smithy.typescript.codegen.CodegenUtils;
 import software.amazon.smithy.typescript.codegen.TypeScriptDependency;
 import software.amazon.smithy.typescript.codegen.TypeScriptWriter;
+import software.amazon.smithy.typescript.codegen.validation.SerdeElision;
 import software.amazon.smithy.utils.OptionalUtils;
 import software.amazon.smithy.utils.SmithyUnstableApi;
 
@@ -129,6 +130,12 @@ public void generateSharedComponents(GenerationContext context) {
 
         TypeScriptWriter writer = context.getWriter();
 
+        if (context.getSettings().generateClient()) {
+            writer.addImport("withBaseException", null, "@aws-sdk/smithy-client");
+            SymbolReference exception = HttpProtocolGeneratorUtils.getClientBaseException(context);
+            writer.write("const throwDefaultError = withBaseException($T);", exception);
+        }
+
         // Write a function to generate HTTP requests since they're so similar.
         SymbolReference requestType = getApplicationProtocol().getRequestType();
         writer.addUseImports(requestType);
@@ -449,7 +456,7 @@ private void generateOperationDeserializer(GenerationContext context, OperationS
                     writer.write("...contents,");
                 });
             });
-            writer.write("return Promise.resolve(response);");
+            writer.write("return response;");
         });
         writer.write("");
 
@@ -487,9 +494,15 @@ private void generateErrorDeserializer(GenerationContext context, StructureShape
                 // the error shape here.
                 writer.write("const body = parseBody($L.body, context);", outputReference);
             }
-            writer.write("const deserialized: any = $L($L, context);",
-                    ProtocolGenerator.getDeserFunctionShortName(errorSymbol),
-                    getErrorBodyLocation(context, "body"));
+
+            if (SerdeElision.forModel(context.getModel()).mayElide(error)) {
+                writer.write("const deserialized: any = _json($L);",
+                getErrorBodyLocation(context, "body"));
+            } else {
+                writer.write("const deserialized: any = $L($L, context);",
+                ProtocolGenerator.getDeserFunctionShortName(errorSymbol),
+                getErrorBodyLocation(context, "body"));
+            }
 
             // Then load it into the object with additional error and response properties.
             writer.openBlock("const exception = new $T({", "});", errorSymbol, () -> {
@@ -598,4 +611,13 @@ protected abstract void deserializeOutputDocument(
             OperationShape operation,
             StructureShape outputStructure
     );
+
+    /**
+     * See {@link software.amazon.smithy.typescript.codegen.validation.SerdeElision}.
+     *
+     * @return whether protocol implementation is compatible with serde elision.
+     */
+    protected boolean enableSerdeElision() {
+        return false;
+    }
 }