Re-export runtime types in server generated crates #1909
Conversation
Re-export commonly used types from aws-smithy-http-server so that customers don't have to depend on that crate. Signed-off-by: Daniele Ahmed <ahmeddan@amazon.de>
Signed-off-by: Daniele Ahmed <ahmeddan@amazon.de>
|
|
||
| rustCrate.withModule( | ||
| RustModule.public( | ||
| "server", |
There was a problem hiding this comment.
Alternatively here we could
pub use aws_smithy_http_server as server;Which would allow us to preserve the root crate docs but would mean that we re-export everything from the aws-smithy-http-server crate.
There was a problem hiding this comment.
The conclusion of a discussion about this was: no, we don't want to do a blanket re-export for now. But we should ensure we preserve the layout between codegen items and aws-smithy-http-server items so that if we reconsider it will be a non-breaking change.
There was a problem hiding this comment.
Isn't server a confusing name? What about calling the module aws_smithy_http_server to better signal where we are re-exporting from? Not a blocker TBH.
There was a problem hiding this comment.
If we want to hide where re-exports are from and allow us to re-export also from other runtime crates possibly, probably we shouldn't signal the name of the crate
There was a problem hiding this comment.
It feels like server is clear from context and it buys us a bit of flexibility, as @82marbag was saying.
There was a problem hiding this comment.
Allright! Thanks for the comments.
| ##[doc(hidden)] | ||
| pub use #{SmithyHttpServer}::instrumentation; | ||
| ##[doc(hidden)] | ||
| pub use #{SmithyHttpServer}::proto; |
There was a problem hiding this comment.
What's the point of doing a #[doc(hidden)] re-export? I might be missing something obvious 🤔
There was a problem hiding this comment.
It means that #1886 would only have to remove the #[doc(hidden)] rather than making decisions on what to include in this module or not. Also, people using these modules for "nightly aws-smithy-http-server" would still be able to remove aws-smithy-http-server from their dependency list.
If #[doc(hidden)] is transitive and re-exporting something #[doc(hidden)] means the re-export is also hidden then this isn't necessary - I'm unsure if this is the case or not.
The decision to do this is made automatically if we choose to #1909 (comment).
There was a problem hiding this comment.
If #[doc(hidden)] is transitive and re-exporting something #[doc(hidden)] means the re-export is also hidden then this isn't necessary - I'm unsure if this is the case or not.
This was my expectation, hence the question.
I tested it and I found that:
- Re-exporting a
#[doc(hidden)]module gives you a#[doc(hidden)]module, so no need to mark the rexport as#[doc(hidden)]; - Any
#[doc(hidden)]item inside the re-exported module remains#[doc(hidden)].
There was a problem hiding this comment.
Code:
pub use dep::hello as hey;
pub use dep::my_hidden_module as hey_from_hidden;Dependency code:
pub mod hello {
#[doc(hidden)]
struct MyHiddenStruct;
}
#[doc(hidden)]
pub mod my_hidden_module {
struct MyVisibleStruct;
}Screenshot of the docs:
There was a problem hiding this comment.
Good to know, we can drop the #[doc(hidden)] from these.
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
Signed-off-by: Daniele Ahmed <ahmeddan@amazon.de>
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
Signed-off-by: Daniele Ahmed <ahmeddan@amazon.de>
Signed-off-by: Daniele Ahmed <ahmeddan@amazon.de>
Signed-off-by: Daniele Ahmed <ahmeddan@amazon.de>
|
A new generated diff is ready to view.
A new doc preview is ready to view. |
Signed-off-by: Daniele Ahmed <ahmeddan@amazon.de>
|
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. |
Re-export commonly used types from aws-smithy-http-server so that customers don't have to depend on that crate.
We did not agree to a full list yet. This is a possible starting point. We could also either add all types from the server runtime crate.
Motivation and Context
Closes #1506
Description
Add a
servermodule that re-exports some of the types from the runtime crate.Testing
Generated the Pokemon service.
Checklist
CHANGELOG.next.tomlif I made changes to the smithy-rs codegen or runtime cratesCHANGELOG.next.tomlif I made changes to the AWS SDK, generated SDK code, or SDK runtime cratesBy submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.