preserve shape names

Author: kuhe

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

@@ -532,7 +532,7 @@ private void generateOperationResponseSerializer(
         TypeScriptWriter writer = context.getWriter();
 
         writer.addUseImports(responseType);
-        String methodName = ProtocolGenerator.getGenericSerFunctionName(symbol) + "Res";
+        String methodName = ProtocolGenerator.getGenericSerFunctionName(symbol) + "Response";
         Symbol outputType = symbol.expectProperty("outputType", Symbol.class);
         writer.addImport("ServerSerdeContext", null, "@aws-smithy/server-common");
 
@@ -1735,7 +1735,7 @@ private void generateOperationRequestDeserializer(
         // Ensure that the request type is imported.
         writer.addUseImports(requestType);
         writer.addImport("Endpoint", "__Endpoint", "@aws-sdk/types");
-        String methodName = ProtocolGenerator.getGenericDeserFunctionName(symbol) + "Req";
+        String methodName = ProtocolGenerator.getGenericDeserFunctionName(symbol) + "Request";
         // Add the normalized input type.
         Symbol inputType = symbol.expectProperty("inputType", Symbol.class);
         String contextType = CodegenUtils.getOperationSerializerContextType(writer, context.getModel(), operation);

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

@@ -1,16 +1,14 @@
 /*
  * Copyright 2019 Amazon.com, Inc. or its affiliates. All Rights Reserved.
  *
- * Licensed under the Apache License, Version 2.0 (the "License").
- * You may not use this file except in compliance with the License.
- * A copy of the License is located at
+ * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except
+ * in compliance with the License. A copy of the License is located at
  *
- *  http://aws.amazon.com/apache2.0
+ * http://aws.amazon.com/apache2.0
  *
- * or in the "license" file accompanying this file. This file is distributed
- * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
- * express or implied. See the License for the specific language governing
- * permissions and limitations under the License.
+ * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
  */
 
 package software.amazon.smithy.typescript.codegen.integration;
@@ -30,7 +28,6 @@
 import software.amazon.smithy.typescript.codegen.TypeScriptDelegator;
 import software.amazon.smithy.typescript.codegen.TypeScriptSettings;
 import software.amazon.smithy.typescript.codegen.TypeScriptWriter;
-import software.amazon.smithy.typescript.codegen.protocol.SerdeFunctionNameShortener;
 import software.amazon.smithy.utils.CaseUtils;
 import software.amazon.smithy.utils.SmithyUnstableApi;
 
@@ -40,16 +37,13 @@
 @SmithyUnstableApi
 public interface ProtocolGenerator {
     String PROTOCOLS_FOLDER = "protocols";
-    SerdeFunctionNameShortener NAME_SHORTENER = new SerdeFunctionNameShortener();
 
     /**
-     * Sanitizes the name of the protocol so it can be used as a symbol
-     * in TypeScript.
+     * Sanitizes the name of the protocol so it can be used as a symbol in TypeScript.
      *
      * <p>
-     * For example, the default implementation converts "." to "_",
-     * and converts "-" to become camelCase separated words. This means
-     * that "aws.rest-json-1.1" becomes "Aws_RestJson1_1".
+     * For example, the default implementation converts "." to "_", and converts "-" to become
+     * camelCase separated words. This means that "aws.rest-json-1.1" becomes "Aws_RestJson1_1".
      *
      * @param name Name of the protocol to sanitize.
      * @return Returns the sanitized name.
@@ -70,8 +64,8 @@ static String getSanitizedName(String name) {
      * Gets the name of the protocol.
      *
      * <p>
-     * The default implementation is the ShapeId name of the protocol trait in
-     * Smithy models (e.g., "aws.protocols#restJson1" would return "restJson1").
+     * The default implementation is the ShapeId name of the protocol trait in Smithy models (e.g.,
+     * "aws.protocols#restJson1" would return "restJson1").
      *
      * @return Returns the protocol name.
      */
@@ -87,36 +81,30 @@ default String getName() {
     ApplicationProtocol getApplicationProtocol();
 
     /**
-     * Determines if two protocol generators are compatible at the
-     * application protocol level, meaning they both use HTTP, or MQTT
-     * for example.
+     * Determines if two protocol generators are compatible at the application protocol level,
+     * meaning they both use HTTP, or MQTT for example.
      *
      * <p>
      * Two protocol implementations are considered compatible if the
-     * {@link ApplicationProtocol#equals} method of {@link #getApplicationProtocol}
-     * returns true when called with {@code other}. The default implementation
-     * should work for most interfaces, but may be overridden for more in-depth
-     * handling of things like minor version incompatibilities.
+     * {@link ApplicationProtocol#equals} method of {@link #getApplicationProtocol} returns true
+     * when called with {@code other}. The default implementation should work for most interfaces,
+     * but may be overridden for more in-depth handling of things like minor version
+     * incompatibilities.
      *
      * <p>
-     * By default, if the application protocols are considered equal, then
-     * {@code other} is returned.
+     * By default, if the application protocols are considered equal, then {@code other} is
+     * returned.
      *
-     * @param service            Service being generated.
+     * @param service Service being generated.
      * @param protocolGenerators Other protocol generators that are being generated.
-     * @param other              Protocol generator to resolve against.
+     * @param other Protocol generator to resolve against.
      * @return Returns the resolved application protocol object.
      */
-    default ApplicationProtocol resolveApplicationProtocol(
-            ServiceShape service,
-            Collection<ProtocolGenerator> protocolGenerators,
-            ApplicationProtocol other) {
+    default ApplicationProtocol resolveApplicationProtocol(ServiceShape service,
+            Collection<ProtocolGenerator> protocolGenerators, ApplicationProtocol other) {
         if (!getApplicationProtocol().equals(other)) {
-            String protocolNames = protocolGenerators.stream()
-                    .map(ProtocolGenerator::getProtocol)
-                    .map(ShapeId::getName)
-                    .sorted()
-                    .collect(Collectors.joining(", "));
+            String protocolNames = protocolGenerators.stream().map(ProtocolGenerator::getProtocol)
+                    .map(ShapeId::getName).sorted().collect(Collectors.joining(", "));
             throw new CodegenException(String.format(
                     "All of the protocols generated for a service must be runtime compatible, but "
                             + "protocol `%s` is incompatible with other application protocols: [%s]. Please pick a "
@@ -133,27 +121,25 @@ default ApplicationProtocol resolveApplicationProtocol(
      * @param context Serde context.
      */
     default void generateSharedComponents(GenerationContext context) {
+        //
     }
 
     /**
-     * Generates the code used to serialize the shapes of a service
-     * for requests.
+     * Generates the code used to serialize the shapes of a service for requests.
      *
      * @param context Serialization context.
      */
     void generateRequestSerializers(GenerationContext context);
 
     /**
-     * Generates the code used to deserialize the shapes of a service
-     * for requests.
+     * Generates the code used to deserialize the shapes of a service for requests.
      *
      * @param context Serialization context.
      */
     void generateRequestDeserializers(GenerationContext context);
 
     /**
-     * Generates the code used to serialize the shapes of a service
-     * for responses.
+     * Generates the code used to serialize the shapes of a service for responses.
      *
      * @param context Serialization context.
      */
@@ -174,20 +160,17 @@ default void generateSharedComponents(GenerationContext context) {
     void generateServiceHandlerFactory(GenerationContext context);
 
     /**
-     * Generates the code used to handle a request for a specific operation in the
-     * given service. This allows the
-     * business logic for a service to be split among multiple deployment targets,
-     * for example, one Lambda function
-     * per operation.
+     * Generates the code used to handle a request for a specific operation in the given service.
+     * This allows the business logic for a service to be split among multiple deployment targets,
+     * for example, one Lambda function per operation.
      *
-     * @param context   Generation context.
+     * @param context Generation context.
      * @param operation The operation to generate a handler factory for.
      */
     void generateOperationHandlerFactory(GenerationContext context, OperationShape operation);
 
     /**
-     * Generates the code used to deserialize the shapes of a service
-     * for responses.
+     * Generates the code used to deserialize the shapes of a service for responses.
      *
      * @param context Deserialization context.
      */
@@ -203,7 +186,7 @@ default void generateSharedComponents(GenerationContext context) {
     /**
      * Generates the name of a serializer function for shapes of a service.
      *
-     * @param symbol   The symbol the serializer function is being generated for.
+     * @param symbol The symbol the serializer function is being generated for.
      * @param protocol Name of the protocol being generated.
      * @return Returns the generated function name.
      */
@@ -212,7 +195,8 @@ static String getSerFunctionName(Symbol symbol, String protocol) {
         String functionName = "serialize" + ProtocolGenerator.getSanitizedName(protocol);
 
         // Update the function to have a component based on the symbol.
-        functionName += getSerdeFunctionSymbolComponent(symbol, symbol.expectProperty("shape", Shape.class));
+        functionName += getSerdeFunctionSymbolComponent(symbol,
+                symbol.expectProperty("shape", Shape.class));
 
         return functionName;
     }
@@ -225,27 +209,28 @@ static String getSerFunctionShortName(Symbol symbol) {
         // e.g., se_ES for ExecuteStatement
         String functionName = "se_";
         // Update the function to have a component based on the symbol.
-        functionName += NAME_SHORTENER
-                .getAbbreviatedName(symbol, symbol.expectProperty("shape", Shape.class));
+        functionName += ProtocolGenerator.getSerdeFunctionSymbolComponent(symbol,
+                symbol.expectProperty("shape", Shape.class));
         return functionName;
     }
 
     /**
-     * Generates the name of a serializer function for shapes of a service that is
-     * not protocol-specific.
+     * Generates the name of a serializer function for shapes of a service that is not
+     * protocol-specific.
      *
      * @param symbol The symbol the serializer function is being generated for.
      * @return Returns the generated function name.
      */
     static String getGenericSerFunctionName(Symbol symbol) {
         // e.g., serializeExecuteStatement
-        return "serialize" + getSerdeFunctionSymbolComponent(symbol, symbol.expectProperty("shape", Shape.class));
+        return "serialize" + getSerdeFunctionSymbolComponent(symbol,
+                symbol.expectProperty("shape", Shape.class));
     }
 
     /**
      * Generates the name of a deserializer function for shapes of a service.
      *
-     * @param symbol   The symbol the deserializer function is being generated for.
+     * @param symbol The symbol the deserializer function is being generated for.
      * @param protocol Name of the protocol being generated.
      * @return Returns the generated function name.
      */
@@ -254,7 +239,8 @@ static String getDeserFunctionName(Symbol symbol, String protocol) {
         String functionName = "deserialize" + ProtocolGenerator.getSanitizedName(protocol);
 
         // Update the function to have a component based on the symbol.
-        functionName += getSerdeFunctionSymbolComponent(symbol, symbol.expectProperty("shape", Shape.class));
+        functionName += getSerdeFunctionSymbolComponent(symbol,
+                symbol.expectProperty("shape", Shape.class));
 
         return functionName;
     }
@@ -267,22 +253,22 @@ static String getDeserFunctionShortName(Symbol symbol) {
         // e.g., de_ES for ExecuteStatement
         String functionName = "de_";
         // Update the function to have a component based on the symbol.
-        functionName += NAME_SHORTENER
-                .getAbbreviatedName(symbol, symbol.expectProperty("shape", Shape.class));
+        functionName += ProtocolGenerator.getSerdeFunctionSymbolComponent(symbol,
+                symbol.expectProperty("shape", Shape.class));
         return functionName;
     }
 
     /**
-     * Generates the name of a deserializer function for shapes of a service that is
-     * not protocol-specific.
+     * Generates the name of a deserializer function for shapes of a service that is not
+     * protocol-specific.
      *
      * @param symbol The symbol the deserializer function is being generated for.
      * @return Returns the generated function name.
      */
     static String getGenericDeserFunctionName(Symbol symbol) {
         // e.g., deserializeExecuteStatement
-        return "deserialize"
-                + getSerdeFunctionSymbolComponent(symbol, symbol.expectProperty("shape", Shape.class));
+        return "deserialize" + getSerdeFunctionSymbolComponent(symbol,
+                symbol.expectProperty("shape", Shape.class));
     }
 
     static String getSerdeFunctionSymbolComponent(Symbol symbol, Shape shape) {
@@ -302,11 +288,12 @@ static String getSerdeFunctionSymbolComponent(Symbol symbol, Shape shape) {
     /**
      * Returns a map of error names to their {@link ShapeId}.
      *
-     * @param context   the generation context
+     * @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) {
+    default Map<String, ShapeId> getOperationErrors(GenerationContext context,
+            OperationShape operation) {
         return HttpProtocolGeneratorUtils.getOperationErrors(context, operation);
     }
 

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

@@ -81,7 +81,7 @@ public static Collection<Object[]> validMemberTargetTypes() {
         MemberShape member = MemberShape.builder().id(id + "$member").target(targetId).build();
         MemberShape key = MemberShape.builder().id(id + "$key").target(targetId).build();
         MemberShape value = MemberShape.builder().id(id + "$value").target(targetId).build();
-        String delegate = "de_F"
+        String delegate = "de_Foo"
                 + "(" + DATA_SOURCE + ", context)";
 
         return ListUtils.of(new Object[][] {
@@ -121,7 +121,7 @@ public static Collection<Object[]> validMemberTargetTypes() {
                 },
                 {
                         UnionShape.builder().id(id).addMember(member).build(),
-                        "de_F(__expectUnion(" + DATA_SOURCE + "), context)",
+                        "de_Foo(__expectUnion(" + DATA_SOURCE + "), context)",
                         source
                 },
         });

smithy-typescript-codegen/src/main/java/software/amazon/smithy/typescript/codegen/protocol/SerdeFunctionNameShortener.java

@@ -66,7 +66,7 @@ public static Collection<Object[]> validMemberTargetTypes() {
         MemberShape member = MemberShape.builder().id(id + "$member").target(targetId).build();
         MemberShape key = MemberShape.builder().id(id + "$key").target(targetId).build();
         MemberShape value = MemberShape.builder().id(id + "$value").target(targetId).build();
-        String delegate = "se_F(" + DATA_SOURCE + ", context)";
+        String delegate = "se_Foo(" + DATA_SOURCE + ", context)";
 
         return ListUtils.of(new Object[][] {
                 { BooleanShape.builder().id(id).build(), DATA_SOURCE },