Auto-fill idempotency token values (#814)

This commit adds support for generating idempotency token values
when not set on input. These values are populated with a UUID v4
value provided by the `uuid` package.

This is done through setting the value on the provided input as to
not further complicate protocol specific member serialization.

Author: kstich

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

@@ -52,7 +52,9 @@ public enum AwsDependency implements SymbolDependencyContainer {
     SQS_MIDDLEWARE(NORMAL_DEPENDENCY, "@aws-sdk/middleware-sdk-sqs", "^1.0.0-alpha.0"),
     XML_BUILDER(NORMAL_DEPENDENCY, "@aws-sdk/xml-builder", "^1.0.0-alpha.1"),
     XML_PARSER(NORMAL_DEPENDENCY, "pixl-xml", "^1.0.13"),
-    XML_PARSER_TYPES(DEV_DEPENDENCY, "@types/pixl-xml", "^1.0.1");
+    XML_PARSER_TYPES(DEV_DEPENDENCY, "@types/pixl-xml", "^1.0.1"),
+    UUID_GENERATOR(NORMAL_DEPENDENCY, "uuid", "^3.4.0"),
+    UUID_GENERATOR_TYPES(DEV_DEPENDENCY, "@types/uuid", "^3.4.7");
 
     public final String packageName;
     public final String version;

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

@@ -76,6 +76,7 @@ public void generateSharedComponents(GenerationContext context) {
         super.generateSharedComponents(context);
         AwsProtocolUtils.generateXmlParseBody(context);
         AwsProtocolUtils.generateBuildFormUrlencodedString(context);
+        AwsProtocolUtils.addItempotencyAutofillImport(context);
 
         TypeScriptWriter writer = context.getWriter();
 

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

@@ -21,9 +21,11 @@
 import software.amazon.smithy.aws.traits.UnsignedPayloadTrait;
 import software.amazon.smithy.model.knowledge.NeighborProviderIndex;
 import software.amazon.smithy.model.neighbor.Walker;
+import software.amazon.smithy.model.shapes.MemberShape;
 import software.amazon.smithy.model.shapes.OperationShape;
 import software.amazon.smithy.model.shapes.Shape;
 import software.amazon.smithy.model.shapes.ShapeVisitor;
+import software.amazon.smithy.model.traits.IdempotencyTokenTrait;
 import software.amazon.smithy.model.traits.XmlNamespaceTrait;
 import software.amazon.smithy.typescript.codegen.TypeScriptWriter;
 import software.amazon.smithy.typescript.codegen.integration.ProtocolGenerator.GenerationContext;
@@ -101,6 +103,12 @@ static void generateJsonParseBody(GenerationContext context) {
         writer.write("");
     }
 
+    /**
+     * Writes a response body parser function for XML protocols. This
+     * will parse a present body after converting it to utf-8.
+     *
+     * @param context The generation context.
+     */
     static void generateXmlParseBody(GenerationContext context) {
         TypeScriptWriter writer = context.getWriter();
 
@@ -156,4 +164,40 @@ static void writeXmlNamespace(GenerationContext context, Shape shape, String nod
             writer.write("$L.addAttribute($S, $S);", nodeName, xmlns, trait.getUri());
         });
     }
+
+    /**
+     * Imports a UUID v4 generating function used for auto-filling idempotency tokens.
+     *
+     * @param context The generation context.
+     */
+    static void addItempotencyAutofillImport(GenerationContext context) {
+        context.getModel().shapes(MemberShape.class)
+                .filter(memberShape -> memberShape.hasTrait(IdempotencyTokenTrait.class))
+                .findFirst()
+                .ifPresent(memberShape -> {
+                    TypeScriptWriter writer = context.getWriter();
+
+                    // Include the uuid package and import the v4 function as our more clearly named alias.
+                    writer.addDependency(AwsDependency.UUID_GENERATOR);
+                    writer.addDependency(AwsDependency.UUID_GENERATOR_TYPES);
+                    writer.addImport("v4", "generateIdempotencyToken", "uuid");
+                });
+    }
+
+    /**
+     * Writes a statement that auto-fills the value of a member that is an idempotency
+     * token if it is undefined at the time of serialization.
+     *
+     * @param context The generation context.
+     * @param memberShape The member that may be an idempotency token.
+     * @param inputLocation The location of input data for the member.
+     */
+    static void writeIdempotencyAutofill(GenerationContext context, MemberShape memberShape, String inputLocation) {
+        if (memberShape.hasTrait(IdempotencyTokenTrait.class)) {
+            TypeScriptWriter writer = context.getWriter();
+
+            writer.openBlock("if ($L === undefined) {", "}", inputLocation, () ->
+                    writer.write("$L = generateIdempotencyToken();", inputLocation));
+        }
+    }
 }

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

@@ -76,6 +76,7 @@ public void generateSharedComponents(GenerationContext context) {
         super.generateSharedComponents(context);
         AwsProtocolUtils.generateXmlParseBody(context);
         AwsProtocolUtils.generateBuildFormUrlencodedString(context);
+        AwsProtocolUtils.addItempotencyAutofillImport(context);
 
         TypeScriptWriter writer = context.getWriter();
 

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

@@ -88,6 +88,7 @@ protected void generateDocumentBodyShapeDeserializers(GenerationContext context,
     public void generateSharedComponents(GenerationContext context) {
         super.generateSharedComponents(context);
         AwsProtocolUtils.generateXmlParseBody(context);
+        AwsProtocolUtils.addItempotencyAutofillImport(context);
 
         TypeScriptWriter writer = context.getWriter();
         writer.addDependency(AwsDependency.XML_BUILDER);
@@ -159,8 +160,11 @@ protected void serializeInputDocument(
             MemberShape memberShape = binding.getMember();
             // The name of the member to get from the input shape.
             String memberName = symbolProvider.toMemberName(memberShape);
-
             String inputLocation = "input." + memberName;
+
+            // Handle if the member is an idempotency token that should be auto-filled.
+            AwsProtocolUtils.writeIdempotencyAutofill(context, memberShape, inputLocation);
+
             writer.openBlock("if ($L !== undefined) {", "}", inputLocation, () -> {
                 shapeSerVisitor.serializeNamedMember(context, memberName, memberShape, () -> inputLocation);
             });

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

@@ -73,6 +73,7 @@ protected void generateDocumentBodyShapeDeserializers(GenerationContext context,
     public void generateSharedComponents(GenerationContext context) {
         super.generateSharedComponents(context);
         AwsProtocolUtils.generateJsonParseBody(context);
+        AwsProtocolUtils.addItempotencyAutofillImport(context);
     }
 
     @Override

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

@@ -97,9 +97,13 @@ public void serializeStructure(GenerationContext context, StructureShape shape)
                     .map(JsonNameTrait::getValue)
                     .orElse(memberName);
             Shape target = context.getModel().expectShape(memberShape.getTarget());
+            String inputLocation = "input." + memberName;
+
+            // Handle if the member is an idempotency token that should be auto-filled.
+            AwsProtocolUtils.writeIdempotencyAutofill(context, memberShape, inputLocation);
 
             // Generate an if statement to set the bodyParam if the member is set.
-            writer.openBlock("if (input.$L !== undefined) {", "}", memberName, () -> {
+            writer.openBlock("if ($L !== undefined) {", "}", inputLocation, () -> {
                 // Dispatch to the input value provider for any additional handling.
                 writer.write("bodyParams['$L'] = $L;", locationName,
                         target.accept(getMemberVisitor("input." + memberName)));

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

@@ -140,6 +140,10 @@ protected void serializeStructure(GenerationContext context, StructureShape shap
         // Serialize every member of the structure if present.
         shape.getAllMembers().forEach((memberName, memberShape) -> {
             String inputLocation = "input." + memberName;
+
+            // Handle if the member is an idempotency token that should be auto-filled.
+            AwsProtocolUtils.writeIdempotencyAutofill(context, memberShape, inputLocation);
+
             writer.openBlock("if ($L !== undefined) {", "}", inputLocation,
                     () -> serializeNamedMember(context, memberName, memberShape, inputLocation));
         });

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

@@ -71,6 +71,7 @@ protected void generateDocumentBodyShapeDeserializers(GenerationContext context,
     public void generateSharedComponents(GenerationContext context) {
         super.generateSharedComponents(context);
         AwsProtocolUtils.generateJsonParseBody(context);
+        AwsProtocolUtils.addItempotencyAutofillImport(context);
     }
 
     @Override
@@ -90,19 +91,23 @@ public void serializeInputDocument(
 
         writer.write("const bodyParams: any = {};");
         for (HttpBinding binding : documentBindings) {
-            MemberShape member = binding.getMember();
+            MemberShape memberShape = binding.getMember();
             // The name of the member to get from the input shape.
-            String memberName = symbolProvider.toMemberName(member);
+            String memberName = symbolProvider.toMemberName(memberShape);
+            String inputLocation = "input." + memberName;
             // Use the jsonName trait value if present, otherwise use the member name.
-            String locationName = member.getTrait(JsonNameTrait.class)
+            String locationName = memberShape.getTrait(JsonNameTrait.class)
                     .map(JsonNameTrait::getValue)
                     .orElseGet(binding::getLocationName);
-            Shape target = context.getModel().expectShape(member.getTarget());
+            Shape target = context.getModel().expectShape(memberShape.getTarget());
+
+            // Handle if the member is an idempotency token that should be auto-filled.
+            AwsProtocolUtils.writeIdempotencyAutofill(context, memberShape, inputLocation);
 
             // Generate an if statement to set the bodyParam if the member is set.
-            writer.openBlock("if (input.$L !== undefined) {", "}", memberName, () -> {
+            writer.openBlock("if ($L !== undefined) {", "}", inputLocation, () -> {
                 writer.write("bodyParams['$L'] = $L;", locationName,
-                        target.accept(getMemberSerVisitor(context, "input." + memberName)));
+                        target.accept(getMemberSerVisitor(context, inputLocation)));
             });
         }
 

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

@@ -147,6 +147,10 @@ protected void serializeStructure(GenerationContext context, StructureShape shap
         Map<String, MemberShape> members = shape.getAllMembers();
         members.forEach((memberName, memberShape) -> {
             String inputLocation = "input." + memberName;
+
+            // Handle if the member is an idempotency token that should be auto-filled.
+            AwsProtocolUtils.writeIdempotencyAutofill(context, memberShape, inputLocation);
+
             writer.openBlock("if ($L !== undefined) {", "}", inputLocation, () -> {
                 serializeNamedMember(context, memberName, memberShape, () -> inputLocation);
             });