Add support for service model protocols field (#6161)

* Add support for service model protocols field

* Changelog

* Add support for service model protocols field

* Account for Kinesis cbor customization in ProtocolUtils

* Deprecate ServiceMetadata.getProtocol()

* Deprecate ServiceMetadata.setProtocol()

* Add test for Cbor v1

Author: davidh44

.changes/next-release/feature-AWSSDKforJavav2-4a7af00.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "AWS SDK for Java v2",
+    "contributor": "",
+    "description": "Add support for protocols field in service model"
+}

codegen/src/main/java/software/amazon/awssdk/codegen/AddMetadata.java

@@ -28,6 +28,7 @@
 import software.amazon.awssdk.codegen.model.service.ServiceModel;
 import software.amazon.awssdk.codegen.naming.DefaultNamingStrategy;
 import software.amazon.awssdk.codegen.naming.NamingStrategy;
+import software.amazon.awssdk.codegen.utils.ProtocolUtils;
 import software.amazon.awssdk.utils.Pair;
 import software.amazon.awssdk.utils.StringUtils;
 
@@ -70,7 +71,7 @@ public static Metadata constructMetadata(ServiceModel serviceModel,
                 .withBaseExceptionName(String.format(Constant.BASE_EXCEPTION_NAME_PATTERN, serviceName))
                 .withBaseRequestName(String.format(Constant.BASE_REQUEST_NAME_PATTERN, serviceName))
                 .withBaseResponseName(String.format(Constant.BASE_RESPONSE_NAME_PATTERN, serviceName))
-                .withProtocol(Protocol.fromValue(serviceMetadata.getProtocol()))
+                .withProtocol(Protocol.fromValue(ProtocolUtils.resolveProtocol(serviceMetadata)))
                 .withJsonVersion(serviceMetadata.getJsonVersion())
                 .withEndpointPrefix(serviceMetadata.getEndpointPrefix())
                 .withSigningName(serviceMetadata.getSigningName())

codegen/src/main/java/software/amazon/awssdk/codegen/AddOperations.java

@@ -37,6 +37,7 @@
 import software.amazon.awssdk.codegen.model.service.ServiceModel;
 import software.amazon.awssdk.codegen.model.service.Shape;
 import software.amazon.awssdk.codegen.naming.NamingStrategy;
+import software.amazon.awssdk.codegen.utils.ProtocolUtils;
 
 /**
  * Constructs the operation model for every operation defined by the service.
@@ -164,7 +165,7 @@ public Map<String, OperationModel> constructOperations() {
             OperationModel operationModel = new OperationModel();
 
             operationModel.setOperationName(operationName);
-            operationModel.setServiceProtocol(serviceModel.getMetadata().getProtocol());
+            operationModel.setServiceProtocol(ProtocolUtils.resolveProtocol(serviceModel.getMetadata()));
             operationModel.setDeprecated(op.isDeprecated());
             operationModel.setDeprecatedMessage(op.getDeprecatedMessage());
             operationModel.setDocumentation(op.getDocumentation());

codegen/src/main/java/software/amazon/awssdk/codegen/AddShapes.java

@@ -40,6 +40,7 @@
 import software.amazon.awssdk.codegen.model.service.ServiceModel;
 import software.amazon.awssdk.codegen.model.service.Shape;
 import software.amazon.awssdk.codegen.naming.NamingStrategy;
+import software.amazon.awssdk.codegen.utils.ProtocolUtils;
 import software.amazon.awssdk.utils.StringUtils;
 import software.amazon.awssdk.utils.Validate;
 
@@ -464,6 +465,6 @@ private void fillContainerTypeMemberMetadata(Map<String, Shape> c2jShapes,
     }
 
     protected String getProtocol() {
-        return getServiceModel().getMetadata().getProtocol();
+        return ProtocolUtils.resolveProtocol(getServiceModel().getMetadata());
     }
 }

codegen/src/main/java/software/amazon/awssdk/codegen/customization/processors/ExplicitStringPayloadQueryProtocolProcessor.java

@@ -23,6 +23,7 @@
 import software.amazon.awssdk.codegen.model.service.Output;
 import software.amazon.awssdk.codegen.model.service.ServiceModel;
 import software.amazon.awssdk.codegen.model.service.Shape;
+import software.amazon.awssdk.codegen.utils.ProtocolUtils;
 
 /**
  * Operations with explicit String payloads are not supported for services with Query protocol. We fail the codegen if the
@@ -31,7 +32,7 @@
 public class ExplicitStringPayloadQueryProtocolProcessor implements CodegenCustomizationProcessor {
     @Override
     public void preprocess(ServiceModel serviceModel) {
-        String protocol = serviceModel.getMetadata().getProtocol();
+        String protocol = ProtocolUtils.resolveProtocol(serviceModel.getMetadata());
         if (!"ec2".equals(protocol) && !"query".equals(protocol)) {
             return;
         }

codegen/src/main/java/software/amazon/awssdk/codegen/customization/processors/MetadataModifiersProcessor.java

@@ -15,6 +15,7 @@
 
 package software.amazon.awssdk.codegen.customization.processors;
 
+import java.util.Collections;
 import software.amazon.awssdk.codegen.customization.CodegenCustomizationProcessor;
 import software.amazon.awssdk.codegen.model.config.customization.MetadataConfig;
 import software.amazon.awssdk.codegen.model.intermediate.IntermediateModel;
@@ -44,7 +45,7 @@ public void preprocess(ServiceModel serviceModel) {
 
         String customProtocol = metadataConfig.getProtocol();
         if (customProtocol != null) {
-            serviceMetadata.setProtocol(customProtocol);
+            serviceMetadata.setProtocols(Collections.singletonList(customProtocol));
         }
 
     }

codegen/src/main/java/software/amazon/awssdk/codegen/customization/processors/SmithyRpcV2CborProtocolProcessor.java

@@ -20,6 +20,7 @@
 import software.amazon.awssdk.codegen.model.service.Http;
 import software.amazon.awssdk.codegen.model.service.Operation;
 import software.amazon.awssdk.codegen.model.service.ServiceModel;
+import software.amazon.awssdk.codegen.utils.ProtocolUtils;
 
 /**
  * This processor only runs for services using the <code>smithy-rpc-v2-cbor</code> protocol.
@@ -29,7 +30,8 @@
 public class SmithyRpcV2CborProtocolProcessor implements CodegenCustomizationProcessor {
     @Override
     public void preprocess(ServiceModel serviceModel) {
-        if (!"smithy-rpc-v2-cbor".equals(serviceModel.getMetadata().getProtocol())) {
+        String protocol = ProtocolUtils.resolveProtocol(serviceModel.getMetadata());
+        if (!"smithy-rpc-v2-cbor".equals(protocol)) {
             return;
         }
         serviceModel.getOperations().forEach((name, op) -> setRequestUri(serviceModel, name, op));

codegen/src/main/java/software/amazon/awssdk/codegen/internal/Utils.java

@@ -39,6 +39,7 @@
 import software.amazon.awssdk.codegen.model.service.ServiceModel;
 import software.amazon.awssdk.codegen.model.service.Shape;
 import software.amazon.awssdk.codegen.model.service.XmlNamespace;
+import software.amazon.awssdk.codegen.utils.ProtocolUtils;
 import software.amazon.awssdk.utils.IoUtils;
 import software.amazon.awssdk.utils.StringUtils;
 
@@ -331,11 +332,13 @@ public static ShapeMarshaller createInputShapeMarshaller(ServiceMetadata service
                     "The operation parameter must be specified!");
         }
 
+        String protocol = ProtocolUtils.resolveProtocol(service);
+
         ShapeMarshaller marshaller = new ShapeMarshaller()
                 .withAction(operation.getName())
                 .withVerb(operation.getHttp().getMethod())
                 .withRequestUri(operation.getHttp().getRequestUri())
-                .withProtocol(service.getProtocol());
+                .withProtocol(protocol);
         Input input = operation.getInput();
         if (input != null) {
             marshaller.setLocationName(input.getLocationName());
@@ -345,7 +348,7 @@ public static ShapeMarshaller createInputShapeMarshaller(ServiceMetadata service
                 marshaller.setXmlNameSpaceUri(xmlNamespace.getUri());
             }
         }
-        if (Metadata.usesOperationIdentifier(service.getProtocol())) {
+        if (Metadata.usesOperationIdentifier(protocol)) {
             marshaller.setTarget(StringUtils.isEmpty(service.getTargetPrefix()) ?
                                  operation.getName() :
                                  service.getTargetPrefix() + "." + operation.getName());

codegen/src/main/java/software/amazon/awssdk/codegen/model/service/ServiceMetadata.java

@@ -17,6 +17,7 @@
 
 import java.util.List;
 import java.util.Map;
+import software.amazon.awssdk.codegen.utils.ProtocolUtils;
 
 public class ServiceMetadata {
 
@@ -36,6 +37,8 @@ public class ServiceMetadata {
 
     private String protocol;
 
+    private List<String> protocols;
+
     private String jsonVersion;
 
     private Map<String, String> awsQueryCompatible;
@@ -103,14 +106,30 @@ public void setXmlNamespace(String xmlNamespace) {
         this.xmlNamespace = xmlNamespace;
     }
 
+    /**
+     * {@code protocol} superseded by {@code protocols} field, resolved in {@link ProtocolUtils#resolveProtocol(ServiceMetadata)}
+     */
+    @Deprecated
     public String getProtocol() {
         return protocol;
     }
 
+    /**
+     * {@code protocol} superseded by {@code protocols} field, resolved in {@link ProtocolUtils#resolveProtocol(ServiceMetadata)}
+     */
+    @Deprecated
     public void setProtocol(String protocol) {
         this.protocol = protocol;
     }
 
+    public List<String> getProtocols() {
+        return protocols;
+    }
+
+    public void setProtocols(List<String> protocols) {
+        this.protocols = protocols;
+    }
+
     public String getJsonVersion() {
         return jsonVersion;
     }

codegen/src/main/java/software/amazon/awssdk/codegen/utils/ProtocolUtils.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright 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
+ *
+ *  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.
+ */
+
+package software.amazon.awssdk.codegen.utils;
+
+import java.util.Arrays;
+import java.util.List;
+import software.amazon.awssdk.codegen.model.service.ServiceMetadata;
+
+/**
+ * Resolves the protocol from the service model {@code protocol} and {@code protocols} fields.
+ */
+public final class ProtocolUtils {
+
+    /**
+     * Priority-ordered list of protocols supported by the SDK.
+     */
+    private static final List<String> SUPPORTED_PROTOCOLS = Arrays.asList(
+        "smithy-rpc-v2-cbor", "json", "rest-json", "rest-xml", "query", "ec2");
+
+    private ProtocolUtils() {
+    }
+
+    /**
+     * {@code protocols} supersedes {@code protocol}. The highest priority protocol supported by the SDK that is present in the
+     * service model {@code protocols} list will be selected. If none of the values in {@code protocols} is supported by the
+     * SDK, an error will be thrown. If {@code protocols} is empty or null, the value from {@code protocol} will be returned.
+     */
+    public static String resolveProtocol(ServiceMetadata serviceMetadata) {
+
+        List<String> protocols = serviceMetadata.getProtocols();
+        String protocol = serviceMetadata.getProtocol();
+
+        if (protocols == null || protocols.isEmpty()) {
+            return protocol;
+        }
+
+        // Kinesis uses customization.config customServiceMetadata to set cbor
+        if ("cbor".equals(protocols.get(0))) {
+            return "cbor";
+        }
+
+        for (String supportedProtocol : SUPPORTED_PROTOCOLS) {
+            if (protocols.contains(supportedProtocol)) {
+                return supportedProtocol;
+            }
+        }
+
+        throw new IllegalArgumentException("The SDK does not support any of provided protocols: " + protocols);
+    }
+}