forge-runtime 0.9.0

Runtime executors and gateway for the Forge framework
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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
//! HTTP ingestion endpoints for client-side signal events.
//!
//! Routes (under /_api/):
//! - POST /signal/event  -- custom events
//! - POST /signal/view   -- page views
//! - POST /signal/user   -- identify (link session to user)
//! - POST /signal/report -- diagnostic error reports
//! - POST /signal/vital  -- Web Vitals / performance metrics
//!
//! Every endpoint except `/signal/report` short-circuits when the request
//! carries `DNT: 1` or `Sec-GPC: 1`. Error reports still land so production
//! crashes from opted-out browsers remain visible.

use std::sync::Arc;

use axum::Json;
use axum::extract::State;
use axum::http::HeaderMap;
use axum::response::IntoResponse;
use forge_core::AuthContext;
use forge_core::signals::{
    DiagnosticReport, IdentifyPayload, PageViewPayload, SignalEvent, SignalEventBatch,
    SignalEventType, SignalResponse, UtmParams, WebVitalBatch,
};
use serde_json::Value;
use sqlx::PgPool;
use tracing::warn;
use uuid::Uuid;

use super::bot;
use super::collector::SignalsCollector;
use super::device;
use super::session;
use super::visitor;

/// Maximum events per batch request.
const MAX_BATCH_SIZE: usize = 50;

/// Check the client's Do-Not-Track header. We honor DNT: 1 by short-circuiting
/// signal ingestion — the browser has explicitly opted out of tracking.
/// Sec-GPC (Global Privacy Control) is also respected.
fn dnt_opted_out(headers: &HeaderMap) -> bool {
    let dnt = extract_header(headers, "dnt");
    if dnt.as_deref() == Some("1") {
        return true;
    }
    let gpc = extract_header(headers, "sec-gpc");
    gpc.as_deref() == Some("1")
}

/// Shared state for signal endpoints.
#[derive(Clone)]
pub struct SignalsState {
    pub collector: SignalsCollector,
    pub pool: PgPool,
    pub server_secret: String,
    /// When true, strip raw client IP from stored events (GDPR-compliant).
    pub anonymize_ip: bool,
    /// Optional GeoIP resolver for country code lookups from client IP.
    pub geoip: Option<super::geoip::GeoIpResolver>,
}

/// POST /signal/event -- batch custom events.
pub async fn event_handler(
    State(state): State<Arc<SignalsState>>,
    auth: Option<axum::Extension<AuthContext>>,
    headers: HeaderMap,
    Json(batch): Json<SignalEventBatch>,
) -> impl IntoResponse {
    if dnt_opted_out(&headers) {
        return Json(SignalResponse {
            ok: true,
            session_id: None,
        });
    }
    if batch.events.len() > MAX_BATCH_SIZE {
        return Json(SignalResponse {
            ok: false,
            session_id: None,
        });
    }

    let ctx = extract_request_ctx(
        &headers,
        &auth,
        &state.server_secret,
        state.anonymize_ip,
        state.geoip.as_ref(),
    );
    let session_id =
        resolve_session_id(batch.context.as_ref().and_then(|c| c.session_id.as_deref()));
    let page_url = batch.context.as_ref().and_then(|c| c.page_url.clone());

    let session_id = session::upsert_session(
        &state.pool,
        session_id,
        &ctx.visitor_id,
        ctx.user_id,
        ctx.tenant_id,
        page_url.as_deref(),
        batch.context.as_ref().and_then(|c| c.referrer.as_deref()),
        ctx.user_agent.as_deref(),
        ctx.client_ip.as_deref(),
        ctx.is_bot,
        "track",
        ctx.device_type.as_deref(),
        ctx.browser.as_deref(),
        ctx.os.as_deref(),
    )
    .await;

    for event in batch.events {
        let signal = SignalEvent {
            event_type: SignalEventType::Track,
            event_name: Some(event.event),
            correlation_id: event.correlation_id,
            session_id,
            visitor_id: Some(ctx.visitor_id.clone()),
            user_id: ctx.user_id,
            tenant_id: ctx.tenant_id,
            properties: event.properties,
            page_url: page_url.clone(),
            referrer: None,
            function_name: None,
            function_kind: None,
            duration_ms: None,
            status: None,
            error_message: None,
            error_stack: None,
            error_context: None,
            client_ip: ctx.client_ip.clone(),
            country: ctx.country.clone(),
            city: ctx.city.clone(),
            user_agent: ctx.user_agent.clone(),
            device_type: ctx.device_type.clone(),
            browser: ctx.browser.clone(),
            os: ctx.os.clone(),
            utm: None,
            is_bot: ctx.is_bot,
            timestamp: event.timestamp.unwrap_or_else(chrono::Utc::now),
        };
        state.collector.try_send(signal);
    }

    Json(SignalResponse {
        ok: true,
        session_id,
    })
}

/// POST /signal/view -- page view event.
pub async fn view_handler(
    State(state): State<Arc<SignalsState>>,
    auth: Option<axum::Extension<AuthContext>>,
    headers: HeaderMap,
    Json(payload): Json<PageViewPayload>,
) -> impl IntoResponse {
    if dnt_opted_out(&headers) {
        return Json(SignalResponse {
            ok: true,
            session_id: None,
        });
    }
    let ctx = extract_request_ctx(
        &headers,
        &auth,
        &state.server_secret,
        state.anonymize_ip,
        state.geoip.as_ref(),
    );
    let session_id_header = extract_header(&headers, "x-session-id");
    let session_id = resolve_session_id(session_id_header.as_deref());

    let session_id = session::upsert_session(
        &state.pool,
        session_id,
        &ctx.visitor_id,
        ctx.user_id,
        ctx.tenant_id,
        Some(&payload.url),
        payload.referrer.as_deref(),
        ctx.user_agent.as_deref(),
        ctx.client_ip.as_deref(),
        ctx.is_bot,
        "page_view",
        ctx.device_type.as_deref(),
        ctx.browser.as_deref(),
        ctx.os.as_deref(),
    )
    .await;

    let utm = if payload.utm_source.is_some()
        || payload.utm_medium.is_some()
        || payload.utm_campaign.is_some()
    {
        Some(UtmParams {
            source: payload.utm_source,
            medium: payload.utm_medium,
            campaign: payload.utm_campaign,
            term: payload.utm_term,
            content: payload.utm_content,
        })
    } else {
        None
    };

    let signal = SignalEvent {
        event_type: SignalEventType::PageView,
        event_name: payload.title,
        correlation_id: payload.correlation_id,
        session_id,
        visitor_id: Some(ctx.visitor_id),
        user_id: ctx.user_id,
        tenant_id: ctx.tenant_id,
        properties: Value::Object(serde_json::Map::new()),
        page_url: Some(payload.url),
        referrer: payload.referrer,
        function_name: None,
        function_kind: None,
        duration_ms: None,
        status: None,
        error_message: None,
        error_stack: None,
        error_context: None,
        client_ip: ctx.client_ip,
        country: ctx.country,
        city: ctx.city,
        user_agent: ctx.user_agent,
        device_type: ctx.device_type,
        browser: ctx.browser,
        os: ctx.os,
        utm,
        is_bot: ctx.is_bot,
        timestamp: chrono::Utc::now(),
    };
    state.collector.try_send(signal);

    Json(SignalResponse {
        ok: true,
        session_id,
    })
}

/// POST /signal/user -- identify user.
pub async fn user_handler(
    State(state): State<Arc<SignalsState>>,
    auth: Option<axum::Extension<AuthContext>>,
    headers: HeaderMap,
    Json(payload): Json<IdentifyPayload>,
) -> impl IntoResponse {
    if dnt_opted_out(&headers) {
        return Json(SignalResponse {
            ok: true,
            session_id: None,
        });
    }
    let user_id = Uuid::parse_str(&payload.user_id).ok().or_else(|| {
        warn!(raw_id = %payload.user_id, "identify called with non-UUID user_id, ignoring");
        None
    });

    let Some(user_id) = user_id else {
        return Json(SignalResponse {
            ok: false,
            session_id: None,
        });
    };

    let session_id_header = extract_header(&headers, "x-session-id");
    let session_id = resolve_session_id(session_id_header.as_deref());

    if let Some(sid) = session_id {
        session::identify_session(&state.pool, sid, user_id).await;
    }

    let referrer: Option<&str> = None;
    session::upsert_user(
        &state.pool,
        user_id,
        &payload.traits,
        referrer,
        None,
        None,
        None,
    )
    .await;

    let ctx = extract_request_ctx(
        &headers,
        &auth,
        &state.server_secret,
        state.anonymize_ip,
        state.geoip.as_ref(),
    );

    let signal = SignalEvent {
        event_type: SignalEventType::Identify,
        event_name: None,
        correlation_id: None,
        session_id,
        visitor_id: Some(ctx.visitor_id),
        user_id: Some(user_id),
        tenant_id: ctx.tenant_id,
        properties: payload.traits,
        page_url: None,
        referrer: None,
        function_name: None,
        function_kind: None,
        duration_ms: None,
        status: None,
        error_message: None,
        error_stack: None,
        error_context: None,
        client_ip: ctx.client_ip,
        country: ctx.country,
        city: ctx.city,
        user_agent: ctx.user_agent,
        device_type: ctx.device_type,
        browser: ctx.browser,
        os: ctx.os,
        utm: None,
        is_bot: ctx.is_bot,
        timestamp: chrono::Utc::now(),
    };
    state.collector.try_send(signal);

    Json(SignalResponse {
        ok: true,
        session_id,
    })
}

/// POST /signal/report -- diagnostic error reports.
///
/// Error reports are never dropped on DNT: users explicitly opted out of
/// *tracking*, not of crash reporting. Without this exception, production
/// crashes from DNT-enabled browsers would be invisible. Reports carry no
/// persistent identifier by default.
pub async fn report_handler(
    State(state): State<Arc<SignalsState>>,
    auth: Option<axum::Extension<AuthContext>>,
    headers: HeaderMap,
    Json(report): Json<DiagnosticReport>,
) -> impl IntoResponse {
    if report.errors.len() > MAX_BATCH_SIZE {
        return Json(SignalResponse {
            ok: false,
            session_id: None,
        });
    }

    let ctx = extract_request_ctx(
        &headers,
        &auth,
        &state.server_secret,
        state.anonymize_ip,
        state.geoip.as_ref(),
    );
    let session_id_header = extract_header(&headers, "x-session-id");
    let session_id = resolve_session_id(session_id_header.as_deref());

    if let Some(sid) = session_id {
        session::upsert_session(
            &state.pool,
            Some(sid),
            &ctx.visitor_id,
            ctx.user_id,
            ctx.tenant_id,
            None,
            None,
            ctx.user_agent.as_deref(),
            ctx.client_ip.as_deref(),
            ctx.is_bot,
            "error",
            ctx.device_type.as_deref(),
            ctx.browser.as_deref(),
            ctx.os.as_deref(),
        )
        .await;
    }

    for err in report.errors {
        let signal = SignalEvent {
            event_type: SignalEventType::Error,
            event_name: Some(err.message.clone()),
            correlation_id: err.correlation_id,
            session_id,
            visitor_id: Some(ctx.visitor_id.clone()),
            user_id: ctx.user_id,
            tenant_id: ctx.tenant_id,
            properties: Value::Object(serde_json::Map::new()),
            page_url: err.page_url,
            referrer: None,
            function_name: None,
            function_kind: None,
            duration_ms: None,
            status: None,
            error_message: Some(err.message),
            error_stack: err.stack,
            error_context: err.context,
            client_ip: ctx.client_ip.clone(),
            country: ctx.country.clone(),
            city: ctx.city.clone(),
            user_agent: ctx.user_agent.clone(),
            device_type: ctx.device_type.clone(),
            browser: ctx.browser.clone(),
            os: ctx.os.clone(),
            utm: None,
            is_bot: ctx.is_bot,
            timestamp: chrono::Utc::now(),
        };
        state.collector.try_send(signal);
    }

    Json(SignalResponse {
        ok: true,
        session_id,
    })
}

/// POST /signal/vital -- Web Vitals + browser performance metrics.
///
/// Accepts a batch of named measurements (lcp, cls, inp, fcp, ttfb,
/// navigation, long_task, resource, etc.). Each is stored as a `web_vital`
/// event so dashboards can slice by metric name and aggregate p75/p95.
pub async fn vital_handler(
    State(state): State<Arc<SignalsState>>,
    auth: Option<axum::Extension<AuthContext>>,
    headers: HeaderMap,
    Json(batch): Json<WebVitalBatch>,
) -> impl IntoResponse {
    if dnt_opted_out(&headers) {
        return Json(SignalResponse {
            ok: true,
            session_id: None,
        });
    }
    if batch.vitals.len() > MAX_BATCH_SIZE {
        return Json(SignalResponse {
            ok: false,
            session_id: None,
        });
    }

    let ctx = extract_request_ctx(
        &headers,
        &auth,
        &state.server_secret,
        state.anonymize_ip,
        state.geoip.as_ref(),
    );
    let session_id =
        resolve_session_id(batch.context.as_ref().and_then(|c| c.session_id.as_deref()));
    let page_url = batch.context.as_ref().and_then(|c| c.page_url.clone());

    let session_id = session::upsert_session(
        &state.pool,
        session_id,
        &ctx.visitor_id,
        ctx.user_id,
        ctx.tenant_id,
        page_url.as_deref(),
        batch.context.as_ref().and_then(|c| c.referrer.as_deref()),
        ctx.user_agent.as_deref(),
        ctx.client_ip.as_deref(),
        ctx.is_bot,
        "web_vital",
        ctx.device_type.as_deref(),
        ctx.browser.as_deref(),
        ctx.os.as_deref(),
    )
    .await;

    for vital in batch.vitals {
        // Duration for timing vitals is encoded into duration_ms; for unitless
        // metrics like CLS we keep the raw value in properties.
        let duration_ms =
            if vital.value.is_finite() && vital.value >= 0.0 && vital.value <= i32::MAX as f64 {
                Some(vital.value.round() as i32)
            } else {
                None
            };
        let mut props = serde_json::Map::new();
        props.insert(
            "value".to_string(),
            serde_json::Number::from_f64(vital.value)
                .map(serde_json::Value::Number)
                .unwrap_or(serde_json::Value::Null),
        );
        if let Some(r) = vital.rating.clone() {
            props.insert("rating".to_string(), serde_json::Value::String(r));
        }
        if !vital.attribution.is_null() {
            props.insert("attribution".to_string(), vital.attribution);
        }

        let signal = SignalEvent {
            event_type: SignalEventType::WebVital,
            event_name: Some(vital.name),
            correlation_id: vital.correlation_id,
            session_id,
            visitor_id: Some(ctx.visitor_id.clone()),
            user_id: ctx.user_id,
            tenant_id: ctx.tenant_id,
            properties: serde_json::Value::Object(props),
            page_url: vital.page_url.or_else(|| page_url.clone()),
            referrer: None,
            function_name: None,
            function_kind: None,
            duration_ms,
            status: vital.rating,
            error_message: None,
            error_stack: None,
            error_context: None,
            client_ip: ctx.client_ip.clone(),
            country: ctx.country.clone(),
            city: ctx.city.clone(),
            user_agent: ctx.user_agent.clone(),
            device_type: ctx.device_type.clone(),
            browser: ctx.browser.clone(),
            os: ctx.os.clone(),
            utm: None,
            is_bot: ctx.is_bot,
            timestamp: vital.timestamp.unwrap_or_else(chrono::Utc::now),
        };
        state.collector.try_send(signal);
    }

    Json(SignalResponse {
        ok: true,
        session_id,
    })
}

/// Shared request context extracted from headers and auth for all signal endpoints.
struct RequestCtx {
    user_agent: Option<String>,
    client_ip: Option<String>,
    country: Option<String>,
    city: Option<String>,
    is_bot: bool,
    visitor_id: String,
    user_id: Option<Uuid>,
    tenant_id: Option<Uuid>,
    device_type: Option<String>,
    browser: Option<String>,
    os: Option<String>,
}

fn extract_request_ctx(
    headers: &HeaderMap,
    auth: &Option<axum::Extension<AuthContext>>,
    server_secret: &str,
    anonymize_ip: bool,
    geoip: Option<&super::geoip::GeoIpResolver>,
) -> RequestCtx {
    let user_agent = extract_header(headers, "user-agent");
    let platform_header = extract_header(headers, "x-forge-platform");
    let raw_ip = extract_client_ip(headers);
    let ua_lower = user_agent
        .as_deref()
        .unwrap_or_default()
        .to_ascii_lowercase();
    let is_bot = bot::is_bot_lower(&ua_lower);
    let visitor_id =
        visitor::generate_visitor_id(raw_ip.as_deref(), user_agent.as_deref(), server_secret);
    let user_id = auth.as_ref().and_then(|a| a.user_id());
    let tenant_id = auth.as_ref().and_then(|a| a.tenant_id());
    let device_info = device::parse_lowered(platform_header.as_deref(), &ua_lower);
    let geo = geoip
        .zip(raw_ip.as_deref())
        .map(|(g, ip)| g.lookup(ip))
        .unwrap_or_default();
    // anonymize_ip drops the raw IP after visitor_id + geo are derived; GDPR-friendly default.
    let client_ip = if anonymize_ip { None } else { raw_ip };
    RequestCtx {
        user_agent,
        client_ip,
        country: geo.country,
        city: geo.city,
        is_bot,
        visitor_id,
        user_id,
        tenant_id,
        device_type: device_info.device_type,
        browser: device_info.browser,
        os: device_info.os,
    }
}

fn extract_header(headers: &HeaderMap, name: &str) -> Option<String> {
    crate::gateway::extract_header(headers, name)
}

fn extract_client_ip(headers: &HeaderMap) -> Option<String> {
    crate::gateway::extract_client_ip(headers)
}

fn resolve_session_id(raw: Option<&str>) -> Option<Uuid> {
    raw.and_then(|s| Uuid::parse_str(s).ok())
}

#[cfg(test)]
#[allow(clippy::unwrap_used)]
mod tests {
    use axum::http::{HeaderMap, HeaderValue};
    use uuid::Uuid;

    use super::{extract_client_ip, extract_header, resolve_session_id};

    #[tokio::test]
    async fn extract_header_returns_value() {
        let mut headers = HeaderMap::new();
        headers.insert("x-custom", HeaderValue::from_static("hello"));
        assert_eq!(extract_header(&headers, "x-custom"), Some("hello".into()));
    }

    #[tokio::test]
    async fn extract_header_returns_none_for_missing() {
        let headers = HeaderMap::new();
        assert_eq!(extract_header(&headers, "x-custom"), None);
    }

    #[tokio::test]
    async fn extract_header_returns_none_for_empty_value() {
        let mut headers = HeaderMap::new();
        headers.insert("x-custom", HeaderValue::from_static(""));
        assert_eq!(extract_header(&headers, "x-custom"), None);
    }

    #[tokio::test]
    async fn extract_client_ip_from_forwarded_for_single() {
        let mut headers = HeaderMap::new();
        headers.insert("x-forwarded-for", HeaderValue::from_static("1.2.3.4"));
        assert_eq!(extract_client_ip(&headers), Some("1.2.3.4".into()));
    }

    #[tokio::test]
    async fn extract_client_ip_from_forwarded_for_multiple() {
        let mut headers = HeaderMap::new();
        headers.insert(
            "x-forwarded-for",
            HeaderValue::from_static("1.2.3.4, 5.6.7.8"),
        );
        assert_eq!(extract_client_ip(&headers), Some("1.2.3.4".into()));
    }

    #[tokio::test]
    async fn extract_client_ip_falls_back_to_real_ip() {
        let mut headers = HeaderMap::new();
        headers.insert("x-real-ip", HeaderValue::from_static("9.8.7.6"));
        assert_eq!(extract_client_ip(&headers), Some("9.8.7.6".into()));
    }

    #[tokio::test]
    async fn extract_client_ip_returns_none_when_no_headers() {
        let headers = HeaderMap::new();
        assert_eq!(extract_client_ip(&headers), None);
    }

    #[tokio::test]
    async fn resolve_session_id_parses_valid_uuid() {
        let raw = "550e8400-e29b-41d4-a716-446655440000";
        let expected = Uuid::parse_str(raw).unwrap();
        assert_eq!(resolve_session_id(Some(raw)), Some(expected));
    }

    #[tokio::test]
    async fn resolve_session_id_returns_none_for_garbage() {
        assert_eq!(resolve_session_id(Some("not-a-uuid")), None);
    }

    #[tokio::test]
    async fn resolve_session_id_returns_none_for_none() {
        assert_eq!(resolve_session_id(None), None);
    }
}