OXYGENHUB
# 2abea30809dd oxygenhub / crates / hub / src / web / proposals.rs
84.0 KiB · Rust · last changed Cancel a landed proposal's runs that have not started 18 days 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
    q: String,
34
    sort: String,
35
    pager: super::Pager,
36
    labels: std::collections::HashMap<i64, Vec<db::issues::Label>>,
37
}
38
39
impl ProposalsPage {
40
    fn labels_of(&self, id: &i64) -> &[db::issues::Label] {
41
        self.labels.get(id).map(Vec::as_slice).unwrap_or(&[])
42
    }
43
}
44
45
#[derive(Deserialize)]
46
pub struct ListQuery {
47
    state: Option<String>,
48
    q: Option<String>,
49
    sort: Option<String>,
50
    page: Option<usize>,
51
}
52
53
/// The list's sort orders.
54
pub const SORTS: &[(&str, &str)] = &[("updated", "recently updated"), ("newest", "newest"), ("oldest", "oldest")];
55
56
pub async fn list(
57
    State(app): State<Shared>,
58
    viewer: Viewer,
59
    Path((owner, name)): Path<(String, String)>,
60
    Query(q): Query<ListQuery>,
61
) -> Result<Page<ProposalsPage>, Error> {
62
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposals"), &viewer);
63
    let (repo, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
64
    let all = pdb::list(&app.db, row.id, &[]).await.map_err(|e| Error::from_db(shell.clone(), e))?;
65
    let counts = (
66
        all.iter().filter(|p| p.is_open()).count(),
67
        all.iter().filter(|p| p.state == "landed").count(),
68
        all.iter().filter(|p| p.state == "closed").count(),
69
    );
70
    let filter = q.state.unwrap_or_else(|| "open".into());
71
    let mut labels: std::collections::HashMap<i64, Vec<db::issues::Label>> = std::collections::HashMap::new();
72
    for (id, l) in db::issues::labels_by_proposal(&app.db, row.id).await.map_err(|e| Error::from_db(shell.clone(), e))? {
73
        labels.entry(id).or_default().push(l);
74
    }
75
    // `author:bob label:ui target:main words…`
76
    let qtext = q.q.clone().unwrap_or_default();
77
    let (mut authors, mut wanted, mut targets, mut words) = (vec![], vec![], vec![], vec![]);
78
    for tok in qtext.split_whitespace() {
79
        match tok.split_once(':') {
80
            Some(("author", v)) => authors.push(v.to_lowercase()),
81
            Some(("label", v)) => wanted.push(v.to_lowercase()),
82
            Some(("target", v)) => targets.push(v.to_string()),
83
            _ => words.push(tok.to_lowercase()),
84
        }
85
    }
86
    let mut rows: Vec<pdb::ProposalRow> = all
87
        .into_iter()
88
        .filter(|p| match filter.as_str() {
89
            "open" => p.is_open(),
90
            "landed" => p.state == "landed",
91
            "closed" => p.state == "closed",
92
            _ => true,
93
        })
94
        .filter(|p| authors.is_empty() || authors.contains(&p.author.to_lowercase()))
95
        .filter(|p| targets.is_empty() || targets.contains(&p.target))
96
        .filter(|p| wanted.iter().all(|w| labels.get(&p.id).is_some_and(|ls| ls.iter().any(|l| l.name.to_lowercase() == *w))))
97
        .filter(|p| words.iter().all(|w| p.title.to_lowercase().contains(w) || p.body.to_lowercase().contains(w)))
98
        .collect();
99
    let sort = q.sort.filter(|s| SORTS.iter().any(|(k, _)| k == s)).unwrap_or_else(|| "updated".into());
100
    match sort.as_str() {
101
        "newest" => rows.sort_by_key(|p| std::cmp::Reverse(p.number)),
102
        "oldest" => rows.sort_by_key(|p| p.number),
103
        _ => rows.sort_by_key(|p| std::cmp::Reverse(p.updated_ms)),
104
    }
105
    let pager = super::Pager::new(rows.len(), q.page, &[("state", &filter), ("q", &qtext), ("sort", &sort)]);
106
    let rows = pager.slice(rows);
107
    let bookmarks = app
108
        .repos
109
        .read(&repo, |r, _| Ok(r.bookmarks()?.into_iter().map(|b| b.name).collect::<Vec<_>>()))
110
        .await
111
        .map_err(|e| Error::from_repo(shell.clone(), e))?;
112
    Ok(Page(ProposalsPage {
113
        shell,
114
        repo: RepoShell::new(&app, &row, "proposals").with_role(role),
115
        rows,
116
        filter,
117
        counts,
118
        bookmarks,
119
        q: qtext,
120
        sort,
121
        pager,
122
        labels,
123
    }))
124
}
125
126
// ------------------------------------------------------------------- new
127
128
#[derive(Template)]
129
#[template(path = "proposal_new.html")]
130
pub struct NewProposalPage {
131
    shell: Shell,
132
    repo: RepoShell,
133
    bookmarks: Vec<String>,
134
    source: String,
135
    target: String,
136
    error: Option<String>,
137
    /// Preview: the changes the proposal would add.
138
    preview: Vec<ChangeView>,
139
    conflicted: bool,
140
    /// What the form holds so far (after a failed open, or a draft).
141
    title: String,
142
    body: String,
143
    /// AI assistants that may draft the description (hub spec §13.4).
144
    assistants: Vec<String>,
145
}
146
147
#[derive(Deserialize)]
148
pub struct NewQuery {
149
    source: Option<String>,
150
    target: Option<String>,
151
}
152
153
/// `owner/name:bookmark` for a fork, else a bookmark of this repository.
154
/// A proposal's source: a bookmark of this repository by name (which may
155
/// hold `/`, as `feature/16-hud` does), or `owner/name:bookmark` of a fork;
156
/// `owner/name:bookmark` naming this repository is its own bookmark.
157
fn parse_source(app: &Shared, repo: &RepoName, source: &str) -> Option<(Option<RepoName>, String)> {
158
    let plain = |b: &str| !b.is_empty() && !b.chars().any(|c| c.is_control() || c == ':');
159
    if let Some((slug, bookmark)) = source.split_once(':') {
160
        let fork = RepoName::parse(slug)?;
161
        if !plain(bookmark) {
162
            return None;
163
        }
164
        if fork == *repo {
165
            return Some((None, bookmark.to_string()));
166
        }
167
        if !app.repos.exists(&fork) {
168
            return None;
169
        }
170
        return Some((Some(fork), bookmark.to_string()));
171
    }
172
    plain(source).then(|| (None, source.to_string()))
173
}
174
175
async fn preview_for(
176
    app: &Shared,
177
    repo: &RepoName,
178
    target: &str,
179
    source: &str,
180
) -> Result<(Vec<ChangeView>, bool), crate::repos::RepoError> {
181
    let Some((fork, bookmark)) = parse_source(app, repo, source) else { return Ok((vec![], false)) };
182
    let target = target.to_string();
183
    let fork_dir = fork.as_ref().map(|f| app.repos.dir(f));
184
    app.repos
185
        .read(repo, move |r, cache| {
186
            let projection = match &fork_dir {
187
                Some(dir) => {
188
                    let fork_repo = oxy_core::repo::Repo::open(dir)?;
189
                    let heads = fork_repo.bookmarks()?.into_iter().find(|b| b.name == bookmark).map(|b| b.heads).unwrap_or_default();
190
                    pl::project(r, cache, &target, Source::Fork { fork: &fork_repo, heads })?
191
                }
192
                None => {
193
                    let heads = r.bookmarks()?.into_iter().find(|b| b.name == bookmark).map(|b| b.heads).unwrap_or_default();
194
                    pl::project(r, cache, &target, Source::Bookmark(heads))?
195
                }
196
            };
197
            Ok((projection.changes, projection.conflicted))
198
        })
199
        .await
200
}
201
202
pub async fn new_form(
203
    State(app): State<Shared>,
204
    viewer: Viewer,
205
    Path((owner, name)): Path<(String, String)>,
206
    Query(q): Query<NewQuery>,
207
) -> Result<Page<NewProposalPage>, Error> {
208
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposals/new"), &viewer);
209
    require(&viewer, &shell)?;
210
    let (repo, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
211
    let bookmarks = app
212
        .repos
213
        .read(&repo, |r, _| Ok(r.bookmarks()?.into_iter().map(|b| b.name).collect::<Vec<_>>()))
214
        .await
215
        .map_err(|e| Error::from_repo(shell.clone(), e))?;
216
    let target = q.target.unwrap_or_else(|| row.default_bookmark.clone());
217
    let source = q.source.unwrap_or_default();
218
    let (preview, conflicted) =
219
        if source.is_empty() { (vec![], false) } else { preview_for(&app, &repo, &target, &source).await.unwrap_or((vec![], false)) };
220
    let assistants = if preview.is_empty() { vec![] } else { assistant_names(&app, &row).await };
221
    Ok(Page(NewProposalPage {
222
        shell,
223
        repo: RepoShell::new(&app, &row, "proposals").with_role(role),
224
        bookmarks,
225
        source,
226
        target,
227
        error: None,
228
        preview,
229
        conflicted,
230
        title: String::new(),
231
        body: String::new(),
232
        assistants,
233
    }))
234
}
235
236
#[derive(Deserialize)]
237
pub struct NewForm {
238
    #[serde(rename = "_csrf")]
239
    csrf_token: String,
240
    title: String,
241
    #[serde(default)]
242
    body: String,
243
    target: String,
244
    source: String,
245
    #[serde(default)]
246
    draft: Option<String>,
247
    /// For `/proposals/new/draft`: which assistant writes the description.
248
    #[serde(default)]
249
    assistant: String,
250
}
251
252
/// Open a proposal from a form or the API: validate, create, index, notify.
253
#[allow(clippy::too_many_arguments)]
254
pub async fn open_proposal(
255
    app: &Shared,
256
    repo: &RepoName,
257
    row: &db::repos::RepoRow,
258
    me: &accounts::Account,
259
    title: &str,
260
    body: &str,
261
    target: &str,
262
    source: &str,
263
    draft: bool,
264
) -> Result<pdb::ProposalRow, String> {
265
    if title.trim().is_empty() {
266
        return Err("Give the proposal a title.".into());
267
    }
268
    let bookmarks =
269
        app.repos.read(repo, |r, _| Ok(r.bookmarks()?.into_iter().map(|b| b.name).collect::<Vec<_>>())).await.map_err(|e| e.to_string())?;
270
    if !bookmarks.iter().any(|b| b == target) {
271
        return Err("Pick a target bookmark of this repository.".into());
272
    }
273
    let Some((fork, bookmark)) = parse_source(app, repo, source.trim()) else {
274
        return Err("The source is a bookmark of this repository, or owner/name:bookmark of a fork.".into());
275
    };
276
    if fork.is_none() && !bookmarks.contains(&bookmark) {
277
        return Err(format!("There is no bookmark {bookmark} in this repository."));
278
    }
279
    if fork.is_none() && bookmark == target {
280
        return Err("The source and the target are the same bookmark.".into());
281
    }
282
    let (preview, _) = preview_for(app, repo, target, source.trim()).await.map_err(|e| e.to_string())?;
283
    if preview.is_empty() {
284
        return Err("The source adds nothing to the target.".into());
285
    }
286
    let source_repo_id = match &fork {
287
        Some(fk) => db::repos::get(&app.db, &fk.owner, &fk.name).await.map_err(|e| e.to_string())?.map(|r| r.id),
288
        None => None,
289
    };
290
    let created = pdb::create(
291
        &app.db,
292
        pdb::NewProposal {
293
            repo_id: row.id,
294
            title: title.trim(),
295
            body: body.trim(),
296
            author_id: Some(me.id),
297
            author: &me.username,
298
            draft,
299
            target,
300
            source_kind: if fork.is_some() { "fork" } else { "bookmark" },
301
            source_repo_id,
302
            source_bookmark: &bookmark,
303
            source_changes: "",
304
        },
305
    )
306
    .await
307
    .map_err(|e| e.to_string())?;
308
    pdb::add_event(&app.db, created.id, &me.username, "opened", "").await.ok();
309
    accounts::audit(&app.db, Some(me), "proposal.opened", &format!("{}#{}", row.slug(), created.number), title).await.ok();
310
    db::notify::index(&app.db, "proposal", row.id, created.id, created.number, &created.title, &created.body).await.ok();
311
    let url = format!("/{}/proposal/{}", row.slug(), created.number);
312
    crate::notify::deliver(
313
        app,
314
        crate::notify::Event {
315
            kind: "proposal.opened",
316
            title: format!("{}#{}: {}", row.slug(), created.number, created.title),
317
            url,
318
            actor: me,
319
            repo_id: row.id,
320
            thread: Some(("proposal", created.id)),
321
            mention_text: body,
322
            direct: vec![],
323
        },
324
    )
325
    .await;
326
    crate::hooks::emit(
327
        app,
328
        row,
329
        "proposal.opened",
330
        &me.username,
331
        serde_json::json!({ "number": created.number, "title": created.title, "target": target, "source": source }),
332
    )
333
    .await;
334
    Ok(created)
335
}
336
337
pub async fn create(
338
    State(app): State<Shared>,
339
    viewer: Viewer,
340
    Path((owner, name)): Path<(String, String)>,
341
    Form(f): Form<NewForm>,
342
) -> Result<Response, Error> {
343
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposals/new"), &viewer);
344
    let me = require(&viewer, &shell)?;
345
    csrf(&viewer, &f.csrf_token, &shell)?;
346
    let (repo, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
347
    super::writable(&row, &shell)?;
348
    match open_proposal(&app, &repo, &row, &me.account, &f.title, &f.body, &f.target, &f.source, f.draft.is_some()).await {
349
        Ok(created) => Ok(Redirect::to(&format!("/{owner}/{name}/proposal/{}", created.number)).into_response()),
350
        Err(msg) => {
351
            let bookmarks =
352
                app.repos.read(&repo, |r, _| Ok(r.bookmarks()?.into_iter().map(|b| b.name).collect::<Vec<_>>())).await.unwrap_or_default();
353
            Ok(Page(NewProposalPage {
354
                shell,
355
                repo: RepoShell::new(&app, &row, "proposals").with_role(role),
356
                bookmarks,
357
                source: f.source.clone(),
358
                target: f.target.clone(),
359
                error: Some(msg),
360
                preview: vec![],
361
                conflicted: false,
362
                title: f.title.clone(),
363
                body: f.body.clone(),
364
                assistants: vec![],
365
            })
366
            .into_response())
367
        }
368
    }
369
}
370
371
// ---------------------------------------------------------------- detail
372
373
/// A comment placed on a diff row, or general.
374
pub struct CommentView {
375
    pub row: pdb::CommentRow,
376
    pub body_html: String,
377
    pub line: Option<usize>,
378
}
379
380
/// One entry of a proposal's conversation, in time order: what kind it
381
/// is and its index in `comments`, `reviews` or `events`.
382
pub struct Entry {
383
    pub kind: &'static str,
384
    pub index: usize,
385
}
386
387
pub struct ReviewView {
388
    pub row: pdb::ReviewRow,
389
    pub body_html: String,
390
    pub sealed: bool,
391
}
392
393
/// Everything the detail page and the API need, computed once under the lock.
394
pub struct Loaded {
395
    pub row: pdb::ProposalRow,
396
    pub changes: Vec<ChangeView>,
397
    pub hashes: Vec<ChangeHash>,
398
    pub heads: Vec<ChangeHash>,
399
    pub target_heads: Vec<ChangeHash>,
400
    pub state: String,
401
    pub target_state: String,
402
    pub conflicted: bool,
403
    pub conflicts: Vec<ConflictView>,
404
    pub files: Vec<FileRows>,
405
    /// The per-file hunks and bases behind `files`, to render again with other options.
406
    pub diffs: Vec<oxy_core::repo::FileDiff>,
407
    pub bases: std::collections::BTreeMap<String, Vec<u8>>,
408
    /// Atom per (path, new line number) of the projected state.
409
    pub atoms: HashMap<(String, usize), (String, u32)>,
410
    pub sealing_keys: Vec<String>,
411
    pub touched: Vec<String>,
412
    pub owners: Vec<String>,
413
    pub landed_already: bool,
414
    /// Whether its source has any changes at all (#141): an open proposal
415
    /// whose source has changes, none of them missing from the target, was
416
    /// landed by some other route.
417
    pub source_has_changes: bool,
418
}
419
420
/// Compute the projection and everything derived from it.
421
pub async fn load(app: &Shared, repo: &RepoName, row: pdb::ProposalRow) -> Result<Loaded, crate::repos::RepoError> {
422
    let fork_dir = match (row.source_kind.as_str(), row.source_repo_id) {
423
        ("fork", Some(id)) => {
424
            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))
425
        }
426
        _ => None,
427
    };
428
    let r2 = row.clone();
429
    let loaded = app
430
        .repos
431
        .read(repo, move |r, cache| {
432
            let source = match (r2.source_kind.as_str(), &fork_dir) {
433
                ("changes", _) => Source::Changes(r2.source_changes().iter().filter_map(|h| ChangeHash::from_hex(h)).collect()),
434
                ("fork", Some(dir)) => {
435
                    let fork_repo = oxy_core::repo::Repo::open(dir)?;
436
                    let heads =
437
                        fork_repo.bookmarks()?.into_iter().find(|b| b.name == r2.source_bookmark).map(|b| b.heads).unwrap_or_default();
438
                    // Bring the fork's changes over now, so the projection below can read them.
439
                    let fork_state = fork_repo.load_state(&heads)?;
440
                    let missing: Vec<ChangeHash> = fork_state.changes().map(|(h, _)| *h).filter(|h| !r.store().has(h)).collect();
441
                    if !missing.is_empty() {
442
                        r.import_bundle(&fork_repo.bundle_for(&missing)?, r.current_policy()?.is_some())?;
443
                    }
444
                    Source::Changes(heads)
445
                }
446
                _ => {
447
                    let heads = r.bookmarks()?.into_iter().find(|b| b.name == r2.source_bookmark).map(|b| b.heads).unwrap_or_default();
448
                    Source::Bookmark(heads)
449
                }
450
            };
451
            let source_has_changes = match &source {
452
                Source::Changes(h) | Source::Bookmark(h) | Source::Fork { heads: h, .. } => !h.is_empty(),
453
            };
454
            let p: Projection = pl::project(r, cache, &r2.target, source)?;
455
            let target_loaded = cache.load(r, &p.target_heads)?;
456
            let files = render_files(&p.files, &p.bases);
457
            let mut atoms = HashMap::new();
458
            for f in &files {
459
                for l in &f.lines {
460
                    if let Some(n) = l.new_no {
461
                        if let Some((h, i)) = pl::atom_at(&p.loaded, &f.path, n as usize) {
462
                            atoms.insert((f.path.clone(), n as usize), (h.to_hex(), i));
463
                        }
464
                    }
465
                }
466
            }
467
            let touched: Vec<String> = p.files.iter().map(|f| f.path.clone()).collect();
468
            let owners = pl::owners_for(&target_loaded, &touched);
469
            let sealing = pl::sealing_keys(r, &p.hashes)?.into_iter().map(|k| k.to_hex()).collect();
470
            let landed_already = !p.hashes.is_empty() && p.hashes.iter().all(|h| target_loaded.state.contains(h));
471
            // A landed proposal's changes are in its target now: it shows
472
            // the ones it landed, as recorded when it landed.
473
            let (changes, hashes) = if r2.state == "landed" && p.hashes.is_empty() {
474
                let hashes: Vec<ChangeHash> = r2.projected_changes().iter().filter_map(|h| ChangeHash::from_hex(h)).collect();
475
                let labels = HashMap::new();
476
                let changes = hashes
477
                    .iter()
478
                    .filter_map(|h| Some(view::change_view_pub(r, h, &r.store().get_change_meta(h).ok()?, false, &labels)))
479
                    .collect();
480
                (changes, hashes)
481
            } else {
482
                (p.changes, p.hashes)
483
            };
484
            Ok(Loaded {
485
                row: r2,
486
                changes,
487
                hashes,
488
                heads: p.heads,
489
                target_heads: p.target_heads.clone(),
490
                state: p.state.to_hex(),
491
                target_state: p.target_state.to_hex(),
492
                conflicted: p.conflicted,
493
                conflicts: p.conflicts,
494
                files,
495
                diffs: p.files.clone(),
496
                bases: p.bases.clone(),
497
                atoms,
498
                sealing_keys: sealing,
499
                touched,
500
                owners,
501
                landed_already,
502
                source_has_changes,
503
            })
504
        })
505
        .await?;
506
    // Landed by another route (#141): `oxy proposal land` from a client (a
507
    // repository with a trust policy needs it), or the work merged and
508
    // pushed by hand. Everything it proposes is in its target, so it is
509
    // landed, not open with nothing to land.
510
    let mut loaded = loaded;
511
    if loaded.row.is_open()
512
        && loaded.source_has_changes
513
        && loaded.hashes.is_empty()
514
        && pdb::set_landed(&app.db, loaded.row.id, &loaded.target_state, "", "push").await.is_ok()
515
    {
516
        loaded.row.state = "landed".into();
517
        loaded.row.landed_via = "push".into();
518
        loaded.row.landed_state = loaded.target_state.clone();
519
        return Ok(loaded);
520
    }
521
    // Remember the projection for the list, the API and other proposals'
522
    // stacking checks, while the proposal is open: a landed one keeps what
523
    // it landed.
524
    if !loaded.row.is_open() {
525
        return Ok(loaded);
526
    }
527
    let heads_csv = loaded.heads.iter().map(|h| h.to_hex()).collect::<Vec<_>>().join(",");
528
    let changes_csv = loaded.hashes.iter().map(|h| h.to_hex()).collect::<Vec<_>>().join(",");
529
    pdb::set_projection(&app.db, loaded.row.id, &loaded.state, &heads_csv, &loaded.target_state, &changes_csv, loaded.conflicted)
530
        .await
531
        .ok();
532
    Ok(loaded)
533
}
534
535
/// After a push moved `bookmark`: open proposals into it whose work it now
536
/// holds are marked landed, by the pusher (#141).
537
pub async fn settle_after_push(app: &Shared, row: &db::repos::RepoRow, bookmark: &str, actor: &str) {
538
    let Some(repo) = RepoName::new(&row.owner, &row.name) else { return };
539
    let Ok(open) = pdb::list(&app.db, row.id, &["open", "draft"]).await else { return };
540
    for p in open.into_iter().filter(|p| p.target == bookmark) {
541
        let id = p.id;
542
        let number = p.number;
543
        if let Ok(l) = load(app, &repo, p).await {
544
            if l.row.state == "landed" && l.row.landed_by.is_empty() {
545
                pdb::set_landed(&app.db, id, &l.target_state, actor, "push").await.ok();
546
                crate::flow::moot_after_landing(app, row, &l.row).await;
547
            } else if l.row.is_open() && !l.hashes.is_empty() && crate::flow::enabled(app, row) {
548
                // The target moved, so the proposal's projected state is
549
                // new and its checks would be for an older one (#134): run
550
                // the pipeline on it, once.
551
                let ran: i64 = sqlx::query_scalar("SELECT COUNT(*) FROM flow_runs WHERE repo_id = $1 AND state = $2")
552
                    .bind(row.id)
553
                    .bind(&l.state)
554
                    .fetch_one(&app.db)
555
                    .await
556
                    .unwrap_or(1);
557
                if ran == 0 {
558
                    let label = format!("proposal/{number}");
559
                    match crate::flow::start_run_scoped(app, row, &label, &l.state, &l.heads, actor, "proposal", None).await {
560
                        Ok(Some(n)) => tracing::info!("proposal {number}: its target moved; run #{n} checks its new projected state"),
561
                        Ok(None) => {}
562
                        Err(e) => tracing::warn!("proposal {number}: a run of its new projected state did not start: {e}"),
563
                    }
564
                }
565
            }
566
        }
567
    }
568
}
569
570
/// Reviews, approvals and blockers.
571
pub struct Verdict {
572
    pub reviews: Vec<ReviewView>,
573
    pub approvals: Vec<Approval>,
574
    pub blockers: Vec<String>,
575
    /// The required-checks blocker, also in `blockers`: the one a
576
    /// maintainer may land over with a reason (#261).
577
    pub checks_blocker: Option<String>,
578
    pub depends_on: Vec<i64>,
579
    pub requirements: pdb::Requirements,
580
}
581
582
pub async fn verdict(app: &Shared, loaded: &Loaded, repo_id: i64) -> Result<Verdict, sqlx::Error> {
583
    let rows = pdb::reviews(&app.db, loaded.row.id).await?;
584
    let links = accounts::identity_accounts(&app.db).await?;
585
    let sealed_accounts: Vec<String> = links.iter().filter(|(k, _)| loaded.sealing_keys.contains(k)).map(|(_, u)| u.clone()).collect();
586
    // Latest verdict per reviewer.
587
    let mut latest: BTreeMap<String, &pdb::ReviewRow> = BTreeMap::new();
588
    for r in rows.iter().filter(|r| r.via.is_empty()) {
589
        // An assistant's answer is never the person's own verdict.
590
        latest.insert(r.author.clone(), r);
591
    }
592
    let mut approvals = Vec::new();
593
    for (who, r) in &latest {
594
        if r.verdict == "approve" {
595
            let sealed = sealed_accounts.contains(who);
596
            let key = links.iter().find(|(k, u)| u == who && loaded.sealing_keys.contains(k)).map(|(k, _)| k.clone());
597
            approvals.push(Approval { account: who.clone(), sealed, key });
598
        }
599
    }
600
    let reviews = rows
601
        .iter()
602
        .map(|r| ReviewView {
603
            row: r.clone(),
604
            body_html: render::markdown::render(&r.body, "/", "/"),
605
            sealed: r.verdict == "approve" && sealed_accounts.contains(&r.author),
606
        })
607
        .collect();
608
    let requirements = pdb::requirements(&app.db, repo_id).await?;
609
    let mut blockers = Vec::new();
610
    // Only an open proposal can be held back.
611
    if !loaded.row.is_open() {
612
        return Ok(Verdict { reviews, approvals, blockers, checks_blocker: None, depends_on: vec![], requirements });
613
    }
614
    if loaded.row.state == "draft" {
615
        blockers.push("the proposal is a draft".into());
616
    }
617
    if loaded.hashes.is_empty() {
618
        blockers.push("the proposal adds no changes".into());
619
    }
620
    let sealed_count = approvals.iter().filter(|a| a.sealed).count() as i64;
621
    if sealed_count < requirements.required_approvals {
622
        blockers.push(format!("{sealed_count} of {} required sealed approvals", requirements.required_approvals));
623
    }
624
    if requirements.require_owners {
625
        let missing: Vec<&String> = loaded.owners.iter().filter(|o| !approvals.iter().any(|a| a.sealed && &a.account == *o)).collect();
626
        if !missing.is_empty() {
627
            blockers.push(format!("code owners still to approve: {}", missing.iter().map(|s| s.as_str()).collect::<Vec<_>>().join(", ")));
628
        }
629
    }
630
    if loaded.conflicted && !requirements.allow_conflicts {
631
        blockers.push("landing would carry conflicts, which this repository refuses".into());
632
    }
633
    let mut checks_blocker = None;
634
    let required = db::hooks::required_checks(&app.db, repo_id).await?;
635
    if !required.is_empty() {
636
        let checks = db::hooks::checks_for_state(&app.db, repo_id, &loaded.state).await?;
637
        let missing: Vec<String> =
638
            required.iter().filter(|n| !checks.iter().any(|c| &c.name == *n && c.status == "passed")).cloned().collect();
639
        if !missing.is_empty() {
640
            let b = format!("required checks not passed on the projected state: {}", missing.join(", "));
641
            checks_blocker = Some(b.clone());
642
            blockers.push(b);
643
        }
644
    }
645
    let requesting: Vec<&String> = latest.iter().filter(|(_, r)| r.verdict == "changes").map(|(who, _)| who).collect();
646
    if !requesting.is_empty() {
647
        blockers.push(format!("changes requested by {}", requesting.iter().map(|s| s.as_str()).collect::<Vec<_>>().join(", ")));
648
    }
649
    // Stacking: another open, earlier proposal whose changes this one includes.
650
    let mut depends_on = Vec::new();
651
    for other in pdb::list(&app.db, repo_id, &["open", "draft"]).await? {
652
        if other.id == loaded.row.id || other.number > loaded.row.number {
653
            continue;
654
        }
655
        let theirs = other.projected_changes();
656
        if !theirs.is_empty() && theirs.iter().all(|h| loaded.hashes.iter().any(|m| m.to_hex() == *h)) {
657
            depends_on.push(other.number);
658
        }
659
    }
660
    if !depends_on.is_empty() {
661
        blockers.push(format!("depends on {}", depends_on.iter().map(|n| format!("#{n}")).collect::<Vec<_>>().join(", ")));
662
    }
663
    Ok(Verdict { reviews, approvals, blockers, checks_blocker, depends_on, requirements })
664
}
665
666
#[derive(Template)]
667
#[template(path = "proposal.html")]
668
pub struct ProposalPage {
669
    shell: Shell,
670
    repo: RepoShell,
671
    p: pdb::ProposalRow,
672
    /// Live topics (oxygenhub#205): the proposal's and its repository's
673
    /// (checks arrive on the latter).
674
    live_topic: String,
675
    repo_topic: String,
676
    /// Assistants answering now: shown as pending until they do.
677
    pending: Vec<String>,
678
    /// Issues it closes, from its description and its changes.
679
    closes: Vec<super::chain::Link>,
680
    /// Projects the viewer may add it to.
681
    project_choices: Option<Vec<db::projects::Project>>,
682
    /// Comments (not anchored to a line), reviews and events, oldest first.
683
    timeline: Vec<Entry>,
684
    /// The viewer may set labels (triage or above).
685
    can_triage: bool,
686
    body_html: String,
687
    tab: String,
688
    changes: Vec<ChangeView>,
689
    files: Vec<FileRows>,
690
    diffs: Vec<oxy_core::repo::FileDiff>,
691
    bases: std::collections::BTreeMap<String, Vec<u8>>,
692
    /// Whitespace-only changes are hidden (`?w=1`).
693
    ignore_ws: bool,
694
    conflicts: Vec<ConflictView>,
695
    conflicted: bool,
696
    comments: Vec<CommentView>,
697
    /// Anchored comments by (path, current line).
698
    placed: HashMap<(String, usize), Vec<usize>>,
699
    outdated: Vec<usize>,
700
    reviews: Vec<ReviewView>,
701
    approvals: Vec<Approval>,
702
    blockers: Vec<String>,
703
    depends_on: Vec<i64>,
704
    events: Vec<pdb::EventRow>,
705
    owners: Vec<String>,
706
    requirements: pdb::Requirements,
707
    landed_already: bool,
708
    can_edit: bool,
709
    /// The landed proposal's source bookmark, when it is this repository's,
710
    /// still there, and the viewer may delete it (oxygenhub#86).
711
    deletable_source: Option<String>,
712
    can_land: bool,
713
    can_land_over_checks: bool,
714
    can_auto_land: bool,
715
    hub_can_land: bool,
716
    notice: Option<String>,
717
    error: Option<String>,
718
    heads: Vec<String>,
719
    state_hash: String,
720
    source_label: String,
721
    api_url: String,
722
    labels: Vec<db::issues::Label>,
723
    all_labels: Vec<db::issues::Label>,
724
    checks: Vec<db::hooks::Check>,
725
    required_checks: Vec<String>,
726
    /// Projects this proposal is on that the viewer may see, with the column.
727
    projects: Vec<(db::projects::Project, String)>,
728
    /// Asked to review and not yet reviewing.
729
    requested: Vec<String>,
730
    /// Who can be asked to review, for the sidebar's menu (oxygenhub#84).
731
    reviewable: Vec<String>,
732
    /// The viewer may ask for reviews (the author, or a writer).
733
    can_request: bool,
734
    /// AI assistants the viewer may ask, by name (hub spec §13.4).
735
    assistants: Vec<String>,
736
    /// A description an assistant just drafted, for the editor.
737
    draft: Option<String>,
738
}
739
740
#[derive(Deserialize)]
741
pub struct DetailQuery {
742
    tab: Option<String>,
743
    /// What an action said, after it redirected here.
744
    #[serde(default)]
745
    notice: Option<String>,
746
    #[serde(default)]
747
    error: Option<String>,
748
    #[serde(default)]
749
    w: Option<String>,
750
    /// Only this part of the page (live pages, oxygenhub#205).
751
    #[serde(default)]
752
    fragment: Option<String>,
753
}
754
755
/// The page assembler every action ends in; its arguments are the route
756
/// plus what to say, and a struct would only rename them.
757
#[allow(clippy::too_many_arguments)]
758
async fn detail(
759
    app: &Shared,
760
    shell: Shell,
761
    viewer: &Viewer,
762
    owner: &str,
763
    name: &str,
764
    number: i64,
765
    tab: String,
766
    notice: Option<String>,
767
    error: Option<String>,
768
) -> Result<Page<ProposalPage>, Error> {
769
    let (repo, row, role) = lookup(app, &shell, viewer, owner, name).await?;
770
    let p = pdb::get(&app.db, row.id, number)
771
        .await
772
        .map_err(|e| Error::from_db(shell.clone(), e))?
773
        .ok_or_else(|| Error::not_found(shell.clone()))?;
774
    let p_id = p.id;
775
    let loaded = load(app, &repo, p).await.map_err(|e| Error::from_repo(shell.clone(), e))?;
776
    // A proposal whose changes all reached the target landed by another route.
777
    if loaded.landed_already && loaded.row.is_open() {
778
        pdb::set_state(&app.db, loaded.row.id, "landed", &loaded.target_state).await.ok();
779
        pdb::add_event(&app.db, loaded.row.id, "", "landed", "every change reached the target").await.ok();
780
        crate::flow::moot_after_landing(app, &row, &loaded.row).await;
781
    }
782
    let p = pdb::get(&app.db, row.id, number).await.map_err(|e| Error::from_db(shell.clone(), e))?.unwrap_or(loaded.row.clone());
783
    let v = verdict(app, &loaded, row.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
784
    let comment_rows = pdb::comments(&app.db, loaded.row.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
785
    let events = pdb::events(&app.db, loaded.row.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
786
    // Place anchored comments at their atom's current line.
787
    let mut by_atom: HashMap<(String, String, u32), usize> = HashMap::new();
788
    for ((path, line), (h, i)) in &loaded.atoms {
789
        by_atom.insert((path.clone(), h.clone(), *i), *line);
790
    }
791
    let mut comments = Vec::new();
792
    let mut placed: HashMap<(String, usize), Vec<usize>> = HashMap::new();
793
    let mut outdated = Vec::new();
794
    for (idx, c) in comment_rows.into_iter().enumerate() {
795
        let line = if c.anchor_change.is_empty() {
796
            None
797
        } else {
798
            by_atom.get(&(c.path.clone(), c.anchor_change.clone(), c.anchor_index as u32)).copied()
799
        };
800
        if !c.anchor_change.is_empty() {
801
            match line {
802
                Some(l) => placed.entry((c.path.clone(), l)).or_default().push(idx),
803
                None => outdated.push(idx),
804
            }
805
        }
806
        comments.push(CommentView { body_html: render::markdown::render(&c.body, "/", "/"), row: c, line });
807
    }
808
    let mut changes = loaded.changes.clone();
809
    super::attribute(app, &mut changes.iter_mut().collect::<Vec<_>>()).await;
810
    let me = viewer.account();
811
    let can_edit = me.is_some_and(|a| Some(a.id) == p.author_id || role >= Role::Maintain);
812
    let deletable_source =
813
        if p.state == "landed" && p.source_kind == "bookmark" && role >= Role::Write && p.source_bookmark != row.default_bookmark {
814
            let b = p.source_bookmark.clone();
815
            app.repos
816
                .read(&repo, move |r, _| Ok(r.view()?.bookmarks.contains_key(&b)))
817
                .await
818
                .unwrap_or(false)
819
                .then(|| p.source_bookmark.clone())
820
        } else {
821
            None
822
        };
823
    let can_land = role >= Role::Write && p.is_open() && v.blockers.is_empty();
824
    // Not landable yet: anyone who may land can set it to land when its
825
    // checks pass (#261).
826
    let can_auto_land = role >= Role::Write && p.is_open() && !v.blockers.is_empty();
827
    // Checks alone in the way: a maintainer may land over them (#261).
828
    let can_land_over_checks = role >= Role::Maintain && p.is_open() && v.checks_blocker.is_some() && v.blockers.len() == 1;
829
    let can_request = p.is_open() && me.is_some_and(|a| Some(a.id) == p.author_id || role >= Role::Write);
830
    let requested = pdb::review_requests(&app.db, p.id).await.unwrap_or_default();
831
    let mut reviewable: Vec<String> = if can_request {
832
        accounts::assignable(&app.db, row.id, &row.owner).await.unwrap_or_default().into_iter().filter(|u| *u != p.author).collect()
833
    } else {
834
        Vec::new()
835
    };
836
    for r in &requested {
837
        if !reviewable.iter().any(|x| x.eq_ignore_ascii_case(r)) {
838
            reviewable.push(r.clone());
839
        }
840
    }
841
    let assistants: Vec<String> = if (can_request || can_edit) && p.is_open() { assistant_names(app, &row).await } else { Vec::new() };
842
    let delegated = match viewer.account() {
843
        Some(a) => super::edit::delegated_identity(app, a.id).await.is_some(),
844
        None => false,
845
    };
846
    let hub_can_land = delegated || app.repos.read(&repo, |r, _| Ok(r.current_policy()?.is_none())).await.unwrap_or(false);
847
    let source_label = match p.source_kind.as_str() {
848
        "fork" => format!(
849
            "fork {}",
850
            db::repos::get_by_id(&app.db, p.source_repo_id.unwrap_or(0))
851
                .await
852
                .ok()
853
                .flatten()
854
                .map(|r| format!("{}:{}", r.slug(), p.source_bookmark))
855
                .unwrap_or_default()
856
        ),
857
        "changes" => format!("{} changes", p.source_changes().len()),
858
        _ => p.source_bookmark.clone(),
859
    };
860
    let projects = super::projects::placements_for(app, viewer, &row, p.number).await;
861
    let texts: Vec<String> = std::iter::once(p.body.clone()).chain(changes.iter().map(|c| format!("{}\n{}", c.title, c.body))).collect();
862
    let closes = super::chain::issues_closed_by(app, &row, &texts.iter().map(String::as_str).collect::<Vec<_>>()).await;
863
    let project_choices = super::projects::project_choices(app, viewer, &row, &projects).await;
864
    let mut dated: Vec<(i64, Entry)> = Vec::new();
865
    for (index, c) in comments.iter().enumerate() {
866
        if c.row.anchor_change.is_empty() {
867
            dated.push((c.row.created_ms, Entry { kind: "comment", index }));
868
        }
869
    }
870
    for (index, r) in v.reviews.iter().enumerate() {
871
        dated.push((r.row.created_ms, Entry { kind: "review", index }));
872
    }
873
    for (index, e) in events.iter().enumerate() {
874
        dated.push((e.at_ms, Entry { kind: "event", index }));
875
    }
876
    dated.sort_by_key(|(at, _)| *at);
877
    let timeline: Vec<Entry> = dated.into_iter().map(|(_, e)| e).collect();
878
    let pending = app.assistant_gate.lock().unwrap_or_else(|e| e.into_inner()).answering(p_id);
879
    Ok(Page(ProposalPage {
880
        live_topic: crate::events::topic::proposal(row.id, number),
881
        repo_topic: crate::events::topic::repo(row.id),
882
        pending,
883
        can_triage: role >= Role::Triage,
884
        timeline,
885
        closes,
886
        project_choices,
887
        projects,
888
        shell,
889
        repo: RepoShell::new(app, &row, "proposals").with_role(role).with_sky(app, &row).await,
890
        body_html: super::issues::markdown(app, &row, &row.default_bookmark, &p.body).await,
891
        p,
892
        tab,
893
        changes,
894
        files: loaded.files,
895
        diffs: loaded.diffs,
896
        bases: loaded.bases,
897
        ignore_ws: false,
898
        conflicts: loaded.conflicts,
899
        conflicted: loaded.conflicted,
900
        comments,
901
        placed,
902
        outdated,
903
        reviews: v.reviews,
904
        approvals: v.approvals,
905
        blockers: v.blockers,
906
        depends_on: v.depends_on,
907
        events,
908
        owners: loaded.owners,
909
        requirements: v.requirements,
910
        landed_already: loaded.landed_already,
911
        can_edit,
912
        deletable_source,
913
        can_land,
914
        can_land_over_checks,
915
        can_auto_land,
916
        hub_can_land,
917
        notice,
918
        error,
919
        heads: loaded.heads.iter().map(|h| h.to_hex()).collect(),
920
        state_hash: loaded.state.clone(),
921
        source_label,
922
        api_url: format!("{}/api/v1/repos/{owner}/{name}/proposals/{number}", app.config.base_url()),
923
        labels: db::issues::proposal_labels(&app.db, loaded.row.id).await.unwrap_or_default(),
924
        all_labels: db::issues::labels(&app.db, row.id).await.unwrap_or_default(),
925
        checks: db::hooks::checks_for_state(&app.db, row.id, &loaded.state).await.unwrap_or_default(),
926
        required_checks: db::hooks::required_checks(&app.db, row.id).await.unwrap_or_default(),
927
        requested,
928
        reviewable,
929
        assistants,
930
        draft: None,
931
        can_request,
932
    }))
933
}
934
935
/// Back to the proposal after an action, with what to say: a redirect, so
936
/// reloading the page (the checks script does) never repeats the action.
937
fn back(owner: &str, name: &str, number: i64, tab: &str, notice: Option<String>, error: Option<String>) -> Response {
938
    let mut url = format!("/{owner}/{name}/proposal/{number}?tab={tab}");
939
    if let Some(n) = notice {
940
        url.push_str(&format!("&notice={}", super::settings::urlencode(&n)));
941
    }
942
    if let Some(e) = error {
943
        url.push_str(&format!("&error={}", super::settings::urlencode(&e)));
944
    }
945
    Redirect::to(&url).into_response()
946
}
947
948
pub async fn show(
949
    State(app): State<Shared>,
950
    viewer: Viewer,
951
    Path((owner, name, number)): Path<(String, String, i64)>,
952
    Query(q): Query<DetailQuery>,
953
) -> Result<Response, Error> {
954
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
955
    let mut page =
956
        detail(&app, shell, &viewer, &owner, &name, number, q.tab.unwrap_or_else(|| "conversation".into()), q.notice, q.error).await?;
957
    if q.w.as_deref() == Some("1") {
958
        // Hide whitespace-only changes: the same hunks, rendered again.
959
        page.0.files =
960
            super::history::render_files_with(&page.0.diffs, &page.0.bases, crate::render::diff::Options { ignore_whitespace: true });
961
        page.0.ignore_ws = true;
962
    }
963
    // A live page asks for one part again (oxygenhub#205): rendered by the
964
    // same route, so the same access, and cut from the whole.
965
    if let Some(name) = q.fragment.as_deref() {
966
        let html = page.0.render().map_err(|e| Error::bad(page.0.shell.clone(), e.to_string()))?;
967
        return Ok(match super::fragment(&html, name) {
968
            Some(part) => ([(axum::http::header::CACHE_CONTROL, "no-store")], axum::response::Html(part)).into_response(),
969
            None => (axum::http::StatusCode::NOT_FOUND, "no such fragment").into_response(),
970
        });
971
    }
972
    Ok(page.into_response())
973
}
974
975
// ---------------------------------------------------------------- actions
976
977
#[derive(Deserialize)]
978
pub struct CommentForm {
979
    #[serde(rename = "_csrf")]
980
    csrf_token: String,
981
    body: String,
982
    #[serde(default)]
983
    path: String,
984
    #[serde(default)]
985
    line: Option<usize>,
986
}
987
988
pub async fn comment(
989
    State(app): State<Shared>,
990
    viewer: Viewer,
991
    Path((owner, name, number)): Path<(String, String, i64)>,
992
    Form(f): Form<CommentForm>,
993
) -> Result<Response, Error> {
994
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
995
    let me = require(&viewer, &shell)?;
996
    csrf(&viewer, &f.csrf_token, &shell)?;
997
    let (repo, row, _) = lookup(&app, &shell, &viewer, &owner, &name).await?;
998
    super::writable(&row, &shell)?;
999
    let p = pdb::get(&app.db, row.id, number)
1000
        .await
1001
        .map_err(|e| Error::from_db(shell.clone(), e))?
1002
        .ok_or_else(|| Error::not_found(shell.clone()))?;
1003
    if f.body.trim().is_empty() {
1004
        return Ok(back(&owner, &name, number, "conversation", None, Some("An empty comment says nothing.".into())));
1005
    }
1006
    let anchor = match (f.path.trim(), f.line) {
1007
        ("", _) | (_, None) => None,
1008
        (path, Some(line)) => {
1009
            let loaded = load(&app, &repo, p.clone()).await.map_err(|e| Error::from_repo(shell.clone(), e))?;
1010
            loaded.atoms.get(&(path.to_string(), line)).cloned()
1011
        }
1012
    };
1013
    let tab = if anchor.is_some() { "files" } else { "conversation" };
1014
    pdb::add_comment(
1015
        &app.db,
1016
        p.id,
1017
        Some(me.account.id),
1018
        &me.account.username,
1019
        f.body.trim(),
1020
        f.path.trim(),
1021
        anchor.as_ref().map(|(h, i)| (h.as_str(), *i as i64)),
1022
    )
1023
    .await
1024
    .map_err(|e| Error::from_db(shell.clone(), e))?;
1025
    app.events.live.publish(&crate::events::topic::proposal(row.id, number), "comment");
1026
    Ok(back(&owner, &name, number, tab, None, None))
1027
}
1028
1029
#[derive(Deserialize)]
1030
pub struct ReviewForm {
1031
    #[serde(rename = "_csrf")]
1032
    csrf_token: String,
1033
    verdict: String,
1034
    #[serde(default)]
1035
    body: String,
1036
}
1037
1038
pub async fn review(
1039
    State(app): State<Shared>,
1040
    viewer: Viewer,
1041
    Path((owner, name, number)): Path<(String, String, i64)>,
1042
    Form(f): Form<ReviewForm>,
1043
) -> Result<Response, Error> {
1044
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
1045
    let me = require(&viewer, &shell)?;
1046
    csrf(&viewer, &f.csrf_token, &shell)?;
1047
    let (_, row, _) = lookup(&app, &shell, &viewer, &owner, &name).await?;
1048
    super::writable(&row, &shell)?;
1049
    let p = pdb::get(&app.db, row.id, number)
1050
        .await
1051
        .map_err(|e| Error::from_db(shell.clone(), e))?
1052
        .ok_or_else(|| Error::not_found(shell.clone()))?;
1053
    if !matches!(f.verdict.as_str(), "comment" | "changes" | "approve") {
1054
        return Err(Error::bad(shell, "a review is comment, changes or approve"));
1055
    }
1056
    if f.verdict == "approve" && Some(me.account.id) == p.author_id {
1057
        return Ok(back(&owner, &name, number, "conversation", None, Some("You cannot approve your own proposal.".into())));
1058
    }
1059
    pdb::add_review(&app.db, p.id, me.account.id, &me.account.username, &f.verdict, f.body.trim())
1060
        .await
1061
        .map_err(|e| Error::from_db(shell.clone(), e))?;
1062
    pdb::add_event(&app.db, p.id, &me.account.username, &format!("review.{}", f.verdict), "").await.ok();
1063
    reviewed(&app, &row, &p, &me.account, &f.verdict).await;
1064
    crate::hooks::emit(&app, &row, "review", &me.account.username, serde_json::json!({ "number": number, "verdict": f.verdict })).await;
1065
    let notice = if f.verdict == "approve" {
1066
        Some(format!(
1067
            "Approval recorded. It counts once you seal the changes: oxy seal --proposal {}/{owner}/{name}/proposal/{number}",
1068
            app.config.base_url()
1069
        ))
1070
    } else {
1071
        None
1072
    };
1073
    Ok(back(&owner, &name, number, "conversation", notice, None))
1074
}
1075
1076
#[derive(Deserialize)]
1077
pub struct EditForm {
1078
    #[serde(rename = "_csrf")]
1079
    csrf_token: String,
1080
    title: String,
1081
    #[serde(default)]
1082
    body: String,
1083
    target: String,
1084
}
1085
1086
pub async fn edit(
1087
    State(app): State<Shared>,
1088
    viewer: Viewer,
1089
    Path((owner, name, number)): Path<(String, String, i64)>,
1090
    Form(f): Form<EditForm>,
1091
) -> Result<Response, Error> {
1092
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
1093
    let me = require(&viewer, &shell)?;
1094
    csrf(&viewer, &f.csrf_token, &shell)?;
1095
    let (_, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
1096
    let p = pdb::get(&app.db, row.id, number)
1097
        .await
1098
        .map_err(|e| Error::from_db(shell.clone(), e))?
1099
        .ok_or_else(|| Error::not_found(shell.clone()))?;
1100
    if Some(me.account.id) != p.author_id && role < Role::Maintain {
1101
        return Err(Error::not_found(shell));
1102
    }
1103
    let target = if crate::repos::names::valid_segment(f.target.trim()) { f.target.trim() } else { &p.target };
1104
    pdb::edit(&app.db, p.id, f.title.trim(), f.body.trim(), target).await.map_err(|e| Error::from_db(shell.clone(), e))?;
1105
    pdb::add_event(&app.db, p.id, &me.account.username, "edited", "").await.ok();
1106
    Ok(back(&owner, &name, number, "conversation", Some("Saved.".into()), None))
1107
}
1108
1109
#[derive(Deserialize)]
1110
pub struct StateForm {
1111
    #[serde(rename = "_csrf")]
1112
    csrf_token: String,
1113
    action: String,
1114
}
1115
1116
pub async fn state(
1117
    State(app): State<Shared>,
1118
    viewer: Viewer,
1119
    Path((owner, name, number)): Path<(String, String, i64)>,
1120
    Form(f): Form<StateForm>,
1121
) -> Result<Response, Error> {
1122
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
1123
    let me = require(&viewer, &shell)?;
1124
    csrf(&viewer, &f.csrf_token, &shell)?;
1125
    let (_, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
1126
    let p = pdb::get(&app.db, row.id, number)
1127
        .await
1128
        .map_err(|e| Error::from_db(shell.clone(), e))?
1129
        .ok_or_else(|| Error::not_found(shell.clone()))?;
1130
    if Some(me.account.id) != p.author_id && role < Role::Triage {
1131
        return Err(Error::not_found(shell));
1132
    }
1133
    let new_state = match (f.action.as_str(), p.state.as_str()) {
1134
        ("close", "open" | "draft") => "closed",
1135
        ("reopen", "closed") => "open",
1136
        ("ready", "draft") => "open",
1137
        ("draft", "open") => "draft",
1138
        _ => return Err(Error::bad(shell, "that transition is not possible")),
1139
    };
1140
    pdb::set_state(&app.db, p.id, new_state, "").await.map_err(|e| Error::from_db(shell.clone(), e))?;
1141
    pdb::add_event(&app.db, p.id, &me.account.username, new_state, "").await.ok();
1142
    crate::hooks::emit(&app, &row, &format!("proposal.{new_state}"), &me.account.username, serde_json::json!({ "number": number })).await;
1143
    Ok(back(&owner, &name, number, "conversation", None, None))
1144
}
1145
1146
pub async fn resolve_comment(
1147
    State(app): State<Shared>,
1148
    viewer: Viewer,
1149
    Path((owner, name, number, id)): Path<(String, String, i64, i64)>,
1150
    Form(f): Form<super::session::CsrfForm>,
1151
) -> Result<Response, Error> {
1152
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
1153
    require(&viewer, &shell)?;
1154
    csrf(&viewer, &f.csrf, &shell)?;
1155
    let (_, row, _) = lookup(&app, &shell, &viewer, &owner, &name).await?;
1156
    let p = pdb::get(&app.db, row.id, number)
1157
        .await
1158
        .map_err(|e| Error::from_db(shell.clone(), e))?
1159
        .ok_or_else(|| Error::not_found(shell.clone()))?;
1160
    let current: Option<bool> = sqlx::query_scalar("SELECT resolved FROM proposal_comments WHERE id = $1 AND proposal_id = $2")
1161
        .bind(id)
1162
        .bind(p.id)
1163
        .fetch_optional(&app.db)
1164
        .await
1165
        .map_err(|e| Error::from_db(shell.clone(), e))?;
1166
    if let Some(r) = current {
1167
        pdb::set_comment_resolved(&app.db, id, !r).await.map_err(|e| Error::from_db(shell.clone(), e))?;
1168
    }
1169
    Ok(back(&owner, &name, number, "files", None, None))
1170
}
1171
1172
/// Land from the hub: only when the repository has no trust policy (the
1173
/// hub never signs a reference update the policy would have to admit).
1174
#[derive(serde::Deserialize)]
1175
pub struct LandForm {
1176
    #[serde(rename = "_csrf")]
1177
    csrf: String,
1178
    /// Why it lands over its required checks (#261), for maintainers.
1179
    #[serde(default)]
1180
    over_checks: Option<String>,
1181
}
1182
1183
pub async fn land(
1184
    State(app): State<Shared>,
1185
    viewer: Viewer,
1186
    Path((owner, name, number)): Path<(String, String, i64)>,
1187
    Form(f): Form<LandForm>,
1188
) -> Result<Response, Error> {
1189
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
1190
    let me = require(&viewer, &shell)?;
1191
    csrf(&viewer, &f.csrf, &shell)?;
1192
    let need = if f.over_checks.is_some() { Access::Maintain } else { Access::Write };
1193
    let (repo, row, _) = lookup_role(&app, &shell, &viewer, &owner, &name, need).await?;
1194
    match land_as(&app, &repo, &row, &me.account, number, "web", false, f.over_checks.as_deref()).await {
1195
        Ok(_) => Ok(back(&owner, &name, number, "conversation", Some("Landed.".into()), None)),
1196
        Err(Landing::NotFound) => Err(Error::not_found(shell)),
1197
        Err(Landing::Refused(m)) => Ok(back(&owner, &name, number, "conversation", None, Some(m))),
1198
    }
1199
}
1200
1201
#[derive(serde::Deserialize)]
1202
pub struct AutoLandForm {
1203
    #[serde(rename = "_csrf")]
1204
    csrf: String,
1205
    /// `1` to set it, else off.
1206
    #[serde(default)]
1207
    on: String,
1208
}
1209
1210
/// `POST …/proposal/{n}/auto-land` (#261): land when its checks pass, set
1211
/// or cleared by someone who may land it.
1212
pub async fn auto_land(
1213
    State(app): State<Shared>,
1214
    viewer: Viewer,
1215
    Path((owner, name, number)): Path<(String, String, i64)>,
1216
    Form(f): Form<AutoLandForm>,
1217
) -> Result<Response, Error> {
1218
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
1219
    let me = require(&viewer, &shell)?;
1220
    csrf(&viewer, &f.csrf, &shell)?;
1221
    let (_, row, _) = lookup_role(&app, &shell, &viewer, &owner, &name, Access::Write).await?;
1222
    let p = pdb::get(&app.db, row.id, number)
1223
        .await
1224
        .map_err(|e| Error::from_db(shell.clone(), e))?
1225
        .filter(|p| p.is_open())
1226
        .ok_or_else(|| Error::not_found(shell.clone()))?;
1227
    let on = f.on == "1";
1228
    crate::autoland::set(&app, &row, &p, &me.account, on).await.map_err(|e| Error::from_db(shell.clone(), e))?;
1229
    let note = if on { "It will land when its checks pass." } else { "It will not land by itself." };
1230
    Ok(back(&owner, &name, number, "conversation", Some(note.into()), None))
1231
}
1232
1233
/// Why a proposal did not land.
1234
pub enum Landing {
1235
    NotFound,
1236
    Refused(String),
1237
}
1238
1239
/// Land proposal `number` as `me` (hub spec §8.4), who has write access:
1240
/// refused while it is not open or has blockers. Moves the target bookmark
1241
/// (attested by the hub key on `me`'s behalf when they delegated to it),
1242
/// then records, announces and audits the landing, saying how it was done
1243
/// (`via`: `web`, or `api (token NAME)`). `as_hub` signs with the hub's own
1244
/// key rather than `me`'s delegation (Diffusion's auto-land).
1245
/// `over_checks`, a reason, lands over required checks that have not
1246
/// passed (#261): the caller has checked `me` maintains the repository;
1247
/// every other blocker still holds. Returns the new state.
1248
#[allow(clippy::too_many_arguments)]
1249
pub async fn land_as(
1250
    app: &Shared,
1251
    repo: &RepoName,
1252
    row: &db::repos::RepoRow,
1253
    me: &accounts::Account,
1254
    number: i64,
1255
    via: &str,
1256
    as_hub: bool,
1257
    over_checks: Option<&str>,
1258
) -> Result<String, Landing> {
1259
    let (owner, name) = (row.owner.clone(), row.name.clone());
1260
    let refused = |e: String| Landing::Refused(e);
1261
    let p = pdb::get(&app.db, row.id, number).await.map_err(|e| refused(e.to_string()))?.ok_or(Landing::NotFound)?;
1262
    let loaded = load(app, repo, p.clone()).await.map_err(|e| refused(e.to_string()))?;
1263
    let v = verdict(app, &loaded, row.id).await.map_err(|e| refused(e.to_string()))?;
1264
    if !p.is_open() {
1265
        return Err(refused(format!("Cannot land: the proposal is {}", p.state)));
1266
    }
1267
    let reason = over_checks.map(str::trim);
1268
    if reason == Some("") {
1269
        return Err(refused("Landing over checks needs a reason: say why it can't wait for them".into()));
1270
    }
1271
    let blocking: Vec<&String> = v.blockers.iter().filter(|b| !(reason.is_some() && v.checks_blocker.as_ref() == Some(*b))).collect();
1272
    if !blocking.is_empty() {
1273
        let list: Vec<&str> = blocking.iter().map(|b| b.as_str()).collect();
1274
        return Err(refused(format!("Cannot land: {}", list.join("; "))));
1275
    }
1276
    // Only when the checks were in the way does the landing say so.
1277
    let over = reason.filter(|_| v.checks_blocker.is_some());
1278
    let via_owned = match over {
1279
        Some(r) => format!("{via}, over checks: {r}"),
1280
        None => via.to_string(),
1281
    };
1282
    let via = via_owned.as_str();
1283
    let target = p.target.clone();
1284
    let heads = loaded.heads.clone();
1285
    // With a delegation the landing is attested by the hub key on the
1286
    // user's behalf, which a policy accepts when it lets the user update
1287
    // the target (spec §14.5); without one, only a policy-free repository
1288
    // can be landed here.
1289
    let signer = if as_hub { super::edit::hub_signer(app) } else { super::edit::signer_for(app, me.id).await };
1290
    let result = match signer {
1291
        Ok(signer) => crate::repos::edits::move_bookmark(&app.repos, repo, target.clone(), heads.clone(), signer).await.map(|_| pl::state_ref(&heads).to_hex()),
1292
        Err(why) => {
1293
            app.repos
1294
                .write(repo, move |r, _| {
1295
                    if r.current_policy()?.is_some() {
1296
                        return Err(crate::repos::RepoError::Oxy(oxy_core::repo::RepoError::Msg(format!(
1297
                            "this repository has a trust policy, so the landing must be signed by a key it authorises. Land from a client with oxy proposal land, or delegate to the hub. {why}"
1298
                        ))));
1299
                    }
1300
                    r.bookmark_set(&target, &heads)?;
1301
                    Ok(pl::state_ref(&heads).to_hex())
1302
                })
1303
                .await
1304
        }
1305
    };
1306
    let state = result.map_err(|e| refused(e.to_string()))?;
1307
    pdb::set_landed(&app.db, p.id, &state, &me.username, via).await.map_err(|e| refused(e.to_string()))?;
1308
    crate::flow::moot_after_landing(app, row, &p).await;
1309
    let how = if v.approvals.is_empty() { format!("{via}, with no approval") } else { via.to_string() };
1310
    pdb::add_event(&app.db, p.id, &me.username, "landed", &how).await.ok();
1311
    crate::hooks::emit(
1312
        app,
1313
        row,
1314
        "proposal.landed",
1315
        &me.username,
1316
        serde_json::json!({ "number": number, "target": p.target, "state": state }),
1317
    )
1318
    .await;
1319
    crate::notify::deliver(
1320
        app,
1321
        crate::notify::Event {
1322
            kind: "proposal.landed",
1323
            title: format!("{owner}/{name}#{number}: {} landed", p.title),
1324
            url: format!("/{owner}/{name}/proposal/{number}"),
1325
            actor: me,
1326
            repo_id: row.id,
1327
            thread: Some(("proposal", p.id)),
1328
            mention_text: "",
1329
            direct: p.author_id.into_iter().collect(),
1330
        },
1331
    )
1332
    .await;
1333
    if p.target == row.default_bookmark {
1334
        let messages: Vec<(String, String)> = loaded.changes.iter().map(|c| (c.hash.clone(), format!("{}\n{}", c.title, c.body))).collect();
1335
        super::issues::close_from_messages(app, row, &messages).await;
1336
    }
1337
    accounts::audit(&app.db, Some(me), "proposal.landed", &format!("{owner}/{name}#{number}"), &how).await.ok();
1338
    if let (Some(r), Some(checks)) = (over, &v.checks_blocker) {
1339
        accounts::audit(&app.db, Some(me), "proposal.land_over_checks", &format!("{owner}/{name}#{number}"), &format!("{r} ({checks})"))
1340
            .await
1341
            .ok();
1342
    }
1343
    db::repos::record_push(
1344
        &app.db,
1345
        row.id,
1346
        Some((me.id, me.username.as_str())),
1347
        &[db::repos::PushOutcome {
1348
            reference: p.target.clone(),
1349
            ok: true,
1350
            reason: format!("landed #{number} ({how})"),
1351
            old_state: loaded.target_state.clone(),
1352
            new_state: state.clone(),
1353
            heads: loaded.heads.len() as i64,
1354
            changes: loaded.hashes.len() as i64,
1355
        }],
1356
    )
1357
    .await
1358
    .ok();
1359
    // The target moved: its other open proposals are checked again (#134).
1360
    settle_after_push(app, row, &p.target, &me.username).await;
1361
    // ...and its pipeline runs, as a push of the same heads would start it
1362
    // (#197): without the run a consumer following it when green would wait
1363
    // for a state that never runs.
1364
    crate::flow::on_push(app, row, &p.target, &state, &loaded.heads, &me.username).await;
1365
    // A landing on the default bookmark closes the issues its changes (and
1366
    // its description) say they close, as a push there would.
1367
    if p.target == row.default_bookmark {
1368
        let body = (format!("proposal #{number}"), p.body.clone());
1369
        crate::web::issues::close_from_arrived(app, row, loaded.target_heads.clone(), loaded.heads.clone(), Some(body)).await;
1370
    }
1371
    // Diffusion (#150): a landing moves the target as a push would, so the
1372
    // pin index follows it, and the consumers of a moved default bookmark
1373
    // are bumped.
1374
    let heads = loaded.heads.clone();
1375
    let moved = vec![(p.target.clone(), state.clone(), heads.clone())];
1376
    crate::diffusion::after_push(app, row, &moved).await;
1377
    if p.target == row.default_bookmark {
1378
        let (app, row) = (app.clone(), row.clone());
1379
        tokio::spawn(async move { crate::diffusion::propagate(&app, &row, heads, false).await });
1380
    }
1381
    Ok(state)
1382
}
1383
1384
#[derive(Deserialize)]
1385
pub struct LabelsForm {
1386
    #[serde(rename = "_csrf")]
1387
    csrf_token: String,
1388
    #[serde(default)]
1389
    label: Vec<i64>,
1390
}
1391
1392
pub async fn set_labels(
1393
    State(app): State<Shared>,
1394
    viewer: Viewer,
1395
    Path((owner, name, number)): Path<(String, String, i64)>,
1396
    axum_extra::extract::Form(f): axum_extra::extract::Form<LabelsForm>,
1397
) -> Result<Response, Error> {
1398
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
1399
    require(&viewer, &shell)?;
1400
    csrf(&viewer, &f.csrf_token, &shell)?;
1401
    let (_, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
1402
    if role < Role::Triage {
1403
        return Err(Error::not_found(shell));
1404
    }
1405
    let p = pdb::get(&app.db, row.id, number)
1406
        .await
1407
        .map_err(|e| Error::from_db(shell.clone(), e))?
1408
        .ok_or_else(|| Error::not_found(shell.clone()))?;
1409
    for l in db::issues::labels(&app.db, row.id).await.map_err(|e| Error::from_db(shell.clone(), e))? {
1410
        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))?;
1411
    }
1412
    Ok(back(&owner, &name, number, "conversation", None, None))
1413
}
1414
1415
/// `GET /{owner}/{name}/proposal/{number}/events`: server-sent events for
1416
/// checks on the projected state (hub spec §13.1).
1417
pub async fn events(
1418
    State(app): State<Shared>,
1419
    viewer: Viewer,
1420
    Path((owner, name, number)): Path<(String, String, i64)>,
1421
) -> Result<axum::response::Sse<impl futures::Stream<Item = Result<axum::response::sse::Event, std::convert::Infallible>>>, Error> {
1422
    use futures::StreamExt;
1423
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
1424
    let (_, row, _) = lookup(&app, &shell, &viewer, &owner, &name).await?;
1425
    let rx = app.events.proposals.subscribe();
1426
    let repo_id = row.id;
1427
    let stream = tokio_stream::wrappers::BroadcastStream::new(rx).filter_map(move |item| async move {
1428
        match item {
1429
            Ok((id, ev)) if id == repo_id => {
1430
                Some(Ok(axum::response::sse::Event::default().event(ev.kind.clone()).data(serde_json::to_string(&ev).unwrap_or_default())))
1431
            }
1432
            _ => None,
1433
        }
1434
    });
1435
    Ok(axum::response::Sse::new(futures::StreamExt::take_until(stream, crate::shutdown::stopping()))
1436
        .keep_alive(axum::response::sse::KeepAlive::default()))
1437
}
1438
1439
// -------------------------------------------------------------------- API
1440
1441
pub async fn to_api(app: &Shared, owner: &str, name: &str, loaded: &Loaded, v: &Verdict, source_url: Option<String>) -> hub_api::Proposal {
1442
    let p = &loaded.row;
1443
    hub_api::Proposal {
1444
        number: p.number,
1445
        title: p.title.clone(),
1446
        body: p.body.clone(),
1447
        author: p.author.clone(),
1448
        state: ProposalState::parse(&p.state).unwrap_or(ProposalState::Open),
1449
        target: p.target.clone(),
1450
        source: match p.source_kind.as_str() {
1451
            "fork" => {
1452
                let (o, n) = source_url
1453
                    .as_deref()
1454
                    .and_then(|u| u.rsplit_once('/'))
1455
                    .and_then(|(b, n)| b.rsplit_once('/').map(|(_, o)| (o.to_string(), n.to_string())))
1456
                    .unwrap_or_default();
1457
                ProposalSource::Fork { owner: o, name: n, bookmark: p.source_bookmark.clone() }
1458
            }
1459
            "changes" => ProposalSource::Changes { hashes: p.source_changes() },
1460
            _ => ProposalSource::Bookmark { bookmark: p.source_bookmark.clone() },
1461
        },
1462
        changes: loaded
1463
            .changes
1464
            .iter()
1465
            .map(|c| hub_api::ChangeSummary {
1466
                hash: c.hash.clone(),
1467
                message: if c.body.is_empty() { c.title.clone() } else { format!("{}\n\n{}", c.title, c.body) },
1468
                author: hub_api::Author {
1469
                    name: c.author.name.clone(),
1470
                    email: c.author.email.clone(),
1471
                    key: c.author.key.clone(),
1472
                    account: c.author.account.clone(),
1473
                    note: hub_api::Author::note_for(&c.author.key, &c.author.account),
1474
                },
1475
                when_ms: c.when_ms,
1476
                deps: c.deps.clone(),
1477
                head: c.head,
1478
                via: c.via.as_ref().map(|v| hub_api::Via {
1479
                    name: v.name.clone(),
1480
                    key: v.key.clone(),
1481
                    scope: v.scope.clone(),
1482
                    expires_ms: v.expires_ms,
1483
                    revoked: v.revoked,
1484
                }),
1485
                signature: match &c.signature {
1486
                    view::SigView::Unsigned => hub_api::Signature::Unsigned,
1487
                    view::SigView::Valid { key, sealed, revoked, .. } => {
1488
                        hub_api::Signature::Valid { key: key.clone(), sealed: *sealed, revoked: *revoked }
1489
                    }
1490
                    view::SigView::Invalid(why) => hub_api::Signature::Invalid { reason: why.clone() },
1491
                },
1492
            })
1493
            .collect(),
1494
        projected_heads: loaded.heads.iter().map(|h| h.to_hex()).collect(),
1495
        projected_state: Some(loaded.state.clone()),
1496
        conflicted: loaded.conflicted,
1497
        approvals: v.approvals.clone(),
1498
        landable: p.is_open() && v.blockers.is_empty(),
1499
        blockers: v.blockers.clone(),
1500
        created_ms: p.created_ms,
1501
        updated_ms: p.updated_ms,
1502
        url: format!("{}/{owner}/{name}/proposal/{}", app.config.base_url(), p.number),
1503
        repository_url: format!("{}/{owner}/{name}", app.config.base_url()),
1504
        source_url,
1505
        landed: (p.state == "landed" && p.landed_ms > 0).then(|| hub_api::Landed {
1506
            by: p.landed_by.clone(),
1507
            via: p.landed_via.clone(),
1508
            when_ms: p.landed_ms,
1509
        }),
1510
        auto_land: (p.is_open() && !p.auto_land_by.is_empty()).then(|| p.auto_land_by.clone()),
1511
        requested_reviewers: pdb::review_requests(&app.db, p.id).await.unwrap_or_default(),
1512
        labels: db::issues::proposal_labels(&app.db, p.id)
1513
            .await
1514
            .unwrap_or_default()
1515
            .into_iter()
1516
            .map(|l| hub_api::Label { name: l.name, colour: l.colour, description: l.description })
1517
            .collect(),
1518
    }
1519
}
1520
1521
/// The line comment form's placement key, for templates.
1522
pub fn key(path: &str, line: impl filters::Num) -> (String, usize) {
1523
    (path.to_string(), line.as_u64() as usize)
1524
}
1525
1526
#[allow(dead_code)]
1527
fn _unused(_: &diff::Line, _: &ConflictView, _: &Role) {}
1528
1529
// ------------------------------------------------------- review requests
1530
1531
/// Ask accounts to review a proposal (hub plan 0.4): each must exist, be
1532
/// someone other than the author, and be able to read the repository. Each
1533
/// newly asked is told, and the proposal records it. The usernames newly
1534
/// asked, or why none could be.
1535
pub async fn request_reviewers(
1536
    app: &Shared,
1537
    row: &db::repos::RepoRow,
1538
    p: &pdb::ProposalRow,
1539
    by: &accounts::Account,
1540
    names: &[String],
1541
) -> Result<Vec<String>, String> {
1542
    let mut found = Vec::new();
1543
    for name in names.iter().map(|n| n.trim().trim_start_matches('@')).filter(|n| !n.is_empty()) {
1544
        let Some(a) = accounts::account_by_name(&app.db, name).await.ok().flatten() else {
1545
            return Err(format!("There is no account {name}."));
1546
        };
1547
        if Some(a.id) == p.author_id {
1548
            return Err(format!("{name} wrote this proposal, and cannot review it."));
1549
        }
1550
        let role = crate::auth::roles::role_for(&app.db, Some(&a), row).await.ok().flatten();
1551
        if !crate::auth::roles::allows(role, crate::auth::Access::Read) {
1552
            return Err(format!("{name} cannot read this repository."));
1553
        }
1554
        found.push(a);
1555
    }
1556
    let mut asked = Vec::new();
1557
    for a in found {
1558
        if !pdb::request_review(&app.db, p.id, a.id, &by.username).await.map_err(|e| e.to_string())? {
1559
            continue;
1560
        }
1561
        pdb::add_event(&app.db, p.id, &by.username, "review requested", &a.username).await.ok();
1562
        crate::notify::deliver(
1563
            app,
1564
            crate::notify::Event {
1565
                kind: "proposal.review_requested",
1566
                title: format!("{}/{}#{}: {} (review requested from {})", row.owner, row.name, p.number, p.title, a.username),
1567
                url: format!("/{}/{}/proposal/{}", row.owner, row.name, p.number),
1568
                actor: by,
1569
                repo_id: row.id,
1570
                thread: None,
1571
                mention_text: "",
1572
                direct: vec![a.id],
1573
            },
1574
        )
1575
        .await;
1576
        asked.push(a.username);
1577
    }
1578
    Ok(asked)
1579
}
1580
1581
/// After a review: it answers the reviewer's request, if there was one, and
1582
/// the proposal's author is told.
1583
pub async fn reviewed(app: &Shared, row: &db::repos::RepoRow, p: &pdb::ProposalRow, by: &accounts::Account, verdict: &str) {
1584
    pdb::unrequest_review(&app.db, p.id, by.id).await.ok();
1585
    let what = match verdict {
1586
        "approve" => "approved",
1587
        "changes" => "changes requested",
1588
        _ => "reviewed",
1589
    };
1590
    crate::notify::deliver(
1591
        app,
1592
        crate::notify::Event {
1593
            kind: "proposal.review",
1594
            title: format!("{}/{}#{}: {} ({what} by {})", row.owner, row.name, p.number, p.title, by.username),
1595
            url: format!("/{}/{}/proposal/{}", row.owner, row.name, p.number),
1596
            actor: by,
1597
            repo_id: row.id,
1598
            thread: Some(("proposal", p.id)),
1599
            mention_text: "",
1600
            direct: p.author_id.into_iter().collect(),
1601
        },
1602
    )
1603
    .await;
1604
}
1605
1606
#[derive(Deserialize)]
1607
pub struct ReviewersForm {
1608
    #[serde(rename = "_csrf")]
1609
    csrf_token: String,
1610
    /// `add`, `remove`, or `set` (the menu: exactly these are asked).
1611
    action: String,
1612
    #[serde(default)]
1613
    username: Vec<String>,
1614
}
1615
1616
/// `POST /{owner}/{name}/proposal/{number}/reviewers`: the author or a
1617
/// writer asks someone to review, or withdraws the request.
1618
pub async fn reviewers(
1619
    State(app): State<Shared>,
1620
    viewer: Viewer,
1621
    Path((owner, name, number)): Path<(String, String, i64)>,
1622
    axum_extra::extract::Form(f): axum_extra::extract::Form<ReviewersForm>,
1623
) -> Result<Response, Error> {
1624
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
1625
    let me = require(&viewer, &shell)?;
1626
    csrf(&viewer, &f.csrf_token, &shell)?;
1627
    let (_, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
1628
    let p = pdb::get(&app.db, row.id, number)
1629
        .await
1630
        .map_err(|e| Error::from_db(shell.clone(), e))?
1631
        .ok_or_else(|| Error::not_found(shell.clone()))?;
1632
    if Some(me.account.id) != p.author_id && role < Role::Write {
1633
        return Err(Error::not_found(shell));
1634
    }
1635
    let names: Vec<String> = f.username.iter().map(|n| n.trim().trim_start_matches('@').to_string()).filter(|n| !n.is_empty()).collect();
1636
    let current = pdb::review_requests(&app.db, p.id).await.map_err(|e| Error::from_db(shell.clone(), e))?;
1637
    // Withdrawn: those named (remove), or those the menu left out (set).
1638
    let withdraw: Vec<String> = match f.action.as_str() {
1639
        "remove" => names.clone(),
1640
        "set" => current.iter().filter(|c| !names.iter().any(|n| n.eq_ignore_ascii_case(c))).cloned().collect(),
1641
        _ => Vec::new(),
1642
    };
1643
    for who in &withdraw {
1644
        if let Some(a) = accounts::account_by_name(&app.db, who).await.ok().flatten() {
1645
            if pdb::unrequest_review(&app.db, p.id, a.id).await.map_err(|e| Error::from_db(shell.clone(), e))? {
1646
                pdb::add_event(&app.db, p.id, &me.account.username, "review request withdrawn", &a.username).await.ok();
1647
            }
1648
        }
1649
    }
1650
    let ask: Vec<String> = match f.action.as_str() {
1651
        "add" => names,
1652
        "set" => names.into_iter().filter(|n| !current.iter().any(|c| c.eq_ignore_ascii_case(n))).collect(),
1653
        _ => return Ok(back(&owner, &name, number, "conversation", None, None)),
1654
    };
1655
    if ask.is_empty() {
1656
        return Ok(back(&owner, &name, number, "conversation", None, None));
1657
    }
1658
    match request_reviewers(&app, &row, &p, &me.account, &ask).await {
1659
        Ok(asked) if asked.is_empty() => Ok(back(&owner, &name, number, "conversation", Some("Already asked.".into()), None)),
1660
        Ok(asked) => Ok(back(&owner, &name, number, "conversation", Some(format!("Asked {} to review.", asked.join(", "))), None)),
1661
        Err(e) => Ok(back(&owner, &name, number, "conversation", None, Some(e))),
1662
    }
1663
}
1664
1665
#[derive(Deserialize)]
1666
pub struct AssistantForm {
1667
    #[serde(rename = "_csrf")]
1668
    csrf_token: String,
1669
    assistant: String,
1670
    /// `summary` asks for a summary comment (oxygenhub#190); otherwise a review.
1671
    #[serde(default)]
1672
    task: String,
1673
}
1674
1675
/// `POST /{owner}/{name}/proposal/{number}/assistant`: the author or a
1676
/// writer asks an AI assistant to review (hub spec §13.4). The answer
1677
/// comes later as a review via the assistant.
1678
pub async fn assistant(
1679
    State(app): State<Shared>,
1680
    viewer: Viewer,
1681
    Path((owner, name, number)): Path<(String, String, i64)>,
1682
    Form(f): Form<AssistantForm>,
1683
) -> Result<Response, Error> {
1684
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
1685
    let me = require(&viewer, &shell)?;
1686
    csrf(&viewer, &f.csrf_token, &shell)?;
1687
    let (_, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
1688
    super::writable(&row, &shell)?;
1689
    let p = pdb::get(&app.db, row.id, number)
1690
        .await
1691
        .map_err(|e| Error::from_db(shell.clone(), e))?
1692
        .ok_or_else(|| Error::not_found(shell.clone()))?;
1693
    if Some(me.account.id) != p.author_id && role < Role::Write {
1694
        return Err(Error::not_found(shell));
1695
    }
1696
    if !p.is_open() {
1697
        return Ok(back(&owner, &name, number, "conversation", None, Some("The proposal is not open.".into())));
1698
    }
1699
    let Some(a) = crate::assistants::enabled_for_repo(&app.db, &row)
1700
        .await
1701
        .map_err(|e| Error::from_db(shell.clone(), e))?
1702
        .into_iter()
1703
        .find(|a| a.name.eq_ignore_ascii_case(f.assistant.trim()))
1704
    else {
1705
        return Ok(back(&owner, &name, number, "conversation", None, Some(format!("No assistant called {} here.", f.assistant.trim()))));
1706
    };
1707
    let who = a.name.clone();
1708
    let summary = f.task == "summary";
1709
    let asked = if summary {
1710
        crate::assistants::request_summary(&app, &row, &p, &me.account, a).await
1711
    } else {
1712
        crate::assistants::request_review(&app, &row, &p, &me.account, a).await
1713
    };
1714
    match asked {
1715
        Ok(()) => Ok(back(
1716
            &owner,
1717
            &name,
1718
            number,
1719
            "conversation",
1720
            Some(if summary {
1721
                format!("Asked {who} for a summary; its comment appears here when it comes.")
1722
            } else {
1723
                format!("Asked {who} to review; its answer appears here when it comes.")
1724
            }),
1725
            None,
1726
        )),
1727
        Err(e) => Ok(back(&owner, &name, number, "conversation", None, Some(format!("Not asked: {e}.")))),
1728
    }
1729
}
1730
1731
/// The assistants a repository may use, by name.
1732
async fn assistant_names(app: &Shared, row: &db::repos::RepoRow) -> Vec<String> {
1733
    crate::assistants::enabled_for_repo(&app.db, row).await.unwrap_or_default().into_iter().map(|a| a.name).collect()
1734
}
1735
1736
/// The changes and the file diffs a proposal from `source` into `target`
1737
/// would carry.
1738
async fn preview_diff(
1739
    app: &Shared,
1740
    repo: &RepoName,
1741
    target: &str,
1742
    source: &str,
1743
) -> Result<(Vec<ChangeView>, Vec<oxy_core::repo::FileDiff>), crate::repos::RepoError> {
1744
    let Some((fork, bookmark)) = parse_source(app, repo, source) else { return Ok((vec![], vec![])) };
1745
    let target = target.to_string();
1746
    let fork_dir = fork.as_ref().map(|f| app.repos.dir(f));
1747
    app.repos
1748
        .read(repo, move |r, cache| {
1749
            let projection = match &fork_dir {
1750
                Some(dir) => {
1751
                    let fork_repo = oxy_core::repo::Repo::open(dir)?;
1752
                    let heads = fork_repo.bookmarks()?.into_iter().find(|b| b.name == bookmark).map(|b| b.heads).unwrap_or_default();
1753
                    pl::project(r, cache, &target, Source::Fork { fork: &fork_repo, heads })?
1754
                }
1755
                None => {
1756
                    let heads = r.bookmarks()?.into_iter().find(|b| b.name == bookmark).map(|b| b.heads).unwrap_or_default();
1757
                    pl::project(r, cache, &target, Source::Bookmark(heads))?
1758
                }
1759
            };
1760
            Ok((projection.changes, projection.files))
1761
        })
1762
        .await
1763
}
1764
1765
/// `POST /{owner}/{name}/proposals/new/draft`: an assistant drafts the
1766
/// description from the changes the proposal would add; the form comes
1767
/// back with the draft to edit (hub spec §13.4).
1768
pub async fn new_draft(
1769
    State(app): State<Shared>,
1770
    viewer: Viewer,
1771
    Path((owner, name)): Path<(String, String)>,
1772
    Form(f): Form<NewForm>,
1773
) -> Result<Page<NewProposalPage>, Error> {
1774
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposals/new"), &viewer);
1775
    let me = require(&viewer, &shell)?;
1776
    csrf(&viewer, &f.csrf_token, &shell)?;
1777
    let (repo, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
1778
    super::writable(&row, &shell)?;
1779
    let bookmarks =
1780
        app.repos.read(&repo, |r, _| Ok(r.bookmarks()?.into_iter().map(|b| b.name).collect::<Vec<_>>())).await.unwrap_or_default();
1781
    let (preview, conflicted) = preview_for(&app, &repo, &f.target, &f.source).await.unwrap_or((vec![], false));
1782
    let assistants = if preview.is_empty() { vec![] } else { assistant_names(&app, &row).await };
1783
    let mut page = NewProposalPage {
1784
        shell,
1785
        repo: RepoShell::new(&app, &row, "proposals").with_role(role),
1786
        bookmarks,
1787
        source: f.source.clone(),
1788
        target: f.target.clone(),
1789
        error: None,
1790
        preview,
1791
        conflicted,
1792
        title: f.title.clone(),
1793
        body: f.body.clone(),
1794
        assistants,
1795
    };
1796
    let assistant = crate::assistants::enabled_for_repo(&app.db, &row)
1797
        .await
1798
        .unwrap_or_default()
1799
        .into_iter()
1800
        .find(|a| a.name.eq_ignore_ascii_case(f.assistant.trim()));
1801
    let Some(a) = assistant else {
1802
        page.error = Some(format!("No assistant called {} here.", f.assistant.trim()));
1803
        return Ok(Page(page));
1804
    };
1805
    if page.preview.is_empty() {
1806
        page.error = Some("Nothing to describe: the source adds nothing to the target.".into());
1807
        return Ok(Page(page));
1808
    }
1809
    let (changes, diffs) = match preview_diff(&app, &repo, &f.target, &f.source).await {
1810
        Ok(x) => x,
1811
        Err(e) => {
1812
            page.error = Some(e.to_string());
1813
            return Ok(Page(page));
1814
        }
1815
    };
1816
    let d = crate::assistants::Draft { slot: -row.id, title: &f.title, target: &f.target, changes: &changes, diffs: &diffs };
1817
    match crate::assistants::draft_description(&app, &row, &me.account, &a, d).await {
1818
        Ok(text) => page.body = text,
1819
        Err(why) => page.error = Some(format!("{} did not answer: {why}.", a.name)),
1820
    }
1821
    Ok(Page(page))
1822
}
1823
1824
#[derive(Deserialize)]
1825
pub struct DraftForm {
1826
    #[serde(rename = "_csrf")]
1827
    csrf_token: String,
1828
    assistant: String,
1829
    #[serde(default)]
1830
    title: String,
1831
}
1832
1833
/// `POST /{owner}/{name}/proposal/{number}/draft`: an assistant drafts the
1834
/// description of an open proposal from its changes; the editor opens
1835
/// with the draft, nothing is saved (hub spec §13.4).
1836
pub async fn draft(
1837
    State(app): State<Shared>,
1838
    viewer: Viewer,
1839
    Path((owner, name, number)): Path<(String, String, i64)>,
1840
    Form(f): Form<DraftForm>,
1841
) -> Result<Response, Error> {
1842
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
1843
    let me = require(&viewer, &shell)?;
1844
    csrf(&viewer, &f.csrf_token, &shell)?;
1845
    let (repo, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
1846
    super::writable(&row, &shell)?;
1847
    let p = pdb::get(&app.db, row.id, number)
1848
        .await
1849
        .map_err(|e| Error::from_db(shell.clone(), e))?
1850
        .ok_or_else(|| Error::not_found(shell.clone()))?;
1851
    if Some(me.account.id) != p.author_id && role < Role::Maintain {
1852
        return Err(Error::not_found(shell));
1853
    }
1854
    let Some(a) = crate::assistants::enabled_for_repo(&app.db, &row)
1855
        .await
1856
        .map_err(|e| Error::from_db(shell.clone(), e))?
1857
        .into_iter()
1858
        .find(|a| a.name.eq_ignore_ascii_case(f.assistant.trim()))
1859
    else {
1860
        return Ok(back(&owner, &name, number, "conversation", None, Some(format!("No assistant called {} here.", f.assistant.trim()))));
1861
    };
1862
    let loaded = crate::web::proposals::load(&app, &repo, p.clone()).await.map_err(|e| Error::from_repo(shell.clone(), e))?;
1863
    let title = if f.title.trim().is_empty() { p.title.clone() } else { f.title.clone() };
1864
    let d = crate::assistants::Draft { slot: p.id, title: &title, target: &p.target, changes: &loaded.changes, diffs: &loaded.diffs };
1865
    let draft = crate::assistants::draft_description(&app, &row, &me.account, &a, d).await;
1866
    match draft {
1867
        Ok(text) => {
1868
            let mut page = detail(&app, shell, &viewer, &owner, &name, number, "conversation".into(), None, None).await?;
1869
            page.0.draft = Some(text);
1870
            Ok(page.into_response())
1871
        }
1872
        Err(why) => Ok(back(&owner, &name, number, "conversation", None, Some(format!("{} did not answer: {why}.", a.name)))),
1873
    }
1874
}
1875
1876
/// A draft being written, as server-sent events for the page: `part` with
1877
/// each piece of text, then `done` with the whole draft or `error` with
1878
/// why there is none (each a JSON string). The response starts at once, so
1879
/// a draft that takes minutes is not cut off by a proxy waiting for it
1880
/// (oxygenhub#248).
1881
type DraftEvents = axum::response::Sse<
1882
    axum::response::sse::KeepAliveStream<
1883
        tokio_stream::wrappers::ReceiverStream<Result<axum::response::sse::Event, std::convert::Infallible>>,
1884
    >,
1885
>;
1886
1887
fn draft_events(rx: tokio::sync::mpsc::Receiver<Result<axum::response::sse::Event, std::convert::Infallible>>) -> DraftEvents {
1888
    axum::response::Sse::new(tokio_stream::wrappers::ReceiverStream::new(rx))
1889
        .keep_alive(axum::response::sse::KeepAlive::new().interval(std::time::Duration::from_secs(15)))
1890
}
1891
1892
fn draft_event(kind: &str, text: &str) -> Result<axum::response::sse::Event, std::convert::Infallible> {
1893
    Ok(axum::response::sse::Event::default().event(kind).data(serde_json::to_string(text).unwrap_or_default()))
1894
}
1895
1896
/// Only an error, for a draft that cannot start.
1897
fn draft_refused(why: String) -> DraftEvents {
1898
    let (tx, rx) = tokio::sync::mpsc::channel(1);
1899
    let _ = tx.try_send(draft_event("error", &why));
1900
    draft_events(rx)
1901
}
1902
1903
/// What a draft is written from, owned so a task of its own can have it.
1904
struct DraftJob {
1905
    row: db::repos::RepoRow,
1906
    by: accounts::Account,
1907
    a: crate::assistants::Assistant,
1908
    slot: i64,
1909
    title: String,
1910
    target: String,
1911
    changes: Vec<ChangeView>,
1912
    diffs: Vec<oxy_core::repo::FileDiff>,
1913
}
1914
1915
/// Write the draft in a task of its own, its parts to the page.
1916
fn draft_in_background(app: Shared, job: DraftJob) -> DraftEvents {
1917
    let (tx, rx) = tokio::sync::mpsc::channel(64);
1918
    tokio::spawn(async move {
1919
        let DraftJob { row, by, a, slot, title, target, changes, diffs } = job;
1920
        let d = crate::assistants::Draft { slot, title: &title, target: &target, changes: &changes, diffs: &diffs };
1921
        let parts = tx.clone();
1922
        let result = crate::assistants::draft_description_streaming(&app, &row, &by, &a, d, move |p: &str| {
1923
            // A page that went away stops nothing: the draft finishes.
1924
            let _ = parts.try_send(draft_event("part", p));
1925
        })
1926
        .await;
1927
        let last = match result {
1928
            Ok(text) => draft_event("done", text.trim()),
1929
            Err(why) => draft_event("error", &format!("{} did not answer: {why}.", a.name)),
1930
        };
1931
        let _ = tx.send(last).await;
1932
    });
1933
    draft_events(rx)
1934
}
1935
1936
/// `POST /{owner}/{name}/proposal/{number}/draft/stream`: [`draft`], with
1937
/// the draft streamed to the page as it is written.
1938
pub async fn draft_stream(
1939
    State(app): State<Shared>,
1940
    viewer: Viewer,
1941
    Path((owner, name, number)): Path<(String, String, i64)>,
1942
    Form(f): Form<DraftForm>,
1943
) -> Result<DraftEvents, Error> {
1944
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposal/{number}"), &viewer);
1945
    let me = require(&viewer, &shell)?;
1946
    csrf(&viewer, &f.csrf_token, &shell)?;
1947
    let (repo, row, role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
1948
    super::writable(&row, &shell)?;
1949
    let p = pdb::get(&app.db, row.id, number)
1950
        .await
1951
        .map_err(|e| Error::from_db(shell.clone(), e))?
1952
        .ok_or_else(|| Error::not_found(shell.clone()))?;
1953
    if Some(me.account.id) != p.author_id && role < Role::Maintain {
1954
        return Err(Error::not_found(shell));
1955
    }
1956
    let Some(a) = crate::assistants::enabled_for_repo(&app.db, &row)
1957
        .await
1958
        .map_err(|e| Error::from_db(shell.clone(), e))?
1959
        .into_iter()
1960
        .find(|a| a.name.eq_ignore_ascii_case(f.assistant.trim()))
1961
    else {
1962
        return Ok(draft_refused(format!("No assistant called {} here.", f.assistant.trim())));
1963
    };
1964
    let loaded = load(&app, &repo, p.clone()).await.map_err(|e| Error::from_repo(shell.clone(), e))?;
1965
    let title = if f.title.trim().is_empty() { p.title.clone() } else { f.title.clone() };
1966
    let job = DraftJob {
1967
        row,
1968
        by: me.account.clone(),
1969
        a,
1970
        slot: p.id,
1971
        title,
1972
        target: p.target.clone(),
1973
        changes: loaded.changes,
1974
        diffs: loaded.diffs,
1975
    };
1976
    Ok(draft_in_background(app.clone(), job))
1977
}
1978
1979
/// `POST /{owner}/{name}/proposals/new/draft/stream`: [`new_draft`], with
1980
/// the draft streamed to the page as it is written.
1981
pub async fn new_draft_stream(
1982
    State(app): State<Shared>,
1983
    viewer: Viewer,
1984
    Path((owner, name)): Path<(String, String)>,
1985
    Form(f): Form<NewForm>,
1986
) -> Result<DraftEvents, Error> {
1987
    let shell = Shell::new(&app, &format!("/{owner}/{name}/proposals/new"), &viewer);
1988
    let me = require(&viewer, &shell)?;
1989
    csrf(&viewer, &f.csrf_token, &shell)?;
1990
    let (repo, row, _role) = lookup(&app, &shell, &viewer, &owner, &name).await?;
1991
    super::writable(&row, &shell)?;
1992
    let Some(a) = crate::assistants::enabled_for_repo(&app.db, &row)
1993
        .await
1994
        .unwrap_or_default()
1995
        .into_iter()
1996
        .find(|a| a.name.eq_ignore_ascii_case(f.assistant.trim()))
1997
    else {
1998
        return Ok(draft_refused(format!("No assistant called {} here.", f.assistant.trim())));
1999
    };
2000
    let (changes, diffs) = match preview_diff(&app, &repo, &f.target, &f.source).await {
2001
        Ok(x) => x,
2002
        Err(e) => return Ok(draft_refused(e.to_string())),
2003
    };
2004
    if changes.is_empty() {
2005
        return Ok(draft_refused("Nothing to describe: the source adds nothing to the target.".into()));
2006
    }
2007
    let job = DraftJob { slot: -row.id, row, by: me.account.clone(), a, title: f.title.clone(), target: f.target.clone(), changes, diffs };
2008
    Ok(draft_in_background(app.clone(), job))
2009
}