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 serde on constrained blobs #3893

Merged
merged 1 commit into from
Dec 23, 2024
+63 −11
Merged

Fix serde on constrained blobs #3893

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
9 changes: 9 additions & 0 deletions .changelog/1729878769.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
applies_to: ["server"]
authors: ["rcoh"]
references: ["smithy-rs#3890"]
breaking: false
new_feature: false
bug_fix: true
---
Fix bug in `serde` decorator that generated non-compiling code on some models
8 changes: 4 additions & 4 deletions ...serde/src/main/kotlin/software/amazon/smithy/rust/codegen/serde/SerializeImplGenerator.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -462,8 +462,8 @@ class SerializeImplGenerator(private val codegenContext: CodegenContext) {
}

private fun serializeBlob(shape: BlobShape): RuntimeType =
RuntimeType.forInlineFun("SerializeBlob", Companion.PrimitiveShapesModule) {
implSerializeConfigured(codegenContext.symbolProvider.toSymbol(shape)) {
RuntimeType.forInlineFun("SerializeBlob", PrimitiveShapesModule) {
implSerializeConfigured(RuntimeType.blob(codegenContext.runtimeConfig).toSymbol()) {
rustTemplate(
"""
if serializer.is_human_readable() {
Expand All @@ -478,7 +478,7 @@ class SerializeImplGenerator(private val codegenContext: CodegenContext) {
}

private fun serializeByteStream(shape: BlobShape): RuntimeType =
RuntimeType.forInlineFun("SerializeByteStream", Companion.PrimitiveShapesModule) {
RuntimeType.forInlineFun("SerializeByteStream", PrimitiveShapesModule) {
implSerializeConfigured(RuntimeType.byteStream(codegenContext.runtimeConfig).toSymbol()) {
// This doesn't work yet—there is no way to get data out of a ByteStream from a sync context
rustTemplate(
Expand All @@ -498,7 +498,7 @@ class SerializeImplGenerator(private val codegenContext: CodegenContext) {
}

private fun serializeDocument(shape: DocumentShape): RuntimeType =
RuntimeType.forInlineFun("SerializeDocument", Companion.PrimitiveShapesModule) {
RuntimeType.forInlineFun("SerializeDocument", PrimitiveShapesModule) {
implSerializeConfigured(codegenContext.symbolProvider.toSymbol(shape)) {
rustTemplate(
"""
Expand Down
57 changes: 50 additions & 7 deletions ...gen-serde/src/test/kotlin/software/amazon/smithy/rust/codegen/serde/SerdeDecoratorTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
package software.amazon.smithy.rust.codegen.serde

import org.junit.jupiter.api.Test
import software.amazon.smithy.model.node.Node
import software.amazon.smithy.rust.codegen.client.testutil.clientIntegrationTest
import software.amazon.smithy.rust.codegen.core.rustlang.Attribute
import software.amazon.smithy.rust.codegen.core.rustlang.Attribute.Companion.cfg
Expand Down Expand Up @@ -190,22 +191,22 @@ class SerdeDecoratorTest {
namespace com.example
use smithy.rust#serde
use aws.protocols#awsJson1_0

@awsJson1_0
@serde
service MyResourceService {
resources: [MyResource]
}

resource MyResource {
read: ReadMyResource
}

@readonly
operation ReadMyResource {
input := { }
}
""".asSmithyModel(smithyVersion = "2")
""".asSmithyModel(smithyVersion = "2")

val params =
IntegrationTestParams(cargoCommand = "cargo test --all-features", service = "com.example#MyResourceService")
Expand Down Expand Up @@ -241,14 +242,14 @@ class SerdeDecoratorTest {
"""
namespace com.example
use aws.protocols#awsJson1_0

@awsJson1_0
service MyService {
operations: [MyOperation]
}

operation MyOperation { }
""".asSmithyModel(smithyVersion = "2")
""".asSmithyModel(smithyVersion = "2")

val params =
IntegrationTestParams(cargoCommand = "cargo test --all-features", service = "com.example#MyService")
Expand All @@ -261,6 +262,48 @@ class SerdeDecoratorTest {
}
}

val onlyConstrained =
"""
namespace com.example
use smithy.rust#serde
use aws.protocols#awsJson1_0
use smithy.framework#ValidationException
@awsJson1_0
service HelloService {
operations: [SayHello],
version: "1"
}
@serde
operation SayHello {
input: TestInput
errors: [ValidationException]
}
structure TestInput {
@length(max: 10)
shortBlob: Blob
}
""".asSmithyModel(smithyVersion = "2")

// There is a "race condition" where if the first blob shape serialized is constrained, it triggered unexpected
// behavior where the constrained shape was used instead. This test verifies the fix.
// Fixes https://github.com/smithy-lang/smithy-rs/issues/3890
@Test
fun compilesOnlyConstrainedModel() {
val constrainedShapesSettings =
Node.objectNodeBuilder().withMember(
"codegen",
Node.objectNodeBuilder()
.withMember("publicConstrainedTypes", true)
.withMember("includeFluentClient", false)
.build(),
).build()
serverIntegrationTest(
onlyConstrained,
params.copy(additionalSettings = constrainedShapesSettings),
) { clientCodegenContext, rustCrate ->
}
}

@Test
fun generateSerializersThatWorkServer() {
serverIntegrationTest(simpleModel, params = params) { ctx, crate ->
Expand Down
Loading