OXYGENHUB
# b1860d6090ec oxygenhub / crates / hub / src / hooks.rs
15.1 KiB · Rust · last changed Carry events between the hub's processes on an event bus 16 days ago source blame history raw
1
//! Webhooks (hub spec §12.2): queueing an event for every hook that wants
2
//! it, signing and delivering with retries, and the payload envelope.
3
4
use crate::db::{self, hooks as hdb};
5
use crate::Shared;
6
use hub_api::WebhookEnvelope;
7
8
/// Queue `event` for the hooks of a repository (and its organisation).
9
pub async fn emit(app: &Shared, repo: &db::repos::RepoRow, event: &str, actor: &str, data: serde_json::Value) {
10
    // Live pages hear of it whether or not any hook does (oxygenhub#203).
11
    app.bus.hook(repo.id, event, &data);
12
    // A check on a state may let a proposal set to land when its checks
13
    // pass land now (#261): every check is announced here.
14
    if event == "check" {
15
        if let Some(state) = data["check"]["state"].as_str() {
16
            let (app, repo, state) = (app.clone(), repo.clone(), state.to_string());
17
            tokio::spawn(crate::autoland::on_check_task(app, repo, state));
18
        }
19
    }
20
    let hooks = match hdb::hooks_hearing(&app.db, repo.id, &repo.owner).await {
21
        Ok(h) => h,
22
        Err(e) => {
23
            tracing::warn!("hooks: {e}");
24
            return;
25
        }
26
    };
27
    if hooks.is_empty() {
28
        return;
29
    }
30
    let repository = hub_api::Repository {
31
        owner: repo.owner.clone(),
32
        name: repo.name.clone(),
33
        description: repo.description.clone(),
34
        default_bookmark: repo.default_bookmark.clone(),
35
        visibility: repo.visibility(),
36
        created_ms: repo.created_ms,
37
        updated_ms: repo.updated_ms,
38
        clone_url: format!("{}/{}", app.config.base_url(), repo.slug()),
39
    };
40
    for h in hooks.into_iter().filter(|h| h.wants(event)) {
41
        let delivery = crate::auth::random_hex(16);
42
        let envelope = WebhookEnvelope {
43
            event: event.into(),
44
            delivery: delivery.clone(),
45
            repository: Some(repository.clone()),
46
            actor: actor.into(),
47
            at_ms: db::now_ms(),
48
            data: data.clone(),
49
        };
50
        let payload = serde_json::to_string(&envelope).unwrap_or_default();
51
        match hdb::queue_delivery(&app.db, h.id, &delivery, event, &payload).await {
52
            Ok(Some(_)) => {}
53
            Ok(None) => tracing::warn!("webhook {} has {} deliveries waiting: {event} not queued", h.id, hdb::MAX_WAITING),
54
            Err(e) => tracing::warn!("queueing delivery: {e}"),
55
        }
56
    }
57
    app.bus.delivery_waiting();
58
}
59
60
/// What a chat message says about an event: a title, the page it links
61
/// to (absolute) and a short detail.
62
pub fn summary(env: &WebhookEnvelope, base: &str) -> (String, String, String) {
63
    let repo = env.repository.as_ref().map(|r| format!("{}/{}", r.owner, r.name)).unwrap_or_default();
64
    let page = |path: &str| format!("{}/{repo}{path}", base.trim_end_matches('/'));
65
    let d = &env.data;
66
    let text = |v: &serde_json::Value| v.as_str().unwrap_or("").to_string();
67
    let num = |v: &serde_json::Value| v.as_i64().unwrap_or(0);
68
    let actor = if env.actor.is_empty() { "Someone".to_string() } else { env.actor.clone() };
69
    let issue_n = if d["issue"]["number"].is_i64() { num(&d["issue"]["number"]) } else { num(&d["number"]) };
70
    let issue_title = text(&d["issue"]["title"]);
71
    match env.event.as_str() {
72
        "ping" => (
73
            "OxygenHub is connected".into(),
74
            if repo.is_empty() { base.to_string() } else { page("") },
75
            "Events from OxygenHub will arrive here.".into(),
76
        ),
77
        "push" => {
78
            let lines: Vec<String> = d["updates"]
79
                .as_array()
80
                .map(|u| {
81
                    u.iter()
82
                        .map(|x| {
83
                            let n = num(&x["changes"]);
84
                            format!("{}: {n} change{}", text(&x["reference"]), if n == 1 { "" } else { "s" })
85
                        })
86
                        .collect()
87
                })
88
                .unwrap_or_default();
89
            let first = d["updates"][0]["reference"].as_str().unwrap_or("").to_string();
90
            (format!("{actor} pushed to {repo}"), page(&format!("/changes/{first}")), lines.join("\n"))
91
        }
92
        "issue.opened" => {
93
            (format!("{actor} opened issue #{issue_n}: {issue_title}"), page(&format!("/issue/{issue_n}")), text(&d["issue"]["body"]))
94
        }
95
        "issue.closed" | "issue.reopened" | "issue.edited" => {
96
            let verb = env.event.trim_start_matches("issue.");
97
            (format!("{actor} {verb} issue #{issue_n}: {issue_title}"), page(&format!("/issue/{issue_n}")), String::new())
98
        }
99
        "comment.issue" => {
100
            let body = if d["comment"]["body"].is_string() { text(&d["comment"]["body"]) } else { String::new() };
101
            (
102
                format!(
103
                    "{actor} commented on issue #{issue_n}{}",
104
                    if issue_title.is_empty() { String::new() } else { format!(": {issue_title}") }
105
                ),
106
                page(&format!("/issue/{issue_n}")),
107
                body,
108
            )
109
        }
110
        "review" => (
111
            format!("{actor} reviewed proposal #{}: {}", num(&d["number"]), text(&d["verdict"])),
112
            page(&format!("/proposal/{}", num(&d["number"]))),
113
            String::new(),
114
        ),
115
        "release.published" => (
116
            format!("{actor} released {} ({})", text(&d["title"]), text(&d["tag"])),
117
            page(&format!("/releases/tag/{}", text(&d["tag"]))),
118
            String::new(),
119
        ),
120
        "check" => (
121
            format!("Check {} {} on {repo}", text(&d["check"]["name"]), text(&d["check"]["status"])),
122
            text(&d["check"]["url"]).chars().take(500).collect::<String>().replace(' ', "%20"),
123
            text(&d["check"]["summary"]),
124
        ),
125
        e if e.starts_with("proposal.") => {
126
            let n = num(&d["number"]);
127
            let verb = e.trim_start_matches("proposal.");
128
            let title = text(&d["title"]);
129
            (
130
                format!("{actor} {verb} proposal #{n}{}", if title.is_empty() { String::new() } else { format!(": {title}") }),
131
                page(&format!("/proposal/{n}")),
132
                String::new(),
133
            )
134
        }
135
        e => (format!("{e} on {repo}"), page(""), String::new()),
136
    }
137
}
138
139
fn cut(s: &str, max: usize) -> String {
140
    if s.chars().count() <= max {
141
        s.to_string()
142
    } else {
143
        format!("{}…", s.chars().take(max.saturating_sub(1)).collect::<String>())
144
    }
145
}
146
147
/// The body a hook receives in its format; the envelope itself for `oxygenhub`.
148
pub fn body_for(format: &str, payload: &str, base: &str) -> String {
149
    let Ok(env) = serde_json::from_str::<WebhookEnvelope>(payload) else { return payload.to_string() };
150
    let (title, url, detail) = summary(&env, base);
151
    let repo = env.repository.as_ref().map(|r| format!("{}/{}", r.owner, r.name)).unwrap_or_else(|| "OxygenHub".into());
152
    match format {
153
        "discord" => {
154
            let mut embed = serde_json::json!({
155
                "title": cut(&title, 256),
156
                "description": cut(&detail, 2000),
157
                "color": 0x0064e0,
158
                "footer": { "text": cut(&format!("{repo} · {}", env.event), 200) },
159
                "timestamp": crate::render::time::rfc3339(env.at_ms as u64),
160
            });
161
            if url.starts_with("http") {
162
                embed["url"] = serde_json::Value::String(url);
163
            }
164
            // No @everyone, @here or role pings from anything a user typed.
165
            serde_json::json!({ "username": "OxygenHub", "allowed_mentions": { "parse": [] }, "embeds": [embed] }).to_string()
166
        }
167
        "slack" => {
168
            let esc = |s: &str| s.replace('&', "&amp;").replace('<', "&lt;").replace('>', "&gt;");
169
            let head = if url.starts_with("http") { format!("<{}|{}>", url, esc(&title)) } else { esc(&title) };
170
            let text = if detail.is_empty() { head } else { format!("{head}\n>{}", esc(&cut(&detail, 1500)).replace('\n', "\n>")) };
171
            serde_json::json!({ "text": text }).to_string()
172
        }
173
        _ => payload.to_string(),
174
    }
175
}
176
177
/// `X-Oxyhub-Signature` for a body: keyed BLAKE3 with the hook's secret.
178
pub fn signature(secret: &str, body: &[u8]) -> String {
179
    let key = blake3::hash(secret.as_bytes());
180
    format!("blake3-keyed={}", hex::encode(blake3::keyed_hash(key.as_bytes(), body).as_bytes()))
181
}
182
183
/// Deliver everything that is due; returns how many were attempted.
184
pub async fn deliver_due(app: &Shared) -> usize {
185
    let due = match hdb::due_deliveries(&app.db, 50).await {
186
        Ok(d) => d,
187
        Err(_) => return 0,
188
    };
189
    let mut n = 0;
190
    for d in due {
191
        let Ok(Some(hook)) = hdb::hook(&app.db, d.hook_id).await else { continue };
192
        n += 1;
193
        // Only public addresses, pinned, no redirects (#219).
194
        let client = match crate::net::client(&hook.url, &app.config.outbound.allow, std::time::Duration::from_secs(20)).await {
195
            Ok(c) => c,
196
            Err(why) => {
197
                hdb::record_attempt(&app.db, d.id, d.attempts, None, &format!("not sent: {why}")).await.ok();
198
                continue;
199
            }
200
        };
201
        let body = body_for(&hook.format, &d.payload, app.config.base_url());
202
        let (status, response) = match client
203
            .post(&hook.url)
204
            .header("content-type", "application/json")
205
            .header("x-oxyhub-event", &d.event)
206
            .header("x-oxyhub-delivery", &d.delivery)
207
            .header("x-oxyhub-signature", signature(&hook.secret, body.as_bytes()))
208
            .body(body)
209
            .send()
210
            .await
211
        {
212
            Ok(r) => {
213
                let status = r.status().as_u16() as i64;
214
                (Some(status), capped_text(r, RESPONSE_LIMIT).await)
215
            }
216
            Err(e) => (None, e.to_string()),
217
        };
218
        hdb::record_attempt(&app.db, d.id, d.attempts, status, &response).await.ok();
219
    }
220
    n
221
}
222
223
/// How much of a webhook's response is read (#220): enough to show why a
224
/// delivery failed, never so much that an endpoint can fill memory.
225
const RESPONSE_LIMIT: usize = 64 * 1024;
226
227
/// A response's body as text, read in chunks and stopped at `limit` bytes.
228
async fn capped_text(mut r: reqwest::Response, limit: usize) -> String {
229
    let mut body = Vec::new();
230
    while let Ok(Some(chunk)) = r.chunk().await {
231
        let room = limit - body.len();
232
        body.extend_from_slice(&chunk[..chunk.len().min(room)]);
233
        if body.len() >= limit {
234
            break;
235
        }
236
    }
237
    String::from_utf8_lossy(&body).into_owned()
238
}
239
240
/// The background worker: delivers when nudged and every minute anyway.
241
pub async fn worker(app: Shared) {
242
    let mut rx = app.bus.subscribe(crate::bus::Topic::Deliveries);
243
    loop {
244
        deliver_due(&app).await;
245
        let cutoff = db::now_ms() - app.config.retention.webhook_log_days as i64 * 86_400_000;
246
        hdb::prune_deliveries(&app.db, cutoff).await.ok();
247
        tokio::select! {
248
            _ = rx.recv() => {}
249
            _ = tokio::time::sleep(std::time::Duration::from_secs(60)) => {}
250
        }
251
    }
252
}
253
254
#[cfg(test)]
255
mod tests {
256
    use super::*;
257
258
    #[tokio::test]
259
    async fn a_response_is_read_only_up_to_the_limit() {
260
        // #220: an endpoint answering 100 KiB is read to 64 KiB, no further.
261
        let big = reqwest::Response::from(axum::http::Response::new("x".repeat(100 * 1024)));
262
        assert_eq!(capped_text(big, RESPONSE_LIMIT).await.len(), RESPONSE_LIMIT);
263
        let small = reqwest::Response::from(axum::http::Response::new("ok".to_string()));
264
        assert_eq!(capped_text(small, RESPONSE_LIMIT).await, "ok");
265
    }
266
267
    fn envelope(event: &str, data: serde_json::Value) -> String {
268
        serde_json::to_string(&WebhookEnvelope {
269
            event: event.into(),
270
            delivery: "d".into(),
271
            repository: Some(hub_api::Repository {
272
                owner: "andymccall".into(),
273
                name: "oxygen".into(),
274
                description: String::new(),
275
                default_bookmark: "main".into(),
276
                visibility: hub_api::Visibility::Public,
277
                created_ms: 0,
278
                updated_ms: 0,
279
                clone_url: String::new(),
280
            }),
281
            actor: "andy".into(),
282
            at_ms: 1_790_000_000_000,
283
            data,
284
        })
285
        .unwrap()
286
    }
287
288
    #[test]
289
    fn discord_gets_an_embed_without_mentions() {
290
        let p = envelope(
291
            "issue.opened",
292
            serde_json::json!({ "issue": { "number": 12, "title": "@everyone crash", "body": "x".repeat(3000) } }),
293
        );
294
        let v: serde_json::Value = serde_json::from_str(&body_for("discord", &p, "https://hub.example:7343/")).unwrap();
295
        let e = &v["embeds"][0];
296
        assert_eq!(e["title"], "andy opened issue #12: @everyone crash");
297
        assert_eq!(e["url"], "https://hub.example:7343/andymccall/oxygen/issue/12");
298
        assert_eq!(e["description"].as_str().unwrap().chars().count(), 2000, "cut to Discord's limits");
299
        assert_eq!(v["allowed_mentions"]["parse"], serde_json::json!([]), "no pings from user text");
300
        assert_eq!(v["username"], "OxygenHub");
301
        let push = envelope("push", serde_json::json!({ "updates": [{ "reference": "main", "changes": 3 }] }));
302
        let v: serde_json::Value = serde_json::from_str(&body_for("discord", &push, "https://h")).unwrap();
303
        assert_eq!(v["embeds"][0]["title"], "andy pushed to andymccall/oxygen");
304
        assert_eq!(v["embeds"][0]["description"], "main: 3 changes");
305
        assert_eq!(v["embeds"][0]["url"], "https://h/andymccall/oxygen/changes/main");
306
        let ping = envelope("ping", serde_json::json!({}));
307
        assert!(body_for("discord", &ping, "https://h").contains("OxygenHub is connected"));
308
    }
309
310
    #[test]
311
    fn slack_text_is_escaped_and_the_envelope_is_unchanged() {
312
        let p = envelope(
313
            "comment.issue",
314
            serde_json::json!({ "number": 3, "issue": { "number": 3, "title": "<b>" }, "comment": { "body": "a & b" } }),
315
        );
316
        let v: serde_json::Value = serde_json::from_str(&body_for("slack", &p, "https://h")).unwrap();
317
        assert_eq!(v["text"], "<https://h/andymccall/oxygen/issue/3|andy commented on issue #3: &lt;b&gt;>\n>a &amp; b");
318
        assert_eq!(body_for("oxygenhub", &p, "https://h"), p);
319
    }
320
321
    #[test]
322
    fn formats_follow_the_url_and_urls_are_masked() {
323
        use crate::db::hooks::{format_for_url, masked_url};
324
        assert_eq!(format_for_url("https://discord.com/api/webhooks/155/abc"), "discord");
325
        assert_eq!(format_for_url("https://hooks.slack.com/services/T/B/x"), "slack");
326
        assert_eq!(format_for_url("https://discord.com.evil.example/api/webhooks/1"), "oxygenhub");
327
        assert_eq!(format_for_url("https://ci.example/hook"), "oxygenhub");
328
        let m = masked_url("https://discord.com/api/webhooks/1554146511347126332/6g_WnXRdNOiVoo8sGXXW_OuIUceluD8lIUckxb9KHPwZ895XE");
329
        assert_eq!(m, "https://discord.com/api/webhooks/1554…/6g_W…");
330
        assert!(!m.contains("6g_WnX"), "the token is not shown");
331
        assert_eq!(masked_url("https://ci.example/hook?token=secret"), "https://ci.example/hook?…");
332
    }
333
334
    #[test]
335
    fn signatures_are_keyed() {
336
        let a = signature("s1", b"body");
337
        assert!(a.starts_with("blake3-keyed="));
338
        assert_ne!(a, signature("s2", b"body"));
339
        assert_ne!(a, signature("s1", b"other"));
340
    }
341
}