alibi 0.8.0

Authentication for Rust, compatible with Better Auth’s TypeScript client
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

//! Explicit application-owned telemetry. No endpoint, environment discovery or
//! process fingerprinting is enabled by the library. Install a sink on the auth
//! builder to opt in; the application owns its transport and retention policy.

use async_trait::async_trait;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::sync::Arc;

/// An initialization or application-defined event delivered to the installed sink.
/// Application payloads are supplied by trusted host code, never HTTP requests.
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct TelemetryEvent {
    #[serde(rename = "type")]
    pub event_type: String,
    pub payload: Value,
}

impl TelemetryEvent {
    #[must_use]
    pub fn new(event_type: impl Into<String>, payload: Value) -> Self {
        Self {
            event_type: event_type.into(),
            payload,
        }
    }
}

/// Application-owned asynchronous event delivery.
#[async_trait]
pub trait TelemetrySink: Send + Sync {
    /// Deliver an event. Failures are nonfatal and logged without the payload or
    /// sink error, which may contain credentials or transport details.
    ///
    /// # Errors
    /// Returns the sink's delivery failure.
    async fn track(&self, event: TelemetryEvent) -> crate::AuthResult<()>;
}

/// Opt-in telemetry configuration. Default construction disables collection.
#[derive(Clone, Default)]
pub struct TelemetryConfig {
    enabled: bool,
    sink: Option<Arc<dyn TelemetrySink>>,
}

impl std::fmt::Debug for TelemetryConfig {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("TelemetryConfig")
            .field("enabled", &self.enabled)
            .finish_non_exhaustive()
    }
}

impl TelemetryConfig {
    /// Install an application sink and enable delivery, including initialization.
    #[must_use]
    pub fn new(sink: impl TelemetrySink + 'static) -> Self {
        Self {
            enabled: true,
            sink: Some(Arc::new(sink)),
        }
    }

    /// Enable or disable collection for this auth instance.
    #[must_use]
    pub const fn enabled(mut self, enabled: bool) -> Self {
        self.enabled = enabled;
        self
    }

    pub(crate) fn is_enabled(&self) -> bool {
        self.enabled && self.sink.is_some()
    }

    pub(crate) async fn publish(&self, event: TelemetryEvent) {
        if self.enabled
            && let Some(sink) = &self.sink
            && sink.track(event).await.is_err()
        {
            tracing::warn!("Authentication telemetry delivery failed");
        }
    }
}