Rexport types for servers #409
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
niklasad1
reviewed
Jul 9, 2021
jsonrpsee/Cargo.toml
Outdated
| @@ -20,6 +20,6 @@ types = { path = "../types", version = "0.2.0", package = "jsonrpsee-types", opt | |||
|
|
|||
| [features] | |||
| client = ["http-client", "ws-client"] | |||
| server = ["http-server", "ws-server", "utils"] | |||
| server = ["http-server", "ws-server", "utils", "macros"] | |||
There was a problem hiding this comment.
I think types should be sufficient here, no?
There was a problem hiding this comment.
"types" is sufficient, but I'm a bit concerned that this will become messy. I'd like to be able to look at lib.rs and see at a glance where everything is coming from.
niklasad1
reviewed
Jul 9, 2021
jsonrpsee/Cargo.toml
Outdated
| @@ -20,6 +20,6 @@ types = { path = "../types", version = "0.2.0", package = "jsonrpsee-types", opt | |||
|
|
|||
| [features] | |||
| client = ["http-client", "ws-client"] | |||
There was a problem hiding this comment.
perhaps we should add types here too? however types are re-exported from the clients
niklasad1
reviewed
Jul 9, 2021
Export types::* from façade when the "types" is active Export types::* from servers
dvdplm
added a commit
to paritytech/substrate
that referenced
this pull request
Jul 9, 2021
maciejhirsz
reviewed
Jul 10, 2021
http-server/src/lib.rs
Outdated
| @@ -40,7 +40,7 @@ pub use access_control::{ | |||
| hosts::{AllowHosts, Host}, | |||
| AccessControl, AccessControlBuilder, | |||
| }; | |||
| pub use jsonrpsee_types::{Error, TEN_MB_SIZE_BYTES}; | |||
| pub use jsonrpsee_types::*; | |||
There was a problem hiding this comment.
Wouldn't it make more sense to re-export types in namespace like: pub use jsonrpsee_types as types?
There was a problem hiding this comment.
Yes I agree. I went ahead and did that so there's a lot more noise here now.
maciejhirsz
approved these changes
Jul 10, 2021
niklasad1
reviewed
Jul 10, 2021
|
|
||
| /// Procedural macros for JSON RPC implementations. | ||
| #[cfg(feature = "macros")] | ||
| pub use proc_macros; | ||
|
|
||
| /// Common types used to implement JSON RPC server and client. | ||
| #[cfg(feature = "macros")] | ||
| #[cfg(any(feature = "types", feature = "macros"))] |
niklasad1
reviewed
Jul 10, 2021
| @@ -27,4 +27,4 @@ mod tokio; | |||
| mod tests; | |||
|
|
|||
| pub use client::{WsClient, WsClientBuilder}; | |||
| pub use jsonrpsee_types::*; | |||
| pub use jsonrpsee_types as types; | |||
niklasad1
approved these changes
Jul 10, 2021
dvdplm
added a commit
to paritytech/substrate
that referenced
this pull request
Jul 12, 2021
* Companion to paritytech/jsonrpsee#409 * Use master
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.
Include the "macros" feature in the the "server" feature so users don't have to import "jsonrpsee-types" explicitly.
Also re-export the
SubscriptionSink.This is possibly slightly contentious. I think it's fair to assume that people writing servers will want to use the "macros" feature (which implies "types"). The downside of this is that "macros" includes the client side macros and "types" also includes types used in clients more.
Alternative solutions would be
CallErrororSubscriptionSink(downside: more cfg-fu)<insert-yours />Fixes #407
Substrate "companion": https://github.com/paritytech/substrate/compare/dp-jsonrpsee-integration-2...dp-tweak-reexports?expand=1