Do not generate public empty modules #1803
Conversation
…de since it does not contain any public type. Tune the visibility of the 'operation' module based on the rendering context
codegen-core/src/main/kotlin/software/amazon/smithy/rust/codegen/core/rustlang/RustModule.kt
Outdated
Show resolved
Hide resolved
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
| @@ -34,7 +35,7 @@ class CustomizableOperationGenerator( | |||
| private val smithyTypes = CargoDependency.SmithyTypes(runtimeConfig).asType() | |||
|
|
|||
| fun render(crate: RustCrate) { | |||
| crate.withModule(RustModule.Operation) { writer -> | |||
| crate.withModule(RustModule.operation(Visibility.PUBLIC)) { writer -> | |||
There was a problem hiding this comment.
I would have expected this to be enough to get the module to show up in lib.rs as pub mod operation, but apparently it wasn't - I had to add https://github.com/awslabs/smithy-rs/pull/1803/files#diff-f7da198414ffe3cefc591164d3b1bb41d67e22812d7ba3a86b8abd6d798cec49R87
I'd be curious to understand why.
There was a problem hiding this comment.
From reading the code, it definitely seems like it should emit the mod statement when it's missing from DefaultPublicModules.
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
| @@ -175,7 +175,6 @@ open class RustCrate( | |||
| */ | |||
| val DefaultPublicModules = setOf( | |||
There was a problem hiding this comment.
I think a better approach is to move DefaultPublicModules into the client and server modules, since it doesn't seem like there's a good reason to share it in codegen-core. This would also allow us to tailor the module docs to the client/servers separately.
There was a problem hiding this comment.
In 8f1b0a8 I removed DefaultPublicModules and gave client/server/test the responsibility to handle their own list of default public modules.
I haven't inlined the definitions of the various module in those lists, but happy to do so if you think that's useful at this stage.
| @@ -34,7 +35,7 @@ class CustomizableOperationGenerator( | |||
| private val smithyTypes = CargoDependency.SmithyTypes(runtimeConfig).asType() | |||
|
|
|||
| fun render(crate: RustCrate) { | |||
| crate.withModule(RustModule.Operation) { writer -> | |||
| crate.withModule(RustModule.operation(Visibility.PUBLIC)) { writer -> | |||
There was a problem hiding this comment.
From reading the code, it definitely seems like it should emit the mod statement when it's missing from DefaultPublicModules.
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
Motivation and Context
When experimenting with
smithy-rsI noticed that the generated server crate exposes two public empty modules -operationandoperation_handler.Description
Make sure that
operationandoperational_handlerare private modules in the generated server crate, while keepingoperationpublic for the generated client crate.Testing
I verified the generated server and client code via
./gradlew codegen-client-test:testand./gradlew codegen-server-test:test.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.