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

Fix stale region cache with no leader #445

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
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
41 changes: 36 additions & 5 deletions src/region_cache.rs
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ impl<C: RetryClientTrait> RegionCache<C> {
.get(&candidate_region_ver_id)
.unwrap();

if region.contains(key) {
// Region in cache maybe stale if the region has not been elected leader yet during start.
if region.contains(key) && region.leader.is_some() {
return Ok(region.clone());
}
}
Expand All @@ -102,7 +103,11 @@ impl<C: RetryClientTrait> RegionCache<C> {
let ver_id = region_cache_guard.id_to_ver_id.get(&id);
if let Some(ver_id) = ver_id {
let region = region_cache_guard.ver_id_to_region.get(ver_id).unwrap();
return Ok(region.clone());

// Region in cache maybe stale if the region has not been elected leader yet during start.
if region.leader.is_some() {
return Ok(region.clone());
}
}

// check concurrent requests
Expand Down Expand Up @@ -492,11 +497,15 @@ mod test {
async fn test_get_region_by_key() -> Result<()> {
let retry_client = Arc::new(MockRetryClient::default());
let cache = RegionCache::new(retry_client.clone());
let leader = Some(metapb::Peer {
store_id: 1,
..Default::default()
});

let region1 = region(1, vec![], vec![10]);
let region2 = region(2, vec![10], vec![20]);
let region1 = region_with_leader(1, vec![], vec![10], leader.clone());
let region2 = region_with_leader(2, vec![10], vec![20], leader.clone());
let region3 = region(3, vec![30], vec![40]);
let region4 = region(4, vec![50], vec![]);
let region4 = region_with_leader(4, vec![50], vec![], leader.clone());
cache.add_region(region1.clone()).await;
cache.add_region(region2.clone()).await;
cache.add_region(region3.clone()).await;
Expand All @@ -516,6 +525,8 @@ mod test {
);
assert!(cache.get_region_by_key(&vec![20].into()).await.is_err());
assert!(cache.get_region_by_key(&vec![25].into()).await.is_err());
// region3 in cache has no leader, the cache is invalid.
assert!(cache.get_region_by_key(&vec![35].into()).await.is_err());
assert_eq!(cache.get_region_by_key(&vec![60].into()).await?, region4);
Ok(())
}
Expand Down Expand Up @@ -552,6 +563,26 @@ mod test {
region
}

fn region_with_leader(
id: RegionId,
start_key: Vec<u8>,
end_key: Vec<u8>,
leader: Option<metapb::Peer>,
) -> RegionWithLeader {
let mut region = RegionWithLeader::default();
region.region.id = id;
region.region.start_key = start_key;
region.region.end_key = end_key;
region.region.region_epoch = Some(RegionEpoch {
conf_ver: 0,
version: 0,
});
// We don't care about other fields here

region.leader = leader;
region
}

#[test]
fn test_is_valid_tikv_store() {
let mut store = metapb::Store::default();
Expand Down
Loading