groupcache 0.3.0

groupcache is a distributed caching and cache-filling library, intended as a replacement for a pool of memcached nodes in many cases. It shards by key to select which peer is responsible for that key.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

use crate::{GroupcacheInner, GroupcachePeer, ValueBounds};
use async_trait::async_trait;
use log::error;
use std::collections::HashSet;
use std::error::Error;
use std::sync::Weak;
use std::time::Duration;

/// This trait abstracts away boilerplate associated with pull-based service discovery.
///
/// groupcache periodically runs [`ServiceDiscovery::pull_instances`] and
/// compares pulled instances with the ones it already knew about
/// from previous invocations of [`ServiceDiscovery::pull_instances`].
///
/// groupcache connects with new peers and disconnects with missing peers via [`Groupcache::set_peers`].
#[async_trait]
pub trait ServiceDiscovery: Send {
    /// Pulls groupcache instances from a source-of-truth system (kubernetes API server, consul etc).
    ///
    /// Based on this function groupcache is able to update its routing table,
    /// so that it can correctly route to healthy instances and stop hitting unhealthy nodes.
    ///
    /// Returning Error from this function will be logged by groupcache
    /// but routing table will not be updated.
    async fn pull_instances(
        &self,
    ) -> Result<HashSet<GroupcachePeer>, Box<dyn Error + Send + Sync + 'static>>;

    /// Specifies duration between consecutive executions of [`ServiceDiscovery::pull_instances`].
    fn interval(&self) -> Duration {
        Duration::from_secs(10)
    }
}

pub(crate) async fn run_service_discovery<Value: ValueBounds>(
    cache: Weak<GroupcacheInner<Value>>,
    service_discovery: Box<dyn ServiceDiscovery>,
) {
    while let Some(cache) = cache.upgrade() {
        tokio::time::sleep(service_discovery.interval()).await;
        match service_discovery.pull_instances().await {
            Ok(instances) => {
                if let Err(error) = cache.set_peers(instances).await {
                    error!("Error connecting to refreshed instances: {}", error);
                };
            }
            Err(error) => {
                error!("Error during when refreshing instances: {}", error);
            }
        }
    }
}