RFC30: add Serde Decorator to RustClientCodegenPlugin #2650
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,50 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| package software.amazon.smithy.rust.codegen.client.smithy.customize | ||
|
|
||
| import software.amazon.smithy.rust.codegen.client.smithy.ClientCodegenContext | ||
| import software.amazon.smithy.rust.codegen.core.rustlang.Feature | ||
| import software.amazon.smithy.rust.codegen.core.smithy.RustCrate | ||
|
|
||
| /** | ||
| * Decorator that adds the `serde-serialize` and `serde-deserialize` features. | ||
| */ | ||
| class SerdeDecorator : ClientCodegenDecorator { | ||
| override val name: String = "SerdeDecorator" | ||
| override val order: Byte = -1 | ||
|
|
||
| override fun extras(codegenContext: ClientCodegenContext, rustCrate: RustCrate) { | ||
| fun feature(featureName: String): Feature { | ||
| return Feature(featureName, false, listOf("aws-smithy-types/$featureName")) | ||
| } | ||
| rustCrate.mergeFeature(feature("serde-serialize")) | ||
| rustCrate.mergeFeature(feature("serde-deserialize")) | ||
| } | ||
|
|
||
| // I initially tried to implement with LibRsCustomization but it didn't work some how. | ||
| companion object { | ||
|
There was a problem hiding this comment. Here is the text that is going to be included on the lib.rs docs. There was a problem hiding this comment. What did it look like when it was overriding libRsCustomization? There was a problem hiding this comment. I was able to make it work! It looks like this.
I tried to put two hash marks, but I couldn't make it work. There was a problem hiding this comment. I tried to find the commit that didn't work, but it's lost somewhere in the commit history. |
||
| const val SerdeInfoText = """## How to enable `Serialize` and `Deserialize` | ||
|
|
||
| This data type implements `Serialize` and `Deserialize` traits from the popular serde crate, | ||
| but those traits are behind feature gate. | ||
|
|
||
| As they increase it's compile time dramatically, you should not turn them on unless it's necessary. | ||
| Furthermore, implementation of serde is still unstable, and implementation may change anytime in future. | ||
|
|
||
| To enable traits, you must pass `aws_sdk_unstable` to RUSTFLAGS and enable `serde-serialize` or `serde-deserialize` feature. | ||
|
|
||
| e.g. | ||
| ```bash,no_run | ||
| export RUSTFLAGS="--cfg aws_sdk_unstable" | ||
| cargo build --features serde-serialize serde-deserialize | ||
| ``` | ||
|
|
||
| If you enable `serde-serialize` and/or `serde-deserialize` without `RUSTFLAGS="--cfg aws_sdk_unstable"`, | ||
| compilation will fail with warning. | ||
|
|
||
| """ | ||
| } | ||
| } | ||
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.
Would be good to also hook into the
ModuleDocSection.ServiceDocs, or even add a newModuleDocSection.Features, so that these features can be described in the docs. That way, the documentation can inform on the--cfg aws_sdk_unstablerequirement. This would require registering aLibRsCustomization, sooverride fun libRsCustomizations(...).There's an example here that adds information to the "Crate Organization" documentation section: https://github.com/awslabs/smithy-rs/blob/2f60a5e0904037ec5237c080c61817617b9d8c06/codegen-client/src/main/kotlin/software/amazon/smithy/rust/codegen/client/smithy/customizations/ClientCustomizations.kt#L19
Uh oh!
There was an error while loading. Please reload this page.
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.
I added this function but it seems like there are no changes to the generated code.
Is there anything else that I'm supposed to add?