Skip to main content

forge_core/webhook/
context.rs

1use std::collections::HashMap;
2use std::sync::Arc;
3use std::time::Duration;
4
5use uuid::Uuid;
6
7use crate::env::{EnvAccess, EnvProvider, RealEnvProvider};
8use crate::function::JobDispatch;
9use crate::http::CircuitBreakerClient;
10
11/// Context available to webhook handlers.
12pub struct WebhookContext {
13    /// Webhook name.
14    pub webhook_name: String,
15    /// Unique request ID for this webhook invocation.
16    pub request_id: String,
17    /// Idempotency key if extracted from request.
18    pub idempotency_key: Option<String>,
19    /// Request headers (lowercase keys).
20    headers: HashMap<String, String>,
21    /// Database pool.
22    db_pool: sqlx::PgPool,
23    /// HTTP client for external calls.
24    http_client: CircuitBreakerClient,
25    /// Default timeout for outbound HTTP requests made through the
26    /// circuit-breaker client. `None` means unlimited.
27    http_timeout: Option<Duration>,
28    /// Job dispatcher for async processing.
29    job_dispatch: Option<Arc<dyn JobDispatch>>,
30    /// Environment variable provider.
31    env_provider: Arc<dyn EnvProvider>,
32}
33
34impl WebhookContext {
35    /// Create a new webhook context.
36    pub fn new(
37        webhook_name: String,
38        request_id: String,
39        headers: HashMap<String, String>,
40        db_pool: sqlx::PgPool,
41        http_client: CircuitBreakerClient,
42    ) -> Self {
43        Self {
44            webhook_name,
45            request_id,
46            idempotency_key: None,
47            headers,
48            db_pool,
49            http_client,
50            http_timeout: None,
51            job_dispatch: None,
52            env_provider: Arc::new(RealEnvProvider::new()),
53        }
54    }
55
56    /// Set idempotency key.
57    pub fn with_idempotency_key(mut self, key: Option<String>) -> Self {
58        self.idempotency_key = key;
59        self
60    }
61
62    /// Set job dispatcher.
63    pub fn with_job_dispatch(mut self, dispatcher: Arc<dyn JobDispatch>) -> Self {
64        self.job_dispatch = Some(dispatcher);
65        self
66    }
67
68    /// Set environment provider.
69    pub fn with_env_provider(mut self, provider: Arc<dyn EnvProvider>) -> Self {
70        self.env_provider = provider;
71        self
72    }
73
74    /// Get database pool.
75    pub fn db(&self) -> crate::function::ForgeDb {
76        crate::function::ForgeDb::from_pool(&self.db_pool)
77    }
78
79    /// Acquire a connection compatible with sqlx compile-time checked macros.
80    pub async fn conn(&self) -> sqlx::Result<crate::function::ForgeConn<'static>> {
81        Ok(crate::function::ForgeConn::Pool(
82            self.db_pool.acquire().await?,
83        ))
84    }
85
86    /// Get the HTTP client for external requests.
87    pub fn http(&self) -> crate::http::HttpClient {
88        self.http_client.with_timeout(self.http_timeout)
89    }
90
91    /// Get the raw reqwest client, bypassing circuit breaker execution.
92    pub fn raw_http(&self) -> &reqwest::Client {
93        self.http_client.inner()
94    }
95
96    pub fn set_http_timeout(&mut self, timeout: Option<Duration>) {
97        self.http_timeout = timeout;
98    }
99
100    /// Get a request header value.
101    ///
102    /// Header names are case-insensitive.
103    pub fn header(&self, name: &str) -> Option<&str> {
104        self.headers.get(&name.to_lowercase()).map(|s| s.as_str())
105    }
106
107    /// Get all headers.
108    pub fn headers(&self) -> &HashMap<String, String> {
109        &self.headers
110    }
111
112    /// Dispatch a background job for async processing.
113    ///
114    /// This is the recommended way to handle webhook events:
115    /// 1. Validate the webhook signature
116    /// 2. Dispatch a job to process the event
117    /// 3. Return 202 Accepted immediately
118    ///
119    /// # Arguments
120    /// * `job_type` - The registered name of the job type
121    /// * `args` - The arguments for the job (will be serialized to JSON)
122    ///
123    /// # Returns
124    /// The UUID of the dispatched job, or an error if dispatch is not available.
125    pub async fn dispatch_job<T: serde::Serialize>(
126        &self,
127        job_type: &str,
128        args: T,
129    ) -> crate::error::Result<Uuid> {
130        let dispatcher = self.job_dispatch.as_ref().ok_or_else(|| {
131            crate::error::ForgeError::Internal("Job dispatch not available".into())
132        })?;
133        let args_json = serde_json::to_value(args)?;
134        dispatcher.dispatch_by_name(job_type, args_json, None).await
135    }
136
137    /// Request cancellation for a job.
138    pub async fn cancel_job(
139        &self,
140        job_id: Uuid,
141        reason: Option<String>,
142    ) -> crate::error::Result<bool> {
143        let dispatcher = self.job_dispatch.as_ref().ok_or_else(|| {
144            crate::error::ForgeError::Internal("Job dispatch not available".into())
145        })?;
146        dispatcher.cancel(job_id, reason).await
147    }
148}
149
150impl EnvAccess for WebhookContext {
151    fn env_provider(&self) -> &dyn EnvProvider {
152        self.env_provider.as_ref()
153    }
154}
155
156#[cfg(test)]
157#[allow(clippy::unwrap_used, clippy::indexing_slicing)]
158mod tests {
159    use super::*;
160
161    #[tokio::test]
162    async fn test_webhook_context_creation() {
163        let pool = sqlx::postgres::PgPoolOptions::new()
164            .max_connections(1)
165            .connect_lazy("postgres://localhost/nonexistent")
166            .expect("Failed to create mock pool");
167
168        let mut headers = HashMap::new();
169        headers.insert("x-github-event".to_string(), "push".to_string());
170        headers.insert("x-github-delivery".to_string(), "abc-123".to_string());
171
172        let ctx = WebhookContext::new(
173            "github_webhook".to_string(),
174            "req-123".to_string(),
175            headers,
176            pool,
177            CircuitBreakerClient::with_defaults(reqwest::Client::new()),
178        )
179        .with_idempotency_key(Some("abc-123".to_string()));
180
181        assert_eq!(ctx.webhook_name, "github_webhook");
182        assert_eq!(ctx.request_id, "req-123");
183        assert_eq!(ctx.idempotency_key, Some("abc-123".to_string()));
184        assert_eq!(ctx.header("X-GitHub-Event"), Some("push"));
185        assert_eq!(ctx.header("x-github-event"), Some("push")); // case-insensitive
186        assert!(ctx.header("nonexistent").is_none());
187    }
188}