Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changes/a928feea-f455-4263-8bae-cf50676a551a.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"id": "a928feea-f455-4263-8bae-cf50676a551a",
"type": "bugfix",
"description": "Idempotency tokens are no longer code-generated for nested structures. See: https://smithy.io/2.0/spec/behavior-traits.html#smithy-api-idempotencytoken-trait"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
package software.amazon.smithy.kotlin.codegen.aws.protocols

import software.amazon.smithy.kotlin.codegen.test.*
import kotlin.test.Test

class AwsQueryTest {
@Test
fun testNonNestedIdempotencyToken() {
val ctx = model.newTestContext("Example")

val generator = AwsQuery()
generator.generateProtocolClient(ctx.generationCtx)

ctx.generationCtx.delegator.finalize()
ctx.generationCtx.delegator.flushWriters()

val expected = """
serializer.serializeStruct(OBJ_DESCRIPTOR) {
input.bar?.let { field(BAR_DESCRIPTOR, it) } ?: field(BAR_DESCRIPTOR, context.idempotencyTokenProvider.generateToken())
}
""".trimIndent()

val actual = ctx
.manifest
.expectFileString("/src/main/kotlin/com/test/serde/GetBarUnNestedOperationSerializer.kt")
.lines(" serializer.serializeStruct(OBJ_DESCRIPTOR) {", " }")
.trimIndent()

actual.shouldContainOnlyOnceWithDiff(expected)
}

@Test
fun testNestedIdempotencyToken() {
val ctx = model.newTestContext("Example")

val generator = AwsQuery()
generator.generateProtocolClient(ctx.generationCtx)

ctx.generationCtx.delegator.finalize()
ctx.generationCtx.delegator.flushWriters()

val expected = """
serializer.serializeStruct(OBJ_DESCRIPTOR) {
input.baz?.let { field(BAZ_DESCRIPTOR, it) }
}
""".trimIndent()

val actual = ctx
.manifest
.expectFileString("/src/main/kotlin/com/test/serde/NestDocumentSerializer.kt")
.lines(" serializer.serializeStruct(OBJ_DESCRIPTOR) {", " }")
.trimIndent()

actual.shouldContainOnlyOnceWithDiff(expected)

val unexpected = """
serializer.serializeStruct(OBJ_DESCRIPTOR) {
input.baz?.let { field(BAZ_DESCRIPTOR, it) } ?: field(BAR_DESCRIPTOR, context.idempotencyTokenProvider.generateToken())
}
""".trimIndent()

actual.shouldNotContainOnlyOnceWithDiff(unexpected)
}

private val model = """
${"$"}version: "2"

namespace com.test

use aws.protocols#awsQuery
use aws.api#service

@awsQuery
@service(sdkId: "Example")
@xmlNamespace(uri: "http://foo.com")
service Example {
version: "1.0.0",
operations: [GetBarUnNested, GetBarNested]
}

@http(method: "POST", uri: "/get-bar-un-nested")
operation GetBarUnNested {
input: BarUnNested
}

structure BarUnNested {
@idempotencyToken
bar: String
}

@http(method: "POST", uri: "/get-bar-nested")
operation GetBarNested {
input: BarNested
}

structure BarNested {
bar: Nest
}

structure Nest {
@idempotencyToken
baz: String
}
""".toSmithyModel()
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
package software.amazon.smithy.kotlin.codegen.aws.protocols

import software.amazon.smithy.kotlin.codegen.test.*
import kotlin.test.Test

class RestJson1Test {
@Test
fun testNonNestedIdempotencyToken() {
val ctx = model.newTestContext("Example")

val generator = RestJson1()
generator.generateProtocolClient(ctx.generationCtx)

ctx.generationCtx.delegator.finalize()
ctx.generationCtx.delegator.flushWriters()

val expected = """
serializer.serializeStruct(OBJ_DESCRIPTOR) {
input.bar?.let { field(BAR_DESCRIPTOR, it) } ?: field(BAR_DESCRIPTOR, context.idempotencyTokenProvider.generateToken())
}
""".trimIndent()

val actual = ctx
.manifest
.expectFileString("/src/main/kotlin/com/test/serde/GetBarUnNestedOperationSerializer.kt")
.lines(" serializer.serializeStruct(OBJ_DESCRIPTOR) {", " }")
.trimIndent()

actual.shouldContainOnlyOnceWithDiff(expected)
}

@Test
fun testNestedIdempotencyToken() {
val ctx = model.newTestContext("Example")

val generator = RestJson1()
generator.generateProtocolClient(ctx.generationCtx)

ctx.generationCtx.delegator.finalize()
ctx.generationCtx.delegator.flushWriters()

val expected = """
serializer.serializeStruct(OBJ_DESCRIPTOR) {
input.baz?.let { field(BAZ_DESCRIPTOR, it) }
}
""".trimIndent()

val actual = ctx
.manifest
.expectFileString("/src/main/kotlin/com/test/serde/NestDocumentSerializer.kt")
.lines(" serializer.serializeStruct(OBJ_DESCRIPTOR) {", " }")
.trimIndent()

actual.shouldContainOnlyOnceWithDiff(expected)

val unexpected = """
serializer.serializeStruct(OBJ_DESCRIPTOR) {
input.baz?.let { field(BAZ_DESCRIPTOR, it) } ?: field(BAR_DESCRIPTOR, context.idempotencyTokenProvider.generateToken())
}
""".trimIndent()

actual.shouldNotContainOnlyOnceWithDiff(unexpected)
}

private val model = """
${"$"}version: "2"

namespace com.test

use aws.protocols#restJson1
use aws.api#service

@restJson1
@service(sdkId: "Example")
service Example {
version: "1.0.0",
operations: [GetBarUnNested, GetBarNested]
}

@http(method: "POST", uri: "/get-bar-un-nested")
operation GetBarUnNested {
input: BarUnNested
}

structure BarUnNested {
@idempotencyToken
bar: String
}

@http(method: "POST", uri: "/get-bar-nested")
operation GetBarNested {
input: BarNested
}

structure BarNested {
bar: Nest
}

structure Nest {
@idempotencyToken
baz: String
}
""".toSmithyModel()
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
package software.amazon.smithy.kotlin.codegen.aws.protocols

import software.amazon.smithy.kotlin.codegen.test.*
import kotlin.test.Test

class RestXmlTest {
@Test
fun testNonNestedIdempotencyToken() {
val ctx = model.newTestContext("Example")

val generator = RestXml()
generator.generateProtocolClient(ctx.generationCtx)

ctx.generationCtx.delegator.finalize()
ctx.generationCtx.delegator.flushWriters()

val expected = """
serializer.serializeStruct(OBJ_DESCRIPTOR) {
input.bar?.let { field(BAR_DESCRIPTOR, it) } ?: field(BAR_DESCRIPTOR, context.idempotencyTokenProvider.generateToken())
}
""".trimIndent()

val actual = ctx
.manifest
.expectFileString("/src/main/kotlin/com/test/serde/GetBarUnNestedOperationSerializer.kt")
.lines(" serializer.serializeStruct(OBJ_DESCRIPTOR) {", " }")
.trimIndent()

actual.shouldContainOnlyOnceWithDiff(expected)
}

@Test
fun testNestedIdempotencyToken() {
val ctx = model.newTestContext("Example")

val generator = RestXml()
generator.generateProtocolClient(ctx.generationCtx)

ctx.generationCtx.delegator.finalize()
ctx.generationCtx.delegator.flushWriters()

val expected = """
serializer.serializeStruct(OBJ_DESCRIPTOR) {
input.baz?.let { field(BAZ_DESCRIPTOR, it) }
}
""".trimIndent()

val actual = ctx
.manifest
.expectFileString("/src/main/kotlin/com/test/serde/NestDocumentSerializer.kt")
.lines(" serializer.serializeStruct(OBJ_DESCRIPTOR) {", " }")
.trimIndent()

actual.shouldContainOnlyOnceWithDiff(expected)

val unexpected = """
serializer.serializeStruct(OBJ_DESCRIPTOR) {
input.baz?.let { field(BAZ_DESCRIPTOR, it) } ?: field(BAR_DESCRIPTOR, context.idempotencyTokenProvider.generateToken())
}
""".trimIndent()

actual.shouldNotContainOnlyOnceWithDiff(unexpected)
}

private val model = """
${"$"}version: "2"

namespace com.test

use aws.protocols#restXml
use aws.api#service

@restXml
@service(sdkId: "Example")
service Example {
version: "1.0.0",
operations: [GetBarUnNested, GetBarNested]
}

@http(method: "POST", uri: "/get-bar-un-nested")
operation GetBarUnNested {
input: BarUnNested
}

structure BarUnNested {
@idempotencyToken
bar: String
}

@http(method: "POST", uri: "/get-bar-nested")
operation GetBarNested {
input: BarNested
}

structure BarNested {
bar: Nest
}

structure Nest {
@idempotencyToken
baz: String
}
""".toSmithyModel()
}
Loading
Loading