Merge branch 'main' of github.com:smithy-lang/smithy-kotlin into kn-refactor-plugin

Author: lauzadis

CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## [1.3.19] - 11/05/2024
+
+## [1.3.18] - 10/31/2024
+
+### Fixes
+* [#1214](https://github.com/awslabs/aws-sdk-kotlin/issues/1214) Add support for connection idle monitoring for OkHttp via the engine config parameter `connectionIdlePollingInterval`. Monitoring is disabled by default to match previous behavior. This monitoring will switch to enabled by default in an upcoming minor version release.
+
+### Miscellaneous
+* Add `Accept` header to all RpcV2Cbor requests
+* Correct documentation for `ByteStream.writeToOutputStream`, add `ByteStream.appendToOutputStream`
+
 ## [1.3.17] - 10/16/2024
 
 ### Miscellaneous

codegen/smithy-aws-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/aws/protocols/RpcV2Cbor.kt

@@ -26,6 +26,9 @@ import software.amazon.smithy.model.traits.TimestampFormatTrait
 import software.amazon.smithy.model.traits.UnitTypeTrait
 import software.amazon.smithy.protocol.traits.Rpcv2CborTrait
 
+private const val ACCEPT_HEADER = "application/cbor"
+private const val ACCEPT_HEADER_EVENT_STREAM = "application/vnd.amazon.eventstream"
+
 class RpcV2Cbor : AwsHttpBindingProtocolGenerator() {
     override val protocol: ShapeId = Rpcv2CborTrait.ID
 
@@ -59,13 +62,16 @@ class RpcV2Cbor : AwsHttpBindingProtocolGenerator() {
             }
         }
 
-        // Requests with event stream responses MUST include an `Accept` header set to the value `application/vnd.amazon.eventstream`
-        val eventStreamsAcceptHeaderMiddleware = object : ProtocolMiddleware {
-            private val mutateHeadersMiddleware = MutateHeadersMiddleware(extraHeaders = mapOf("Accept" to "application/vnd.amazon.eventstream"))
-
-            override fun isEnabledFor(ctx: ProtocolGenerator.GenerationContext, op: OperationShape): Boolean = op.isOutputEventStream(ctx.model)
-            override val name: String = "RpcV2CborEventStreamsAcceptHeaderMiddleware"
-            override fun render(ctx: ProtocolGenerator.GenerationContext, op: OperationShape, writer: KotlinWriter) = mutateHeadersMiddleware.render(ctx, op, writer)
+        // Add `Accept` header with value `application/cbor` for standard responses
+        // and `application/vnd.amazon.eventstream` for event stream responses
+        val acceptHeaderMiddleware = object : ProtocolMiddleware {
+            override val name: String = "RpcV2CborAcceptHeaderMiddleware"
+            override fun render(ctx: ProtocolGenerator.GenerationContext, op: OperationShape, writer: KotlinWriter) {
+                val acceptHeaderValue = if (op.isOutputEventStream(ctx.model)) ACCEPT_HEADER_EVENT_STREAM else ACCEPT_HEADER
+                MutateHeadersMiddleware(
+                    extraHeaders = mapOf("Accept" to acceptHeaderValue),
+                ).render(ctx, op, writer)
+            }
         }
 
         // Emit a metric to track usage of RpcV2Cbor
@@ -79,7 +85,7 @@ class RpcV2Cbor : AwsHttpBindingProtocolGenerator() {
         return super.getDefaultHttpMiddleware(ctx) + listOf(
             smithyProtocolHeaderMiddleware,
             validateSmithyProtocolHeaderMiddleware,
-            eventStreamsAcceptHeaderMiddleware,
+            acceptHeaderMiddleware,
             businessMetricsMiddleware,
         )
     }

codegen/smithy-aws-kotlin-codegen/src/test/kotlin/software/amazon/smithy/kotlin/codegen/aws/protocols/RpcV2CborTest.kt

@@ -0,0 +1,101 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+package software.amazon.smithy.kotlin.codegen.aws.protocols
+
+import software.amazon.smithy.kotlin.codegen.test.*
+import kotlin.test.Test
+
+class RpcV2CborTest {
+    val model = """
+        ${"$"}version: "2"
+
+        namespace com.test
+        
+        use smithy.protocols#rpcv2Cbor
+        use aws.api#service
+
+        @rpcv2Cbor
+        @service(sdkId: "CborExample")
+        service CborExample {
+            version: "1.0.0",
+            operations: [GetFoo, GetFooStreaming]
+        }
+
+        @http(method: "POST", uri: "/foo")
+        operation GetFoo {}
+        
+        @http(method: "POST", uri: "/foo-streaming")
+        operation GetFooStreaming {
+            input := {}
+            output := {
+                events: FooEvents
+            }
+        }
+        
+        // Model taken from https://smithy.io/2.0/spec/streaming.html#event-streams
+        @streaming
+        union FooEvents {
+            up: Movement
+            down: Movement
+            left: Movement
+            right: Movement
+            throttlingError: ThrottlingError
+        }
+        
+        structure Movement {
+           velocity: Float
+        }
+        
+        @error("client")
+        @retryable(throttling: true)
+        structure ThrottlingError {}
+        """.toSmithyModel()
+
+    @Test
+    fun testStandardAcceptHeader() {
+        val ctx = model.newTestContext("CborExample")
+
+        val generator = RpcV2Cbor()
+        generator.generateProtocolClient(ctx.generationCtx)
+
+        ctx.generationCtx.delegator.finalize()
+        ctx.generationCtx.delegator.flushWriters()
+
+        val actual = ctx.manifest.expectFileString("/src/main/kotlin/com/test/DefaultTestClient.kt")
+        val getFooMethod = actual.lines("    override suspend fun getFoo(input: GetFooRequest): GetFooResponse {", "    }")
+
+        val expectedHeaderMutation = """
+        op.install(
+            MutateHeaders().apply {
+                append("Accept", "application/cbor")
+            }
+        )
+        """.replaceIndent("        ")
+        getFooMethod.shouldContainOnlyOnceWithDiff(expectedHeaderMutation)
+    }
+
+    @Test
+    fun testEventStreamAcceptHeader() {
+        val ctx = model.newTestContext("CborExample")
+
+        val generator = RpcV2Cbor()
+        generator.generateProtocolClient(ctx.generationCtx)
+
+        ctx.generationCtx.delegator.finalize()
+        ctx.generationCtx.delegator.flushWriters()
+
+        val actual = ctx.manifest.expectFileString("/src/main/kotlin/com/test/DefaultTestClient.kt")
+        val getFooMethod = actual.lines("    override suspend fun <T> getFooStreaming(input: GetFooStreamingRequest, block: suspend (GetFooStreamingResponse) -> T): T {", "    }")
+
+        val expectedHeaderMutation = """
+        op.install(
+            MutateHeaders().apply {
+                append("Accept", "application/vnd.amazon.eventstream")
+            }
+        )
+        """.replaceIndent("        ")
+        getFooMethod.shouldContainOnlyOnceWithDiff(expectedHeaderMutation)
+    }
+}

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

@@ -28,6 +28,7 @@ import software.amazon.smithy.model.traits.TimestampFormatTrait
 import software.amazon.smithy.model.traits.Trait
 import software.amazon.smithy.protocol.traits.Rpcv2CborTrait
 import software.amazon.smithy.utils.StringUtils
+import kotlin.test.assertNotEquals
 
 // This file houses test classes and functions relating to the code generator (protocols, serializers, etc)
 // Items contained here should be relatively high-level, utilizing all members of codegen classes, Smithy, and
@@ -274,3 +275,19 @@ fun KotlinCodegenPlugin.Companion.createSymbolProvider(
  * create a new [KotlinWriter] using the test context package name
  */
 fun TestContext.newWriter(): KotlinWriter = KotlinWriter(generationCtx.settings.pkg.name)
+
+/**
+ * Get all the lines between [fromLine] and [toLine]
+ */
+fun String.lines(fromLine: String, toLine: String): String {
+    val allLines = lines()
+
+    val fromIdx = allLines.indexOf(fromLine)
+    assertNotEquals(-1, fromIdx, """Could not find from line "$fromLine" in all lines""")
+
+    val toIdxOffset = allLines.drop(fromIdx + 1).indexOf(toLine)
+    assertNotEquals(-1, toIdxOffset, """Could not find to line "$toLine" in all lines""")
+
+    val toIdx = toIdxOffset + fromIdx + 1
+    return allLines.subList(fromIdx, toIdx + 1).joinToString("\n")
+}

codegen/smithy-kotlin-codegen/src/test/resources/sdk-ids-test-output.csv

@@ -236,7 +236,6 @@ Neptune,Neptune
 neptunedata,Neptunedata
 Network Firewall,NetworkFirewall
 NetworkManager,NetworkManager
-nimble,Nimble
 OAM,Oam
 Omics,Omics
 OpenSearch,OpenSearch

codegen/smithy-kotlin-codegen/src/test/resources/sdk-ids.csv

@@ -236,7 +236,6 @@ Neptune
 neptunedata
 Network Firewall
 NetworkManager
-nimble
 OAM
 Omics
 OpenSearch

gradle.properties

@@ -13,7 +13,7 @@ kotlinx.atomicfu.enableNativeIrTransformation=false
 org.gradle.jvmargs=-Xmx2G -XX:MaxMetaspaceSize=1G
 
 # SDK
-sdkVersion=1.3.18-SNAPSHOT
+sdkVersion=1.3.20-SNAPSHOT
 
 # codegen
-codegenVersion=0.33.18-SNAPSHOT
+codegenVersion=0.33.20-SNAPSHOT

gradle/libs.versions.toml

@@ -92,7 +92,7 @@ ktor-http-cio = { module = "io.ktor:ktor-http-cio", version.ref = "ktor-version"
 ktor-utils = { module = "io.ktor:ktor-utils", version.ref = "ktor-version" }
 ktor-io = { module = "io.ktor:ktor-io", version.ref = "ktor-version" }
 ktor-server-netty = { module = "io.ktor:ktor-server-netty", version.ref = "ktor-version" }
-ktor-server-jetty = { module = "io.ktor:ktor-server-jetty", version.ref = "ktor-version" }
+ktor-server-jetty-jakarta = { module = "io.ktor:ktor-server-jetty-jakarta", version.ref = "ktor-version" }
 ktor-server-cio = { module = "io.ktor:ktor-server-cio", version.ref = "ktor-version" }
 ktor-network-tls-certificates = { module = "io.ktor:ktor-network-tls-certificates", version.ref = "ktor-version" }
 

runtime/auth/aws-credentials/api/aws-credentials.api

@@ -3,6 +3,7 @@ public final class aws/smithy/kotlin/runtime/auth/awscredentials/CachedCredentia
 	public synthetic fun <init> (Laws/smithy/kotlin/runtime/auth/awscredentials/CredentialsProvider;JJLaws/smithy/kotlin/runtime/time/Clock;Lkotlin/jvm/internal/DefaultConstructorMarker;)V
 	public fun close ()V
 	public fun resolve (Laws/smithy/kotlin/runtime/collections/Attributes;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public fun toString ()Ljava/lang/String;
 }
 
 public final class aws/smithy/kotlin/runtime/auth/awscredentials/CachedCredentialsProviderKt {
@@ -45,6 +46,7 @@ public final class aws/smithy/kotlin/runtime/auth/awscredentials/CredentialsProv
 	public fun <init> (Ljava/util/List;)V
 	public fun <init> ([Laws/smithy/kotlin/runtime/auth/awscredentials/CredentialsProvider;)V
 	public fun resolve (Laws/smithy/kotlin/runtime/collections/Attributes;Lkotlin/coroutines/Continuation;)Ljava/lang/Object;
+	public fun toString ()Ljava/lang/String;
 }
 
 public abstract interface class aws/smithy/kotlin/runtime/auth/awscredentials/CredentialsProviderConfig {
@@ -61,6 +63,10 @@ public final class aws/smithy/kotlin/runtime/auth/awscredentials/CredentialsProv
 	public synthetic fun <init> (Ljava/lang/String;Ljava/lang/Throwable;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
 }
 
+public final class aws/smithy/kotlin/runtime/auth/awscredentials/CredentialsProviderKt {
+	public static final fun getSimpleClassName (Laws/smithy/kotlin/runtime/auth/awscredentials/CredentialsProvider;)Ljava/lang/String;
+}
+
 public abstract interface class aws/smithy/kotlin/runtime/auth/awscredentials/SigV4aClientConfig {
 	public abstract fun getSigV4aSigningRegionSet ()Ljava/util/Set;
 }

runtime/auth/aws-credentials/common/src/aws/smithy/kotlin/runtime/auth/awscredentials/CachedCredentialsProvider.kt

@@ -73,6 +73,8 @@ public class CachedCredentialsProvider(
         cachedCredentials.close()
         source.closeIfCloseable()
     }
+
+    override fun toString(): String = this.simpleClassName + ": " + this.source.simpleClassName
 }
 
 /**