rhood-core 0.2.0

Async Rust client library for the Robinhood trading API
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106

//! In-memory caches for identity/metadata lookups.
//!
//! See [`ResolverCache`] for the full policy. Financial data is **never**
//! stored here, only immutable identifiers and metadata that the Robinhood
//! API returns repeatedly over the lifetime of a client.

use std::sync::Arc;
use std::time::Duration;

use moka::future::Cache;
use tokio::sync::OnceCell;

use crate::config::CacheConfig;
use crate::models::futures::FuturesContract;
use crate::models::stock::{IndexInstrument, Instrument};

/// Per-client caches backing symbol↔id resolution.
///
/// Contents are cloneable because all fields are reference-counted internally
/// (moka caches clone by bumping an atomic, [`OnceCell`] is shared via
/// [`Arc`]). Dropping the last clone releases the allocations.
///
/// # Policy
///
/// The cache stores only identity and metadata lookups that are effectively
/// immutable over the server lifetime:
///
/// - `symbol → Instrument` (equity metadata)
/// - `uuid → symbol` (reverse lookup for enrichment)
/// - `symbol → IndexInstrument`
/// - `symbol → FuturesContract`
/// - The singleton futures account id
///
/// Financial data such as quotes, prices, candles, positions, orders, fundamentals,
/// news, ratings are **never** stored here.
#[derive(Clone)]
pub struct ResolverCache {
    pub(crate) enabled: bool,
    pub(crate) enrichment_batch_size: usize,
    pub(crate) instruments_by_symbol: Cache<String, Arc<Instrument>>,
    pub(crate) instruments_by_id: Cache<String, String>,
    pub(crate) index_instruments: Cache<String, Arc<IndexInstrument>>,
    pub(crate) futures_contracts: Cache<String, Arc<FuturesContract>>,
    pub(crate) futures_account_id: Arc<OnceCell<String>>,
}

impl ResolverCache {
    /// Builds a cache from a configuration.
    ///
    /// The returned value is cheap to clone and share across
    /// [`RobinhoodClient`](crate::RobinhoodClient) clones: every field is
    /// internally reference-counted.
    pub fn from_config(config: &CacheConfig) -> Self {
        let instruments_by_symbol = Cache::builder()
            .max_capacity(config.instrument_max_entries)
            .time_to_live(Duration::from_secs(config.instrument_ttl_secs))
            .build();
        let instruments_by_id = Cache::builder()
            .max_capacity(config.instrument_id_max_entries)
            .time_to_live(Duration::from_secs(config.instrument_id_ttl_secs))
            .build();
        let index_instruments = Cache::builder()
            .max_capacity(config.index_max_entries)
            .time_to_live(Duration::from_secs(config.index_ttl_secs))
            .build();
        let futures_contracts = Cache::builder()
            .max_capacity(config.futures_max_entries)
            .time_to_live(Duration::from_secs(config.futures_ttl_secs))
            .build();
        Self {
            enabled: config.enabled,
            enrichment_batch_size: config.enrichment_batch_size,
            instruments_by_symbol,
            instruments_by_id,
            index_instruments,
            futures_contracts,
            futures_account_id: Arc::new(OnceCell::new()),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[tokio::test]
    async fn from_config_builds_empty_caches() {
        let cache = ResolverCache::from_config(&CacheConfig::default());
        assert!(cache.enabled);
        assert_eq!(cache.instruments_by_symbol.entry_count(), 0);
        assert_eq!(cache.instruments_by_id.entry_count(), 0);
        assert_eq!(cache.index_instruments.entry_count(), 0);
        assert_eq!(cache.futures_contracts.entry_count(), 0);
        assert!(cache.futures_account_id.get().is_none());
    }

    #[tokio::test]
    async fn disabled_flag_propagates() {
        let cfg = CacheConfig {
            enabled: false,
            ..CacheConfig::default()
        };
        let cache = ResolverCache::from_config(&cfg);
        assert!(!cache.enabled);
    }
}