Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(consensus): replace Notify with CancellationToken #2762

Merged
merged 1 commit into from
Dec 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,7 @@ tokio = "1.37.0"
tokio-retry = "0.3"
tokio-stream = "0.1.8"
tokio-test = "0.4.4"
tokio-util = "0.7.13"
toml = "0.8"
tower = "0.4.13"
tracing = "0.1.37"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ starknet-types-core.workspace = true
starknet_api.workspace = true
starknet_batcher_types = { workspace = true, features = ["testing"] }
tokio = { workspace = true, features = ["full"] }
tokio-util.workspace = true
tracing.workspace = true

[dev-dependencies]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,8 @@ use starknet_batcher_types::batcher_types::{
ValidateBlockInput,
};
use starknet_batcher_types::communication::BatcherClient;
use tokio::sync::Notify;
use tokio::task::JoinHandle;
use tokio_util::sync::CancellationToken;
use tracing::{debug, debug_span, info, trace, warn, Instrument};

// TODO(Dan, Matan): Remove this once and replace with real gas prices.
Expand Down Expand Up @@ -104,7 +104,7 @@ pub struct SequencerConsensusContext {
// Building proposals are not tracked as active, as consensus can't move on to the next
// height/round until building is done. Context only works on proposals for the
// current round.
active_proposal: Option<(Arc<Notify>, JoinHandle<()>)>,
active_proposal: Option<(CancellationToken, JoinHandle<()>)>,
// Stores proposals for future rounds until the round is reached.
queued_proposals:
BTreeMap<Round, (ValidationParams, oneshot::Sender<(ProposalContentId, ProposalFin)>)>,
Expand Down Expand Up @@ -399,15 +399,15 @@ impl SequencerConsensusContext {
};
batcher.validate_block(input).await.expect("Failed to initiate proposal validation");

let notify = Arc::new(Notify::new());
let notify_clone = Arc::clone(&notify);
let token = CancellationToken::new();
let token_clone = token.clone();
let chain_id = self.chain_id.clone();
let mut content = Vec::new();

let handle = tokio::spawn(async move {
let (built_block, received_fin) = loop {
tokio::select! {
_ = notify_clone.notified() => {
_ = token_clone.cancelled() => {
warn!("Proposal interrupted: {:?}", proposal_id);
batcher_abort_proposal(batcher.as_ref(), proposal_id).await;
return;
Expand Down Expand Up @@ -443,12 +443,12 @@ impl SequencerConsensusContext {
warn!("Failed to send proposal content ids");
}
});
self.active_proposal = Some((notify, handle));
self.active_proposal = Some((token, handle));
}

fn interrupt_active_proposal(&self) {
if let Some((notify, _)) = &self.active_proposal {
notify.notify_one();
if let Some((token, _)) = &self.active_proposal {
token.cancel();
}
}
}
Expand Down
Loading