OXYGENHUB
# 25ab8c73514a oxygenhub / crates / hub / src / web / proposals.rs
42.7 KiB · Rust · last changed Milestone 0.5: API, webhooks, checks 1 month ago source blame history raw
1
//! Proposal pages (hub spec §7): list, new, detail with conversation,
2
//! changes and files, comments anchored to atoms, reviews, landing.
3
4
use super::history::{render_files, FileRows};
5
use super::settings::{csrf, require};
6
use super::{filters, lookup, lookup_role, Error, Page, RepoShell, Shell};
7
use crate::auth::{Access, Role, Viewer};
8
use crate::db::{self, accounts, proposals as pdb};
9
use crate::render::{self, diff};
10
use crate::repos::proposals::{self as pl, Projection, Source};
11
use crate::repos::view::{self, ChangeView, ConflictView};
12
use crate::repos::RepoName;
13
use crate::Shared;
14
use askama::Template;
15
use axum::extract::{Form, Path, Query, State};
16
use axum::response::{IntoResponse, Redirect, Response};
17
use hub_api::{Approval, ProposalSource, ProposalState};
18
use oxy_core::hash::ChangeHash;
19
use serde::Deserialize;
20
use std::collections::{BTreeMap, HashMap};
21
22
// ------------------------------------------------------------------ list
23
24
#[derive(Template)]
25
#[template(path = "proposals.html")]
26
pub struct ProposalsPage {
27
    shell: Shell,
28
    repo: RepoShell,
29
    rows: Vec<pdb::ProposalRow>,
30
    filter: String,
31
    counts: (usize, usize, usize),
32
    bookmarks: Vec<String>,
33
}
34
35
#[derive(Deserialize)]
36
pub struct ListQuery {
37
    state: Option<String>,
38
}
39
40
pub async fn list(
41
    State(app): State<Shared>,
42
    viewer: Viewer,
43
    Path((owner, name)): Path<(String, String)>,
44
    Query(q): Query<ListQuery>,
45
) -> Result<Page<ProposalsPage>, Error> {
46
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposals"), &viewer);
47
    let (repo, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
48
    let all = pdb::list(&app.db, row.id, &[]).await.map_err(|e| Error::from_db(shell.clone(), e))?;
49
    let counts = (
50
        all.iter().filter(|p| p.is_open()).count(),
51
        all.iter().filter(|p| p.state == "landed").count(),
52
        all.iter().filter(|p| p.state == "closed").count(),
53
    );
54
    let filter = q.state.unwrap_or_else(|| "open".into());
55
    let rows = all
56
        .into_iter()
57
        .filter(|p| match filter.as_str() {
58
            "open" => p.is_open(),
59
            "landed" => p.state == "landed",
60
            "closed" => p.state == "closed",
61
            _ => true,
62
        })
63
        .collect();
64
    let bookmarks = app
65
        .repos
66
        .read(&repo, |r, _| Ok(r.bookmarks()?.into_iter().map(|b| b.name).collect::<Vec<_>>()))
67
        .await
68
        .map_err(|e| Error::from_repo(shell.clone(), e))?;
69
    Ok(Page(ProposalsPage { shell, repo: RepoShell::new(&app, &row, "proposals").with_role(role), rows, filter, counts, bookmarks }))
70
}
71
72
// ------------------------------------------------------------------- new
73
74
#[derive(Template)]
75
#[template(path = "proposal_new.html")]
76
pub struct NewProposalPage {
77
    shell: Shell,
78
    repo: RepoShell,
79
    bookmarks: Vec<String>,
80
    source: String,
81
    target: String,
82
    error: Option<String>,
83
    /// Preview: the changes the proposal would add.
84
    preview: Vec<ChangeView>,
85
    conflicted: bool,
86
}
87
88
#[derive(Deserialize)]
89
pub struct NewQuery {
90
    source: Option<String>,
91
    target: Option<String>,
92
}
93
94
/// `owner/name:bookmark` for a fork, else a bookmark of this repository.
95
fn parse_source(app: &Shared, repo: &RepoName, source: &str) -> Option<(Option<RepoName>, String)> {
96
    if let Some((slug, bookmark)) = source.split_once(':') {
97
        let fork = RepoName::parse(slug)?;
98
        if !app.repos.exists(&fork) || fork == *repo {
99
            return None;
100
        }
101
        return Some((Some(fork), bookmark.to_string()));
102
    }
103
    crate::repos::names::valid_segment(source).then(|| (None, source.to_string()))
104
}
105
106
async fn preview_for(
107
    app: &Shared,
108
    repo: &RepoName,
109
    target: &str,
110
    source: &str,
111
) -> Result<(Vec<ChangeView>, bool), crate::repos::RepoError> {
112
    let Some((fork, bookmark)) = parse_source(app, repo, source) else { return Ok((vec![], false)) };
113
    let target = target.to_string();
114
    let fork_dir = fork.as_ref().map(|f| app.repos.dir(f));
115
    app.repos
116
        .read(repo, move |r, cache| {
117
            let projection = match &fork_dir {
118
                Some(dir) => {
119
                    let fork_repo = oxy_core::repo::Repo::open(dir)?;
120
                    let heads = fork_repo.bookmarks()?.into_iter().find(|b| b.name == bookmark).map(|b| b.heads).unwrap_or_default();
121
                    pl::project(r, cache, &target, Source::Fork { fork: &fork_repo, heads })?
122
                }
123
                None => {
124
                    let heads = r.bookmarks()?.into_iter().find(|b| b.name == bookmark).map(|b| b.heads).unwrap_or_default();
125
                    pl::project(r, cache, &target, Source::Bookmark(heads))?
126
                }
127
            };
128
            Ok((projection.changes, projection.conflicted))
129
        })
130
        .await
131
}
132
133
pub async fn new_form(
134
    State(app): State<Shared>,
135
    viewer: Viewer,
136
    Path((owner, name)): Path<(String, String)>,
137
    Query(q): Query<NewQuery>,
138
) -> Result<Page<NewProposalPage>, Error> {
139
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposals/new"), &viewer);
140
    require(&viewer, &shell)?;
141
    let (repo, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
142
    let bookmarks = app
143
        .repos
144
        .read(&repo, |r, _| Ok(r.bookmarks()?.into_iter().map(|b| b.name).collect::<Vec<_>>()))
145
        .await
146
        .map_err(|e| Error::from_repo(shell.clone(), e))?;
147
    let target = q.target.unwrap_or_else(|| row.default_bookmark.clone());
148
    let source = q.source.unwrap_or_default();
149
    let (preview, conflicted) =
150
        if source.is_empty() { (vec![], false) } else { preview_for(&app, &repo, &target, &source).await.unwrap_or((vec![], false)) };
151
    Ok(Page(NewProposalPage {
152
        shell,
153
        repo: RepoShell::new(&app, &row, "proposals").with_role(role),
154
        bookmarks,
155
        source,
156
        target,
157
        error: None,
158
        preview,
159
        conflicted,
160
    }))
161
}
162
163
#[derive(Deserialize)]
164
pub struct NewForm {
165
    #[serde(rename = "_csrf")]
166
    csrf_token: String,
167
    title: String,
168
    #[serde(default)]
169
    body: String,
170
    target: String,
171
    source: String,
172
    #[serde(default)]
173
    draft: Option<String>,
174
}
175
176
/// Open a proposal from a form or the API: validate, create, index, notify.
177
#[allow(clippy::too_many_arguments)]
178
pub async fn open_proposal(
179
    app: &Shared,
180
    repo: &RepoName,
181
    row: &db::repos::RepoRow,
182
    me: &accounts::Account,
183
    title: &str,
184
    body: &str,
185
    target: &str,
186
    source: &str,
187
    draft: bool,
188
) -> Result<pdb::ProposalRow, String> {
189
    if title.trim().is_empty() {
190
        return Err("Give the proposal a title.".into());
191
    }
192
    let bookmarks =
193
        app.repos.read(repo, |r, _| Ok(r.bookmarks()?.into_iter().map(|b| b.name).collect::<Vec<_>>())).await.map_err(|e| e.to_string())?;
194
    if !bookmarks.iter().any(|b| b == target) {
195
        return Err("Pick a target bookmark of this repository.".into());
196
    }
197
    let Some((fork, bookmark)) = parse_source(app, repo, source.trim()) else {
198
        return Err("The source is a bookmark of this repository, or owner/name:bookmark of a fork.".into());
199
    };
200
    if fork.is_none() && bookmark == target {
201
        return Err("The source and the target are the same bookmark.".into());
202
    }
203
    let (preview, _) = preview_for(app, repo, target, source.trim()).await.map_err(|e| e.to_string())?;
204
    if preview.is_empty() {
205
        return Err("The source adds nothing to the target.".into());
206
    }
207
    let source_repo_id = match &fork {
208
        Some(fk) => db::repos::get(&app.db, &fk.owner, &fk.name).await.map_err(|e| e.to_string())?.map(|r| r.id),
209
        None => None,
210
    };
211
    let created = pdb::create(
212
        &app.db,
213
        pdb::NewProposal {
214
            repo_id: row.id,
215
            title: title.trim(),
216
            body: body.trim(),
217
            author_id: Some(me.id),
218
            author: &me.username,
219
            draft,
220
            target,
221
            source_kind: if fork.is_some() { "fork" } else { "bookmark" },
222
            source_repo_id,
223
            source_bookmark: &bookmark,
224
            source_changes: "",
225
        },
226
    )
227
    .await
228
    .map_err(|e| e.to_string())?;
229
    pdb::add_event(&app.db, created.id, &me.username, "opened", "").await.ok();
230
    accounts::audit(&app.db, Some(me), "proposal.opened", &format!("{}#{}", row.slug(), created.number), title).await.ok();
231
    db::notify::index(&app.db, "proposal", row.id, created.id, created.number, &created.title, &created.body).await.ok();
232
    let url = format!("/{}/proposal/{}", row.slug(), created.number);
233
    crate::notify::deliver(
234
        app,
235
        crate::notify::Event {
236
            kind: "proposal.opened",
237
            title: format!("{}#{}: {}", row.slug(), created.number, created.title),
238
            url,
239
            actor: me,
240
            repo_id: row.id,
241
            thread: Some(("proposal", created.id)),
242
            mention_text: body,
243
            direct: vec![],
244
        },
245
    )
246
    .await;
247
    crate::hooks::emit(
248
        app,
249
        row,
250
        "proposal.opened",
251
        &me.username,
252
        serde_json::json!({ "number": created.number, "title": created.title, "target": target, "source": source }),
253
    )
254
    .await;
255
    Ok(created)
256
}
257
258
pub async fn create(
259
    State(app): State<Shared>,
260
    viewer: Viewer,
261
    Path((owner, name)): Path<(String, String)>,
262
    Form(f): Form<NewForm>,
263
) -> Result<Response, Error> {
264
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposals/new"), &viewer);
265
    let me = require(&viewer, &shell)?;
266
    csrf(&viewer, &f.csrf_token, &shell)?;
267
    let (repo, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
268
    match open_proposal(&app, &repo, &row, &me.account, &f.title, &f.body, &f.target, &f.source, f.draft.is_some()).await {
269
        Ok(created) => Ok(Redirect::to(&format!("/{owner}/{name}/proposal/{}", created.number)).into_response()),
270
        Err(msg) => {
271
            let bookmarks =
272
                app.repos.read(&repo, |r, _| Ok(r.bookmarks()?.into_iter().map(|b| b.name).collect::<Vec<_>>())).await.unwrap_or_default();
273
            Ok(Page(NewProposalPage {
274
                shell,
275
                repo: RepoShell::new(&app, &row, "proposals").with_role(role),
276
                bookmarks,
277
                source: f.source.clone(),
278
                target: f.target.clone(),
279
                error: Some(msg),
280
                preview: vec![],
281
                conflicted: false,
282
            })
283
            .into_response())
284
        }
285
    }
286
}
287
288
// ---------------------------------------------------------------- detail
289
290
/// A comment placed on a diff row, or general.
291
pub struct CommentView {
292
    pub row: pdb::CommentRow,
293
    pub body_html: String,
294
    pub line: Option<usize>,
295
}
296
297
pub struct ReviewView {
298
    pub row: pdb::ReviewRow,
299
    pub body_html: String,
300
    pub sealed: bool,
301
}
302
303
/// Everything the detail page and the API need, computed once under the lock.
304
pub struct Loaded {
305
    pub row: pdb::ProposalRow,
306
    pub changes: Vec<ChangeView>,
307
    pub hashes: Vec<ChangeHash>,
308
    pub heads: Vec<ChangeHash>,
309
    pub state: String,
310
    pub target_state: String,
311
    pub conflicted: bool,
312
    pub conflicts: Vec<ConflictView>,
313
    pub files: Vec<FileRows>,
314
    /// Atom per (path, new line number) of the projected state.
315
    pub atoms: HashMap<(String, usize), (String, u32)>,
316
    pub sealing_keys: Vec<String>,
317
    pub touched: Vec<String>,
318
    pub owners: Vec<String>,
319
    pub landed_already: bool,
320
}
321
322
/// Compute the projection and everything derived from it.
323
pub async fn load(app: &Shared, repo: &RepoName, row: pdb::ProposalRow) -> Result<Loaded, crate::repos::RepoError> {
324
    let fork_dir = match (row.source_kind.as_str(), row.source_repo_id) {
325
        ("fork", Some(id)) => {
326
            db::repos::get_by_id(&app.db, id).await.ok().flatten().and_then(|r| RepoName::new(&r.owner, &r.name)).map(|n| app.repos.dir(&n))
327
        }
328
        _ => None,
329
    };
330
    let r2 = row.clone();
331
    let loaded = app
332
        .repos
333
        .read(repo, move |r, cache| {
334
            let source = match (r2.source_kind.as_str(), &fork_dir) {
335
                ("changes", _) => Source::Changes(r2.source_changes().iter().filter_map(|h| ChangeHash::from_hex(h)).collect()),
336
                ("fork", Some(dir)) => {
337
                    let fork_repo = oxy_core::repo::Repo::open(dir)?;
338
                    let heads =
339
                        fork_repo.bookmarks()?.into_iter().find(|b| b.name == r2.source_bookmark).map(|b| b.heads).unwrap_or_default();
340
                    // Bring the fork's changes over now, so the projection below can read them.
341
                    let fork_state = fork_repo.load_state(&heads)?;
342
                    let missing: Vec<ChangeHash> = fork_state.changes().map(|(h, _)| *h).filter(|h| !r.store().has(h)).collect();
343
                    if !missing.is_empty() {
344
                        r.import_bundle(&fork_repo.bundle_for(&missing)?, r.current_policy()?.is_some())?;
345
                    }
346
                    Source::Changes(heads)
347
                }
348
                _ => {
349
                    let heads = r.bookmarks()?.into_iter().find(|b| b.name == r2.source_bookmark).map(|b| b.heads).unwrap_or_default();
350
                    Source::Bookmark(heads)
351
                }
352
            };
353
            let p: Projection = pl::project(r, cache, &r2.target, source)?;
354
            let target_loaded = cache.load(r, &p.target_heads)?;
355
            let files = render_files(&p.files, &p.bases);
356
            let mut atoms = HashMap::new();
357
            for f in &files {
358
                for l in &f.lines {
359
                    if let Some(n) = l.new_no {
360
                        if let Some((h, i)) = pl::atom_at(&p.loaded, &f.path, n as usize) {
361
                            atoms.insert((f.path.clone(), n as usize), (h.to_hex(), i));
362
                        }
363
                    }
364
                }
365
            }
366
            let touched: Vec<String> = p.files.iter().map(|f| f.path.clone()).collect();
367
            let owners = pl::owners_for(&target_loaded, &touched);
368
            let sealing = pl::sealing_keys(r, &p.hashes)?.into_iter().map(|k| k.to_hex()).collect();
369
            let landed_already = !p.hashes.is_empty() && p.hashes.iter().all(|h| target_loaded.state.contains(h));
370
            Ok(Loaded {
371
                row: r2,
372
                changes: p.changes,
373
                hashes: p.hashes,
374
                heads: p.heads,
375
                state: p.state.to_hex(),
376
                target_state: p.target_state.to_hex(),
377
                conflicted: p.conflicted,
378
                conflicts: p.conflicts,
379
                files,
380
                atoms,
381
                sealing_keys: sealing,
382
                touched,
383
                owners,
384
                landed_already,
385
            })
386
        })
387
        .await?;
388
    // Remember the projection for the list, the API and other proposals' stacking checks.
389
    let heads_csv = loaded.heads.iter().map(|h| h.to_hex()).collect::<Vec<_>>().join(",");
390
    let changes_csv = loaded.hashes.iter().map(|h| h.to_hex()).collect::<Vec<_>>().join(",");
391
    pdb::set_projection(&app.db, loaded.row.id, &loaded.state, &heads_csv, &loaded.target_state, &changes_csv, loaded.conflicted)
392
        .await
393
        .ok();
394
    Ok(loaded)
395
}
396
397
/// Reviews, approvals and blockers.
398
pub struct Verdict {
399
    pub reviews: Vec<ReviewView>,
400
    pub approvals: Vec<Approval>,
401
    pub blockers: Vec<String>,
402
    pub depends_on: Vec<i64>,
403
    pub requirements: pdb::Requirements,
404
}
405
406
pub async fn verdict(app: &Shared, loaded: &Loaded, repo_id: i64) -> Result<Verdict, sqlx::Error> {
407
    let rows = pdb::reviews(&app.db, loaded.row.id).await?;
408
    let links = accounts::identity_accounts(&app.db).await?;
409
    let sealed_accounts: Vec<String> = links.iter().filter(|(k, _)| loaded.sealing_keys.contains(k)).map(|(_, u)| u.clone()).collect();
410
    // Latest verdict per reviewer.
411
    let mut latest: BTreeMap<String, &pdb::ReviewRow> = BTreeMap::new();
412
    for r in &rows {
413
        latest.insert(r.author.clone(), r);
414
    }
415
    let mut approvals = Vec::new();
416
    for (who, r) in &latest {
417
        if r.verdict == "approve" {
418
            let sealed = sealed_accounts.contains(who);
419
            let key = links.iter().find(|(k, u)| u == who && loaded.sealing_keys.contains(k)).map(|(k, _)| k.clone());
420
            approvals.push(Approval { account: who.clone(), sealed, key });
421
        }
422
    }
423
    let reviews = rows
424
        .iter()
425
        .map(|r| ReviewView {
426
            row: r.clone(),
427
            body_html: render::markdown::render(&r.body, "/", "/"),
428
            sealed: r.verdict == "approve" && sealed_accounts.contains(&r.author),
429
        })
430
        .collect();
431
    let requirements = pdb::requirements(&app.db, repo_id).await?;
432
    let mut blockers = Vec::new();
433
    if loaded.row.state == "draft" {
434
        blockers.push("the proposal is a draft".into());
435
    }
436
    if loaded.hashes.is_empty() {
437
        blockers.push("the proposal adds no changes".into());
438
    }
439
    let sealed_count = approvals.iter().filter(|a| a.sealed).count() as i64;
440
    if sealed_count < requirements.required_approvals {
441
        blockers.push(format!("{sealed_count} of {} required sealed approvals", requirements.required_approvals));
442
    }
443
    if requirements.require_owners {
444
        let missing: Vec<&String> = loaded.owners.iter().filter(|o| !approvals.iter().any(|a| a.sealed && &a.account == *o)).collect();
445
        if !missing.is_empty() {
446
            blockers.push(format!("code owners still to approve: {}", missing.iter().map(|s| s.as_str()).collect::<Vec<_>>().join(", ")));
447
        }
448
    }
449
    if loaded.conflicted && !requirements.allow_conflicts {
450
        blockers.push("landing would carry conflicts, which this repository refuses".into());
451
    }
452
    let required = db::hooks::required_checks(&app.db, repo_id).await?;
453
    if !required.is_empty() {
454
        let checks = db::hooks::checks_for_state(&app.db, repo_id, &loaded.state).await?;
455
        let missing: Vec<String> =
456
            required.iter().filter(|n| !checks.iter().any(|c| &c.name == *n && c.status == "passed")).cloned().collect();
457
        if !missing.is_empty() {
458
            blockers.push(format!("required checks not passed on the projected state: {}", missing.join(", ")));
459
        }
460
    }
461
    let requesting: Vec<&String> = latest.iter().filter(|(_, r)| r.verdict == "changes").map(|(who, _)| who).collect();
462
    if !requesting.is_empty() {
463
        blockers.push(format!("changes requested by {}", requesting.iter().map(|s| s.as_str()).collect::<Vec<_>>().join(", ")));
464
    }
465
    // Stacking: another open, earlier proposal whose changes this one includes.
466
    let mut depends_on = Vec::new();
467
    for other in pdb::list(&app.db, repo_id, &["open", "draft"]).await? {
468
        if other.id == loaded.row.id || other.number > loaded.row.number {
469
            continue;
470
        }
471
        let theirs = other.projected_changes();
472
        if !theirs.is_empty() && theirs.iter().all(|h| loaded.hashes.iter().any(|m| m.to_hex() == *h)) {
473
            depends_on.push(other.number);
474
        }
475
    }
476
    if !depends_on.is_empty() {
477
        blockers.push(format!("depends on {}", depends_on.iter().map(|n| format!("#{n}")).collect::<Vec<_>>().join(", ")));
478
    }
479
    Ok(Verdict { reviews, approvals, blockers, depends_on, requirements })
480
}
481
482
#[derive(Template)]
483
#[template(path = "proposal.html")]
484
pub struct ProposalPage {
485
    shell: Shell,
486
    repo: RepoShell,
487
    p: pdb::ProposalRow,
488
    body_html: String,
489
    tab: String,
490
    changes: Vec<ChangeView>,
491
    files: Vec<FileRows>,
492
    conflicts: Vec<ConflictView>,
493
    conflicted: bool,
494
    comments: Vec<CommentView>,
495
    /// Anchored comments by (path, current line).
496
    placed: HashMap<(String, usize), Vec<usize>>,
497
    outdated: Vec<usize>,
498
    reviews: Vec<ReviewView>,
499
    approvals: Vec<Approval>,
500
    blockers: Vec<String>,
501
    depends_on: Vec<i64>,
502
    events: Vec<pdb::EventRow>,
503
    owners: Vec<String>,
504
    requirements: pdb::Requirements,
505
    landed_already: bool,
506
    can_edit: bool,
507
    can_land: bool,
508
    hub_can_land: bool,
509
    notice: Option<String>,
510
    error: Option<String>,
511
    heads: Vec<String>,
512
    state_hash: String,
513
    source_label: String,
514
    api_url: String,
515
    labels: Vec<db::issues::Label>,
516
    all_labels: Vec<db::issues::Label>,
517
    checks: Vec<db::hooks::Check>,
518
    required_checks: Vec<String>,
519
}
520
521
#[derive(Deserialize)]
522
pub struct DetailQuery {
523
    tab: Option<String>,
524
}
525
526
/// The page assembler every action ends in; its arguments are the route
527
/// plus what to say, and a struct would only rename them.
528
#[allow(clippy::too_many_arguments)]
529
async fn detail(
530
    app: &Shared,
531
    shell: Shell,
532
    viewer: &Viewer,
533
    owner: &str,
534
    name: &str,
535
    number: i64,
536
    tab: String,
537
    notice: Option<String>,
538
    error: Option<String>,
539
) -> Result<Page<ProposalPage>, Error> {
540
    let (repo, row, role) = lookup(app, &shell, viewer, owner, name).await?;
541
    let p = pdb::get(&app.db, row.id, number)
542
        .await
543
        .map_err(|e| Error::from_db(shell.clone(), e))?
544
        .ok_or_else(|| Error::not_found(shell.clone()))?;
545
    let loaded = load(app, &repo, p).await.map_err(|e| Error::from_repo(shell.clone(), e))?;
546
    // A proposal whose changes all reached the target landed by another route.
547
    if loaded.landed_already && loaded.row.is_open() {
548
        pdb::set_state(&app.db, loaded.row.id, "landed", &loaded.target_state).await.ok();
549
        pdb::add_event(&app.db, loaded.row.id, "", "landed", "every change reached the target").await.ok();
550
    }
551
    let p = pdb::get(&app.db, row.id, number).await.map_err(|e| Error::from_db(shell.clone(), e))?.unwrap_or(loaded.row.clone());
552
    let v = verdict(app, &loaded, row.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
553
    let comment_rows = pdb::comments(&app.db, loaded.row.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
554
    let events = pdb::events(&app.db, loaded.row.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
555
    // Place anchored comments at their atom's current line.
556
    let mut by_atom: HashMap<(String, String, u32), usize> = HashMap::new();
557
    for ((path, line), (h, i)) in &loaded.atoms {
558
        by_atom.insert((path.clone(), h.clone(), *i), *line);
559
    }
560
    let mut comments = Vec::new();
561
    let mut placed: HashMap<(String, usize), Vec<usize>> = HashMap::new();
562
    let mut outdated = Vec::new();
563
    for (idx, c) in comment_rows.into_iter().enumerate() {
564
        let line = if c.anchor_change.is_empty() {
565
            None
566
        } else {
567
            by_atom.get(&(c.path.clone(), c.anchor_change.clone(), c.anchor_index as u32)).copied()
568
        };
569
        if !c.anchor_change.is_empty() {
570
            match line {
571
                Some(l) => placed.entry((c.path.clone(), l)).or_default().push(idx),
572
                None => outdated.push(idx),
573
            }
574
        }
575
        comments.push(CommentView { body_html: render::markdown::render(&c.body, "/", "/"), row: c, line });
576
    }
577
    let mut changes = loaded.changes.clone();
578
    super::attribute(app, &mut changes.iter_mut().collect::<Vec<_>>()).await;
579
    let me = viewer.account();
580
    let can_edit = me.is_some_and(|a| Some(a.id) == p.author_id || role >= Role::Maintain);
581
    let can_land = role >= Role::Write && p.is_open() && v.blockers.is_empty();
582
    let hub_can_land = app.repos.read(&repo, |r, _| Ok(r.current_policy()?.is_none())).await.unwrap_or(false);
583
    let source_label = match p.source_kind.as_str() {
584
        "fork" => format!(
585
            "fork {}",
586
            db::repos::get_by_id(&app.db, p.source_repo_id.unwrap_or(0))
587
                .await
588
                .ok()
589
                .flatten()
590
                .map(|r| format!("{}:{}", r.slug(), p.source_bookmark))
591
                .unwrap_or_default()
592
        ),
593
        "changes" => format!("{} changes", p.source_changes().len()),
594
        _ => p.source_bookmark.clone(),
595
    };
596
    Ok(Page(ProposalPage {
597
        shell,
598
        repo: RepoShell::new(app, &row, "proposals").with_role(role),
599
        body_html: super::issues::markdown(app, row.id, &format!("/{owner}/{name}"), &p.body).await,
600
        p,
601
        tab,
602
        changes,
603
        files: loaded.files,
604
        conflicts: loaded.conflicts,
605
        conflicted: loaded.conflicted,
606
        comments,
607
        placed,
608
        outdated,
609
        reviews: v.reviews,
610
        approvals: v.approvals,
611
        blockers: v.blockers,
612
        depends_on: v.depends_on,
613
        events,
614
        owners: loaded.owners,
615
        requirements: v.requirements,
616
        landed_already: loaded.landed_already,
617
        can_edit,
618
        can_land,
619
        hub_can_land,
620
        notice,
621
        error,
622
        heads: loaded.heads.iter().map(|h| h.to_hex()).collect(),
623
        state_hash: loaded.state.clone(),
624
        source_label,
625
        api_url: format!("{}/api/v1/repos/{owner}/{name}/proposals/{number}", app.config.base_url()),
626
        labels: db::issues::proposal_labels(&app.db, loaded.row.id).await.unwrap_or_default(),
627
        all_labels: db::issues::labels(&app.db, row.id).await.unwrap_or_default(),
628
        checks: db::hooks::checks_for_state(&app.db, row.id, &loaded.state).await.unwrap_or_default(),
629
        required_checks: db::hooks::required_checks(&app.db, row.id).await.unwrap_or_default(),
630
    }))
631
}
632
633
pub async fn show(
634
    State(app): State<Shared>,
635
    viewer: Viewer,
636
    Path((owner, name, number)): Path<(String, String, i64)>,
637
    Query(q): Query<DetailQuery>,
638
) -> Result<Page<ProposalPage>, Error> {
639
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
640
    detail(&app, shell, &viewer, &owner, &name, number, q.tab.unwrap_or_else(|| "conversation".into()), None, None).await
641
}
642
643
// ---------------------------------------------------------------- actions
644
645
#[derive(Deserialize)]
646
pub struct CommentForm {
647
    #[serde(rename = "_csrf")]
648
    csrf_token: String,
649
    body: String,
650
    #[serde(default)]
651
    path: String,
652
    #[serde(default)]
653
    line: Option<usize>,
654
}
655
656
pub async fn comment(
657
    State(app): State<Shared>,
658
    viewer: Viewer,
659
    Path((owner, name, number)): Path<(String, String, i64)>,
660
    Form(f): Form<CommentForm>,
661
) -> Result<Page<ProposalPage>, Error> {
662
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
663
    let me = require(&viewer, &shell)?;
664
    csrf(&viewer, &f.csrf_token, &shell)?;
665
    let (repo, row, _) = lookup(&app, &shell, &viewer, &owner, &name).await?;
666
    let p = pdb::get(&app.db, row.id, number)
667
        .await
668
        .map_err(|e| Error::from_db(shell.clone(), e))?
669
        .ok_or_else(|| Error::not_found(shell.clone()))?;
670
    if f.body.trim().is_empty() {
671
        return detail(
672
            &app,
673
            shell,
674
            &viewer,
675
            &owner,
676
            &name,
677
            number,
678
            "conversation".into(),
679
            None,
680
            Some("An empty comment says nothing.".into()),
681
        )
682
        .await;
683
    }
684
    let anchor = match (f.path.trim(), f.line) {
685
        ("", _) | (_, None) => None,
686
        (path, Some(line)) => {
687
            let loaded = load(&app, &repo, p.clone()).await.map_err(|e| Error::from_repo(shell.clone(), e))?;
688
            loaded.atoms.get(&(path.to_string(), line)).cloned()
689
        }
690
    };
691
    let tab = if anchor.is_some() { "files" } else { "conversation" };
692
    pdb::add_comment(
693
        &app.db,
694
        p.id,
695
        Some(me.account.id),
696
        &me.account.username,
697
        f.body.trim(),
698
        f.path.trim(),
699
        anchor.as_ref().map(|(h, i)| (h.as_str(), *i as i64)),
700
    )
701
    .await
702
    .map_err(|e| Error::from_db(shell.clone(), e))?;
703
    detail(&app, shell, &viewer, &owner, &name, number, tab.into(), None, None).await
704
}
705
706
#[derive(Deserialize)]
707
pub struct ReviewForm {
708
    #[serde(rename = "_csrf")]
709
    csrf_token: String,
710
    verdict: String,
711
    #[serde(default)]
712
    body: String,
713
}
714
715
pub async fn review(
716
    State(app): State<Shared>,
717
    viewer: Viewer,
718
    Path((owner, name, number)): Path<(String, String, i64)>,
719
    Form(f): Form<ReviewForm>,
720
) -> Result<Page<ProposalPage>, Error> {
721
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
722
    let me = require(&viewer, &shell)?;
723
    csrf(&viewer, &f.csrf_token, &shell)?;
724
    let (_, row, _) = lookup(&app, &shell, &viewer, &owner, &name).await?;
725
    let p = pdb::get(&app.db, row.id, number)
726
        .await
727
        .map_err(|e| Error::from_db(shell.clone(), e))?
728
        .ok_or_else(|| Error::not_found(shell.clone()))?;
729
    if !matches!(f.verdict.as_str(), "comment" | "changes" | "approve") {
730
        return Err(Error::bad(shell, "a review is comment, changes or approve"));
731
    }
732
    if f.verdict == "approve" && Some(me.account.id) == p.author_id {
733
        return detail(
734
            &app,
735
            shell,
736
            &viewer,
737
            &owner,
738
            &name,
739
            number,
740
            "conversation".into(),
741
            None,
742
            Some("You cannot approve your own proposal.".into()),
743
        )
744
        .await;
745
    }
746
    pdb::add_review(&app.db, p.id, me.account.id, &me.account.username, &f.verdict, f.body.trim())
747
        .await
748
        .map_err(|e| Error::from_db(shell.clone(), e))?;
749
    pdb::add_event(&app.db, p.id, &me.account.username, &format!("review.{}", f.verdict), "").await.ok();
750
    crate::hooks::emit(&app, &row, "review", &me.account.username, serde_json::json!({ "number": number, "verdict": f.verdict })).await;
751
    let notice = if f.verdict == "approve" {
752
        Some(format!(
753
            "Approval recorded. It counts once you seal the changes: oxy seal --proposal {}/{owner}/{name}/proposal/{number}",
754
            app.config.base_url()
755
        ))
756
    } else {
757
        None
758
    };
759
    detail(&app, shell, &viewer, &owner, &name, number, "conversation".into(), notice, None).await
760
}
761
762
#[derive(Deserialize)]
763
pub struct EditForm {
764
    #[serde(rename = "_csrf")]
765
    csrf_token: String,
766
    title: String,
767
    #[serde(default)]
768
    body: String,
769
    target: String,
770
}
771
772
pub async fn edit(
773
    State(app): State<Shared>,
774
    viewer: Viewer,
775
    Path((owner, name, number)): Path<(String, String, i64)>,
776
    Form(f): Form<EditForm>,
777
) -> Result<Page<ProposalPage>, Error> {
778
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
779
    let me = require(&viewer, &shell)?;
780
    csrf(&viewer, &f.csrf_token, &shell)?;
781
    let (_, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
782
    let p = pdb::get(&app.db, row.id, number)
783
        .await
784
        .map_err(|e| Error::from_db(shell.clone(), e))?
785
        .ok_or_else(|| Error::not_found(shell.clone()))?;
786
    if Some(me.account.id) != p.author_id && role < Role::Maintain {
787
        return Err(Error::not_found(shell));
788
    }
789
    let target = if crate::repos::names::valid_segment(f.target.trim()) { f.target.trim() } else { &p.target };
790
    pdb::edit(&app.db, p.id, f.title.trim(), f.body.trim(), target).await.map_err(|e| Error::from_db(shell.clone(), e))?;
791
    pdb::add_event(&app.db, p.id, &me.account.username, "edited", "").await.ok();
792
    detail(&app, shell, &viewer, &owner, &name, number, "conversation".into(), Some("Saved.".into()), None).await
793
}
794
795
#[derive(Deserialize)]
796
pub struct StateForm {
797
    #[serde(rename = "_csrf")]
798
    csrf_token: String,
799
    action: String,
800
}
801
802
pub async fn state(
803
    State(app): State<Shared>,
804
    viewer: Viewer,
805
    Path((owner, name, number)): Path<(String, String, i64)>,
806
    Form(f): Form<StateForm>,
807
) -> Result<Page<ProposalPage>, Error> {
808
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
809
    let me = require(&viewer, &shell)?;
810
    csrf(&viewer, &f.csrf_token, &shell)?;
811
    let (_, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
812
    let p = pdb::get(&app.db, row.id, number)
813
        .await
814
        .map_err(|e| Error::from_db(shell.clone(), e))?
815
        .ok_or_else(|| Error::not_found(shell.clone()))?;
816
    if Some(me.account.id) != p.author_id && role < Role::Triage {
817
        return Err(Error::not_found(shell));
818
    }
819
    let new_state = match (f.action.as_str(), p.state.as_str()) {
820
        ("close", "open" | "draft") => "closed",
821
        ("reopen", "closed") => "open",
822
        ("ready", "draft") => "open",
823
        ("draft", "open") => "draft",
824
        _ => return Err(Error::bad(shell, "that transition is not possible")),
825
    };
826
    pdb::set_state(&app.db, p.id, new_state, "").await.map_err(|e| Error::from_db(shell.clone(), e))?;
827
    pdb::add_event(&app.db, p.id, &me.account.username, new_state, "").await.ok();
828
    crate::hooks::emit(&app, &row, &format!("proposal.{new_state}"), &me.account.username, serde_json::json!({ "number": number })).await;
829
    detail(&app, shell, &viewer, &owner, &name, number, "conversation".into(), None, None).await
830
}
831
832
pub async fn resolve_comment(
833
    State(app): State<Shared>,
834
    viewer: Viewer,
835
    Path((owner, name, number, id)): Path<(String, String, i64, i64)>,
836
    Form(f): Form<super::session::CsrfForm>,
837
) -> Result<Page<ProposalPage>, Error> {
838
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
839
    require(&viewer, &shell)?;
840
    csrf(&viewer, &f.csrf, &shell)?;
841
    let (_, row, _) = lookup(&app, &shell, &viewer, &owner, &name).await?;
842
    let p = pdb::get(&app.db, row.id, number)
843
        .await
844
        .map_err(|e| Error::from_db(shell.clone(), e))?
845
        .ok_or_else(|| Error::not_found(shell.clone()))?;
846
    let current: Option<bool> = sqlx::query_scalar("SELECT resolved FROM proposal_comments WHERE id = ? AND proposal_id = ?")
847
        .bind(id)
848
        .bind(p.id)
849
        .fetch_optional(&app.db)
850
        .await
851
        .map_err(|e| Error::from_db(shell.clone(), e))?;
852
    if let Some(r) = current {
853
        pdb::set_comment_resolved(&app.db, id, !r).await.map_err(|e| Error::from_db(shell.clone(), e))?;
854
    }
855
    detail(&app, shell, &viewer, &owner, &name, number, "files".into(), None, None).await
856
}
857
858
/// Land from the hub: only when the repository has no trust policy (the
859
/// hub never signs a reference update the policy would have to admit).
860
pub async fn land(
861
    State(app): State<Shared>,
862
    viewer: Viewer,
863
    Path((owner, name, number)): Path<(String, String, i64)>,
864
    Form(f): Form<super::session::CsrfForm>,
865
) -> Result<Page<ProposalPage>, Error> {
866
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
867
    let me = require(&viewer, &shell)?;
868
    csrf(&viewer, &f.csrf, &shell)?;
869
    let (repo, row, _) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Write).await?;
870
    let p = pdb::get(&app.db, row.id, number)
871
        .await
872
        .map_err(|e| Error::from_db(shell.clone(), e))?
873
        .ok_or_else(|| Error::not_found(shell.clone()))?;
874
    let loaded = load(&app, &repo, p.clone()).await.map_err(|e| Error::from_repo(shell.clone(), e))?;
875
    let v = verdict(&app, &loaded, row.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
876
    if !p.is_open() || !v.blockers.is_empty() {
877
        return detail(
878
            &app,
879
            shell,
880
            &viewer,
881
            &owner,
882
            &name,
883
            number,
884
            "conversation".into(),
885
            None,
886
            Some(format!("Cannot land: {}", v.blockers.join("; "))),
887
        )
888
        .await;
889
    }
890
    let target = p.target.clone();
891
    let heads = loaded.heads.clone();
892
    let result = app
893
        .repos
894
        .write(&repo, move |r, _| {
895
            if r.current_policy()?.is_some() {
896
                return Err(crate::repos::RepoError::Oxy(oxy_core::repo::RepoError::Msg(
897
                    "this repository has a trust policy, so a reference update must be signed by an authorised key: land from a client with oxy proposal land".into(),
898
                )));
899
            }
900
            r.bookmark_set(&target, &heads)?;
901
            Ok(pl::state_ref(&heads).to_hex())
902
        })
903
        .await;
904
    match result {
905
        Ok(state) => {
906
            pdb::set_state(&app.db, p.id, "landed", &state).await.map_err(|e| Error::from_db(shell.clone(), e))?;
907
            pdb::add_event(&app.db, p.id, &me.account.username, "landed", "from the hub").await.ok();
908
            crate::hooks::emit(
909
                &app,
910
                &row,
911
                "proposal.landed",
912
                &me.account.username,
913
                serde_json::json!({ "number": number, "target": p.target, "state": state }),
914
            )
915
            .await;
916
            crate::notify::deliver(
917
                &app,
918
                crate::notify::Event {
919
                    kind: "proposal.landed",
920
                    title: format!("{owner}/{name}#{number}: {} landed", p.title),
921
                    url: format!("/{owner}/{name}/proposal/{number}"),
922
                    actor: &me.account,
923
                    repo_id: row.id,
924
                    thread: Some(("proposal", p.id)),
925
                    mention_text: "",
926
                    direct: p.author_id.into_iter().collect(),
927
                },
928
            )
929
            .await;
930
            if p.target == row.default_bookmark {
931
                let messages: Vec<(String, String)> =
932
                    loaded.changes.iter().map(|c| (c.hash.clone(), format!("{}\n{}", c.title, c.body))).collect();
933
                super::issues::close_from_messages(&app, &row, &messages).await;
934
            }
935
            accounts::audit(&app.db, Some(&me.account), "proposal.landed", &format!("{owner}/{name}#{number}"), "").await.ok();
936
            db::repos::record_push(
937
                &app.db,
938
                row.id,
939
                Some((me.account.id, me.account.username.as_str())),
940
                &[db::repos::PushOutcome {
941
                    reference: p.target.clone(),
942
                    ok: true,
943
                    reason: format!("landed #{number}"),
944
                    old_state: loaded.target_state.clone(),
945
                    new_state: state,
946
                    heads: loaded.heads.len() as i64,
947
                    changes: loaded.hashes.len() as i64,
948
                }],
949
            )
950
            .await
951
            .ok();
952
            detail(&app, shell, &viewer, &owner, &name, number, "conversation".into(), Some("Landed.".into()), None).await
953
        }
954
        Err(e) => detail(&app, shell, &viewer, &owner, &name, number, "conversation".into(), None, Some(e.to_string())).await,
955
    }
956
}
957
958
#[derive(Deserialize)]
959
pub struct LabelsForm {
960
    #[serde(rename = "_csrf")]
961
    csrf_token: String,
962
    #[serde(default)]
963
    label: Vec<i64>,
964
}
965
966
pub async fn set_labels(
967
    State(app): State<Shared>,
968
    viewer: Viewer,
969
    Path((owner, name, number)): Path<(String, String, i64)>,
970
    axum_extra::extract::Form(f): axum_extra::extract::Form<LabelsForm>,
971
) -> Result<Page<ProposalPage>, Error> {
972
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
973
    require(&viewer, &shell)?;
974
    csrf(&viewer, &f.csrf_token, &shell)?;
975
    let (_, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
976
    if role < Role::Triage {
977
        return Err(Error::not_found(shell));
978
    }
979
    let p = pdb::get(&app.db, row.id, number)
980
        .await
981
        .map_err(|e| Error::from_db(shell.clone(), e))?
982
        .ok_or_else(|| Error::not_found(shell.clone()))?;
983
    for l in db::issues::labels(&app.db, row.id).await.map_err(|e| Error::from_db(shell.clone(), e))? {
984
        db::issues::set_proposal_label(&app.db, p.id, l.id, f.label.contains(&l.id)).await.map_err(|e| Error::from_db(shell.clone(), e))?;
985
    }
986
    detail(&app, shell, &viewer, &owner, &name, number, "conversation".into(), None, None).await
987
}
988
989
/// `GET /{owner}/{name}/proposal/{number}/events`: server-sent events for
990
/// checks on the projected state (hub spec §13.1).
991
pub async fn events(
992
    State(app): State<Shared>,
993
    viewer: Viewer,
994
    Path((owner, name, number)): Path<(String, String, i64)>,
995
) -> Result<axum::response::Sse<impl futures::Stream<Item = Result<axum::response::sse::Event, std::convert::Infallible>>>, Error> {
996
    use futures::StreamExt;
997
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
998
    let (_, row, _) = lookup(&app, &shell, &viewer, &owner, &name).await?;
999
    let rx = app.events.proposals.subscribe();
1000
    let repo_id = row.id;
1001
    let stream = tokio_stream::wrappers::BroadcastStream::new(rx).filter_map(move |item| async move {
1002
        match item {
1003
            Ok((id, ev)) if id == repo_id => {
1004
                Some(Ok(axum::response::sse::Event::default().event(ev.kind.clone()).data(serde_json::to_string(&ev).unwrap_or_default())))
1005
            }
1006
            _ => None,
1007
        }
1008
    });
1009
    Ok(axum::response::Sse::new(stream).keep_alive(axum::response::sse::KeepAlive::default()))
1010
}
1011
1012
// -------------------------------------------------------------------- API
1013
1014
pub async fn to_api(app: &Shared, owner: &str, name: &str, loaded: &Loaded, v: &Verdict, source_url: Option<String>) -> hub_api::Proposal {
1015
    let p = &loaded.row;
1016
    hub_api::Proposal {
1017
        number: p.number,
1018
        title: p.title.clone(),
1019
        body: p.body.clone(),
1020
        author: p.author.clone(),
1021
        state: ProposalState::parse(&p.state).unwrap_or(ProposalState::Open),
1022
        target: p.target.clone(),
1023
        source: match p.source_kind.as_str() {
1024
            "fork" => {
1025
                let (o, n) = source_url
1026
                    .as_deref()
1027
                    .and_then(|u| u.rsplit_once('/'))
1028
                    .and_then(|(b, n)| b.rsplit_once('/').map(|(_, o)| (o.to_string(), n.to_string())))
1029
                    .unwrap_or_default();
1030
                ProposalSource::Fork { owner: o, name: n, bookmark: p.source_bookmark.clone() }
1031
            }
1032
            "changes" => ProposalSource::Changes { hashes: p.source_changes() },
1033
            _ => ProposalSource::Bookmark { bookmark: p.source_bookmark.clone() },
1034
        },
1035
        changes: loaded
1036
            .changes
1037
            .iter()
1038
            .map(|c| hub_api::ChangeSummary {
1039
                hash: c.hash.clone(),
1040
                message: if c.body.is_empty() { c.title.clone() } else { format!("{}\n\n{}", c.title, c.body) },
1041
                author: hub_api::Author {
1042
                    name: c.author.name.clone(),
1043
                    email: c.author.email.clone(),
1044
                    key: c.author.key.clone(),
1045
                    account: c.author.account.clone(),
1046
                },
1047
                when_ms: c.when_ms,
1048
                deps: c.deps.clone(),
1049
                head: c.head,
1050
                signature: match &c.signature {
1051
                    view::SigView::Unsigned => hub_api::Signature::Unsigned,
1052
                    view::SigView::Valid { key, sealed, revoked, .. } => {
1053
                        hub_api::Signature::Valid { key: key.clone(), sealed: *sealed, revoked: *revoked }
1054
                    }
1055
                    view::SigView::Invalid(why) => hub_api::Signature::Invalid { reason: why.clone() },
1056
                },
1057
            })
1058
            .collect(),
1059
        projected_heads: loaded.heads.iter().map(|h| h.to_hex()).collect(),
1060
        projected_state: Some(loaded.state.clone()),
1061
        conflicted: loaded.conflicted,
1062
        approvals: v.approvals.clone(),
1063
        landable: p.is_open() && v.blockers.is_empty(),
1064
        blockers: v.blockers.clone(),
1065
        created_ms: p.created_ms,
1066
        updated_ms: p.updated_ms,
1067
        url: format!("{}/{owner}/{name}/proposal/{}", app.config.base_url(), p.number),
1068
        repository_url: format!("{}/{owner}/{name}", app.config.base_url()),
1069
        source_url,
1070
    }
1071
}
1072
1073
/// The line comment form's placement key, for templates.
1074
pub fn key(path: &str, line: impl filters::Num) -> (String, usize) {
1075
    (path.to_string(), line.as_u64() as usize)
1076
}
1077
1078
#[allow(dead_code)]
1079
fn _unused(_: &diff::Line, _: &ConflictView, _: &Role) {}