Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: stop serializing default values for @clientOptional members #917

Merged
merged 1 commit into from
Aug 14, 2023
Merged

fix: stop serializing default values for @clientOptional members #917

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 8 additions & 0 deletions .changes/3b0318b9-d379-4fb4-8bcc-8dd4de6029a0.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"id": "3b0318b9-d379-4fb4-8bcc-8dd4de6029a0",
"type": "bugfix",
"description": "Stop serializing default values for `@clientOptional` members",
"issues": [
"awslabs/aws-sdk-kotlin#1016"
]
}
7 changes: 5 additions & 2 deletions ...odegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/core/KotlinSymbolProvider.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ import software.amazon.smithy.kotlin.codegen.utils.dq
import software.amazon.smithy.model.Model
import software.amazon.smithy.model.knowledge.NullableIndex
import software.amazon.smithy.model.shapes.*
import software.amazon.smithy.model.traits.ClientOptionalTrait
import software.amazon.smithy.model.traits.DefaultTrait
import software.amazon.smithy.model.traits.SparseTrait
import software.amazon.smithy.model.traits.StreamingTrait
Expand Down Expand Up @@ -183,8 +184,10 @@ class KotlinSymbolProvider(private val model: Model, private val settings: Kotli
.apply {
if (nullableIndex.isMemberNullable(shape, NullableIndex.CheckMode.CLIENT_ZERO_VALUE_V1_NO_INPUT)) nullable()

shape.getTrait<DefaultTrait>()?.let {
defaultValue(it.getDefaultValue(targetShape), DefaultValueType.MODELED)
if (!shape.hasTrait<ClientOptionalTrait>()) { // @ClientOptional supersedes @default
shape.getTrait<DefaultTrait>()?.let {
defaultValue(it.getDefaultValue(targetShape), DefaultValueType.MODELED)
}
}
}
.build()
Expand Down
21 changes: 21 additions & 0 deletions ...-codegen/src/test/kotlin/software/amazon/smithy/kotlin/codegen/core/SymbolProviderTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -366,6 +366,27 @@ class SymbolProviderTest {
assertEquals("null", memberSymbol.defaultValue())
}

@Test
fun `@clientOptional overrides @default`() {
val model = """
structure MyStruct {
@required
@clientOptional
@default("Foo")
quux: QuuxType
}

string QuuxType
""".prependNamespaceAndService().toSmithyModel()

val provider: SymbolProvider = KotlinCodegenPlugin.createSymbolProvider(model)
val member = model.expectShape<MemberShape>("com.test#MyStruct\$quux")
val memberSymbol = provider.toSymbol(member)
assertEquals("kotlin", memberSymbol.namespace)
assertTrue(memberSymbol.isNullable)
assertEquals("null", memberSymbol.defaultValue())
}

@Test
fun `@input`() {
val model = """
Expand Down