feat: redesign presigning API (#854)

Author: ianbotsf

.changes/5066f1c0-75a2-4eac-beb8-a48a1fbc8f18.json

@@ -0,0 +1,8 @@
+{
+    "id": "5066f1c0-75a2-4eac-beb8-a48a1fbc8f18",
+    "type": "feature",
+    "description": "**Breaking**: Refresh presigning APIs to simplify usage and add new capabilities. See [this discussion post](https://github.com/awslabs/aws-sdk-kotlin/discussions/925) for more information.",
+    "issues": [
+        "awslabs/smithy-kotlin#755"
+    ]
+}

codegen/smithy-kotlin-codegen-testutils/src/main/kotlin/software/amazon/smithy/kotlin/codegen/test/CodegenTestUtils.kt

@@ -4,7 +4,12 @@
  */
 package software.amazon.smithy.kotlin.codegen.test
 
+import software.amazon.smithy.aws.traits.protocols.AwsJson1_0Trait
+import software.amazon.smithy.aws.traits.protocols.AwsJson1_1Trait
+import software.amazon.smithy.aws.traits.protocols.AwsQueryTrait
+import software.amazon.smithy.aws.traits.protocols.Ec2QueryTrait
 import software.amazon.smithy.aws.traits.protocols.RestJson1Trait
+import software.amazon.smithy.aws.traits.protocols.RestXmlTrait
 import software.amazon.smithy.build.MockManifest
 import software.amazon.smithy.codegen.core.Symbol
 import software.amazon.smithy.codegen.core.SymbolProvider
@@ -19,6 +24,7 @@ import software.amazon.smithy.model.knowledge.HttpBinding
 import software.amazon.smithy.model.knowledge.HttpBindingIndex
 import software.amazon.smithy.model.shapes.*
 import software.amazon.smithy.model.traits.TimestampFormatTrait
+import software.amazon.smithy.model.traits.Trait
 import software.amazon.smithy.utils.StringUtils
 
 // This file houses test classes and functions relating to the code generator (protocols, serializers, etc)
@@ -130,13 +136,29 @@ class TestProtocolClientGenerator(
     httpBindingResolver: HttpBindingResolver,
 ) : HttpProtocolClientGenerator(ctx, features, httpBindingResolver)
 
+private val allProtocols = setOf(
+    AwsJson1_0Trait.ID,
+    AwsJson1_1Trait.ID,
+    AwsQueryTrait.ID,
+    Ec2QueryTrait.ID,
+    RestJson1Trait.ID,
+    RestXmlTrait.ID,
+)
+
 /** An HttpBindingProtocolGenerator for testing (nothing is rendered for serializing/deserializing payload bodies) */
-class MockHttpProtocolGenerator : HttpBindingProtocolGenerator() {
+class MockHttpProtocolGenerator(model: Model) : HttpBindingProtocolGenerator() {
     override val defaultTimestampFormat: TimestampFormatTrait.Format = TimestampFormatTrait.Format.EPOCH_SECONDS
     override fun getProtocolHttpBindingResolver(model: Model, serviceShape: ServiceShape): HttpBindingResolver =
         HttpTraitResolver(model, serviceShape, ProtocolContentTypes.consistent("application/json"))
 
-    override val protocol: ShapeId = RestJson1Trait.ID
+    override val protocol: ShapeId = model
+        .serviceShapes
+        .single()
+        .allTraits
+        .values
+        .map(Trait::toShapeId)
+        .singleOrNull(allProtocols::contains)
+        ?: RestJson1Trait.ID
 
     override fun generateProtocolUnitTests(ctx: ProtocolGenerator.GenerationContext) {}
 

codegen/smithy-kotlin-codegen-testutils/src/main/kotlin/software/amazon/smithy/kotlin/codegen/test/ModelTestUtils.kt

@@ -116,7 +116,7 @@ fun Model.newTestContext(
     serviceName: String = TestModelDefault.SERVICE_NAME,
     packageName: String = TestModelDefault.NAMESPACE,
     settings: KotlinSettings = this.defaultSettings(serviceName, packageName),
-    generator: ProtocolGenerator = MockHttpProtocolGenerator(),
+    generator: ProtocolGenerator = MockHttpProtocolGenerator(this),
     integrations: List<KotlinIntegration> = listOf(),
 ): TestContext {
     val manifest = MockManifest()

codegen/smithy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/core/RuntimeTypes.kt

@@ -189,6 +189,12 @@ object RuntimeTypes {
             val EndpointProvider = symbol("EndpointProvider")
             val Endpoint = symbol("Endpoint")
             val EndpointProviderException = symbol("EndpointProviderException")
+            val SigningContext = symbol("SigningContext")
+            val SigningContextAttributeKey = symbol("SigningContextAttributeKey")
+
+            @get:JvmName("getSigningContextExtMethod")
+            val signingContext = symbol("signingContext")
+
             object Functions : RuntimeTypePackage(KotlinDependency.SMITHY_CLIENT, "endpoints.functions") {
                 val substring = symbol("substring")
                 val isValidHostLabel = symbol("isValidHostLabel")
@@ -272,13 +278,10 @@ object RuntimeTypes {
                 val AwsSignedBodyHeader = symbol("AwsSignedBodyHeader")
                 val AwsSigner = symbol("AwsSigner")
                 val AwsSigningAttributes = symbol("AwsSigningAttributes")
+                val AwsSigningConfig = symbol("AwsSigningConfig")
                 val HashSpecification = symbol("HashSpecification")
-                val createPresignedRequest = symbol("createPresignedRequest")
-                val PresignedRequestConfig = symbol("PresignedRequestConfig")
-                val PresigningLocation = symbol("PresigningLocation")
-                val ServicePresignConfig = symbol("ServicePresignConfig")
-                val SigningEndpointProvider = symbol("SigningEndpointProvider")
-                val SigningContextualizedEndpoint = symbol("SigningContextualizedEndpoint")
+                val mergeInto = symbol("mergeInto")
+                val presignRequest = symbol("presignRequest")
             }
 
             object AwsSigningStandard : RuntimeTypePackage(KotlinDependency.AWS_SIGNING_DEFAULT) {

codegen/smithy-kotlin-codegen/src/test/kotlin/software/amazon/smithy/kotlin/codegen/rendering/ServiceClientGeneratorTest.kt

@@ -203,7 +203,7 @@ class ServiceClientGeneratorTest {
         val writer = KotlinWriter(TestModelDefault.NAMESPACE)
         val service = model.getShape(ShapeId.from(TestModelDefault.SERVICE_SHAPE_ID)).get().asServiceShape().get()
         val settings = KotlinSettings(service.id, KotlinSettings.PackageSettings(TestModelDefault.NAMESPACE, TestModelDefault.MODEL_VERSION), sdkId = service.id.name)
-        val protocolGenerator = if (withProtocolGenerator) MockHttpProtocolGenerator() else null
+        val protocolGenerator = if (withProtocolGenerator) MockHttpProtocolGenerator(model) else null
         val renderingCtx = RenderingContext(writer, service, model, provider, settings, protocolGenerator)
         val generator = ServiceClientGenerator(renderingCtx)
 

gradle.properties

@@ -6,7 +6,7 @@ kotlin.native.ignoreDisabledTargets=true
 kotlin.mpp.enableCompatibilityMetadataVariant=true
 
 # SDK
-sdkVersion=0.20.1-SNAPSHOT
+sdkVersion=0.21.0-SNAPSHOT
 
 # kotlin
 kotlinVersion=1.8.10
@@ -44,4 +44,4 @@ kotlinLoggingVersion=3.0.0
 slf4jVersion=2.0.6
 
 # crt
-crtKotlinVersion=0.6.8
+crtKotlinVersion=0.6.8

runtime/auth/aws-signing-common/api/aws-signing-common.api

@@ -40,6 +40,9 @@ public final class aws/smithy/kotlin/runtime/auth/awssigning/AwsSigningAttribute
 	public final fun getSigningService ()Laws/smithy/kotlin/runtime/util/AttributeKey;
 }
 
+public final class aws/smithy/kotlin/runtime/auth/awssigning/AwsSigningAttributesKt {
+}
+
 public final class aws/smithy/kotlin/runtime/auth/awssigning/AwsSigningConfig {
 	public static final field Companion Laws/smithy/kotlin/runtime/auth/awssigning/AwsSigningConfig$Companion;
 	public fun <init> (Laws/smithy/kotlin/runtime/auth/awssigning/AwsSigningConfig$Builder;)V
@@ -154,77 +157,9 @@ public final class aws/smithy/kotlin/runtime/auth/awssigning/HashSpecification$U
 	public static final field INSTANCE Laws/smithy/kotlin/runtime/auth/awssigning/HashSpecification$UnsignedPayload;
 }
 
-public final class aws/smithy/kotlin/runtime/auth/awssigning/PresignedRequestConfig {
-	public synthetic fun <init> (Laws/smithy/kotlin/runtime/http/HttpMethod;Ljava/lang/String;Laws/smithy/kotlin/runtime/net/QueryParameters;JZLaws/smithy/kotlin/runtime/auth/awssigning/PresigningLocation;Laws/smithy/kotlin/runtime/http/Headers;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
-	public synthetic fun <init> (Laws/smithy/kotlin/runtime/http/HttpMethod;Ljava/lang/String;Laws/smithy/kotlin/runtime/net/QueryParameters;JZLaws/smithy/kotlin/runtime/auth/awssigning/PresigningLocation;Laws/smithy/kotlin/runtime/http/Headers;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
-	public final fun component1 ()Laws/smithy/kotlin/runtime/http/HttpMethod;
-	public final fun component2 ()Ljava/lang/String;
-	public final fun component3 ()Laws/smithy/kotlin/runtime/net/QueryParameters;
-	public final fun component4-UwyO8pc ()J
-	public final fun component5 ()Z
-	public final fun component6 ()Laws/smithy/kotlin/runtime/auth/awssigning/PresigningLocation;
-	public final fun component7 ()Laws/smithy/kotlin/runtime/http/Headers;
-	public final fun copy-45ZY6uE (Laws/smithy/kotlin/runtime/http/HttpMethod;Ljava/lang/String;Laws/smithy/kotlin/runtime/net/QueryParameters;JZLaws/smithy/kotlin/runtime/auth/awssigning/PresigningLocation;Laws/smithy/kotlin/runtime/http/Headers;)Laws/smithy/kotlin/runtime/auth/awssigning/PresignedRequestConfig;
-	public static synthetic fun copy-45ZY6uE$default (Laws/smithy/kotlin/runtime/auth/awssigning/PresignedRequestConfig;Laws/smithy/kotlin/runtime/http/HttpMethod;Ljava/lang/String;Laws/smithy/kotlin/runtime/net/QueryParameters;JZLaws/smithy/kotlin/runtime/auth/awssigning/PresigningLocation;Laws/smithy/kotlin/runtime/http/Headers;ILjava/lang/Object;)Laws/smithy/kotlin/runtime/auth/awssigning/PresignedRequestConfig;
-	public fun equals (Ljava/lang/Object;)Z
-	public final fun getAdditionalHeaders ()Laws/smithy/kotlin/runtime/http/Headers;
-	public final fun getExpiresAfter-UwyO8pc ()J
-	public final fun getMethod ()Laws/smithy/kotlin/runtime/http/HttpMethod;
-	public final fun getPath ()Ljava/lang/String;
-	public final fun getPresigningLocation ()Laws/smithy/kotlin/runtime/auth/awssigning/PresigningLocation;
-	public final fun getQueryString ()Laws/smithy/kotlin/runtime/net/QueryParameters;
-	public final fun getSignBody ()Z
-	public fun hashCode ()I
-	public fun toString ()Ljava/lang/String;
-}
-
 public final class aws/smithy/kotlin/runtime/auth/awssigning/PresignerKt {
 }
 
-public final class aws/smithy/kotlin/runtime/auth/awssigning/PresigningLocation : java/lang/Enum {
-	public static final field HEADER Laws/smithy/kotlin/runtime/auth/awssigning/PresigningLocation;
-	public static final field QUERY_STRING Laws/smithy/kotlin/runtime/auth/awssigning/PresigningLocation;
-	public static fun valueOf (Ljava/lang/String;)Laws/smithy/kotlin/runtime/auth/awssigning/PresigningLocation;
-	public static fun values ()[Laws/smithy/kotlin/runtime/auth/awssigning/PresigningLocation;
-}
-
-public abstract interface class aws/smithy/kotlin/runtime/auth/awssigning/ServicePresignConfig {
-	public abstract fun getCredentialsProvider ()Laws/smithy/kotlin/runtime/auth/awscredentials/CredentialsProvider;
-	public abstract fun getEndpointProvider ()Lkotlin/jvm/functions/Function2;
-	public abstract fun getNormalizeUriPath ()Z
-	public abstract fun getRegion ()Ljava/lang/String;
-	public abstract fun getServiceId ()Ljava/lang/String;
-	public abstract fun getSigner ()Laws/smithy/kotlin/runtime/auth/awssigning/AwsSigner;
-	public abstract fun getSigningName ()Ljava/lang/String;
-	public abstract fun getUseDoubleUriEncode ()Z
-}
-
-public final class aws/smithy/kotlin/runtime/auth/awssigning/SigningContext {
-	public fun <init> (Ljava/lang/String;Ljava/lang/String;)V
-	public final fun component1 ()Ljava/lang/String;
-	public final fun component2 ()Ljava/lang/String;
-	public final fun copy (Ljava/lang/String;Ljava/lang/String;)Laws/smithy/kotlin/runtime/auth/awssigning/SigningContext;
-	public static synthetic fun copy$default (Laws/smithy/kotlin/runtime/auth/awssigning/SigningContext;Ljava/lang/String;Ljava/lang/String;ILjava/lang/Object;)Laws/smithy/kotlin/runtime/auth/awssigning/SigningContext;
-	public fun equals (Ljava/lang/Object;)Z
-	public final fun getRegion ()Ljava/lang/String;
-	public final fun getService ()Ljava/lang/String;
-	public fun hashCode ()I
-	public fun toString ()Ljava/lang/String;
-}
-
-public final class aws/smithy/kotlin/runtime/auth/awssigning/SigningContextualizedEndpoint {
-	public fun <init> (Laws/smithy/kotlin/runtime/client/endpoints/Endpoint;Laws/smithy/kotlin/runtime/auth/awssigning/SigningContext;)V
-	public final fun component1 ()Laws/smithy/kotlin/runtime/client/endpoints/Endpoint;
-	public final fun component2 ()Laws/smithy/kotlin/runtime/auth/awssigning/SigningContext;
-	public final fun copy (Laws/smithy/kotlin/runtime/client/endpoints/Endpoint;Laws/smithy/kotlin/runtime/auth/awssigning/SigningContext;)Laws/smithy/kotlin/runtime/auth/awssigning/SigningContextualizedEndpoint;
-	public static synthetic fun copy$default (Laws/smithy/kotlin/runtime/auth/awssigning/SigningContextualizedEndpoint;Laws/smithy/kotlin/runtime/client/endpoints/Endpoint;Laws/smithy/kotlin/runtime/auth/awssigning/SigningContext;ILjava/lang/Object;)Laws/smithy/kotlin/runtime/auth/awssigning/SigningContextualizedEndpoint;
-	public fun equals (Ljava/lang/Object;)Z
-	public final fun getContext ()Laws/smithy/kotlin/runtime/auth/awssigning/SigningContext;
-	public final fun getEndpoint ()Laws/smithy/kotlin/runtime/client/endpoints/Endpoint;
-	public fun hashCode ()I
-	public fun toString ()Ljava/lang/String;
-}
-
 public final class aws/smithy/kotlin/runtime/auth/awssigning/internal/AwsChunkedUtilJVMKt {
 }
 

runtime/auth/aws-signing-common/common/src/aws/smithy/kotlin/runtime/auth/awssigning/AwsSigningAttributes.kt

@@ -4,7 +4,10 @@
  */
 package aws.smithy.kotlin.runtime.auth.awssigning
 
+import aws.smithy.kotlin.runtime.InternalApi
 import aws.smithy.kotlin.runtime.auth.awscredentials.CredentialsProvider
+import aws.smithy.kotlin.runtime.client.endpoints.SigningContext
+import aws.smithy.kotlin.runtime.operation.ExecutionContext
 import aws.smithy.kotlin.runtime.time.Instant
 import aws.smithy.kotlin.runtime.util.AttributeKey
 import kotlinx.coroutines.CompletableDeferred
@@ -64,3 +67,17 @@ public object AwsSigningAttributes {
      */
     public val RequestSignature: AttributeKey<CompletableDeferred<ByteArray>> = AttributeKey("aws.smithy.kotlin#RequestSignature")
 }
+
+/**
+ * Merges this signing context into the given [ExecutionContext].
+ * @param context The execution context into which to merge the values from this signing context.
+ */
+@InternalApi
+public fun SigningContext.SigV4.mergeInto(context: ExecutionContext) {
+    context.setUnlessBlank(AwsSigningAttributes.SigningService, signingName)
+    context.setUnlessBlank(AwsSigningAttributes.SigningRegion, signingRegion)
+}
+
+private fun ExecutionContext.setUnlessBlank(key: AttributeKey<String>, value: String?) {
+    if (!value.isNullOrBlank()) set(key, value)
+}