forked from databendlabs/openraft
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix: Immediate response when snapshot installation is unnecessary
When `Engine::handle_install_full_snapshot()` is called and the provided snapshot is not up-to-date, the snapshot should not be installed, and the response should be sent back immediately. Previously, the method might delay the response unnecessarily, waiting for an installation process that would not proceed. This commit adjusts the logic so that if the snapshot is recognized as outdated, it immediately returns a `None` `Condition`, ensuring the caller is informed straightaway that no installation will occur.
- Loading branch information
1 parent
946dc3f
commit 5c83e16
Showing
5 changed files
with
212 additions
and
17 deletions.
There are no files selected for viewing
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
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
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
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
163 changes: 163 additions & 0 deletions
163
openraft/src/engine/tests/install_full_snapshot_test.rs
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| use std::io::Cursor; | ||
|
|
||
| use maplit::btreeset; | ||
| use pretty_assertions::assert_eq; | ||
|
|
||
| use crate::core::sm; | ||
| use crate::engine::testing::UTConfig; | ||
| use crate::engine::Command; | ||
| use crate::engine::Condition; | ||
| use crate::engine::Engine; | ||
| use crate::engine::LogIdList; | ||
| use crate::engine::Respond; | ||
| use crate::raft::SnapshotResponse; | ||
| use crate::testing::log_id; | ||
| use crate::type_config::alias::AsyncRuntimeOf; | ||
| use crate::AsyncRuntime; | ||
| use crate::Membership; | ||
| use crate::Snapshot; | ||
| use crate::SnapshotMeta; | ||
| use crate::StoredMembership; | ||
| use crate::TokioInstant; | ||
| use crate::Vote; | ||
|
|
||
| fn m12() -> Membership<UTConfig> { | ||
| Membership::<UTConfig>::new(vec![btreeset! {1,2}], None) | ||
| } | ||
|
|
||
| fn m1234() -> Membership<UTConfig> { | ||
| Membership::<UTConfig>::new(vec![btreeset! {1,2,3,4}], None) | ||
| } | ||
|
|
||
| fn eng() -> Engine<UTConfig> { | ||
| let mut eng = Engine::testing_default(0); | ||
| eng.state.enable_validation(false); // Disable validation for incomplete state | ||
|
|
||
| eng.state.vote.update(TokioInstant::now(), Vote::new_committed(2, 1)); | ||
| eng.state.committed = Some(log_id(4, 1, 5)); | ||
| eng.state.log_ids = LogIdList::new(vec![ | ||
| // | ||
| log_id(2, 1, 2), | ||
| log_id(3, 1, 5), | ||
| log_id(4, 1, 6), | ||
| log_id(4, 1, 8), | ||
| ]); | ||
| eng.state.snapshot_meta = SnapshotMeta { | ||
| last_log_id: Some(log_id(2, 1, 2)), | ||
| last_membership: StoredMembership::new(Some(log_id(1, 1, 1)), m12()), | ||
| snapshot_id: "1-2-3-4".to_string(), | ||
| }; | ||
| eng.state.server_state = eng.calc_server_state(); | ||
|
|
||
| eng | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_handle_install_full_snapshot_lt_last_snapshot() -> anyhow::Result<()> { | ||
| // Snapshot will not be installed because new `last_log_id` is less or equal current | ||
| // `snapshot_meta.last_log_id`. | ||
| // | ||
| // It should respond at once. | ||
|
|
||
| let mut eng = eng(); | ||
|
|
||
| let curr_vote = *eng.state.vote_ref(); | ||
|
|
||
| let (tx, _rx) = AsyncRuntimeOf::<UTConfig>::oneshot(); | ||
|
|
||
| eng.handle_install_full_snapshot( | ||
| curr_vote, | ||
| Snapshot { | ||
| meta: SnapshotMeta { | ||
| last_log_id: Some(log_id(1, 1, 2)), | ||
| last_membership: StoredMembership::new(Some(log_id(1, 1, 1)), m1234()), | ||
| snapshot_id: "1-2-3-4".to_string(), | ||
| }, | ||
| snapshot: Box::new(Cursor::new(vec![0u8])), | ||
| }, | ||
| tx, | ||
| ); | ||
|
|
||
| assert_eq!( | ||
| SnapshotMeta { | ||
| last_log_id: Some(log_id(2, 1, 2)), | ||
| last_membership: StoredMembership::new(Some(log_id(1, 1, 1)), m12()), | ||
| snapshot_id: "1-2-3-4".to_string(), | ||
| }, | ||
| eng.state.snapshot_meta | ||
| ); | ||
|
|
||
| let (dummy_tx, _rx) = AsyncRuntimeOf::<UTConfig>::oneshot(); | ||
| assert_eq!( | ||
| vec![ | ||
| // | ||
| Command::Respond { | ||
| when: None, | ||
| resp: Respond::new(Ok(SnapshotResponse::new(curr_vote)), dummy_tx), | ||
| }, | ||
| ], | ||
| eng.output.take_commands() | ||
| ); | ||
|
|
||
| Ok(()) | ||
| } | ||
|
|
||
| #[test] | ||
| fn test_handle_install_full_snapshot_no_conflict() -> anyhow::Result<()> { | ||
| // Snapshot will be installed and there are no conflicting logs. | ||
| // The response should be sent after the snapshot is installed. | ||
|
|
||
| let mut eng = eng(); | ||
|
|
||
| let curr_vote = *eng.state.vote_ref(); | ||
|
|
||
| let (tx, _rx) = AsyncRuntimeOf::<UTConfig>::oneshot(); | ||
|
|
||
| eng.handle_install_full_snapshot( | ||
| curr_vote, | ||
| Snapshot { | ||
| meta: SnapshotMeta { | ||
| last_log_id: Some(log_id(4, 1, 6)), | ||
| last_membership: StoredMembership::new(Some(log_id(1, 1, 1)), m1234()), | ||
| snapshot_id: "1-2-3-4".to_string(), | ||
| }, | ||
| snapshot: Box::new(Cursor::new(vec![0u8])), | ||
| }, | ||
| tx, | ||
| ); | ||
|
|
||
| assert_eq!( | ||
| SnapshotMeta { | ||
| last_log_id: Some(log_id(4, 1, 6)), | ||
| last_membership: StoredMembership::new(Some(log_id(1, 1, 1)), m1234()), | ||
| snapshot_id: "1-2-3-4".to_string(), | ||
| }, | ||
| eng.state.snapshot_meta | ||
| ); | ||
|
|
||
| let (dummy_tx, _rx) = AsyncRuntimeOf::<UTConfig>::oneshot(); | ||
| assert_eq!( | ||
| vec![ | ||
| // | ||
| Command::from( | ||
| sm::Command::install_full_snapshot(Snapshot { | ||
| meta: SnapshotMeta { | ||
| last_log_id: Some(log_id(4, 1, 6)), | ||
| last_membership: StoredMembership::new(Some(log_id(1, 1, 1)), m1234()), | ||
| snapshot_id: "1-2-3-4".to_string(), | ||
| }, | ||
| snapshot: Box::new(Cursor::new(vec![0u8])), | ||
| }) | ||
| .with_seq(1) | ||
| ), | ||
| Command::PurgeLog { upto: log_id(4, 1, 6) }, | ||
| Command::Respond { | ||
| when: Some(Condition::StateMachineCommand { command_seq: 1 }), | ||
| resp: Respond::new(Ok(SnapshotResponse::new(curr_vote)), dummy_tx), | ||
| }, | ||
| ], | ||
| eng.output.take_commands() | ||
| ); | ||
|
|
||
| Ok(()) | ||
| } |