rpc/interface: separate RpcHandler into 3 tower::Services
#266
Conversation
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
github-actions
bot
added
A-docs
12 tasks
hinto-janai
commented
Sep 3, 2024
Comment on lines
+11
to
+38
| /// An RPC [`tower::Service`]. | ||
| /// | ||
| /// This trait solely exists to encapsulate the traits needed | ||
| /// to handle RPC requests and respond with responses - **it is | ||
| /// not meant to be used directly.** | ||
| /// | ||
| /// The `Request` and `Response` are generic and | ||
| /// are used in the [`tower::Service`] bounds. | ||
| /// | ||
| /// The error type is always [`RpcError`]. | ||
| /// | ||
| /// There is a blanket implementation that implements this | ||
| /// trait on types that implement `tower::Service` correctly. | ||
| /// | ||
| /// See [`RpcHandler`](crate::RpcHandler) for more information. | ||
| pub trait RpcService<Request, Response>: | ||
| Clone | ||
| + Send | ||
| + Sync | ||
| + 'static | ||
| + Service< | ||
| Request, | ||
| Response = Response, | ||
| Error = RpcError, | ||
| Future: Future<Output = Result<Response, RpcError>> + Send + Sync + 'static, | ||
| > | ||
| { | ||
| } |
There was a problem hiding this comment.
Should this exist? It's just an alias because these bounds x3 on RpcHandler looked messy.
There was a problem hiding this comment.
Yeah I think it's a good idea.
FWIW I don't think you need the Sync bound here, although I also overuse the Sync bound in other parts of the code, I plan to go through it at some point and check so if this isn't needed then I'll remove it.
Boog900
approved these changes
Sep 5, 2024
Comment on lines
+11
to
+38
| /// An RPC [`tower::Service`]. | ||
| /// | ||
| /// This trait solely exists to encapsulate the traits needed | ||
| /// to handle RPC requests and respond with responses - **it is | ||
| /// not meant to be used directly.** | ||
| /// | ||
| /// The `Request` and `Response` are generic and | ||
| /// are used in the [`tower::Service`] bounds. | ||
| /// | ||
| /// The error type is always [`RpcError`]. | ||
| /// | ||
| /// There is a blanket implementation that implements this | ||
| /// trait on types that implement `tower::Service` correctly. | ||
| /// | ||
| /// See [`RpcHandler`](crate::RpcHandler) for more information. | ||
| pub trait RpcService<Request, Response>: | ||
| Clone | ||
| + Send | ||
| + Sync | ||
| + 'static | ||
| + Service< | ||
| Request, | ||
| Response = Response, | ||
| Error = RpcError, | ||
| Future: Future<Output = Result<Response, RpcError>> + Send + Sync + 'static, | ||
| > | ||
| { | ||
| } |
There was a problem hiding this comment.
Yeah I think it's a good idea.
FWIW I don't think you need the Sync bound here, although I also overuse the Sync bound in other parts of the code, I plan to go through it at some point and check so if this isn't needed then I'll remove it.
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.
What
Rpc{Request,Response}enums incuprate_rpc_interfacetower::Servicebound oncuprate_rpc_interface::RpcHandlerwith 3 ones, one for each RPC enum type i.e.JsonRpcRequest, BinRequest, OtherRequestWhy
The size difference between the smallest and largest enum variant triggers this lint.
Discussed in this meeting: monero-project/meta#1064.
How
The 300 byte figure I left in the meeting is incorrect since this PR also decouples request enums with JSON-RPC types.
It's closer to a 32 byte difference across enums and 96 byte difference within the largest enum itself
OtherRequest(one variant is 96 bytes, one is 0 bytes). This can be solved by implementingtower::Servicefor each request type, but this was decided as too unwieldy, so for now it is implemented on the 3 RPC enum types.