Merge branch 'main' of github.com:smithy-lang/smithy-kotlin into jmespath-flatten

Author: lauzadis

.github/workflows/kat-transform.yml

@@ -0,0 +1,71 @@
+name: Kat Transform
+
+on:
+  pull_request:
+    types: [ opened, synchronize, reopened, labeled, unlabeled ]
+    branches: [ main ]
+
+# Allow one instance of this workflow per pull request, and cancel older runs when new changes are pushed
+concurrency:
+  group: kat-pr-${{ github.ref }}
+  cancel-in-progress: true
+
+permissions:
+  id-token: write
+  contents: read
+
+env:
+  RUN: ${{ github.run_id }}-${{ github.run_number }}
+  GRADLE_OPTS: "-Dorg.gradle.daemon=false -Dkotlin.incremental=false"
+
+jobs:
+  verify-transform:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout sources
+        uses: actions/checkout@v4
+        with:
+          path: 'smithy-kotlin'
+
+      - name: Configure AWS Credentials
+        uses: aws-actions/configure-aws-credentials@v4
+        with:
+          role-to-assume: ${{ secrets.CI_AWS_ROLE_ARN }}
+          aws-region: us-west-2
+
+      - name: Setup kat
+        uses: awslabs/aws-kotlin-repo-tools/.github/actions/setup-kat@main
+
+      - name: Configure JDK
+        uses: actions/setup-java@v3
+        with:
+          distribution: 'corretto'
+          java-version: 17
+          cache: 'gradle'
+
+      - name: Build
+        working-directory: ./smithy-kotlin
+        shell: bash
+        run: |
+          pwd
+          ls -lsa
+          kat bump-version  # Bump from `vNext-SNAPSHOT` to `vNext`. kat transform only works on non-SNAPSHOT versions
+          kat bump-version --property codegenVersion
+          ./gradlew build
+          ./gradlew publishAllPublicationsToTestLocalRepository
+
+      - name: Transform
+        working-directory: ./smithy-kotlin
+        shell: bash
+        run: |
+          pwd
+          ls -lsa
+          kat brazil transform -i ./build/m2 -o ./transformed -t .brazil.json -v live
+          
+          # Check for manifest file
+          if [ ! -f "./transformed/brazil-import-manifest.json" ]; then
+            echo "Error: brazil-import-manifest.json not found in the transformed artifact"
+            exit 1
+          fi
+          
+          echo "Transformation succeeded!"

CHANGELOG.md

@@ -1,5 +1,21 @@
 # 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
+* Upgrade to Kotlin 2.0.21
+
 ## [1.3.16] - 10/10/2024
 
 ## [1.3.15] - 10/08/2024

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/build.gradle.kts

@@ -21,7 +21,6 @@ group = "software.amazon.smithy.kotlin"
 version = codegenVersion
 
 dependencies {
-    implementation(kotlin("stdlib-jdk8"))
     implementation(libs.smithy.aws.traits)
     implementation(libs.smithy.protocol.traits)
     api(project(":codegen:smithy-kotlin-codegen"))

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/build.gradle.kts

@@ -24,7 +24,6 @@ val sdkVersion: String by project
 val runtimeVersion = sdkVersion
 
 dependencies {
-    implementation(kotlin("stdlib-jdk8"))
     api(libs.smithy.codegen.core)
     api(libs.smithy.waiters)
     implementation(libs.smithy.rules.engine)

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.17-SNAPSHOT
+sdkVersion=1.3.20-SNAPSHOT
 
 # codegen
-codegenVersion=0.33.17-SNAPSHOT
+codegenVersion=0.33.20-SNAPSHOT