Break up RustCodegenDecorator
#2099
Merged
Conversation
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
jdisanti
added
needs-sdk-review
needs-server-review
server
This change creates `ClientCodegenDecorator` and `ServerCodegenDecorator` in `codegen-client` and `codegen-server` respectively to replace `RustCodegenDecorator`. Client/server equivalents are created to replace `CombinedCodegenDecorator` as well. This eliminates the need for the `supportsCodegenContext` method since the decorator interface is no longer generic, so the `ServiceLoader` is now powerful enough to differentiate. The largest benefit, however, is that now clients and servers can have separate customizations.
jdisanti
force-pushed
the
jdisanti-split-codegen-decorator
branch
from
79db806
to
d74997d
Compare
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
crisidev
approved these changes
Dec 14, 2022
Comment on lines
+153
to
+171
| companion object { | ||
| fun fromClasspath( | ||
| context: PluginContext, | ||
| vararg extras: ClientCodegenDecorator, | ||
| logger: Logger = Logger.getLogger("RustClientCodegenSPILoader"), | ||
| ): CombinedClientCodegenDecorator { | ||
| val decorators = ServiceLoader.load( | ||
| ClientCodegenDecorator::class.java, | ||
| context.pluginClassLoader.orElse(ClientCodegenDecorator::class.java.classLoader), | ||
| ) | ||
|
|
||
| val filteredDecorators = decorators.asSequence() | ||
| .onEach { logger.info("Discovered Codegen Decorator: ${it.javaClass.name}") } | ||
| .filter { it.classpathDiscoverable() } | ||
| .onEach { logger.info("Adding Codegen Decorator: ${it.javaClass.name}") } | ||
| .toList() | ||
| return CombinedClientCodegenDecorator(filteredDecorators + extras) | ||
| } | ||
| } |
There was a problem hiding this comment.
Wonderful, this is much more readable than what we had before with generics!
...kotlin/software/amazon/smithy/rust/codegen/server/smithy/customize/ServerCodegenDecorator.kt
Outdated
Show resolved
Hide resolved
| * AWS services. A different downstream customer may wish to add a different set of derive | ||
| * attributes to the generated classes. | ||
| */ | ||
| interface ServerCodegenDecorator { |
There was a problem hiding this comment.
I think it's great that now the interface for the Server Codegen is smaller and completely customizable without interfering with the Client..
unexge
approved these changes
Dec 14, 2022
david-perez
approved these changes
Dec 14, 2022
...kotlin/software/amazon/smithy/rust/codegen/server/smithy/customize/ServerCodegenDecorator.kt
Outdated
Show resolved
Hide resolved
rcoh
approved these changes
Dec 14, 2022
Comment on lines
+15
to
+18
| references = ["smithy-rs#2099"] | ||
| meta = { "breaking" = true, "tada" = false, "bug" = false, "target" = "client"} | ||
| author = "jdisanti" |
There was a problem hiding this comment.
this will break a ton of people...I wonder if we should have a backwards compatibility shim
...kotlin/software/amazon/smithy/rust/codegen/client/smithy/customize/ClientCodegenDecorator.kt
Outdated
Show resolved
Hide resolved
...kotlin/software/amazon/smithy/rust/codegen/client/smithy/customize/ClientCodegenDecorator.kt
Show resolved
Hide resolved
...rc/main/kotlin/software/amazon/smithy/rust/codegen/client/testutil/CodegenIntegrationTest.kt
Show resolved
Hide resolved
...rc/main/kotlin/software/amazon/smithy/rust/codegen/client/testutil/CodegenIntegrationTest.kt
Show resolved
Hide resolved
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
rcoh
approved these changes
Dec 14, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation and Context
This change creates
ClientCodegenDecoratorandServerCodegenDecoratorincodegen-clientandcodegen-serverrespectively to replaceRustCodegenDecorator. Client/server equivalents are created to replaceCombinedCodegenDecoratoras well.This eliminates the need for the
supportsCodegenContextmethod since the decorator interface is no longer generic, so theServiceLoaderis now powerful enough to differentiate.The largest benefit, however, is that now clients and servers can have separate customizations.
Checklist
CHANGELOG.next.tomlif I made changes to the smithy-rs codegen or runtime cratesBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.