Extract smithy.rust#serde trait to a new smithy-shapes Gradle subproject
#3897
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package software.amazon.smithy.rust.codegen.client.smithy.customizations | ||
|
|
||
| import software.amazon.smithy.rust.codegen.client.smithy.ClientCodegenContext | ||
| import software.amazon.smithy.rust.codegen.client.smithy.customize.ClientCodegenDecorator | ||
| import software.amazon.smithy.rust.codegen.core.rustlang.writable | ||
| import software.amazon.smithy.rust.codegen.core.smithy.RustCrate | ||
| import software.amazon.smithy.rust.codegen.core.smithy.customizations.serde.extrasCommon | ||
|
|
||
| class ClientSerdeDecorator : ClientCodegenDecorator { | ||
| override val name: String = "ClientSerdeDecorator" | ||
| override val order: Byte = 0 | ||
|
|
||
| override fun extras( | ||
| codegenContext: ClientCodegenContext, | ||
| rustCrate: RustCrate, | ||
| ) = extrasCommon( | ||
| codegenContext, | ||
| rustCrate, | ||
| // Constraints don't affect client codegen. | ||
| unwrapConstraints = { writable { } }, | ||
| ) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package software.amazon.smithy.rust.codegen.client.smithy.customizations.serde | ||
|
|
||
| import org.junit.jupiter.api.Test | ||
| import software.amazon.smithy.rust.codegen.client.testutil.clientIntegrationTest | ||
| import software.amazon.smithy.rust.codegen.core.rustlang.CargoDependency | ||
| import software.amazon.smithy.rust.codegen.core.rustlang.CratesIo | ||
| import software.amazon.smithy.rust.codegen.core.rustlang.RustType | ||
| import software.amazon.smithy.rust.codegen.core.rustlang.rustTemplate | ||
| import software.amazon.smithy.rust.codegen.core.testutil.IntegrationTestParams | ||
| import software.amazon.smithy.rust.codegen.core.testutil.asSmithyModel | ||
| import software.amazon.smithy.rust.codegen.core.testutil.integrationTest | ||
| import software.amazon.smithy.rust.codegen.core.testutil.unitTest | ||
|
|
||
| /** | ||
| * The serde decorators for the client and the server are _identical_, but they live in separate Gradle projects. | ||
| * There's no point in testing everything twice, since the code is the same. Hence this file just contains a simple | ||
| * smoke test to ensure we don't disable the client decorator _somehow_; all tests testing the decorator's logic should | ||
| * live in `SerdeDecoratorTest` of the `codegen-server` project instead. | ||
| */ | ||
|
Comment on lines
+19
to
+24
There was a problem hiding this comment. this isn't really true. The code they generate is identical but client and server shapes are not the same—we really need to test against both. |
||
| class SerdeDecoratorTest { | ||
| @Test | ||
| fun `smoke test`() { | ||
| val model = | ||
| """ | ||
| 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") | ||
|
|
||
| val params = | ||
| IntegrationTestParams(cargoCommand = "cargo test --all-features", service = "com.example#MyResourceService") | ||
| clientIntegrationTest(model, params = params) { ctx, crate -> | ||
| val codegenScope = | ||
| arrayOf( | ||
| "crate" to RustType.Opaque(ctx.moduleUseName()), | ||
| "serde_json" to CargoDependency("serde_json", CratesIo("1")).toDevDependency().toType(), | ||
| // we need the derive feature | ||
| "serde" to CargoDependency.Serde.toDevDependency().toType(), | ||
| ) | ||
|
|
||
| crate.integrationTest("test_serde") { | ||
| unitTest("input_serialized") { | ||
| rustTemplate( | ||
| """ | ||
| use #{crate}::operation::read_my_resource::ReadMyResourceInput; | ||
| use #{crate}::serde::*; | ||
| let input = ReadMyResourceInput::builder().build().unwrap(); | ||
| let settings = SerializationSettings::default(); | ||
| let _serialized = #{serde_json}::to_string(&input.serialize_ref(&settings)).expect("failed to serialize"); | ||
| """, | ||
| *codegenScope, | ||
| ) | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
so this turns it on by default for all clients? I'm a little worried this would accidentally start generating serializers for the Rust SDK if a team ever exported the
serdetrait in their model. I think we need to make this opt-in in some way, e.g. via a codegen setting if we are going to bundle it like this.