forge-runtime 0.10.0

Runtime executors and gateway for the Forge framework
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

//! RPC auto-capture signals: bridges the function router to the signals
//! collector so every successful or failed RPC call is recorded as a signal
//! event without each handler having to opt in.

#![cfg(feature = "gateway")]

use std::time::Duration;

use forge_core::{AuthContext, RequestMetadata, signals::SignalEvent};

use crate::signals::{SignalsCollector, bot::is_bot, visitor::generate_visitor_id};

/// Captured request/auth metadata required to emit an RPC signal after the
/// handler runs. Stored before the handler consumes auth/request.
pub struct RpcSignalContext {
    user_id: Option<uuid::Uuid>,
    tenant_id: Option<uuid::Uuid>,
    correlation_id: Option<String>,
    client_ip: Option<String>,
    user_agent: Option<String>,
}

impl RpcSignalContext {
    pub fn capture(auth: &AuthContext, request: &RequestMetadata) -> Self {
        Self {
            user_id: auth.user_id(),
            tenant_id: auth.tenant_id(),
            correlation_id: request.correlation_id().map(str::to_string),
            client_ip: request.client_ip().map(str::to_string),
            user_agent: request.user_agent().map(str::to_string),
        }
    }
}

/// Emit RPC signal events. Holds the collector handle and the server secret
/// used to derive a stable, GDPR-friendly visitor id.
pub struct RpcSignalsEmitter {
    collector: SignalsCollector,
    server_secret: String,
}

impl RpcSignalsEmitter {
    pub fn new(collector: SignalsCollector, server_secret: String) -> Self {
        Self {
            collector,
            server_secret,
        }
    }

    pub fn emit(
        &self,
        function_name: &str,
        function_kind: &str,
        duration: Duration,
        success: bool,
        ctx: RpcSignalContext,
    ) {
        let bot = is_bot(ctx.user_agent.as_deref());
        let visitor_id = ctx.client_ip.as_ref().map(|_| {
            generate_visitor_id(
                ctx.client_ip.as_deref(),
                ctx.user_agent.as_deref(),
                &self.server_secret,
            )
        });

        let event = SignalEvent::rpc_call(
            function_name,
            function_kind,
            duration.as_millis() as i32,
            success,
            ctx.user_id,
            ctx.tenant_id,
            ctx.correlation_id,
            ctx.client_ip,
            ctx.user_agent,
            visitor_id,
            bot,
        );
        self.collector.try_send(event);
    }
}