Add support for protocol version Bilrost (v2) #3190
Merged
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
This was referenced Apr 23, 2025
e2d0499 to
c3fc171
Compare
967bce7 to
be41686
Compare
|
@muhamadazmy I've removed myself as reviewer, feel free to add me back when this is ready for review. |
3edffff to
248eddd
Compare
9cbe49d to
74d1e48
Compare
AhmedSoliman
approved these changes
Apr 29, 2025
There was a problem hiding this comment.
Very good work @mohammedazmy. I like how clear it's to follow the design.
crates/encoding/derive/Cargo.toml
Outdated
| @@ -0,0 +1,17 @@ | |||
| [package] | |||
| name = "encoding-derive" | |||
There was a problem hiding this comment.
Suggested change
| name = "encoding-derive" | |
| name = "restate-encoding-derive" |
crates/encoding/src/lib.rs
Outdated
|
|
||
| impl<T> NetSerde for Vec<T> where T: NetSerde {} | ||
| impl<T> NetSerde for Option<T> where T: NetSerde {} | ||
| impl<K, V> NetSerde for HashMap<K, V> |
There was a problem hiding this comment.
You might need to add S as a third parameter here to cover all hashmap types.
| @@ -16,6 +16,7 @@ use bytes::Bytes; | |||
| use serde::Serialize; | |||
| use serde::de::DeserializeOwned; | |||
|
|
|||
| use super::{FromBilrostDto, IntoBilrostDto}; | |||
| use crate::protobuf::common::ProtocolVersion; | |||
|
|
|||
| pub trait WireEncode { | |||
There was a problem hiding this comment.
I wonder if we should make WireEncode be bound to NetSerde types, that would be cool. Can happen in follow-up PRs.
Also introduce two new derive macros: - `BilrostNewType` to use with all ID types or any tuple with a single item. This will effectively flatten this tuple to its inner type. Given that the inner field is bilrost serializable - `NetworkMessage` which must be derived for each message that is going to be send over the network
| /// allowing them to be stored or transferred directly without transformation. | ||
| /// | ||
| pub trait FromBilrostDto: Sized { | ||
| type Target: bilrost::OwnedMessage + NetSerde; |
There was a problem hiding this comment.
Should this be Source instead of Target?
Comment on lines
+312
to
+328
| impl $crate::net::IntoBilrostDto for $message { | ||
| type Target = $as_type; | ||
|
|
||
| fn into_dto(self) -> $as_type { | ||
| self.into() | ||
| } | ||
| } | ||
|
|
||
| impl $crate::net::FromBilrostDto for $message { | ||
| type Target = $as_type; | ||
| type Error = <$message as TryFrom<$as_type>>::Error; | ||
|
|
||
| fn from_dto(value: Self::Target) -> Result<Self, Self::Error> { | ||
| value.try_into() | ||
| } | ||
| } | ||
| )? |
There was a problem hiding this comment.
I think we should mention the TryFrom and Into requirements fro the $as_type. This is not clear from the docs of the macro.
Comment on lines
+17
to
+20
| #[proc_macro_derive(BilrostNewType)] | ||
| pub fn bilrost_new_type(item: TokenStream) -> TokenStream { | ||
| bilrost::new_type(item) | ||
| } |
There was a problem hiding this comment.
Some minimal for when and how to use this macro could be helpful.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Add support for protocol version Bilrost (v2)
Also introduce two new derive macros:
BilrostNewTypeto use with all ID types or any tuple with a single item. This willeffectively flatten this tuple to its inner type. Given that the inner field is bilrost serializable
NetworkMessagewhich must be derived for each message that is going to be send over the networkStack created with Sapling. Best reviewed with ReviewStack.