refactor(composer): interact with executor through handle #834
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
bharath-123
changed the title
bharath-123
changed the title
bharath-123
requested review from
joroshiba,
noot and
SuperFluffy
as code owners
bharath-123
commented
Mar 19, 2024
bharath-123
commented
Mar 19, 2024
bharath-123
force-pushed
the
bharath/executor-creates-handles
branch
from
650bf69 to
f27fc69
Compare
bharath-123
changed the title
bharath-123
force-pushed
the
bharath/executor-creates-handles
branch
4 times, most recently
from
ec91a39 to
6a053e9
Compare
noot
approved these changes
Mar 19, 2024
bharath-123
force-pushed
the
bharath/executor-creates-handles
branch
from
6a053e9 to
bbf53b7
Compare
SuperFluffy
approved these changes
Mar 20, 2024
| } | ||
|
|
||
| impl Handle { | ||
| pub(super) fn new(serialized_rollup_transactions_tx: mpsc::Sender<SequenceAction>) -> Self { |
There was a problem hiding this comment.
This constructor should not be pub(super) - it should only be callable from inside this module
(Very minor nit: I don't think this needs an explicit constructor - just create the handle in Executor::new (or however it's constructor is called).)
There was a problem hiding this comment.
i think thats a good point. i ll try just creating it in the Executor::new
| } | ||
| } | ||
|
|
||
| pub(super) async fn send_with_timeout( |
There was a problem hiding this comment.
i like the thin wrapper - but IMO just call this send_timeout.
| @@ -89,7 +90,7 @@ pub(super) struct Executor { | |||
| // The status of this executor | |||
| status: watch::Sender<Status>, | |||
| // Channel for receiving `SequenceAction`s to be bundled. | |||
| serialized_rollup_transactions_rx: mpsc::Receiver<SequenceAction>, | |||
| sequence_action_rx: mpsc::Receiver<SequenceAction>, | |||
There was a problem hiding this comment.
Personally, I'd just call this sequence_actions or new_sequence_actions. The _rx` doesn't add anything of substance.
There was a problem hiding this comment.
i ll call it serialized_rollup_transactions just to keep the naming consistent.
SuperFluffy
changed the title
SuperFluffy
changed the title
bharath-123
force-pushed
the
bharath/executor-creates-handles
branch
8 times, most recently
from
aa22f69 to
a3a06a8
Compare
SuperFluffy
reviewed
Mar 20, 2024
| @@ -238,11 +238,11 @@ impl Geth { | |||
| /// # Errors | |||
| /// | |||
| /// Returns the same error as tokio's [`Sender::send`]. | |||
| pub fn abort(&self) -> Result<usize, SendError<SubscriptionCommand>> { | |||
| pub fn cancel_subscriptions(&self) -> Result<usize, SendError<SubscriptionCommand>> { | |||
There was a problem hiding this comment.
Yeah, this is more descriptive. I was confused by abort.
bharath-123
force-pushed
the
bharath/executor-creates-handles
branch
from
a3a06a8 to
8e0da40
Compare
bharath-123
force-pushed
the
bharath/executor-creates-handles
branch
5 times, most recently
from
20f99e6 to
d7ee826
Compare
bharath-123
force-pushed
the
bharath/executor-creates-handles
branch
from
d7ee826 to
7e225cb
Compare
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.
Summary
This is a minor refactor PR which moves the creation of the channel through which executor receives SequenceActions to submit to the Shared Sequence N/w to the executor.
Background
Previously, the channels were created by the Composer which creates the Executor. It is better practice to allow the Executor to create the channel which it owns and just return the sending end of it back to the Composer.
Changes
Handlein Executor which is referenced asexecutor::Handle.executor::Handlein Executor and allow Executor to pass it back.Testing
Since this is not a functional PR change, making sure that the code compiles and the tests run is enough to ensure that this works.
Note
The tests were initially using just
sendon the channel but the executor usessend_with_timeout. We could add just asendmethod to theexecutor::Handle. But to avoid clippy errors w.r.t unused methodsendand avoiding a#[cfg(test)]in the method, I updated the tests to usesend_with_timeoutinstead ofsend.closes