Update to SerdeContext

kstich · kstich · commit afd97d2c75fb · 2019-10-24T16:04:20.000-07:00
This commit updates Command and Protocol generation to match expected,
consolidated SerdeContext instead of distinct (de)serializers. It also
fixes issues in writing the serde dispatch.
diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/ApplicationProtocol.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/ApplicationProtocol.java
@@ -96,6 +96,7 @@ static ApplicationProtocol resolve(
             ServiceShape service,
             Collection<TypeScriptIntegration> integrations
     ) {
+        // TODO If we're going to need to resolve this more than once, store it.
         List<String> resolvedProtocols = settings.resolveServiceProtocols(service);
         // Get the list of protocol generators that have implementations from the service.
         List<ProtocolGenerator> generators = integrations.stream()
diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CommandGenerator.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/CommandGenerator.java
@@ -89,14 +89,14 @@ public void run() {
         writer.addImport("ServiceInputTypes", "ServiceInputTypes", serviceSymbol.getNamespace());
         writer.addImport("ServiceOutputTypes", "ServiceOutputTypes", serviceSymbol.getNamespace());
         writer.addImport("Command", "$Command", "@aws-sdk/smithy-client");
-        writer.addImport("*", "$types", "@aws-sdk/types");
+        writer.addImport("FinalizeHandlerArguments", "FinalizeHandlerArguments", "@aws-sdk/types");
+        writer.addImport("Handler", "Handler", "@aws-sdk/types");
+        writer.addImport("HandlerExecutionContext", "HandlerExecutionContext", "@aws-sdk/types");
+        writer.addImport("MiddlewareStack", "MiddlewareStack", "@aws-sdk/types");
+        writer.addImport("SerdeContext", "SerdeContext", "@aws-sdk/types");
 
         addInputAndOutputTypes();
 
-        // This "Utils" type is used when serializing and deserializing commands. It
-        // provides various platform specific methods that serde needs.
-        writer.write("type Utils = { [key: string]: any };").write("");
-
         String name = symbol.getName();
         writer.openBlock("export class $L extends $$Command<$L, $L> {", "}", name, inputType, outputType, () -> {
 
@@ -126,17 +126,13 @@ private void generateCommandConstructor() {
                     .pushState(COMMAND_CONSTRUCTOR_SECTION)
                     .write("super();")
                     .popState()
-                    .write("// Start section: $L", COMMAND_CONSTRUCTOR_SECTION);
+                    .write("// End section: $L", COMMAND_CONSTRUCTOR_SECTION);
         });
     }
 
     private void generateCommandMiddlewareResolver(String configType) {
-        Symbol ser = Symbol.builder()
-                .name("serializerPlugin")
-                .namespace("@aws-sdk/middleware-serde", "/")
-                .build();
-        Symbol deser = Symbol.builder()
-                .name("deserializerPlugin")
+        Symbol serde = Symbol.builder()
+                .name("serdePlugin")
                 .namespace("@aws-sdk/middleware-serde", "/")
                 .addDependency(PackageJsonGenerator.NORMAL_DEPENDENCY,
                                "@aws-sdk/middleware-serde",
@@ -145,26 +141,25 @@ private void generateCommandMiddlewareResolver(String configType) {
 
         writer.write("resolveMiddleware(")
                 .indent()
-                .write("clientStack: $$types.MiddlewareStack<$L, $L>,", inputType, outputType)
+                .write("clientStack: MiddlewareStack<$L, $L>,", inputType, outputType)
                 .write("configuration: $L,", configType)
                 .write("options?: $T", applicationProtocol.getOptionsType())
                 .dedent();
-        writer.openBlock("): $$types.Handler<$L, $L> {", "}", inputType, outputType, () -> {
-            // Add serialization and deserialization plugins.
-            writer.write("this.use($T(configuration, this.serialize));", ser);
-            writer.write("this.use($T<$L>(configuration, this.deserialize));", deser, outputType);
+        writer.openBlock("): Handler<$L, $L> {", "}", inputType, outputType, () -> {
+            // Add serialization and deserialization plugin.
+            writer.write("this.use($T(configuration, this.serialize, this.deserialize));", serde);
 
             // Add customizations.
             addCommandSpecificPlugins();
 
             // Resolve the middleware stack.
             writer.write("\nconst stack = clientStack.concat(this.middlewareStack);\n");
-            writer.openBlock("const handlerExecutionContext: $$types.HandlerExecutionContext = {", "}", () -> {
+            writer.openBlock("const handlerExecutionContext: HandlerExecutionContext = {", "}", () -> {
                 writer.write("logger: {} as any,");
             });
             writer.write("const { httpHandler } = configuration;");
             writer.openBlock("return stack.resolve(", ");", () -> {
-                writer.write("(request: $$types.FinalizeHandlerArguments<any>) => ");
+                writer.write("(request: FinalizeHandlerArguments<any>) => ");
                 writer.write("  httpHandler.handle(request.request as $T, options || {}),",
                              applicationProtocol.getRequestType());
                 writer.write("handlerExecutionContext");
@@ -205,7 +200,7 @@ private void writeSerde() {
                 .indent()
                     .write("input: $L,", inputType)
                     .write("protocol: string,")
-                    .write("utils?: Utils")
+                    .write("context: SerdeContext")
                 .dedent()
                 .openBlock("): $T {", "}", applicationProtocol.getRequestType(), () -> writeSerdeDispatcher("input"));
 
@@ -214,7 +209,7 @@ private void writeSerde() {
                 .indent()
                     .write("output: $T,", applicationProtocol.getResponseType())
                     .write("protocol: string,")
-                    .write("utils?: Utils")
+                    .write("context: SerdeContext")
                 .dedent()
                 .openBlock("): Promise<$L> {", "}", outputType, () -> writeSerdeDispatcher("output"))
                 .write("");
@@ -226,11 +221,13 @@ private void writeSerdeDispatcher(String inputOrOutput) {
             // For example:
             // case 'aws.rest-json-1.1':
             //   return getFooCommandAws_RestJson1_1Serialize(input, utils);
-            //
-            for (String protocol : settings.getProtocols()) {
+            // TODO Validate this is the right set of protocols; settings.protocols was empty here.
+            for (String protocol : settings.resolveServiceProtocols(service)) {
                 String serdeFunctionName = getSerdeFunctionName(symbol, protocol, inputOrOutput);
+                writer.addImport(serdeFunctionName, serdeFunctionName,
+                        "./protocols/" + ProtocolGenerator.getSanitizedName(protocol));
                 writer.write("case '$L':", protocol)
-                        .write("  return $L($L, utils);", serdeFunctionName, inputOrOutput);
+                        .write("  return $L($L, context);", serdeFunctionName, inputOrOutput);
             }
 
             writer.write("default:")
diff --git a/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptSettings.java b/smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/TypeScriptSettings.java
@@ -189,7 +189,7 @@ public ServiceShape getService(Model model) {
     /**
      * Gets the explicitly configured list of protocols to generate.
      *
-     * <p>Every returned protocol must utilize compatibke application protocols.
+     * <p>Every returned protocol must utilize compatible application protocols.
      *
      * @return Returns the configured list of protocols or an empty list.
      */
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
@@ -89,7 +89,7 @@ private void generateOperationSerializer(GenerationContext context, OperationSha
 
         // Ensure that the request type is imported.
         writer.addUseImports(requestType);
-        writer.addImport("SerializerUtils", "SerializerUtils", "@aws-sdk/types");
+        writer.addImport("SerdeContext", "SerdeContext", "@aws-sdk/types");
         writer.addImport("Endpoint", "__Endpoint", "@aws-sdk/types");
         // e.g., serializeAws_restJson1_1ExecuteStatement
         String serializerMethodName = "serialize" + ProtocolGenerator.getSanitizedName(getName()) + symbol.getName();
@@ -99,15 +99,15 @@ private void generateOperationSerializer(GenerationContext context, OperationSha
 
         writer.openBlock("export function $L(\n"
                          + "  input: $L,\n"
-                         + "  utils: SerializerUtils\n"
+                         + "  context: SerdeContext\n"
                          + "): $T {", "}", serializerMethodName, inputType, requestType, () -> {
             List<HttpBinding> labelBindings = writeRequestLabels(context, operation, bindingIndex, trait);
             List<HttpBinding> queryBindings = writeRequestQueryString(context, operation, bindingIndex);
             writeHeaders(context, operation, bindingIndex);
             List<HttpBinding> documentBindings = writeRequestBody(context, operation, bindingIndex);
 
             writer.openBlock("return new $T({", "});", requestType, () -> {
-                writer.write("...utils.endpoint,");
+                writer.write("...context.endpoint,");
                 writer.write("protocol: \"https\",");
                 writer.write("method: $S,", trait.getMethod());
                 if (labelBindings.isEmpty()) {
@@ -310,7 +310,7 @@ private void generateOperationDeserializer(GenerationContext context, OperationS
 
         // Ensure that the response type is imported.
         writer.addUseImports(responseType);
-        writer.addImport("DeserializerUtils", "DeserializerUtils", "@aws-sdk/types");
+        writer.addImport("SerdeContext", "SerdeContext", "@aws-sdk/types");
         // e.g., deserializeAws_restJson1_1ExecuteStatement
         String methodName = "deserialize" + ProtocolGenerator.getSanitizedName(getName()) + symbol.getName();
 
@@ -320,7 +320,7 @@ private void generateOperationDeserializer(GenerationContext context, OperationS
 
         writer.openBlock("export function $L(\n"
                          + "  output: $T,\n"
-                         + "  utils: DeserializerUtils\n"
+                         + "  context: SerdeContext\n"
                          + "): Promise<$L> {", "}", methodName, responseType, outputType, () -> {
             // TODO: Check status code to create appropriate error type or response type.
             writeHeaders(context, operation, bindingIndex);

Original file line number	Diff line number	Diff line change
`@@ -189,7 +189,7 @@ public ServiceShape getService(Model model) {`
`189`	`189`	`/**`
`190`	`190`	`* Gets the explicitly configured list of protocols to generate.`
`191`	`191`	`*`
`192`		`- * <p>Every returned protocol must utilize compatibke application protocols.`
	`192`	`+ * <p>Every returned protocol must utilize compatible application protocols.`
`193`	`193`	`*`
`194`	`194`	`* @return Returns the configured list of protocols or an empty list.`
`195`	`195`	`*/`