Skip to content

fix: always serialize defaults #1315

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

Merged
merged 2 commits into from
Jul 8, 2025
Merged

fix: always serialize defaults #1315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0f7d949
fix: always serialize defaults
ianbotsf Jun 20, 2025
fe56c02
retrigger CI
ianbotsf Jul 7, 2025
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/d4f09e32-8bcc-406e-96e0-2743280c13d9.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"id": "d4f09e32-8bcc-406e-96e0-2743280c13d9",
"type": "bugfix",
"description": "Switch to always serialize defaults in requests. Previously fields were not serialized in requests if they weren't `@required` and hadn't been changed from the default value.",
"issues": [
"https://github.com/awslabs/aws-sdk-kotlin/issues/1608"
]
}
2 changes: 1 addition & 1 deletion ...en-testutils/src/main/kotlin/software/amazon/smithy/kotlin/codegen/test/ModelTestUtils.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ fun Model.defaultSettings(
sdkId: String = TestModelDefault.SDK_ID,
generateDefaultBuildFiles: Boolean = false,
nullabilityCheckMode: CheckMode = CheckMode.CLIENT_CAREFUL,
defaultValueSerializationMode: DefaultValueSerializationMode = DefaultValueSerializationMode.WHEN_DIFFERENT,
defaultValueSerializationMode: DefaultValueSerializationMode = DefaultValueSerializationMode.DEFAULT,
): KotlinSettings {
val serviceId = if (serviceName == null) {
this.inferService()
Expand Down
28 changes: 14 additions & 14 deletions ...hy-kotlin-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/KotlinSettings.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,7 @@

package software.amazon.smithy.kotlin.codegen

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.aws.traits.protocols.*
import software.amazon.smithy.codegen.core.CodegenException
import software.amazon.smithy.kotlin.codegen.lang.isValidPackageName
import software.amazon.smithy.kotlin.codegen.utils.getOrNull
Expand All @@ -24,10 +19,10 @@ import software.amazon.smithy.model.shapes.ServiceShape
import software.amazon.smithy.model.shapes.Shape
import software.amazon.smithy.model.shapes.ShapeId
import software.amazon.smithy.protocol.traits.Rpcv2CborTrait
import java.util.Optional
import java.util.*
import java.util.logging.Logger
import java.util.stream.Collectors
import kotlin.IllegalArgumentException
import kotlin.streams.toList

// shapeId of service from which to generate an SDK
private const val SERVICE = "service"
Expand Down Expand Up @@ -164,7 +159,7 @@ fun Model.inferService(): ShapeId {
val services = shapes(ServiceShape::class.java)
.map(Shape::getId)
.sorted()
.toList()
.collect(Collectors.toList())

return when {
services.isEmpty() -> {
Expand Down Expand Up @@ -273,10 +268,15 @@ enum class DefaultValueSerializationMode(val value: String) {

override fun toString(): String = value
companion object {
/**
* The default value serialization mode, which is [ALWAYS]
*/
val DEFAULT = ALWAYS

fun fromValue(value: String): DefaultValueSerializationMode =
values().find {
it.value == value
} ?: throw IllegalArgumentException("$value is not a valid DefaultValueSerializationMode, expected one of ${values().map { it.value }}")
requireNotNull(entries.find { it.value.equals(value, ignoreCase = true) }) {
"$value is not a valid DefaultValueSerializationMode, expected one of ${values().map { it.value }}"
}
}
}

Expand All @@ -291,7 +291,7 @@ enum class DefaultValueSerializationMode(val value: String) {
data class ApiSettings(
val visibility: Visibility = Visibility.PUBLIC,
val nullabilityCheckMode: CheckMode = CheckMode.CLIENT_CAREFUL,
val defaultValueSerializationMode: DefaultValueSerializationMode = DefaultValueSerializationMode.WHEN_DIFFERENT,
val defaultValueSerializationMode: DefaultValueSerializationMode = DefaultValueSerializationMode.DEFAULT,
val enableEndpointAuthProvider: Boolean = false,
val protocolResolutionPriority: Set<ShapeId> = DEFAULT_PROTOCOL_RESOLUTION_PRIORITY,
) {
Expand All @@ -315,7 +315,7 @@ data class ApiSettings(
node.get()
.getStringMemberOrDefault(
DEFAULT_VALUE_SERIALIZATION_MODE,
DefaultValueSerializationMode.WHEN_DIFFERENT.value,
DefaultValueSerializationMode.DEFAULT.value,
),
)
val enableEndpointAuthProvider = node.get().getBooleanMemberOrDefault(ENABLE_ENDPOINT_AUTH_PROVIDER, false)
Expand Down
1 change: 1 addition & 0 deletions ...in-codegen/src/main/kotlin/software/amazon/smithy/kotlin/codegen/core/KotlinDependency.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ data class KotlinDependency(
// External third-party dependencies
val KOTLIN_STDLIB = KotlinDependency(GradleConfiguration.Implementation, "kotlin", "org.jetbrains.kotlin", "kotlin-stdlib", KOTLIN_COMPILER_VERSION)
val KOTLIN_TEST = KotlinDependency(GradleConfiguration.TestImplementation, "kotlin.test", "org.jetbrains.kotlin", "kotlin-test", KOTLIN_COMPILER_VERSION)
val KOTLIN_TEST_IMPL = KOTLIN_TEST.copy(config = GradleConfiguration.Implementation)
}

override fun getDependencies(): List<SymbolDependency> {
Expand Down
9 changes: 6 additions & 3 deletions ...ware/amazon/smithy/kotlin/codegen/rendering/protocol/HttpStringValuesMapSerializerTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,8 @@ class HttpStringValuesMapSerializerTest {

@Test
fun `it handles primitive header shapes when different mode`() {
val contents = getTestContents(defaultModel, "com.test#PrimitiveShapesOperation", HttpBinding.Location.HEADER)
val settings = defaultModel.defaultSettings(defaultValueSerializationMode = DefaultValueSerializationMode.WHEN_DIFFERENT)
val contents = getTestContents(defaultModel, "com.test#PrimitiveShapesOperation", HttpBinding.Location.HEADER, settings)
Comment on lines +56 to +57
Copy link
Contributor

@lauzadis lauzadis Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still think we should have tests for the new behavior

#1302 (comment)

Copy link
Contributor Author

@ianbotsf ianbotsf Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already had/have tests which explicitly set ALWAYS. My changes in this PR make all of the implicit WHEN_DIFFERENT values into explicit ones. Are there specific tests you'd like to see added/expanded?

Copy link
Contributor

@lauzadis lauzadis Jul 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh right, I totally missed the names of the tests here. These are perfectly fine

contents.assertBalancedBracesAndParens()

val expectedContents = """
Expand All @@ -68,7 +69,8 @@ class HttpStringValuesMapSerializerTest {

@Test
fun `it handles primitive query shapes when different mode`() {
val contents = getTestContents(defaultModel, "com.test#PrimitiveShapesOperation", HttpBinding.Location.QUERY)
val settings = defaultModel.defaultSettings(defaultValueSerializationMode = DefaultValueSerializationMode.WHEN_DIFFERENT)
val contents = getTestContents(defaultModel, "com.test#PrimitiveShapesOperation", HttpBinding.Location.QUERY, settings)
contents.assertBalancedBracesAndParens()

val expectedContents = """
Expand Down Expand Up @@ -129,7 +131,8 @@ class HttpStringValuesMapSerializerTest {
}
""".prependNamespaceAndService(operations = listOf("Foo")).toSmithyModel()

val contents = getTestContents(model, "com.test#Foo", HttpBinding.Location.HEADER)
val settings = defaultModel.defaultSettings(defaultValueSerializationMode = DefaultValueSerializationMode.WHEN_DIFFERENT)
val contents = getTestContents(model, "com.test#Foo", HttpBinding.Location.HEADER, settings)
contents.assertBalancedBracesAndParens()

val expectedContents = """
Expand Down
3 changes: 2 additions & 1 deletion ...lin/software/amazon/smithy/kotlin/codegen/rendering/serde/SerializeStructGeneratorTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,8 @@ class SerializeStructGeneratorTest {
}
""".trimIndent()

val actual = codegenSerializerForShape(model, "com.test#Foo")
val settings = model.defaultSettings(defaultValueSerializationMode = DefaultValueSerializationMode.WHEN_DIFFERENT)
val actual = codegenSerializerForShape(model, "com.test#Foo", settings = settings)
actual.shouldContainOnlyOnceWithDiff(expected)
}

Expand Down
Loading