unifly-api 0.9.2

Async Rust client, reactive data layer, and domain model for UniFi controller APIs
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
133
134
135
136
137
138
139
140

use std::sync::Arc;

use tracing::{debug, warn};

use crate::SessionClient;
use crate::core_error::CoreError;
use crate::model::{Client, Device, Event, FirewallGroup, HealthSummary, NatPolicy, Site};
use crate::session::models::{SessionClientEntry, SessionDevice, SessionUserEntry};

use super::super::support::convert_health_summaries;

#[derive(Default)]
pub(super) struct OptionalSessionRefresh {
    pub(super) events: Vec<Event>,
    pub(super) health: Vec<HealthSummary>,
    pub(super) clients: Vec<SessionClientEntry>,
    pub(super) devices: Vec<SessionDevice>,
    pub(super) users: Vec<SessionUserEntry>,
    pub(super) nat: Vec<NatPolicy>,
    pub(super) firewall_groups: Vec<FirewallGroup>,
}

pub(super) struct SessionOnlyRefresh {
    pub(super) devices: Vec<Device>,
    pub(super) clients: Vec<Client>,
    pub(super) events: Vec<Event>,
    pub(super) sites: Vec<Site>,
    pub(super) firewall_groups: Vec<FirewallGroup>,
}

pub(super) async fn fetch_optional(session: Option<Arc<SessionClient>>) -> OptionalSessionRefresh {
    let Some(session) = session else {
        return OptionalSessionRefresh::default();
    };

    let (events_res, health_res, clients_res, devices_res, users_res, nat_res, fwg_res) = tokio::join!(
        session.list_events(Some(100)),
        session.get_health(),
        session.list_clients(),
        session.list_devices(),
        session.list_users(),
        session.list_nat_rules(),
        session.list_firewall_groups(),
    );

    OptionalSessionRefresh {
        events: optional_events(&session, events_res),
        health: match health_res {
            Ok(raw) => convert_health_summaries(raw),
            Err(error) => {
                warn!(error = %error, "session health fetch failed (non-fatal)");
                Vec::new()
            }
        },
        clients: optional_raw("session client", clients_res),
        devices: optional_raw("session device", devices_res),
        users: optional_raw("session user", users_res),
        nat: match nat_res {
            Ok(raw) => raw
                .iter()
                .filter_map(crate::convert::nat_policy_from_v2)
                .collect(),
            Err(error) => {
                warn!(error = %error, "v2 NAT fetch failed (non-fatal)");
                Vec::new()
            }
        },
        firewall_groups: firewall_groups_or_empty(fwg_res),
    }
}

pub(super) async fn fetch_required(
    session: Arc<SessionClient>,
) -> Result<SessionOnlyRefresh, CoreError> {
    let (devices_res, clients_res, events_res, sites_res, fwg_res) = tokio::join!(
        session.list_devices(),
        session.list_clients(),
        session.list_events(Some(100)),
        session.list_sites(),
        session.list_firewall_groups(),
    );

    Ok(SessionOnlyRefresh {
        devices: devices_res?.into_iter().map(Device::from).collect(),
        clients: clients_res?.into_iter().map(Client::from).collect(),
        events: events_res?.into_iter().map(Event::from).collect(),
        sites: sites_res?.into_iter().map(Site::from).collect(),
        firewall_groups: firewall_groups_or_empty(fwg_res),
    })
}

fn optional_events(
    session: &SessionClient,
    result: Result<Vec<crate::session::models::SessionEvent>, crate::Error>,
) -> Vec<Event> {
    match result {
        Ok(raw) => raw.into_iter().map(Event::from).collect(),
        Err(ref error) if error.is_not_found() => {
            debug!(
                auth = ?session.auth(),
                error = %error,
                "session event endpoint unavailable; treating as empty"
            );
            Vec::new()
        }
        Err(error) => {
            warn!(
                auth = ?session.auth(),
                error = %error,
                "session event fetch failed (non-fatal)"
            );
            Vec::new()
        }
    }
}

fn optional_raw<T>(label: &str, result: Result<Vec<T>, crate::Error>) -> Vec<T> {
    match result {
        Ok(raw) => raw,
        Err(error) => {
            warn!(error = %error, "{label} fetch failed (non-fatal)");
            Vec::new()
        }
    }
}

fn firewall_groups_or_empty(
    result: Result<Vec<serde_json::Value>, crate::Error>,
) -> Vec<FirewallGroup> {
    match result {
        Ok(raw) => raw
            .iter()
            .filter_map(crate::convert::firewall_group_from_session)
            .collect(),
        Err(error) => {
            warn!(error = %error, "firewall group fetch failed (non-fatal)");
            Vec::new()
        }
    }
}