|
| 1 | +//! Tester-cookie endpoint helpers. |
| 2 | +//! |
| 3 | +//! The tester route is intentionally disabled unless configured. When enabled, |
| 4 | +//! it sets a first-party `ts-tester=true` cookie scoped to the configured |
| 5 | +//! publisher cookie domain. |
| 6 | +
|
| 7 | +use edgezero_core::body::Body as EdgeBody; |
| 8 | +use error_stack::{Report, ResultExt}; |
| 9 | +use http::{header, HeaderValue, Response, StatusCode}; |
| 10 | + |
| 11 | +use crate::constants::COOKIE_TS_TESTER; |
| 12 | +use crate::error::TrustedServerError; |
| 13 | +use crate::settings::Settings; |
| 14 | + |
| 15 | +/// Formats the tester cookie `Set-Cookie` header value. |
| 16 | +fn format_tester_cookie(domain: &str) -> String { |
| 17 | + format!( |
| 18 | + "{}=true; Domain={}; Path=/; Secure; SameSite=Lax", |
| 19 | + COOKIE_TS_TESTER, domain, |
| 20 | + ) |
| 21 | +} |
| 22 | + |
| 23 | +/// Handles `GET /_ts/set-tester`. |
| 24 | +/// |
| 25 | +/// Returns `404 Not Found` while `[tester_cookie].enabled` is false. When the |
| 26 | +/// feature is enabled, returns `204 No Content` with `Set-Cookie: ts-tester=true` |
| 27 | +/// scoped to `publisher.cookie_domain`. |
| 28 | +/// |
| 29 | +/// # Errors |
| 30 | +/// |
| 31 | +/// Returns [`TrustedServerError::InvalidHeaderValue`] if the configured cookie |
| 32 | +/// domain cannot be rendered as an HTTP header value. |
| 33 | +pub fn handle_set_tester( |
| 34 | + settings: &Settings, |
| 35 | +) -> Result<Response<EdgeBody>, Report<TrustedServerError>> { |
| 36 | + if !settings.tester_cookie.enabled { |
| 37 | + let mut response = Response::new(EdgeBody::empty()); |
| 38 | + *response.status_mut() = StatusCode::NOT_FOUND; |
| 39 | + return Ok(response); |
| 40 | + } |
| 41 | + |
| 42 | + let set_cookie = |
| 43 | + HeaderValue::from_str(&format_tester_cookie(&settings.publisher.cookie_domain)) |
| 44 | + .change_context(TrustedServerError::InvalidHeaderValue { |
| 45 | + message: "tester cookie contains invalid header value".to_string(), |
| 46 | + })?; |
| 47 | + |
| 48 | + let mut response = Response::new(EdgeBody::empty()); |
| 49 | + *response.status_mut() = StatusCode::NO_CONTENT; |
| 50 | + response.headers_mut().insert( |
| 51 | + header::CACHE_CONTROL, |
| 52 | + HeaderValue::from_static("no-store, private"), |
| 53 | + ); |
| 54 | + response |
| 55 | + .headers_mut() |
| 56 | + .insert(header::SET_COOKIE, set_cookie); |
| 57 | + Ok(response) |
| 58 | +} |
| 59 | + |
| 60 | +#[cfg(test)] |
| 61 | +mod tests { |
| 62 | + use super::*; |
| 63 | + use crate::test_support::tests::create_test_settings; |
| 64 | + |
| 65 | + #[test] |
| 66 | + fn tester_cookie_uses_configured_cookie_domain() { |
| 67 | + let mut settings = create_test_settings(); |
| 68 | + settings.tester_cookie.enabled = true; |
| 69 | + settings.publisher.cookie_domain = ".tester.example".to_string(); |
| 70 | + |
| 71 | + let response = handle_set_tester(&settings).expect("should build tester response"); |
| 72 | + |
| 73 | + assert_eq!( |
| 74 | + response.status(), |
| 75 | + StatusCode::NO_CONTENT, |
| 76 | + "enabled tester route should return no content" |
| 77 | + ); |
| 78 | + assert_eq!( |
| 79 | + response |
| 80 | + .headers() |
| 81 | + .get(header::CACHE_CONTROL) |
| 82 | + .and_then(|value| value.to_str().ok()), |
| 83 | + Some("no-store, private"), |
| 84 | + "tester route should not be cacheable" |
| 85 | + ); |
| 86 | + let set_cookie = response |
| 87 | + .headers() |
| 88 | + .get(header::SET_COOKIE) |
| 89 | + .expect("should set tester cookie") |
| 90 | + .to_str() |
| 91 | + .expect("should render set-cookie as utf-8"); |
| 92 | + assert_eq!( |
| 93 | + set_cookie, "ts-tester=true; Domain=.tester.example; Path=/; Secure; SameSite=Lax", |
| 94 | + "tester cookie should use publisher.cookie_domain" |
| 95 | + ); |
| 96 | + } |
| 97 | + |
| 98 | + #[test] |
| 99 | + fn tester_cookie_route_is_disabled_by_default() { |
| 100 | + let settings = create_test_settings(); |
| 101 | + |
| 102 | + let response = handle_set_tester(&settings).expect("should build disabled tester response"); |
| 103 | + |
| 104 | + assert_eq!( |
| 105 | + response.status(), |
| 106 | + StatusCode::NOT_FOUND, |
| 107 | + "disabled tester route should return not found" |
| 108 | + ); |
| 109 | + assert!( |
| 110 | + response.headers().get(header::SET_COOKIE).is_none(), |
| 111 | + "disabled tester route should not set a cookie" |
| 112 | + ); |
| 113 | + } |
| 114 | +} |
0 commit comments