Module API refactor #412
Merged
Module API refactor #412
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
dvdplm
reviewed
Jul 12, 2021
There was a problem hiding this comment.
Still a draft but here are my thought so far:
- I think that in the back of our heads we had in mind a setup flow where a ref to the
Serverwould be passed around to different subsystems and each wouldregister_module()to add "their" RPC calls. Instead what substrate does is the opposite, the subsystems are all asked for their sets of RPC calls and when they're all collected they are added to the server in a single place. (This architecture is what is making initialization tricky to do in more than one place, such as adding specific RPC modules on the basis of config files that are processed in different places. This is hackfix-solved by passing around closures.) - This work here makes it more obvious that setting up the server and the methods to call are quite separate things. I think it makes sense (and the DRYing is welcome obviously).
- A UI-test for a bad macro setup would be nice, one proving that the static method check works as expected.
- I might be wrong but I'm not sure we have good tests for setting up and starting both a ws and http server; would be good to have one.
dvdplm
approved these changes
Jul 12, 2021
| #[method(name = "foo")] | ||
| async fn foo(&self) -> u8; | ||
|
|
||
| #[method(name = "foo")] |
There was a problem hiding this comment.
Ok, but this is the easy case. Let's do two separate modules?
There was a problem hiding this comment.
Separate modules need to be merged on runtime, and merge can return regular errors, there is no way to check them on compile time.
Co-authored-by: David <dvdplm@gmail.com>
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.
Since we want to support both HTTP and WS servers sharing the same
Methodsinternally, it makes more sense to force the user to pre-merge all their modules into one before cloning it and passing it to their respective servers. This PR changes some of the module API to make this the expected behavior.register_moduleon both WS and HTTP server, instead when starting a server you can pass a singleInto<Methods>type.RpcModule<T>implementsDeref<Target = Methods>andDerefMutto keep module merging logic DRY.into_rpcneed not return aResult.method_namesreturns anIteratorinstead of aVec.