0g-storage-node/node/network/src/behaviour/gossip_cache.rs

use std::collections::hash_map::Entry;
use std::collections::HashMap;
use std::pin::Pin;
use std::task::{Context, Poll};
use std::time::Duration;

use crate::types::GossipKind;
use crate::GossipTopic;

use tokio_util::time::delay_queue::{DelayQueue, Key};

/// Store of gossip messages that we failed to publish and will try again later. By default, all
/// messages are ignored. This behaviour can be changed using `GossipCacheBuilder::default_timeout`
/// to apply the same delay to every kind. Individual timeouts for specific kinds can be set and
/// will overwrite the default_timeout if present.
pub struct GossipCache {
    /// Expire timeouts for each topic-msg pair.
    expirations: DelayQueue<(GossipTopic, Vec<u8>)>,
    /// Messages cached for each topic.
    topic_msgs: HashMap<GossipTopic, HashMap<Vec<u8>, Key>>,
    /// Timeout for Example messages.
    example: Option<Duration>,
    /// Timeout for FindFile messages.
    find_file: Option<Duration>,
    /// Timeout for FindChunks messages.
    find_chunks: Option<Duration>,
    /// Timeout for AnnounceFile.
    announce_file: Option<Duration>,
    /// Timeout for AnnounceChunks.
    announce_chunks: Option<Duration>,
    /// Timeout for AnnounceShardConfig.
    announce_shard_config: Option<Duration>,
}

#[derive(Default)]
pub struct GossipCacheBuilder {
    default_timeout: Option<Duration>,
    /// Timeout for Example messages.
    example: Option<Duration>,
    /// Timeout for blocks FindFile messages.
    find_file: Option<Duration>,
    /// Timeout for blocks FindChunks messages.
    find_chunks: Option<Duration>,
    /// Timeout for AnnounceFile messages.
    announce_file: Option<Duration>,
    /// Timeout for AnnounceChunks messages.
    announce_chunks: Option<Duration>,
    /// Timeout for AnnounceShardConfig messages.
    announce_shard_config: Option<Duration>,
}

#[allow(dead_code)]
impl GossipCacheBuilder {
    /// By default, all timeouts all disabled. Setting a default timeout will enable all timeout
    /// that are not already set.
    pub fn default_timeout(mut self, timeout: Duration) -> Self {
        self.default_timeout = Some(timeout);
        self
    }

    /// Timeout for Example messages.
    pub fn example_timeout(mut self, timeout: Duration) -> Self {
        self.example = Some(timeout);
        self
    }

    /// Timeout for FindFile messages.
    pub fn find_file_timeout(mut self, timeout: Duration) -> Self {
        self.find_file = Some(timeout);
        self
    }

    /// Timeout for FindChunks messages.
    pub fn find_chunks_timeout(mut self, timeout: Duration) -> Self {
        self.find_chunks = Some(timeout);
        self
    }

    /// Timeout for AnnounceFile messages.
    pub fn announce_file_timeout(mut self, timeout: Duration) -> Self {
        self.announce_file = Some(timeout);
        self
    }

    /// Timeout for AnnounceChunks messages.
    pub fn announce_chunks_timeout(mut self, timeout: Duration) -> Self {
        self.announce_chunks = Some(timeout);
        self
    }

    /// Timeout for AnnounceShardConfig messages.
    pub fn announce_shard_config_timeout(mut self, timeout: Duration) -> Self {
        self.announce_shard_config = Some(timeout);
        self
    }

    pub fn build(self) -> GossipCache {
        let GossipCacheBuilder {
            default_timeout,
            example,
            find_file,
            find_chunks,
            announce_file,
            announce_chunks,
            announce_shard_config,
        } = self;

        GossipCache {
            expirations: DelayQueue::default(),
            topic_msgs: HashMap::default(),
            example: example.or(default_timeout),
            find_file: find_file.or(default_timeout),
            find_chunks: find_chunks.or(default_timeout),
            announce_file: announce_file.or(default_timeout),
            announce_chunks: announce_chunks.or(default_timeout),
            announce_shard_config: announce_shard_config.or(default_timeout),
        }
    }
}

impl GossipCache {
    /// Get a builder of a `GossipCache`. Topic kinds for which no timeout is defined will be
    /// ignored if added in `insert`.
    pub fn builder() -> GossipCacheBuilder {
        GossipCacheBuilder::default()
    }

    // Insert a message to be sent later.
    pub fn insert(&mut self, topic: GossipTopic, data: Vec<u8>) {
        let expire_timeout = match topic.kind() {
            GossipKind::Example => self.example,
            GossipKind::FindFile => self.find_file,
            GossipKind::FindChunks => self.find_chunks,
            GossipKind::AnnounceFile => self.announce_file,
            GossipKind::AnnounceChunks => self.announce_chunks,
            GossipKind::AnnounceShardConfig => self.announce_shard_config,
        };

        let expire_timeout = match expire_timeout {
            Some(expire_timeout) => expire_timeout,
            None => return,
        };

        match self
            .topic_msgs
            .entry(topic.clone())
            .or_default()
            .entry(data.clone())
        {
            Entry::Occupied(key) => self.expirations.reset(key.get(), expire_timeout),
            Entry::Vacant(entry) => {
                let key = self.expirations.insert((topic, data), expire_timeout);
                entry.insert(key);
            }
        }
    }

    // Get the registered messages for this topic.
    pub fn retrieve(&mut self, topic: &GossipTopic) -> Option<impl Iterator<Item = Vec<u8>> + '_> {
        if let Some(msgs) = self.topic_msgs.remove(topic) {
            for (_, key) in msgs.iter() {
                self.expirations.remove(key);
            }
            Some(msgs.into_keys())
        } else {
            None
        }
    }
}

impl futures::stream::Stream for GossipCache {
    type Item = Result<GossipTopic, String>; // We don't care to retrieve the expired data.

    fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Option<Self::Item>> {
        match self.expirations.poll_expired(cx) {
            Poll::Ready(Some(Ok(expired))) => {
                let expected_key = expired.key();
                let (topic, data) = expired.into_inner();
                match self.topic_msgs.get_mut(&topic) {
                    Some(msgs) => {
                        let key = msgs.remove(&data);
                        debug_assert_eq!(key, Some(expected_key));
                        if msgs.is_empty() {
                            // no more messages for this topic.
                            self.topic_msgs.remove(&topic);
                        }
                    }
                    None => {
                        #[cfg(debug_assertions)]
                        panic!("Topic for registered message is not present.")
                    }
                }
                Poll::Ready(Some(Ok(topic)))
            }
            Poll::Ready(Some(Err(x))) => Poll::Ready(Some(Err(x.to_string()))),
            Poll::Ready(None) => Poll::Ready(None),
            Poll::Pending => Poll::Pending,
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::types::GossipKind;

    use super::*;
    use futures::stream::StreamExt;

    #[tokio::test]
    async fn test_stream() {
        let mut cache = GossipCache::builder()
            .default_timeout(Duration::from_millis(300))
            .build();
        let test_topic =
            GossipTopic::new(GossipKind::Example, crate::types::GossipEncoding::SSZSnappy);
        cache.insert(test_topic, vec![]);
        tokio::time::sleep(Duration::from_millis(300)).await;
        while cache.next().await.is_some() {}
        assert!(cache.expirations.is_empty());
        assert!(cache.topic_msgs.is_empty());
    }
}