foxglove 0.19.0

Foxglove SDK
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

#![allow(dead_code)]

use std::sync::Arc;

use arc_swap::ArcSwapOption;
use thiserror::Error;
use tokio::sync::Mutex;

use crate::api_client::{
    DeviceResponse, DeviceToken, FoxgloveApiClient, FoxgloveApiClientBuilder,
    FoxgloveApiClientError, RtcCredentials,
};

#[derive(Error, Debug)]
#[non_exhaustive]
pub(crate) enum CredentialsError {
    #[error("failed to fetch credentials: {0}")]
    FetchFailed(#[from] FoxgloveApiClientError),
}

pub(crate) struct CredentialsProvider {
    device: DeviceResponse,
    client: FoxgloveApiClient<DeviceToken>,
    credentials: ArcSwapOption<RtcCredentials>,
    refresh_lock: Mutex<()>,
}

impl CredentialsProvider {
    pub async fn new(
        client_builder: FoxgloveApiClientBuilder<DeviceToken>,
    ) -> Result<Self, FoxgloveApiClientError> {
        let client = client_builder.build()?;
        let device = client.fetch_device_info().await?;
        Ok(Self {
            device,
            client,
            credentials: ArcSwapOption::new(None),
            refresh_lock: Mutex::new(()),
        })
    }

    #[must_use]
    pub fn current_credentials(&self) -> Option<Arc<RtcCredentials>> {
        self.credentials.load_full()
    }

    pub async fn load_credentials(&self) -> Result<Arc<RtcCredentials>, CredentialsError> {
        if let Some(credentials) = self.current_credentials() {
            return Ok(credentials);
        }

        let _refresh_guard = self.refresh_lock.lock().await;
        if let Some(credentials) = self.current_credentials() {
            return Ok(credentials);
        }

        tracing::info!("refreshing credentials");
        let credentials = Arc::new(self.client.authorize_remote_viz(&self.device.id).await?);
        self.credentials.store(Some(credentials.clone()));
        Ok(credentials)
    }

    pub fn device_name(&self) -> &str {
        &self.device.name
    }

    pub async fn clear(&self) {
        let _refresh_guard = self.refresh_lock.lock().await;
        self.credentials.store(None);
    }
}

#[cfg(test)]
mod tests {
    use crate::api_client::test_utils::{
        TEST_DEVICE_TOKEN, create_test_builder, create_test_server,
    };

    use crate::api_client::DeviceToken;

    use super::CredentialsProvider;

    #[tokio::test]
    async fn new_succeeds_with_no_cached_credentials() {
        let server = create_test_server().await;
        let builder = create_test_builder(server.url(), DeviceToken::new(TEST_DEVICE_TOKEN));

        let provider = CredentialsProvider::new(builder)
            .await
            .expect("should construct successfully");

        assert!(provider.current_credentials().is_none());
    }

    #[tokio::test]
    async fn new_fails_with_bad_token() {
        let server = create_test_server().await;
        let builder = create_test_builder(server.url(), DeviceToken::new("bad-token"));

        let result = CredentialsProvider::new(builder).await;
        assert!(result.is_err());
    }

    #[tokio::test]
    async fn load_credentials_fetches_and_caches() {
        let server = create_test_server().await;
        let builder = create_test_builder(server.url(), DeviceToken::new(TEST_DEVICE_TOKEN));
        let provider = CredentialsProvider::new(builder).await.unwrap();

        let credentials = provider
            .load_credentials()
            .await
            .expect("should fetch credentials");

        assert_eq!(credentials.token, "rtc-token-abc123");
        assert_eq!(credentials.url, "wss://rtc.foxglove.dev");
        assert!(provider.current_credentials().is_some());
    }

    #[tokio::test]
    async fn clear_removes_cached_credentials() {
        let server = create_test_server().await;
        let builder = create_test_builder(server.url(), DeviceToken::new(TEST_DEVICE_TOKEN));
        let provider = CredentialsProvider::new(builder).await.unwrap();

        provider.load_credentials().await.unwrap();
        assert!(provider.current_credentials().is_some());

        provider.clear().await;
        assert!(provider.current_credentials().is_none());
    }
}