OXYGENHUB
# d4792b4a4629 oxygenhub / crates / hub / src / api / mod.rs
87.7 KiB · Rust · last changed Milestones over the API, and oh milestone 1 month ago source blame history raw
b64e2537 Andy McCall ↶ 1
//! The JSON API (hub spec §12.1) under `/api/v1`: bearer tokens, RFC 7807
2
//! problems, the same shapes as `oxy --json` where one exists. Reads need
3
//! `repo:read` (anonymous for public repositories); writes the scope named
4
//! on each handler.
d23464c0 Andy McCall ↶ 5
b64e2537 Andy McCall ↶ 6
use crate::auth::{self, Access, Role};
7
use crate::db::{self, accounts::Account};
d23464c0 Andy McCall ↶ 8
use crate::repos::{view, RepoError, RepoName};
b64e2537 Andy McCall ↶ 9
use crate::Shared;
10
use axum::extract::{Path, Query, State};
11
use axum::http::{HeaderMap, StatusCode};
d23464c0 Andy McCall ↶ 12
use axum::response::{IntoResponse, Response};
b64e2537 Andy McCall ↶ 13
use axum::routing::{get, post};
d23464c0 Andy McCall ↶ 14
use axum::{Json, Router};
b64e2537 Andy McCall ↶ 15
use hub_api::*;
16
use serde::Deserialize;
d23464c0 Andy McCall ↶ 17
df71c789 Andy McCall ↶ 18
pub mod device;
ef20fdc1 Andy McCall ↶ 19
mod projects;
20
90326c96 Andy McCall ↶ 21
/// Any other path under `/api/v1`: a problem document, not the site's page.
e9bfea8e Andy McCall ↶ 22
/// `GET /api/v1/version`: the hub's version and build, and the Oxygen and
23
/// OxygenFlow library versions it is built on.
24
async fn version() -> Json<serde_json::Value> {
25
    Json(crate::web::home::versions())
26
}
27
90326c96 Andy McCall ↶ 28
async fn no_route() -> ApiError {
29
    ApiError(StatusCode::NOT_FOUND, "no such API route".into())
30
}
31
5533e91a Andy McCall ↶ 32
/// The API, with release assets up to `asset_limit` bytes (the web form's
33
/// limit too; axum's default of 2 MiB refused ordinary builds).
34
pub fn router(asset_limit: usize) -> Router<Shared> {
d23464c0 Andy McCall ↶ 35
    Router::new()
90326c96 Andy McCall ↶ 36
        .fallback(no_route)
42fa9554 Andy McCall ↶ 37
        .route("/flow/claim", post(crate::flow::claim))
b6b7e4cf Andy McCall ↶ 38
        .route("/flow/runners/register", post(crate::flow::register))
42fa9554 Andy McCall ↶ 39
        .route("/flow/jobs/{id}/log", post(crate::flow::log))
40
        .route("/flow/jobs/{id}/finish", post(crate::flow::finish))
a3c8288b Andy McCall ↶ 41
        .route(
42
            "/flow/jobs/{id}/artifacts/{name}",
43
            post(crate::flow::artifact).layer(axum::extract::DefaultBodyLimit::max(crate::flow::MAX_ARTIFACT_BYTES + (1 << 20))),
44
        )
ef20fdc1 Andy McCall ↶ 45
        .route("/projects/{owner}", get(projects::list).post(projects::create))
46
        .route("/projects/{owner}/{number}", get(projects::board).patch(projects::edit))
47
        .route("/projects/{owner}/{number}/cards", post(projects::add_card))
48
        .route("/projects/{owner}/{number}/cards/{id}", axum::routing::patch(projects::move_card).delete(projects::remove_card))
df71c789 Andy McCall ↶ 49
        .route("/device/code", post(device::code))
50
        .route("/device/token", post(device::token))
b66e70b7 Andy McCall ↶ 51
        .route("/runners", get(runners))
52
        .route("/runners/queue", get(runner_queue))
53
        .route("/runners/{id}/jobs", get(runner_jobs))
b64e2537 Andy McCall ↶ 54
        .route("/user", get(me))
60f11b71 Andy McCall ↶ 55
        .route("/user/token", axum::routing::delete(revoke_own_token))
e9bfea8e Andy McCall ↶ 56
        .route("/version", get(version))
42a0ba4b Andy McCall ↶ 57
        .route("/notifications", get(notifications))
58
        .route("/notifications/read", post(notifications_read_all))
59
        .route("/notifications/{id}/read", post(notification_read))
b64e2537 Andy McCall ↶ 60
        .route("/users/{name}", get(user))
61
        .route("/orgs/{name}", get(org))
62
        .route("/search", get(search))
63
        .route("/repos", get(list_repos).post(create_repo))
d23464c0 Andy McCall ↶ 64
        .route("/repos/{owner}/{name}", get(get_repo))
65
        .route("/repos/{owner}/{name}/bookmarks", get(bookmarks))
66
        .route("/repos/{owner}/{name}/tags", get(tags))
b64e2537 Andy McCall ↶ 67
        .route("/repos/{owner}/{name}/history/{r}", get(history))
68
        .route("/repos/{owner}/{name}/changes/{hash}", get(change))
69
        .route("/repos/{owner}/{name}/tree/{r}", get(tree_root))
70
        .route("/repos/{owner}/{name}/tree/{r}/{*path}", get(tree))
71
        .route("/repos/{owner}/{name}/file/{r}/{*path}", get(file))
72
        .route("/repos/{owner}/{name}/blame/{r}/{*path}", get(blame))
73
        .route("/repos/{owner}/{name}/conflicts", get(conflicts))
74
        .route("/repos/{owner}/{name}/trust", get(trust))
df940d75 Andy McCall ↶ 75
        .route("/repos/{owner}/{name}/releases/trust/{*tag}", get(release_trust))
b64e2537 Andy McCall ↶ 76
        .route("/repos/{owner}/{name}/pushes", get(pushes))
77
        .route("/repos/{owner}/{name}/proposals", get(proposals).post(create_proposal))
739a763a Andy McCall ↶ 78
        .route("/repos/{owner}/{name}/proposals/{number}", get(proposal).patch(edit_proposal))
1f1eb06a Andy McCall ↶ 79
        .route("/repos/{owner}/{name}/proposals/{number}/land", post(land_proposal))
b64e2537 Andy McCall ↶ 80
        .route("/repos/{owner}/{name}/proposals/{number}/comments", get(proposal_comments).post(proposal_comment))
81
        .route("/repos/{owner}/{name}/proposals/{number}/reviews", get(proposal_reviews).post(proposal_review))
cc1cd197 Andy McCall ↶ 82
        .route("/repos/{owner}/{name}/proposals/{number}/reviewers", post(request_reviewers))
83
        .route("/repos/{owner}/{name}/proposals/{number}/reviewers/{username}", axum::routing::delete(withdraw_reviewer))
b64e2537 Andy McCall ↶ 84
        .route("/repos/{owner}/{name}/proposals/{number}/checks", get(proposal_checks))
3f02e5ea Andy McCall ↶ 85
        .route("/repos/{owner}/{name}/proposals/{number}/files", get(proposal_files))
86
        .route("/repos/{owner}/{name}/proposals/{number}/content/{side}/{*path}", get(proposal_content))
b64e2537 Andy McCall ↶ 87
        .route("/repos/{owner}/{name}/issues", get(issues).post(create_issue))
76f262e1 Andy McCall ↶ 88
        .route("/repos/{owner}/{name}/issues/{number}", get(issue).post(issue_state).patch(issue_edit))
b64e2537 Andy McCall ↶ 89
        .route("/repos/{owner}/{name}/issues/{number}/comments", get(issue_comments).post(issue_comment))
76f262e1 Andy McCall ↶ 90
        .route("/repos/{owner}/{name}/labels", get(labels).post(create_label))
91
        .route("/repos/{owner}/{name}/labels/{label}", axum::routing::delete(delete_label))
5ea4872f Andy McCall ↶ 92
        .route("/repos/{owner}/{name}/milestones", get(milestones).post(create_milestone))
93
        .route("/repos/{owner}/{name}/milestones/{title}", axum::routing::patch(edit_milestone))
b64e2537 Andy McCall ↶ 94
        .route("/repos/{owner}/{name}/hooks", get(hooks).post(create_hook))
95
        .route("/repos/{owner}/{name}/hooks/{id}/delete", post(delete_hook))
96
        .route("/repos/{owner}/{name}/checks", post(post_check))
90326c96 Andy McCall ↶ 97
        .route("/repos/{owner}/{name}/flow/runs", get(flow_runs).post(start_flow_run))
98
        .route("/repos/{owner}/{name}/flow/runs/{number}", get(flow_run))
99
        .route("/repos/{owner}/{name}/flow/runs/{number}/jobs/{job}/log", get(flow_job_log))
1edac4b6 Andy McCall ↶ 100
        .route("/repos/{owner}/{name}/flow/runs/{number}/rerun", post(rerun_flow_run))
745d225d Andy McCall ↶ 101
        .route("/repos/{owner}/{name}/flow/runs/{number}/cancel", post(cancel_flow_run))
961c10be Andy McCall ↶ 102
        .route("/repos/{owner}/{name}/checks/required", get(required_checks).put(set_required_checks))
b64e2537 Andy McCall ↶ 103
        .route("/repos/{owner}/{name}/checks/{state}", get(checks_for_state))
3f4b0ea6 Andy McCall ↶ 104
        .route("/repos/{owner}/{name}/releases", get(releases).post(create_release))
ced6d3af Andy McCall ↶ 105
        .route("/repos/{owner}/{name}/releases/{tag}", axum::routing::patch(edit_release))
5533e91a Andy McCall ↶ 106
        .route(
107
            "/repos/{owner}/{name}/releases/{tag}/assets",
108
            post(upload_asset).layer(axum::extract::DefaultBodyLimit::max(asset_limit + (1 << 20))),
109
        )
3f4b0ea6 Andy McCall ↶ 110
}
111
112
async fn releases(
113
    State(app): State<Shared>,
114
    headers: HeaderMap,
115
    Path((owner, name)): Path<(String, String)>,
116
) -> Result<Json<Vec<Release>>, ApiError> {
117
    let c = caller(&app, &headers).await?;
118
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
119
    Ok(Json(crate::web::releases::api_views(&app, &repo, &row).await?))
120
}
121
122
async fn create_release(
123
    State(app): State<Shared>,
124
    headers: HeaderMap,
125
    Path((owner, name)): Path<(String, String)>,
126
    Json(body): Json<NewRelease>,
127
) -> Result<(StatusCode, Json<Release>), ApiError> {
128
    let c = caller(&app, &headers).await?;
129
    let me = c.require("repo:write")?.clone();
130
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
131
    crate::web::releases::create_release(&app, &repo, &row, &me, &body.tag, &body.title, body.notes, body.prerelease)
132
        .await
133
        .map_err(|m| ApiError(StatusCode::BAD_REQUEST, m))?;
134
    let r = crate::web::releases::api_views(&app, &repo, &row)
135
        .await?
136
        .into_iter()
137
        .find(|r| r.tag == body.tag)
138
        .ok_or_else(|| not_found("no such release"))?;
139
    Ok((StatusCode::CREATED, Json(r)))
140
}
141
ced6d3af Andy McCall ↶ 142
/// `PATCH …/releases/{tag}` (oxygenhub#72): change a release's title,
143
/// notes or prerelease flag, as the release page's Edit does.
144
async fn edit_release(
145
    State(app): State<Shared>,
146
    headers: HeaderMap,
147
    Path((owner, name, tag)): Path<(String, String, String)>,
148
    Json(body): Json<ReleaseEdit>,
149
) -> Result<Json<Release>, ApiError> {
150
    let c = caller(&app, &headers).await?;
151
    let me = c.require("repo:write")?.clone();
152
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
153
    let r = db::releases::get(&app.db, row.id, &tag).await?.ok_or_else(|| not_found("no such release"))?;
154
    let title = body.title.as_deref().map(str::trim).filter(|t| !t.is_empty()).unwrap_or(&r.title);
155
    let notes = body.notes.as_deref().map(str::trim).unwrap_or(&r.notes);
156
    db::releases::edit(&app.db, r.id, title, notes, body.prerelease.unwrap_or(r.prerelease)).await?;
157
    db::accounts::audit(&app.db, Some(&me), "release.edited", &format!("{owner}/{name}@{tag}"), "").await.ok();
158
    let r = crate::web::releases::api_views(&app, &repo, &row)
159
        .await?
160
        .into_iter()
161
        .find(|r| r.tag == tag)
162
        .ok_or_else(|| not_found("no such release"))?;
163
    Ok(Json(r))
164
}
165
3f4b0ea6 Andy McCall ↶ 166
#[derive(Deserialize)]
167
struct AssetQuery {
168
    name: String,
de505df5 Andy McCall ↶ 169
}
170
3f4b0ea6 Andy McCall ↶ 171
/// `POST …/releases/{tag}/assets?name=file.tar.gz` with the file as the body.
172
async fn upload_asset(
173
    State(app): State<Shared>,
174
    headers: HeaderMap,
175
    Path((owner, name, tag)): Path<(String, String, String)>,
176
    Query(q): Query<AssetQuery>,
177
    body: axum::body::Bytes,
178
) -> Result<(StatusCode, Json<Release>), ApiError> {
179
    let c = caller(&app, &headers).await?;
180
    c.require("repo:write")?;
181
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
182
    let r = db::releases::get(&app.db, row.id, &tag).await?.ok_or_else(|| not_found("no such release"))?;
183
    let ct = headers.get(axum::http::header::CONTENT_TYPE).and_then(|v| v.to_str().ok()).unwrap_or("application/octet-stream").to_string();
184
    crate::web::releases::store_asset(&app, r.id, &q.name, &ct, &body).await.map_err(|m| ApiError(StatusCode::BAD_REQUEST, m))?;
185
    let r = crate::web::releases::api_views(&app, &repo, &row)
186
        .await?
187
        .into_iter()
188
        .find(|r| r.tag == tag)
189
        .ok_or_else(|| not_found("no such release"))?;
190
    Ok((StatusCode::CREATED, Json(r)))
191
}
192
42fa9554 Andy McCall ↶ 193
pub struct ApiError(pub StatusCode, pub String);
b64e2537 Andy McCall ↶ 194
195
impl IntoResponse for ApiError {
196
    fn into_response(self) -> Response {
197
        let body = Problem { status: self.0.as_u16(), title: self.0.canonical_reason().unwrap_or("error").into(), detail: self.1 };
198
        (self.0, [("content-type", "application/problem+json")], Json(body)).into_response()
de505df5 Andy McCall ↶ 199
    }
b64e2537 Andy McCall ↶ 200
}
201
202
impl From<RepoError> for ApiError {
203
    fn from(e: RepoError) -> ApiError {
204
        match e {
205
            RepoError::NotFound => not_found("no such repository"),
206
            RepoError::Oxy(oxy_core::repo::RepoError::Msg(m)) => ApiError(StatusCode::NOT_FOUND, m),
207
            other => ApiError(StatusCode::INTERNAL_SERVER_ERROR, other.to_string()),
208
        }
209
    }
210
}
211
212
impl From<sqlx::Error> for ApiError {
213
    fn from(e: sqlx::Error) -> ApiError {
214
        ApiError(StatusCode::INTERNAL_SERVER_ERROR, e.to_string())
215
    }
216
}
217
ef20fdc1 Andy McCall ↶ 218
pub(crate) fn not_found(what: &str) -> ApiError {
b64e2537 Andy McCall ↶ 219
    ApiError(StatusCode::NOT_FOUND, what.into())
220
}
221
ef20fdc1 Andy McCall ↶ 222
pub(crate) fn forbidden(what: &str) -> ApiError {
b64e2537 Andy McCall ↶ 223
    ApiError(StatusCode::FORBIDDEN, what.into())
224
}
225
60f11b71 Andy McCall ↶ 226
/// The address a request came from: the client's, as the proxy reports
227
/// it when the hub is behind one (`server.behind_proxy`), else the peer's.
228
/// Only an address's characters are kept, so it is safe to show.
229
pub fn client_addr(app: &Shared, headers: &HeaderMap, extensions: &axum::http::Extensions) -> String {
230
    let from_proxy = || {
231
        ["cf-connecting-ip", "x-forwarded-for", "x-real-ip"]
232
            .iter()
233
            .find_map(|h| headers.get(*h).and_then(|v| v.to_str().ok()).and_then(|v| v.split(',').next()).map(|v| v.trim().to_string()))
234
    };
235
    let addr = if app.config.server.behind_proxy {
236
        from_proxy()
237
    } else {
238
        extensions.get::<axum::extract::ConnectInfo<std::net::SocketAddr>>().map(|c| c.0.ip().to_string())
239
    };
240
    addr.map(|a| a.chars().filter(|c| c.is_ascii_hexdigit() || matches!(c, '.' | ':')).take(45).collect()).unwrap_or_default()
241
}
242
243
/// `DELETE /api/v1/user/token`: revoke the token this request is made
244
/// with, as `oxy auth logout` does.
245
async fn revoke_own_token(State(app): State<Shared>, headers: HeaderMap) -> Result<StatusCode, ApiError> {
246
    let c = caller(&app, &headers).await?;
247
    let (Some(account), Some(id)) = (c.account.as_ref(), c.token_id) else {
248
        return Err(ApiError(StatusCode::UNAUTHORIZED, "revoking needs the personal access token to revoke".into()));
249
    };
250
    db::accounts::delete_token(&app.db, account.id, id).await?;
251
    db::accounts::audit(&app.db, Some(account), "token.revoke", &c.token, "").await.ok();
252
    Ok(StatusCode::NO_CONTENT)
253
}
254
b64e2537 Andy McCall ↶ 255
/// Who calls: the account behind a bearer token, with the token's scopes.
256
pub struct Caller {
257
    pub account: Option<Account>,
258
    pub scopes: Vec<String>,
259
    pub site: bool,
0b20f1ec Andy McCall ↶ 260
    /// The token's name, for records of what a call did.
261
    pub token: String,
60f11b71 Andy McCall ↶ 262
    /// The personal access token's id, when one is used.
263
    pub token_id: Option<i64>,
b64e2537 Andy McCall ↶ 264
}
265
266
impl Caller {
267
    fn has(&self, scope: &str) -> bool {
268
        self.site
269
            || self.scopes.iter().any(|s| {
270
                s == scope
271
                    || (scope == "repo:read" && (s == "repo:write" || s == "repo:admin"))
272
                    || (scope == "repo:write" && s == "repo:admin")
273
            })
274
    }
275
276
    fn require(&self, scope: &str) -> Result<&Account, ApiError> {
277
        if !self.has(scope) {
278
            return Err(forbidden(&format!("this token lacks the {scope} scope")));
279
        }
280
        self.account.as_ref().ok_or_else(|| ApiError(StatusCode::UNAUTHORIZED, "a personal access token is required".into()))
281
    }
282
}
283
284
pub async fn caller(app: &Shared, headers: &HeaderMap) -> Result<Caller, ApiError> {
0b20f1ec Andy McCall ↶ 285
    let Some(t) = oxy_server::bearer_token(headers) else {
60f11b71 Andy McCall ↶ 286
        return Ok(Caller { account: None, scopes: vec![], site: false, token: String::new(), token_id: None });
0b20f1ec Andy McCall ↶ 287
    };
b64e2537 Andy McCall ↶ 288
    if app.config.auth.push_tokens.iter().any(|x| auth::mac_equal(x, t)) {
289
        let admin = db::accounts::accounts(&app.db).await?.into_iter().find(|a| a.is_admin);
0b20f1ec Andy McCall ↶ 290
        return Ok(Caller {
291
            account: admin,
292
            scopes: vec!["repo:admin".into(), "user:read".into(), "checks:write".into()],
293
            site: true,
294
            token: "site token".into(),
60f11b71 Andy McCall ↶ 295
            token_id: None,
0b20f1ec Andy McCall ↶ 296
        });
b64e2537 Andy McCall ↶ 297
    }
298
    let token = db::accounts::token_by_hash(&app.db, &auth::token_hash(t)).await?;
de505df5 Andy McCall ↶ 299
    match token {
b64e2537 Andy McCall ↶ 300
        Some(tok) if !tok.expired(db::now_ms()) => {
6a178055 Andy McCall ↶ 301
            let account = db::accounts::account_by_id(&app.db, tok.account_id).await?.filter(|a| !a.blocked());
b64e2537 Andy McCall ↶ 302
            db::accounts::touch_token(&app.db, tok.id).await.ok();
60f11b71 Andy McCall ↶ 303
            Ok(Caller {
304
                account,
305
                scopes: tok.scope_list().iter().map(|s| s.to_string()).collect(),
306
                site: false,
307
                token: tok.name.clone(),
308
                token_id: Some(tok.id),
309
            })
b64e2537 Andy McCall ↶ 310
        }
de505df5 Andy McCall ↶ 311
        _ => Err(ApiError(StatusCode::UNAUTHORIZED, "unknown or expired token".into())),
312
    }
313
}
314
b64e2537 Andy McCall ↶ 315
fn repository(app: &Shared, r: &db::repos::RepoRow) -> Repository {
316
    Repository {
317
        owner: r.owner.clone(),
318
        name: r.name.clone(),
319
        description: r.description.clone(),
320
        default_bookmark: r.default_bookmark.clone(),
321
        visibility: r.visibility(),
322
        created_ms: r.created_ms,
323
        updated_ms: r.updated_ms,
324
        clone_url: format!("{}/{}/{}", app.config.base_url(), r.owner, r.name),
325
    }
326
}
327
328
/// A repository the caller may reach with `access`, else 404.
329
async fn reach(
de505df5 Andy McCall ↶ 330
    app: &Shared,
b64e2537 Andy McCall ↶ 331
    c: &Caller,
de505df5 Andy McCall ↶ 332
    owner: &str,
333
    name: &str,
b64e2537 Andy McCall ↶ 334
    access: Access,
335
) -> Result<(RepoName, db::repos::RepoRow, Role), ApiError> {
336
    let repo = RepoName::new(owner, name).ok_or_else(|| not_found("no such repository"))?;
337
    let row = db::repos::get(&app.db, owner, name).await?.ok_or_else(|| not_found("no such repository"))?;
338
    let role = auth::roles::role_for(&app.db, c.account.as_ref(), &row).await?;
339
    if !auth::roles::allows(role, access) {
340
        return Err(not_found("no such repository"));
341
    }
342
    Ok((repo, row, role.unwrap_or(Role::Read)))
343
}
344
345
fn summary(c: &view::ChangeView) -> ChangeSummary {
346
    ChangeSummary {
347
        hash: c.hash.clone(),
348
        message: if c.body.is_empty() { c.title.clone() } else { format!("{}\n\n{}", c.title, c.body) },
349
        author: Author {
350
            name: c.author.name.clone(),
351
            email: c.author.email.clone(),
352
            key: c.author.key.clone(),
353
            account: c.author.account.clone(),
760a7dd3 Andy McCall ↶ 354
            note: Author::note_for(&c.author.key, &c.author.account),
b64e2537 Andy McCall ↶ 355
        },
356
        when_ms: c.when_ms,
357
        deps: c.deps.clone(),
358
        head: c.head,
359
        signature: match &c.signature {
360
            view::SigView::Unsigned => Signature::Unsigned,
361
            view::SigView::Valid { key, sealed, revoked, .. } => Signature::Valid { key: key.clone(), sealed: *sealed, revoked: *revoked },
362
            view::SigView::Invalid(why) => Signature::Invalid { reason: why.clone() },
363
        },
364
    }
365
}
366
367
// ---------------------------------------------------------------- accounts
368
369
async fn me(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<User>, ApiError> {
370
    let c = caller(&app, &headers).await?;
371
    let a = c.require("user:read")?;
372
    Ok(Json(user_of(&app, a).await?))
373
}
374
42a0ba4b Andy McCall ↶ 375
#[derive(Deserialize)]
376
struct InboxQuery {
377
    #[serde(default)]
378
    limit: Option<i64>,
379
}
380
381
/// The caller's inbox; reading and clearing it needs `user:read`, since
382
/// it touches nothing but the caller's own notifications.
383
async fn notifications(
384
    State(app): State<Shared>,
385
    headers: HeaderMap,
386
    Query(q): Query<InboxQuery>,
387
) -> Result<Json<hub_api::Inbox>, ApiError> {
388
    let c = caller(&app, &headers).await?;
389
    let a = c.require("user:read")?;
390
    let limit = q.limit.unwrap_or(50).clamp(1, 200);
391
    let base = app.config.base_url().trim_end_matches('/').to_string();
392
    let items = db::notify::inbox(&app.db, a.id, limit)
393
        .await?
394
        .into_iter()
395
        .map(|n| hub_api::Notification {
396
            id: n.id,
397
            at_ms: n.at_ms,
398
            kind: n.kind,
399
            title: n.title,
400
            url: if n.url.starts_with('/') { format!("{base}{}", n.url) } else { n.url },
401
            actor: n.actor,
402
            read: n.read,
403
        })
404
        .collect();
405
    Ok(Json(hub_api::Inbox { unread: db::notify::unread(&app.db, a.id).await?, items }))
406
}
407
408
async fn notification_read(State(app): State<Shared>, headers: HeaderMap, Path(id): Path<i64>) -> Result<StatusCode, ApiError> {
409
    let c = caller(&app, &headers).await?;
410
    let a = c.require("user:read")?;
411
    db::notify::mark_read(&app.db, a.id, Some(id)).await?;
412
    Ok(StatusCode::NO_CONTENT)
413
}
414
415
async fn notifications_read_all(State(app): State<Shared>, headers: HeaderMap) -> Result<StatusCode, ApiError> {
416
    let c = caller(&app, &headers).await?;
417
    let a = c.require("user:read")?;
418
    db::notify::mark_read(&app.db, a.id, None).await?;
419
    Ok(StatusCode::NO_CONTENT)
420
}
421
b64e2537 Andy McCall ↶ 422
async fn user_of(app: &Shared, a: &Account) -> Result<User, ApiError> {
423
    let keys = db::accounts::identities_of(&app.db, a.id).await?.into_iter().map(|i| i.key).collect();
424
    Ok(User { username: a.username.clone(), display_name: a.display_name.clone(), is_admin: a.is_admin, keys, created_ms: a.created_ms })
425
}
426
427
async fn user(State(app): State<Shared>, Path(name): Path<String>) -> Result<Json<User>, ApiError> {
428
    let a = db::accounts::account_by_name(&app.db, &name).await?.ok_or_else(|| not_found("no such account"))?;
429
    Ok(Json(user_of(&app, &a).await?))
430
}
431
432
async fn org(State(app): State<Shared>, Path(name): Path<String>) -> Result<Json<Organisation>, ApiError> {
433
    let o = db::accounts::org_by_name(&app.db, &name).await?.ok_or_else(|| not_found("no such organisation"))?;
434
    let members = db::accounts::org_members(&app.db, o.id).await?.into_iter().map(|(a, _)| a.username).collect();
435
    Ok(Json(Organisation { name: o.name, display_name: o.display_name, description: o.description, members }))
436
}
437
438
#[derive(Deserialize)]
439
struct SearchQuery {
440
    q: String,
441
}
442
443
async fn search(
444
    State(app): State<Shared>,
445
    headers: HeaderMap,
446
    Query(q): Query<SearchQuery>,
447
) -> Result<Json<Vec<serde_json::Value>>, ApiError> {
448
    let c = caller(&app, &headers).await?;
449
    let mut out = Vec::new();
450
    for h in db::notify::search(&app.db, &q.q, None, 50).await? {
451
        let Some(row) = db::repos::get_by_id(&app.db, h.repo_id).await? else { continue };
452
        let role = auth::roles::role_for(&app.db, c.account.as_ref(), &row).await?;
453
        if !auth::roles::allows(role, Access::Read) {
454
            continue;
455
        }
456
        out.push(
457
            serde_json::json!({ "kind": h.kind, "repository": row.slug(), "number": h.number, "title": h.title, "snippet": h.snippet }),
458
        );
459
    }
460
    Ok(Json(out))
461
}
462
463
// ------------------------------------------------------------ repositories
464
465
async fn list_repos(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<Vec<Repository>>, ApiError> {
466
    let c = caller(&app, &headers).await?;
467
    let mut out = Vec::new();
468
    for r in db::repos::list(&app.db).await? {
469
        let role = auth::roles::role_for(&app.db, c.account.as_ref(), &r).await?;
470
        if auth::roles::allows(role, Access::Read) {
471
            out.push(repository(&app, &r));
472
        }
de505df5 Andy McCall ↶ 473
    }
b64e2537 Andy McCall ↶ 474
    Ok(Json(out))
475
}
476
477
async fn create_repo(
478
    State(app): State<Shared>,
479
    headers: HeaderMap,
480
    Json(body): Json<NewRepository>,
481
) -> Result<(StatusCode, Json<Repository>), ApiError> {
482
    let c = caller(&app, &headers).await?;
483
    let me = c.require("repo:admin")?;
484
    let name = RepoName::new(&body.owner, &body.name).ok_or_else(|| ApiError(StatusCode::BAD_REQUEST, "invalid owner or name".into()))?;
485
    if !auth::roles::may_create_under(&app.db, me, &name.owner).await? {
486
        return Err(forbidden("you cannot create repositories under that owner"));
487
    }
488
    if db::repos::get(&app.db, &name.owner, &name.name).await?.is_some() || app.repos.exists(&name) {
489
        return Err(ApiError(StatusCode::CONFLICT, "that repository exists".into()));
490
    }
491
    app.repos.create(&name, None)?;
492
    let row = db::repos::create(&app.db, &name.owner, &name.name, &body.description, body.visibility).await?;
493
    db::accounts::audit(&app.db, Some(me), "repo.created", &name.to_string(), "api").await.ok();
494
    Ok((StatusCode::CREATED, Json(repository(&app, &row))))
495
}
496
497
async fn get_repo(
498
    State(app): State<Shared>,
499
    headers: HeaderMap,
500
    Path((owner, name)): Path<(String, String)>,
501
) -> Result<Json<Repository>, ApiError> {
502
    let c = caller(&app, &headers).await?;
503
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
504
    Ok(Json(repository(&app, &row)))
505
}
506
507
async fn bookmarks(
508
    State(app): State<Shared>,
509
    headers: HeaderMap,
510
    Path((owner, name)): Path<(String, String)>,
511
) -> Result<Json<Vec<Bookmark>>, ApiError> {
512
    let c = caller(&app, &headers).await?;
513
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
514
    let default = row.default_bookmark.clone();
515
    let list = app.repos.read(&repo, move |r, cache| view::bookmarks(r, cache, &default)).await?;
516
    Ok(Json(list.into_iter().map(|b| Bookmark { name: b.name, heads: b.heads, changes: b.changes, default: b.default }).collect()))
517
}
518
519
async fn tags(
520
    State(app): State<Shared>,
521
    headers: HeaderMap,
522
    Path((owner, name)): Path<(String, String)>,
523
) -> Result<Json<Vec<Tag>>, ApiError> {
524
    let c = caller(&app, &headers).await?;
525
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
526
    let list = app.repos.read(&repo, |r, _| view::tags(r)).await?;
527
    Ok(Json(list.into_iter().map(|t| Tag { name: t.name, heads: t.heads, message: t.message, signer: t.signer }).collect()))
528
}
529
530
#[derive(Deserialize)]
531
struct HistoryQuery {
532
    path: Option<String>,
533
    offset: Option<usize>,
534
    limit: Option<usize>,
535
}
536
537
async fn history(
538
    State(app): State<Shared>,
539
    headers: HeaderMap,
540
    Path((owner, name, r)): Path<(String, String, String)>,
541
    Query(q): Query<HistoryQuery>,
542
) -> Result<Json<History>, ApiError> {
543
    let c = caller(&app, &headers).await?;
544
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
545
    let (offset, limit) = (q.offset.unwrap_or(0), q.limit.unwrap_or(50).min(500));
546
    let h = app
547
        .repos
548
        .read(&repo, move |repo, cache| {
549
            let target = view::resolve(repo, cache, &r)?;
550
            view::history(repo, cache, target, q.path.as_deref(), offset, limit)
551
        })
552
        .await?;
553
    let mut entries = h.entries;
554
    crate::web::attribute(&app, &mut entries.iter_mut().collect::<Vec<_>>()).await;
555
    Ok(Json(History {
556
        reference: h.target.label,
557
        heads: h.target.heads.iter().map(|x| x.to_hex()).collect(),
558
        total: h.total,
559
        offset: h.offset,
560
        changes: entries.iter().map(summary).collect(),
561
    }))
562
}
563
564
async fn change(
565
    State(app): State<Shared>,
566
    headers: HeaderMap,
567
    Path((owner, name, hash)): Path<(String, String, String)>,
568
) -> Result<Json<ChangeDetail>, ApiError> {
569
    let c = caller(&app, &headers).await?;
570
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
571
    let d = app
572
        .repos
573
        .read(&repo, move |repo, cache| {
574
            let h = view::resolve_change(repo, cache, &hash)?;
575
            view::change(repo, cache, &h)
576
        })
577
        .await?;
578
    let mut v = d.view;
579
    crate::web::attribute(&app, &mut [&mut v]).await;
580
    let files = crate::web::history::render_files(&d.files, &d.bases)
581
        .into_iter()
582
        .map(|f| FileChange { path: f.path, kind: f.kind, from: f.from, added: f.added, removed: f.removed })
583
        .collect();
584
    Ok(Json(ChangeDetail {
585
        body: v.body.clone(),
586
        change: summary(&v),
587
        dependents: d.dependents.iter().map(|x| x.hash.clone()).collect(),
588
        in_bookmarks: d.in_bookmarks,
589
        in_tags: d.in_tags,
590
        files,
591
    }))
592
}
593
594
fn entry(e: &view::Entry) -> TreeEntry {
595
    TreeEntry {
596
        name: e.name.clone(),
597
        path: e.path.clone(),
598
        kind: match e.kind {
599
            view::EntryKind::Dir => "dir",
600
            view::EntryKind::File => "file",
601
            view::EntryKind::Symlink => "symlink",
602
            view::EntryKind::Subrepo => "subrepo",
603
        }
604
        .into(),
605
        exec: e.exec,
606
        size: e.size,
607
        conflicted: e.conflicted,
608
    }
609
}
610
611
async fn tree_root(
612
    State(app): State<Shared>,
613
    headers: HeaderMap,
614
    Path((owner, name, r)): Path<(String, String, String)>,
615
) -> Result<Json<Vec<TreeEntry>>, ApiError> {
616
    tree(State(app), headers, Path((owner, name, r, String::new()))).await
617
}
618
619
async fn tree(
620
    State(app): State<Shared>,
621
    headers: HeaderMap,
622
    Path((owner, name, r, path)): Path<(String, String, String, String)>,
623
) -> Result<Json<Vec<TreeEntry>>, ApiError> {
624
    let c = caller(&app, &headers).await?;
625
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
626
    let t = app
627
        .repos
628
        .read(&repo, move |repo, cache| {
629
            let target = view::resolve(repo, cache, &r)?;
630
            view::tree(repo, cache, target, &path)
631
        })
632
        .await?;
633
    Ok(Json(t.entries.iter().map(entry).collect()))
634
}
635
636
async fn file(
637
    State(app): State<Shared>,
638
    headers: HeaderMap,
639
    Path((owner, name, r, path)): Path<(String, String, String, String)>,
640
) -> Result<Response, ApiError> {
641
    let c = caller(&app, &headers).await?;
642
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
643
    let limit = app.config.limits.render_limit.0;
644
    let f = app
645
        .repos
646
        .read(&repo, move |repo, cache| {
647
            let target = view::resolve(repo, cache, &r)?;
648
            view::file(repo, cache, target, &path, limit)
649
        })
650
        .await?;
651
    Ok(crate::web::raw(f.bytes, &f.name, false))
652
}
653
654
async fn blame(
655
    State(app): State<Shared>,
656
    headers: HeaderMap,
657
    Path((owner, name, r, path)): Path<(String, String, String, String)>,
658
) -> Result<Json<Vec<BlameLine>>, ApiError> {
659
    let c = caller(&app, &headers).await?;
660
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
661
    let limit = app.config.limits.render_limit.0;
662
    let b = app
663
        .repos
664
        .read(&repo, move |repo, cache| {
665
            let target = view::resolve(repo, cache, &r)?;
666
            view::blame(repo, cache, target, &path, limit)
667
        })
668
        .await?;
669
    Ok(Json(
670
        b.lines
671
            .into_iter()
672
            .map(|l| BlameLine {
673
                line: l.line,
674
                change: l.hash.to_hex(),
675
                index: l.index,
676
                author: l.author,
677
                when_ms: l.when_ms,
678
                text: String::from_utf8_lossy(&l.text).into_owned(),
679
            })
680
            .collect(),
681
    ))
682
}
683
684
async fn conflicts(
685
    State(app): State<Shared>,
686
    headers: HeaderMap,
687
    Path((owner, name)): Path<(String, String)>,
688
) -> Result<Json<Vec<Conflict>>, ApiError> {
689
    let c = caller(&app, &headers).await?;
690
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
691
    let list = app.repos.read(&repo, view::conflicts).await?;
692
    Ok(Json(
693
        list.into_iter()
694
            .map(|c| Conflict {
695
                bookmark: c.bookmark,
696
                path: c.path,
697
                kind: c.kind,
698
                contributors: c.contributors.iter().map(|x| x.hash.clone()).collect(),
699
            })
700
            .collect(),
701
    ))
df940d75 Andy McCall ↶ 702
}
703
704
/// `GET /repos/{o}/{n}/releases/trust/{tag}`: a release's trust report
705
/// (hub spec §9.1), as the page's JSON export.
706
async fn release_trust(
707
    State(app): State<Shared>,
708
    headers: HeaderMap,
709
    Path((owner, name, tag)): Path<(String, String, String)>,
710
) -> Result<Json<crate::web::release_trust::ReleaseTrust>, ApiError> {
711
    let c = caller(&app, &headers).await?;
712
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
713
    match crate::web::release_trust::report(&app, &repo, &row, &tag).await.map_err(|m| ApiError(StatusCode::INTERNAL_SERVER_ERROR, m))? {
714
        Some(t) => Ok(Json(t)),
715
        None => Err(ApiError(StatusCode::NOT_FOUND, format!("no release {tag}"))),
716
    }
b64e2537 Andy McCall ↶ 717
}
718
719
async fn trust(
720
    State(app): State<Shared>,
721
    headers: HeaderMap,
722
    Path((owner, name)): Path<(String, String)>,
723
) -> Result<Json<Trust>, ApiError> {
724
    let c = caller(&app, &headers).await?;
725
    let (repo, _, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
726
    let key = app.hub_key.key;
727
    let t = app.repos.read(&repo, move |r, cache| view::trust(r, cache, &key)).await?;
728
    Ok(Json(Trust {
729
        policy: t.policy.map(|p| Policy {
730
            serial: p.serial,
731
            expires_ms: p.expires_ms,
732
            roots: p.roots.iter().map(|k| k.key.clone()).collect(),
733
            root_threshold: p.root_threshold,
734
            rules: p
735
                .rules
736
                .iter()
737
                .map(|r| Rule {
738
                    pattern: r.pattern.clone(),
739
                    keys: r.keys.iter().map(|k| k.key.clone()).collect(),
740
                    threshold: r.threshold,
741
                    require: r.require.clone(),
742
                    allow_conflicts: r.allow_conflicts,
743
                })
744
                .collect(),
745
        }),
746
        signed: t.verification.signed,
747
        sealed: t.verification.sealed,
748
        unsigned: t.verification.unsigned,
749
        invalid: t.verification.invalid.iter().map(|(h, _)| h.clone()).collect(),
750
        hub_key: t.hub_key,
751
    }))
752
}
753
754
async fn pushes(
755
    State(app): State<Shared>,
756
    headers: HeaderMap,
757
    Path((owner, name)): Path<(String, String)>,
758
) -> Result<Json<Vec<Push>>, ApiError> {
759
    let c = caller(&app, &headers).await?;
760
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
761
    let rows = db::repos::pushes(&app.db, row.id, 200).await?;
762
    Ok(Json(
763
        rows.into_iter()
764
            .map(|p| Push {
765
                at_ms: p.at_ms,
766
                pusher: p.pusher,
767
                reference: p.reference,
768
                ok: p.ok,
769
                reason: p.reason,
770
                old_state: p.old_state,
771
                new_state: p.new_state,
772
                heads: p.heads,
773
                changes: p.changes,
774
            })
775
            .collect(),
776
    ))
de505df5 Andy McCall ↶ 777
}
778
b64e2537 Andy McCall ↶ 779
// --------------------------------------------------------------- proposals
780
0b20f1ec Andy McCall ↶ 781
/// `GET /repos/{o}/{n}/proposals?state=open|draft|landed|closed|all`:
782
/// open ones (drafts too) by default.
de505df5 Andy McCall ↶ 783
async fn proposals(
784
    State(app): State<Shared>,
b64e2537 Andy McCall ↶ 785
    headers: HeaderMap,
de505df5 Andy McCall ↶ 786
    Path((owner, name)): Path<(String, String)>,
0b20f1ec Andy McCall ↶ 787
    Query(q): Query<IssuesQuery>,
b64e2537 Andy McCall ↶ 788
) -> Result<Json<Vec<Proposal>>, ApiError> {
789
    let c = caller(&app, &headers).await?;
790
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
0b20f1ec Andy McCall ↶ 791
    let states: &[&str] = match q.state.as_deref().unwrap_or("open") {
792
        "open" => &["open", "draft"],
793
        "draft" => &["draft"],
794
        "landed" => &["landed"],
795
        "closed" => &["closed"],
796
        "all" => &["open", "draft", "landed", "closed"],
797
        other => return Err(ApiError(StatusCode::BAD_REQUEST, format!("state is open, draft, landed, closed or all, not {other:?}"))),
798
    };
de505df5 Andy McCall ↶ 799
    let mut out = Vec::new();
0b20f1ec Andy McCall ↶ 800
    for p in db::proposals::list(&app.db, row.id, states).await? {
de505df5 Andy McCall ↶ 801
        let loaded = crate::web::proposals::load(&app, &repo, p).await?;
802
        let v = crate::web::proposals::verdict(&app, &loaded, row.id).await?;
803
        out.push(crate::web::proposals::to_api(&app, &owner, &name, &loaded, &v, None).await);
804
    }
805
    Ok(Json(out))
806
}
807
808
async fn proposal(
809
    State(app): State<Shared>,
b64e2537 Andy McCall ↶ 810
    headers: HeaderMap,
de505df5 Andy McCall ↶ 811
    Path((owner, name, number)): Path<(String, String, i64)>,
b64e2537 Andy McCall ↶ 812
) -> Result<Json<Proposal>, ApiError> {
813
    let c = caller(&app, &headers).await?;
814
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
815
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
de505df5 Andy McCall ↶ 816
    let source_url = match p.source_repo_id {
817
        Some(id) => db::repos::get_by_id(&app.db, id).await?.map(|r| format!("{}/{}", app.config.base_url(), r.slug())),
818
        None => None,
819
    };
820
    let loaded = crate::web::proposals::load(&app, &repo, p).await?;
821
    let v = crate::web::proposals::verdict(&app, &loaded, row.id).await?;
822
    Ok(Json(crate::web::proposals::to_api(&app, &owner, &name, &loaded, &v, source_url).await))
1f1eb06a Andy McCall ↶ 823
}
824
739a763a Andy McCall ↶ 825
/// `PATCH /repos/{o}/{n}/proposals/{number}`: change the title or body,
826
/// keeping what is not given; the author or a maintainer, as on the page
827
/// (oxygenhub#76). The target is changed on the page, which re-projects.
828
async fn edit_proposal(
829
    State(app): State<Shared>,
830
    headers: HeaderMap,
831
    Path((owner, name, number)): Path<(String, String, i64)>,
832
    Json(body): Json<hub_api::ProposalEdit>,
833
) -> Result<Json<Proposal>, ApiError> {
834
    let c = caller(&app, &headers).await?;
835
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
836
    let (repo, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
837
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
2291f8cc Andy McCall ↶ 838
    let text = body.title.is_some() || body.body.is_some();
839
    if text && Some(me.id) != p.author_id && role < Role::Maintain {
739a763a Andy McCall ↶ 840
        return Err(ApiError(StatusCode::FORBIDDEN, "only the proposal's author or a maintainer can edit it".into()));
2291f8cc Andy McCall ↶ 841
    }
842
    if body.labels.is_some() && role < Role::Triage {
843
        return Err(forbidden("setting labels needs triage access"));
844
    }
845
    // Every name is checked before anything changes.
846
    let labels = resolve_triage(&app, row.id, body.labels.as_deref(), None, None).await?.labels;
847
    if text {
848
        let title = match body.title.as_deref().map(str::trim) {
849
            Some("") => return Err(ApiError(StatusCode::BAD_REQUEST, "a proposal needs a title".into())),
850
            Some(t) => t,
851
            None => p.title.as_str(),
852
        };
853
        let text = body.body.as_deref().map(str::trim).unwrap_or(&p.body);
854
        db::proposals::edit(&app.db, p.id, title, text, &p.target).await?;
855
        db::proposals::add_event(&app.db, p.id, &me.username, "edited", "").await.ok();
739a763a Andy McCall ↶ 856
    }
2291f8cc Andy McCall ↶ 857
    if let Some(want) = labels {
858
        let have = db::issues::proposal_labels(&app.db, p.id).await?;
859
        for l in &have {
860
            if !want.iter().any(|w| w.id == l.id) {
861
                db::issues::set_proposal_label(&app.db, p.id, l.id, false).await?;
862
            }
863
        }
864
        for w in &want {
865
            if !have.iter().any(|l| l.id == w.id) {
866
                db::issues::set_proposal_label(&app.db, p.id, w.id, true).await?;
867
            }
868
        }
869
        let names: Vec<&str> = want.iter().map(|l| l.name.as_str()).collect();
870
        db::proposals::add_event(&app.db, p.id, &me.username, "set labels", &names.join(", ")).await.ok();
871
    }
739a763a Andy McCall ↶ 872
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
873
    let source_url = match p.source_repo_id {
874
        Some(id) => db::repos::get_by_id(&app.db, id).await?.map(|r| format!("{}/{}", app.config.base_url(), r.slug())),
875
        None => None,
876
    };
877
    let loaded = crate::web::proposals::load(&app, &repo, p).await?;
878
    let v = crate::web::proposals::verdict(&app, &loaded, row.id).await?;
879
    Ok(Json(crate::web::proposals::to_api(&app, &owner, &name, &loaded, &v, source_url).await))
880
}
881
1f1eb06a Andy McCall ↶ 882
/// `POST /repos/{o}/{n}/proposals/{number}/land` (repo:write): land it as
883
/// the page's Land button does; `409` with the blockers when it cannot.
884
async fn land_proposal(
885
    State(app): State<Shared>,
886
    headers: HeaderMap,
887
    Path((owner, name, number)): Path<(String, String, i64)>,
888
) -> Result<Json<Proposal>, ApiError> {
889
    let c = caller(&app, &headers).await?;
890
    let me = c.require("repo:write")?.clone();
891
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
0b20f1ec Andy McCall ↶ 892
    let via = format!("api (token {})", c.token);
893
    match crate::web::proposals::land_as(&app, &repo, &row, &me, number, &via).await {
1f1eb06a Andy McCall ↶ 894
        Ok(_) => proposal(State(app), headers, Path((owner, name, number))).await,
895
        Err(crate::web::proposals::Landing::NotFound) => Err(not_found("no such proposal")),
896
        Err(crate::web::proposals::Landing::Refused(m)) => Err(ApiError(StatusCode::CONFLICT, m)),
897
    }
d23464c0 Andy McCall ↶ 898
}
899
3f02e5ea Andy McCall ↶ 900
/// The files a proposal changes (hub spec §12.1).
901
async fn proposal_files(
902
    State(app): State<Shared>,
903
    headers: HeaderMap,
904
    Path((owner, name, number)): Path<(String, String, i64)>,
905
) -> Result<Json<Vec<hub_api::ProposalFile>>, ApiError> {
906
    let c = caller(&app, &headers).await?;
907
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
908
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
909
    let loaded = crate::web::proposals::load(&app, &repo, p).await?;
910
    Ok(Json(
911
        loaded
912
            .files
913
            .iter()
914
            .map(|f| hub_api::ProposalFile {
915
                path: f.path.clone(),
916
                from: f.from.clone(),
917
                kind: f.kind.clone(),
918
                added: f.added,
919
                removed: f.removed,
920
            })
921
            .collect(),
922
    ))
923
}
924
925
/// One file's bytes on a side of a proposal: `base` is the target's
926
/// state, `head` the projected state. 404 when the file does not exist
927
/// on that side.
928
async fn proposal_content(
929
    State(app): State<Shared>,
930
    headers: HeaderMap,
931
    Path((owner, name, number, side, path)): Path<(String, String, i64, String, String)>,
932
) -> Result<Response, ApiError> {
933
    let c = caller(&app, &headers).await?;
934
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
935
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
936
    let loaded = crate::web::proposals::load(&app, &repo, p).await?;
937
    let heads = match side.as_str() {
938
        "base" => loaded.target_heads,
939
        "head" => loaded.heads,
940
        _ => return Err(ApiError(StatusCode::BAD_REQUEST, "the side is base or head".into())),
941
    };
942
    let limit = app.config.limits.render_limit.0;
943
    let target = view::RefTarget { label: side, kind: view::RefKind::Change, heads };
944
    let f = app.repos.read(&repo, move |repo, cache| view::file(repo, cache, target, &path, limit)).await?;
945
    Ok(crate::web::raw(f.bytes, &f.name, false))
946
}
947
b64e2537 Andy McCall ↶ 948
async fn create_proposal(
949
    State(app): State<Shared>,
950
    headers: HeaderMap,
951
    Path((owner, name)): Path<(String, String)>,
952
    Json(body): Json<NewProposal>,
953
) -> Result<(StatusCode, Json<Proposal>), ApiError> {
954
    let c = caller(&app, &headers).await?;
955
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
956
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
957
    let created =
958
        crate::web::proposals::open_proposal(&app, &repo, &row, &me, &body.title, &body.body, &body.target, &body.source, body.draft)
959
            .await
960
            .map_err(|e| ApiError(StatusCode::BAD_REQUEST, e))?;
961
    let loaded = crate::web::proposals::load(&app, &repo, created).await?;
962
    let v = crate::web::proposals::verdict(&app, &loaded, row.id).await?;
963
    Ok((StatusCode::CREATED, Json(crate::web::proposals::to_api(&app, &owner, &name, &loaded, &v, None).await)))
964
}
d23464c0 Andy McCall ↶ 965
b64e2537 Andy McCall ↶ 966
fn comment_of(c: &db::proposals::CommentRow) -> Comment {
967
    Comment {
968
        id: c.id,
969
        author: c.author.clone(),
970
        body: c.body.clone(),
971
        created_ms: c.created_ms,
972
        path: if c.path.is_empty() { None } else { Some(c.path.clone()) },
973
        anchor: if c.anchor_change.is_empty() {
974
            None
975
        } else {
976
            Some(Atom { change: c.anchor_change.clone(), index: c.anchor_index as u32 })
977
        },
978
        resolved: c.resolved,
d23464c0 Andy McCall ↶ 979
    }
980
}
981
b64e2537 Andy McCall ↶ 982
async fn proposal_comments(
983
    State(app): State<Shared>,
984
    headers: HeaderMap,
985
    Path((owner, name, number)): Path<(String, String, i64)>,
986
) -> Result<Json<Vec<Comment>>, ApiError> {
987
    let c = caller(&app, &headers).await?;
988
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
989
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
990
    Ok(Json(db::proposals::comments(&app.db, p.id).await?.iter().map(comment_of).collect()))
991
}
992
993
async fn proposal_comment(
994
    State(app): State<Shared>,
995
    headers: HeaderMap,
996
    Path((owner, name, number)): Path<(String, String, i64)>,
997
    Json(body): Json<NewComment>,
998
) -> Result<(StatusCode, Json<Comment>), ApiError> {
999
    let c = caller(&app, &headers).await?;
1000
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
1001
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1002
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1003
    if body.body.trim().is_empty() {
1004
        return Err(ApiError(StatusCode::BAD_REQUEST, "an empty comment says nothing".into()));
1005
    }
3f4b0ea6 Andy McCall ↶ 1006
    let (repo, _) = (RepoName::new(&owner, &name).ok_or_else(|| not_found("no such repository"))?, ());
1007
    let anchor = match (body.path.as_deref().map(|x| x.trim_matches('/')), body.line) {
1008
        (Some(path), Some(line)) if !path.is_empty() => {
1009
            let loaded = crate::web::proposals::load(&app, &repo, p.clone()).await?;
1010
            let (heads, file) = (loaded.heads.clone(), path.to_string());
1011
            let atom = app
1012
                .repos
1013
                .read(&repo, move |r, cache| {
1014
                    let projected = cache.load(r, &heads)?;
1015
                    Ok(crate::repos::proposals::atom_at(&projected, &file, line).map(|(h, i)| (h.to_hex(), i)))
1016
                })
1017
                .await?
1018
                .ok_or_else(|| ApiError(StatusCode::BAD_REQUEST, format!("{path}:{line} is not a line of the projected state")))?;
1019
            Some((path.to_string(), atom))
1020
        }
1021
        _ => None,
1022
    };
1023
    let row_c = db::proposals::add_comment(
1024
        &app.db,
1025
        p.id,
1026
        Some(me.id),
1027
        &me.username,
1028
        body.body.trim(),
1029
        anchor.as_ref().map(|(path, _)| path.as_str()).unwrap_or(""),
1030
        anchor.as_ref().map(|(_, (h, i))| (h.as_str(), *i as i64)),
1031
    )
1032
    .await?;
b64e2537 Andy McCall ↶ 1033
    crate::notify::deliver(
1034
        &app,
1035
        crate::notify::Event {
1036
            kind: "proposal.comment",
1037
            title: format!("{owner}/{name}#{number}: {}", p.title),
1038
            url: format!("/{owner}/{name}/proposal/{number}"),
1039
            actor: &me,
1040
            repo_id: row.id,
1041
            thread: Some(("proposal", p.id)),
1042
            mention_text: &body.body,
1043
            direct: p.author_id.into_iter().collect(),
1044
        },
1045
    )
1046
    .await;
1047
    crate::hooks::emit(
1048
        &app,
1049
        &row,
1050
        "comment.proposal",
1051
        &me.username,
1052
        serde_json::json!({ "number": number, "comment": comment_of(&row_c) }),
1053
    )
1054
    .await;
1055
    Ok((StatusCode::CREATED, Json(comment_of(&row_c))))
1056
}
1057
1058
async fn proposal_reviews(
1059
    State(app): State<Shared>,
1060
    headers: HeaderMap,
1061
    Path((owner, name, number)): Path<(String, String, i64)>,
1062
) -> Result<Json<Vec<Review>>, ApiError> {
1063
    let c = caller(&app, &headers).await?;
1064
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1065
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1066
    let loaded = crate::web::proposals::load(&app, &repo, p).await?;
1067
    let v = crate::web::proposals::verdict(&app, &loaded, row.id).await?;
1068
    Ok(Json(
1069
        v.reviews
1070
            .into_iter()
1071
            .map(|r| Review {
1072
                id: r.row.id,
1073
                author: r.row.author,
1074
                verdict: r.row.verdict,
1075
                body: r.row.body,
1076
                sealed: r.sealed,
1077
                created_ms: r.row.created_ms,
1078
            })
1079
            .collect(),
1080
    ))
1081
}
1082
1083
async fn proposal_review(
1084
    State(app): State<Shared>,
1085
    headers: HeaderMap,
1086
    Path((owner, name, number)): Path<(String, String, i64)>,
1087
    Json(body): Json<NewReview>,
1088
) -> Result<(StatusCode, Json<Review>), ApiError> {
1089
    let c = caller(&app, &headers).await?;
1090
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
1091
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1092
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1093
    if !matches!(body.verdict.as_str(), "comment" | "changes" | "approve") {
1094
        return Err(ApiError(StatusCode::BAD_REQUEST, "verdict is comment, changes or approve".into()));
1095
    }
1096
    if body.verdict == "approve" && Some(me.id) == p.author_id {
1097
        return Err(forbidden("you cannot approve your own proposal"));
1098
    }
1099
    let r = db::proposals::add_review(&app.db, p.id, me.id, &me.username, &body.verdict, body.body.trim()).await?;
1100
    db::proposals::add_event(&app.db, p.id, &me.username, &format!("review.{}", body.verdict), "").await.ok();
cc1cd197 Andy McCall ↶ 1101
    crate::web::proposals::reviewed(&app, &row, &p, &me, &body.verdict).await;
b64e2537 Andy McCall ↶ 1102
    crate::hooks::emit(&app, &row, "review", &me.username, serde_json::json!({ "number": number, "verdict": body.verdict })).await;
1103
    Ok((
1104
        StatusCode::CREATED,
1105
        Json(Review { id: r.id, author: r.author, verdict: r.verdict, body: r.body, sealed: false, created_ms: r.created_ms }),
1106
    ))
1107
}
1108
cc1cd197 Andy McCall ↶ 1109
/// `POST .../proposals/{number}/reviewers`: ask accounts to review (the
1110
/// author, or a writer). Answers with everyone asked now.
1111
async fn request_reviewers(
1112
    State(app): State<Shared>,
1113
    headers: HeaderMap,
1114
    Path((owner, name, number)): Path<(String, String, i64)>,
1115
    Json(body): Json<ReviewRequest>,
1116
) -> Result<Json<Vec<String>>, ApiError> {
1117
    let c = caller(&app, &headers).await?;
1118
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
1119
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
1120
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1121
    if Some(me.id) != p.author_id && role < Role::Write {
1122
        return Err(forbidden("only the author or a writer asks for reviews"));
1123
    }
1124
    if !p.is_open() {
1125
        return Err(ApiError(StatusCode::CONFLICT, "the proposal is not open".into()));
1126
    }
1127
    crate::web::proposals::request_reviewers(&app, &row, &p, &me, &body.reviewers)
1128
        .await
1129
        .map_err(|e| ApiError(StatusCode::UNPROCESSABLE_ENTITY, e))?;
1130
    Ok(Json(db::proposals::review_requests(&app.db, p.id).await?))
1131
}
1132
1133
/// `DELETE .../proposals/{number}/reviewers/{username}`: withdraw a request.
1134
async fn withdraw_reviewer(
1135
    State(app): State<Shared>,
1136
    headers: HeaderMap,
1137
    Path((owner, name, number, username)): Path<(String, String, i64, String)>,
1138
) -> Result<StatusCode, ApiError> {
1139
    let c = caller(&app, &headers).await?;
1140
    let me = c.require("proposals:write").or_else(|_| c.require("repo:write"))?.clone();
1141
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
1142
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1143
    if Some(me.id) != p.author_id && role < Role::Write {
1144
        return Err(forbidden("only the author or a writer withdraws review requests"));
1145
    }
1146
    let a = db::accounts::account_by_name(&app.db, &username).await?.ok_or_else(|| not_found("no such account"))?;
1147
    if db::proposals::unrequest_review(&app.db, p.id, a.id).await? {
1148
        db::proposals::add_event(&app.db, p.id, &me.username, "review request withdrawn", &a.username).await.ok();
1149
    }
1150
    Ok(StatusCode::NO_CONTENT)
1151
}
1152
b64e2537 Andy McCall ↶ 1153
async fn proposal_checks(
1154
    State(app): State<Shared>,
1155
    headers: HeaderMap,
1156
    Path((owner, name, number)): Path<(String, String, i64)>,
1157
) -> Result<Json<Vec<Check>>, ApiError> {
1158
    let c = caller(&app, &headers).await?;
1159
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1160
    let p = db::proposals::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such proposal"))?;
1161
    let loaded = crate::web::proposals::load(&app, &repo, p).await?;
1162
    Ok(Json(db::hooks::checks_for_state(&app.db, row.id, &loaded.state).await?.iter().map(check_of).collect()))
1163
}
1164
1165
// ------------------------------------------------------------------ issues
1166
1167
async fn issue_of(app: &Shared, row: &db::repos::RepoRow, i: &db::issues::IssueRow) -> Result<Issue, ApiError> {
1168
    let labels = db::issues::issue_labels(&app.db, i.id)
1169
        .await?
1170
        .into_iter()
1171
        .map(|l| Label { name: l.name, colour: l.colour, description: l.description })
1172
        .collect();
1173
    let assignees = db::issues::assignees(&app.db, i.id).await?;
1174
    let milestone = match i.milestone_id {
1175
        Some(id) => db::issues::milestone(&app.db, id).await?.map(|m| m.title),
1176
        None => None,
1177
    };
1178
    let comments: i64 = sqlx::query_scalar("SELECT COUNT(*) FROM issue_comments WHERE issue_id = ?").bind(i.id).fetch_one(&app.db).await?;
1179
    Ok(Issue {
1180
        number: i.number,
1181
        title: i.title.clone(),
1182
        body: i.body.clone(),
1183
        author: i.author.clone(),
1184
        state: i.state.clone(),
1185
        reason: i.reason.clone(),
1186
        labels,
1187
        assignees,
1188
        milestone,
1189
        comments,
1190
        locked: i.locked,
1191
        pinned: i.pinned,
1192
        created_ms: i.created_ms,
1193
        updated_ms: i.updated_ms,
1194
        closed_ms: i.closed_ms,
1195
        url: format!("{}/{}/issue/{}", app.config.base_url(), row.slug(), i.number),
1196
    })
1197
}
1198
1199
#[derive(Deserialize)]
1200
struct IssuesQuery {
1201
    state: Option<String>,
1202
}
1203
1204
async fn issues(
1205
    State(app): State<Shared>,
1206
    headers: HeaderMap,
1207
    Path((owner, name)): Path<(String, String)>,
1208
    Query(q): Query<IssuesQuery>,
1209
) -> Result<Json<Vec<Issue>>, ApiError> {
1210
    let c = caller(&app, &headers).await?;
1211
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1212
    let state = q.state.unwrap_or_else(|| "open".into());
1213
    let mut out = Vec::new();
1214
    for i in db::issues::list(&app.db, row.id).await? {
1215
        if state == "all" || i.state == state {
1216
            out.push(issue_of(&app, &row, &i).await?);
d23464c0 Andy McCall ↶ 1217
        }
1218
    }
b64e2537 Andy McCall ↶ 1219
    Ok(Json(out))
d23464c0 Andy McCall ↶ 1220
}
1221
b64e2537 Andy McCall ↶ 1222
async fn create_issue(
1223
    State(app): State<Shared>,
1224
    headers: HeaderMap,
1225
    Path((owner, name)): Path<(String, String)>,
1226
    Json(body): Json<NewIssue>,
1227
) -> Result<(StatusCode, Json<Issue>), ApiError> {
1228
    let c = caller(&app, &headers).await?;
1229
    let me = c.require("issues:write").or_else(|_| c.require("repo:write"))?.clone();
76f262e1 Andy McCall ↶ 1230
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
b64e2537 Andy McCall ↶ 1231
    if body.title.trim().is_empty() {
1232
        return Err(ApiError(StatusCode::BAD_REQUEST, "an issue needs a title".into()));
d23464c0 Andy McCall ↶ 1233
    }
76f262e1 Andy McCall ↶ 1234
    let triage = !body.labels.is_empty() || !body.assignees.is_empty() || body.milestone.is_some();
1235
    if triage && role < Role::Triage {
1236
        return Err(forbidden("setting labels, assignees or a milestone needs triage access"));
1237
    }
1238
    // Check the names before anything is created.
1239
    resolve_triage(&app, row.id, Some(&body.labels), Some(&body.assignees), body.milestone.as_deref()).await?;
b64e2537 Andy McCall ↶ 1240
    let i = db::issues::create(
1241
        &app.db,
1242
        db::issues::NewIssue {
1243
            repo_id: row.id,
1244
            title: body.title.trim(),
1245
            body: body.body.trim(),
1246
            author_id: Some(me.id),
1247
            author: &me.username,
1248
        },
1249
    )
1250
    .await?;
1251
    db::issues::add_event(&app.db, i.id, &me.username, "opened", "").await.ok();
76f262e1 Andy McCall ↶ 1252
    if triage {
1253
        let t = resolve_triage(&app, row.id, Some(&body.labels), Some(&body.assignees), body.milestone.as_deref()).await?;
1254
        apply_triage(&app, &i, &me, t).await?;
1255
    }
1256
    let i = db::issues::get(&app.db, row.id, i.number).await?.unwrap_or(i);
b64e2537 Andy McCall ↶ 1257
    crate::web::issues::reindex(&app, row.id, &i).await;
1258
    let api = issue_of(&app, &row, &i).await?;
1259
    crate::notify::deliver(
1260
        &app,
1261
        crate::notify::Event {
1262
            kind: "issue.opened",
1263
            title: format!("{owner}/{name}#{}: {}", i.number, i.title),
1264
            url: format!("/{owner}/{name}/issue/{}", i.number),
1265
            actor: &me,
1266
            repo_id: row.id,
1267
            thread: Some(("issue", i.id)),
1268
            mention_text: &body.body,
1269
            direct: vec![],
1270
        },
1271
    )
1272
    .await;
1273
    crate::hooks::emit(&app, &row, "issue.opened", &me.username, serde_json::json!({ "issue": api })).await;
1274
    Ok((StatusCode::CREATED, Json(api)))
1275
}
1276
1277
async fn issue(
1278
    State(app): State<Shared>,
1279
    headers: HeaderMap,
1280
    Path((owner, name, number)): Path<(String, String, i64)>,
1281
) -> Result<Json<Issue>, ApiError> {
1282
    let c = caller(&app, &headers).await?;
1283
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1284
    let i = db::issues::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such issue"))?;
1285
    Ok(Json(issue_of(&app, &row, &i).await?))
1286
}
1287
1288
async fn issue_state(
1289
    State(app): State<Shared>,
1290
    headers: HeaderMap,
1291
    Path((owner, name, number)): Path<(String, String, i64)>,
1292
    Json(body): Json<IssueStateChange>,
1293
) -> Result<Json<Issue>, ApiError> {
1294
    let c = caller(&app, &headers).await?;
1295
    let me = c.require("issues:write").or_else(|_| c.require("repo:write"))?.clone();
1296
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
1297
    let i = db::issues::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such issue"))?;
1298
    if role < Role::Triage && Some(me.id) != i.author_id {
1299
        return Err(forbidden("only the author or triage may change the state"));
1300
    }
1301
    let (state, reason) = match body.state.as_str() {
1302
        "closed" => ("closed", if body.reason == "not_planned" { "not_planned" } else { "completed" }),
1303
        "open" => ("open", ""),
1304
        _ => return Err(ApiError(StatusCode::BAD_REQUEST, "state is open or closed".into())),
1305
    };
1306
    db::issues::set_state(&app.db, i.id, state, reason).await?;
1307
    db::issues::add_event(&app.db, i.id, &me.username, if state == "closed" { "closed" } else { "reopened" }, "").await.ok();
1308
    let fresh = db::issues::get(&app.db, row.id, number).await?.unwrap_or(i);
1309
    let api = issue_of(&app, &row, &fresh).await?;
1310
    crate::hooks::emit(
1311
        &app,
1312
        &row,
1313
        if state == "closed" { "issue.closed" } else { "issue.reopened" },
1314
        &me.username,
1315
        serde_json::json!({ "issue": api }),
1316
    )
1317
    .await;
1318
    Ok(Json(api))
1319
}
1320
1321
async fn issue_comments(
1322
    State(app): State<Shared>,
1323
    headers: HeaderMap,
1324
    Path((owner, name, number)): Path<(String, String, i64)>,
1325
) -> Result<Json<Vec<Comment>>, ApiError> {
1326
    let c = caller(&app, &headers).await?;
1327
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1328
    let i = db::issues::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such issue"))?;
1329
    Ok(Json(
1330
        db::issues::comments(&app.db, i.id)
1331
            .await?
1332
            .into_iter()
1333
            .map(|c| Comment {
1334
                id: c.id,
1335
                author: c.author,
1336
                body: c.body,
1337
                created_ms: c.created_ms,
1338
                path: None,
1339
                anchor: None,
1340
                resolved: false,
1341
            })
1342
            .collect(),
1343
    ))
1344
}
1345
1346
async fn issue_comment(
1347
    State(app): State<Shared>,
1348
    headers: HeaderMap,
1349
    Path((owner, name, number)): Path<(String, String, i64)>,
1350
    Json(body): Json<NewComment>,
1351
) -> Result<(StatusCode, Json<Comment>), ApiError> {
1352
    let c = caller(&app, &headers).await?;
1353
    let me = c.require("issues:write").or_else(|_| c.require("repo:write"))?.clone();
1354
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
1355
    let i = db::issues::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such issue"))?;
1356
    if i.locked && role < Role::Triage {
1357
        return Err(forbidden("this issue is locked"));
1358
    }
1359
    if body.body.trim().is_empty() {
1360
        return Err(ApiError(StatusCode::BAD_REQUEST, "an empty comment says nothing".into()));
1361
    }
1362
    let cm = db::issues::add_comment(&app.db, i.id, Some(me.id), &me.username, body.body.trim()).await?;
1363
    crate::web::issues::reindex(&app, row.id, &i).await;
1364
    crate::notify::deliver(
1365
        &app,
1366
        crate::notify::Event {
1367
            kind: "issue.comment",
1368
            title: format!("{owner}/{name}#{number}: {}", i.title),
1369
            url: format!("/{owner}/{name}/issue/{number}"),
1370
            actor: &me,
1371
            repo_id: row.id,
1372
            thread: Some(("issue", i.id)),
1373
            mention_text: &body.body,
1374
            direct: i.author_id.into_iter().collect(),
1375
        },
1376
    )
1377
    .await;
1378
    let api = Comment { id: cm.id, author: cm.author, body: cm.body, created_ms: cm.created_ms, path: None, anchor: None, resolved: false };
1379
    crate::hooks::emit(&app, &row, "comment.issue", &me.username, serde_json::json!({ "number": number, "comment": api })).await;
1380
    Ok((StatusCode::CREATED, Json(api)))
76f262e1 Andy McCall ↶ 1381
}
1382
1383
/// Labels, assignees and milestone named in a request, looked up.
1384
struct Triage {
1385
    labels: Option<Vec<db::issues::Label>>,
1386
    assignees: Option<Vec<Account>>,
1387
    /// `Some(None)` clears the milestone.
1388
    milestone: Option<Option<db::issues::Milestone>>,
1389
}
1390
1391
async fn resolve_triage(
1392
    app: &Shared,
1393
    repo_id: i64,
1394
    labels: Option<&[String]>,
1395
    assignees: Option<&[String]>,
1396
    milestone: Option<&str>,
1397
) -> Result<Triage, ApiError> {
1398
    let bad = |m: String| ApiError(StatusCode::BAD_REQUEST, m);
1399
    let labels = match labels {
1400
        Some(names) => {
1401
            let mut out = Vec::new();
1402
            for n in names {
1403
                out.push(
1404
                    db::issues::label_by_name(&app.db, repo_id, n.trim())
1405
                        .await?
1406
                        .ok_or_else(|| bad(format!("no label {n:?}; create it first")))?,
1407
                );
1408
            }
1409
            Some(out)
1410
        }
1411
        None => None,
1412
    };
1413
    let assignees = match assignees {
1414
        Some(names) => {
1415
            let mut out = Vec::new();
1416
            for n in names {
1417
                out.push(db::accounts::account_by_name(&app.db, n.trim()).await?.ok_or_else(|| bad(format!("no account {n:?}")))?);
1418
            }
1419
            Some(out)
1420
        }
1421
        None => None,
1422
    };
1423
    let milestone = match milestone.map(str::trim) {
1424
        None => None,
1425
        Some("") => Some(None),
1426
        Some(title) => Some(Some(
1427
            db::issues::milestones(&app.db, repo_id)
1428
                .await?
1429
                .into_iter()
1430
                .find(|m| m.title == title)
1431
                .ok_or_else(|| bad(format!("no milestone {title:?}")))?,
1432
        )),
1433
    };
1434
    Ok(Triage { labels, assignees, milestone })
1435
}
1436
1437
/// Make an issue's labels, assignees and milestone what `t` says, with
1438
/// timeline events for what changed.
1439
async fn apply_triage(app: &Shared, i: &db::issues::IssueRow, me: &Account, t: Triage) -> Result<(), ApiError> {
1440
    if let Some(want) = t.labels {
1441
        let have = db::issues::issue_labels(&app.db, i.id).await?;
1442
        for l in &have {
1443
            if !want.iter().any(|w| w.id == l.id) {
1444
                db::issues::set_issue_label(&app.db, i.id, l.id, false).await?;
1445
            }
1446
        }
1447
        for w in &want {
1448
            if !have.iter().any(|l| l.id == w.id) {
1449
                db::issues::set_issue_label(&app.db, i.id, w.id, true).await?;
1450
            }
1451
        }
1452
        let names: Vec<&str> = want.iter().map(|l| l.name.as_str()).collect();
1453
        db::issues::add_event(&app.db, i.id, &me.username, "set labels", &names.join(", ")).await.ok();
1454
    }
1455
    if let Some(want) = t.assignees {
1456
        let have = db::issues::assignees(&app.db, i.id).await?;
1457
        for name in &have {
1458
            if !want.iter().any(|a| &a.username == name) {
1459
                if let Some(a) = db::accounts::account_by_name(&app.db, name).await? {
1460
                    db::issues::set_assignee(&app.db, i.id, a.id, false).await?;
1461
                    db::issues::add_event(&app.db, i.id, &me.username, "unassigned", name).await.ok();
1462
                }
1463
            }
1464
        }
1465
        for a in &want {
1466
            if !have.contains(&a.username) {
1467
                db::issues::set_assignee(&app.db, i.id, a.id, true).await?;
1468
                db::issues::add_event(&app.db, i.id, &me.username, "assigned", &a.username).await.ok();
1469
            }
1470
        }
1471
    }
1472
    if let Some(m) = t.milestone {
1473
        db::issues::set_milestone(&app.db, i.id, m.as_ref().map(|m| m.id)).await?;
1474
        db::issues::add_event(&app.db, i.id, &me.username, "set milestone", m.as_ref().map(|m| m.title.as_str()).unwrap_or("")).await.ok();
1475
    }
1476
    Ok(())
1477
}
1478
1479
/// `PATCH /repos/{o}/{n}/issues/{number}`.
1480
async fn issue_edit(
1481
    State(app): State<Shared>,
1482
    headers: HeaderMap,
1483
    Path((owner, name, number)): Path<(String, String, i64)>,
1484
    Json(body): Json<IssueEdit>,
1485
) -> Result<Json<Issue>, ApiError> {
1486
    let c = caller(&app, &headers).await?;
1487
    let me = c.require("issues:write").or_else(|_| c.require("repo:write"))?.clone();
1488
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
1489
    let i = db::issues::get(&app.db, row.id, number).await?.ok_or_else(|| not_found("no such issue"))?;
1490
    let text = body.title.is_some() || body.body.is_some();
1491
    let triage = body.labels.is_some() || body.assignees.is_some() || body.milestone.is_some();
1492
    if text && role < Role::Triage && Some(me.id) != i.author_id {
1493
        return Err(forbidden("only the author or triage may edit the title and body"));
1494
    }
1495
    if triage && role < Role::Triage {
1496
        return Err(forbidden("setting labels, assignees or a milestone needs triage access"));
1497
    }
1498
    if i.locked && role < Role::Triage {
1499
        return Err(forbidden("this issue is locked"));
1500
    }
1501
    let t = resolve_triage(&app, row.id, body.labels.as_deref(), body.assignees.as_deref(), body.milestone.as_deref()).await?;
1502
    if text {
1503
        let title = body.title.as_deref().map(str::trim).unwrap_or(&i.title);
1504
        if title.is_empty() {
1505
            return Err(ApiError(StatusCode::BAD_REQUEST, "an issue needs a title".into()));
1506
        }
1507
        db::issues::edit(&app.db, i.id, title, body.body.as_deref().unwrap_or(&i.body)).await?;
1508
        db::issues::add_event(&app.db, i.id, &me.username, "edited", "").await.ok();
1509
    }
1510
    apply_triage(&app, &i, &me, t).await?;
1511
    db::issues::touch(&app.db, i.id).await.ok();
1512
    let fresh = db::issues::get(&app.db, row.id, number).await?.unwrap_or(i);
1513
    crate::web::issues::reindex(&app, row.id, &fresh).await;
1514
    let api = issue_of(&app, &row, &fresh).await?;
1515
    crate::hooks::emit(&app, &row, "issue.edited", &me.username, serde_json::json!({ "issue": api })).await;
1516
    Ok(Json(api))
1517
}
1518
1519
/// `POST /repos/{o}/{n}/labels` (triage).
1520
async fn create_label(
1521
    State(app): State<Shared>,
1522
    headers: HeaderMap,
1523
    Path((owner, name)): Path<(String, String)>,
1524
    Json(body): Json<NewLabel>,
1525
) -> Result<(StatusCode, Json<Label>), ApiError> {
1526
    let c = caller(&app, &headers).await?;
1527
    c.require("issues:write").or_else(|_| c.require("repo:write"))?;
1528
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
1529
    if role < Role::Triage {
1530
        return Err(forbidden("labels need triage access"));
1531
    }
1532
    let label = body.name.trim();
1533
    if label.is_empty() || label.len() > 50 {
1534
        return Err(ApiError(StatusCode::BAD_REQUEST, "a label has a name of 1 to 50 characters".into()));
1535
    }
1536
    let colour = match body.colour.as_deref() {
1537
        Some(c) if c.len() == 7 && c.starts_with('#') && c[1..].chars().all(|x| x.is_ascii_hexdigit()) => c.to_string(),
1538
        Some(c) => return Err(ApiError(StatusCode::BAD_REQUEST, format!("colour {c:?} is not #rrggbb"))),
1539
        None => "#5aa8ff".to_string(),
1540
    };
1541
    let l = db::issues::upsert_label(&app.db, row.id, label, &colour, body.description.trim()).await?;
1542
    Ok((StatusCode::CREATED, Json(Label { name: l.name, colour: l.colour, description: l.description })))
1543
}
1544
1545
/// `DELETE /repos/{o}/{n}/labels/{label}` (triage).
1546
async fn delete_label(
1547
    State(app): State<Shared>,
1548
    headers: HeaderMap,
1549
    Path((owner, name, label)): Path<(String, String, String)>,
1550
) -> Result<StatusCode, ApiError> {
1551
    let c = caller(&app, &headers).await?;
1552
    c.require("issues:write").or_else(|_| c.require("repo:write"))?;
1553
    let (_, row, role) = reach(&app, &c, &owner, &name, Access::Read).await?;
1554
    if role < Role::Triage {
1555
        return Err(forbidden("labels need triage access"));
1556
    }
1557
    let l = db::issues::label_by_name(&app.db, row.id, &label).await?.ok_or_else(|| not_found("no such label"))?;
1558
    db::issues::delete_label(&app.db, l.id).await?;
1559
    Ok(StatusCode::NO_CONTENT)
d23464c0 Andy McCall ↶ 1560
}
1561
b64e2537 Andy McCall ↶ 1562
async fn labels(
1563
    State(app): State<Shared>,
1564
    headers: HeaderMap,
1565
    Path((owner, name)): Path<(String, String)>,
1566
) -> Result<Json<Vec<Label>>, ApiError> {
1567
    let c = caller(&app, &headers).await?;
1568
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1569
    Ok(Json(
1570
        db::issues::labels(&app.db, row.id)
1571
            .await?
1572
            .into_iter()
1573
            .map(|l| Label { name: l.name, colour: l.colour, description: l.description })
1574
            .collect(),
1575
    ))
1576
}
1577
1578
async fn milestones(
1579
    State(app): State<Shared>,
1580
    headers: HeaderMap,
1581
    Path((owner, name)): Path<(String, String)>,
1582
) -> Result<Json<Vec<Milestone>>, ApiError> {
1583
    let c = caller(&app, &headers).await?;
1584
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1585
    let mut out = Vec::new();
1586
    for m in db::issues::milestones(&app.db, row.id).await? {
1587
        let (open, closed) = db::issues::milestone_counts(&app.db, m.id).await?;
1588
        out.push(Milestone { title: m.title, description: m.description, due_ms: m.due_ms, state: m.state, open, closed });
d23464c0 Andy McCall ↶ 1589
    }
b64e2537 Andy McCall ↶ 1590
    Ok(Json(out))
1591
}
1592
5ea4872f Andy McCall ↶ 1593
fn milestone_of(m: db::issues::Milestone, open: i64, closed: i64) -> Milestone {
1594
    Milestone { title: m.title, description: m.description, due_ms: m.due_ms, state: m.state, open, closed }
1595
}
1596
1597
/// A due date as `YYYY-MM-DD` (UTC midnight), or the empty string for none.
1598
fn due_ms_of(due: &str) -> Result<Option<i64>, ApiError> {
1599
    let due = due.trim();
1600
    if due.is_empty() {
1601
        return Ok(None);
1602
    }
1603
    time::Date::parse(due, &time::macros::format_description!("[year]-[month]-[day]"))
1604
        .map(|d| Some(d.midnight().assume_utc().unix_timestamp() * 1000))
1605
        .map_err(|_| ApiError(StatusCode::BAD_REQUEST, format!("due {due:?} is not YYYY-MM-DD")))
1606
}
1607
1608
async fn triage_for_milestones(app: &Shared, headers: &HeaderMap, owner: &str, name: &str) -> Result<db::repos::RepoRow, ApiError> {
1609
    let c = caller(app, headers).await?;
1610
    c.require("issues:write").or_else(|_| c.require("repo:write"))?;
1611
    let (_, row, role) = reach(app, &c, owner, name, Access::Read).await?;
1612
    if role < Role::Triage {
1613
        return Err(forbidden("milestones need triage access"));
1614
    }
1615
    Ok(row)
1616
}
1617
1618
/// `POST /repos/{o}/{n}/milestones` (triage, oxygenhub#91): create a
1619
/// milestone, or change the description and due date of the one with
1620
/// that title.
1621
async fn create_milestone(
1622
    State(app): State<Shared>,
1623
    headers: HeaderMap,
1624
    Path((owner, name)): Path<(String, String)>,
1625
    Json(body): Json<NewMilestone>,
1626
) -> Result<(StatusCode, Json<Milestone>), ApiError> {
1627
    let row = triage_for_milestones(&app, &headers, &owner, &name).await?;
1628
    let title = body.title.trim();
1629
    if title.is_empty() || title.len() > 100 {
1630
        return Err(ApiError(StatusCode::BAD_REQUEST, "a milestone has a title of 1 to 100 characters".into()));
1631
    }
1632
    let due_ms = due_ms_of(body.due.as_deref().unwrap_or(""))?;
1633
    let m = db::issues::upsert_milestone(&app.db, row.id, title, body.description.trim(), due_ms).await?;
1634
    let (open, closed) = db::issues::milestone_counts(&app.db, m.id).await?;
1635
    Ok((StatusCode::CREATED, Json(milestone_of(m, open, closed))))
1636
}
1637
1638
/// `PATCH /repos/{o}/{n}/milestones/{title}` (triage): title,
1639
/// description, due date and state; what is not given stays.
1640
async fn edit_milestone(
1641
    State(app): State<Shared>,
1642
    headers: HeaderMap,
1643
    Path((owner, name, title)): Path<(String, String, String)>,
1644
    Json(body): Json<MilestoneEdit>,
1645
) -> Result<Json<Milestone>, ApiError> {
1646
    let row = triage_for_milestones(&app, &headers, &owner, &name).await?;
1647
    let m = db::issues::milestones(&app.db, row.id)
1648
        .await?
1649
        .into_iter()
1650
        .find(|m| m.title == title)
1651
        .ok_or_else(|| not_found("no such milestone"))?;
1652
    let new_title = body.title.as_deref().map(str::trim).unwrap_or(&m.title);
1653
    if new_title.is_empty() || new_title.len() > 100 {
1654
        return Err(ApiError(StatusCode::BAD_REQUEST, "a milestone has a title of 1 to 100 characters".into()));
1655
    }
1656
    let due_ms = match body.due.as_deref() {
1657
        Some(d) => due_ms_of(d)?,
1658
        None => m.due_ms,
1659
    };
1660
    let description = body.description.as_deref().map(str::trim).unwrap_or(&m.description);
1661
    if body.title.is_some() || body.description.is_some() || body.due.is_some() {
1662
        db::issues::update_milestone(&app.db, m.id, new_title, description, due_ms).await?;
1663
    }
1664
    if let Some(state) = body.state.as_deref() {
1665
        match state {
1666
            "open" | "closed" => db::issues::set_milestone_state(&app.db, m.id, state).await?,
1667
            other => return Err(ApiError(StatusCode::BAD_REQUEST, format!("state {other:?} is open or closed"))),
1668
        }
1669
    }
1670
    let fresh = db::issues::milestone(&app.db, m.id).await?.ok_or_else(|| not_found("no such milestone"))?;
1671
    let (open, closed) = db::issues::milestone_counts(&app.db, fresh.id).await?;
1672
    Ok(Json(milestone_of(fresh, open, closed)))
1673
}
1674
b64e2537 Andy McCall ↶ 1675
// --------------------------------------------------------- hooks, checks
1676
1677
fn hook_of(h: &db::hooks::Hook) -> Hook {
1678
    Hook { id: h.id, url: h.url.clone(), events: h.events.clone(), active: h.active, created_ms: h.created_ms }
1679
}
1680
1681
async fn hooks(
1682
    State(app): State<Shared>,
1683
    headers: HeaderMap,
1684
    Path((owner, name)): Path<(String, String)>,
1685
) -> Result<Json<Vec<Hook>>, ApiError> {
1686
    let c = caller(&app, &headers).await?;
1687
    c.require("hooks:admin").or_else(|_| c.require("repo:admin"))?;
1688
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Admin).await?;
1689
    Ok(Json(db::hooks::hooks_for_repo(&app.db, row.id).await?.iter().map(hook_of).collect()))
d23464c0 Andy McCall ↶ 1690
}
1691
b64e2537 Andy McCall ↶ 1692
async fn create_hook(
1693
    State(app): State<Shared>,
1694
    headers: HeaderMap,
1695
    Path((owner, name)): Path<(String, String)>,
1696
    Json(body): Json<NewHook>,
1697
) -> Result<(StatusCode, Json<Hook>), ApiError> {
1698
    let c = caller(&app, &headers).await?;
1699
    let me = c.require("hooks:admin").or_else(|_| c.require("repo:admin"))?.clone();
1700
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Admin).await?;
1701
    if !(body.url.starts_with("http://") || body.url.starts_with("https://")) {
1702
        return Err(ApiError(StatusCode::BAD_REQUEST, "the URL must be http or https".into()));
1703
    }
1704
    let h = db::hooks::create_hook(&app.db, Some(row.id), None, &body.url, &body.secret, &body.events).await?;
1705
    db::accounts::audit(&app.db, Some(&me), "hook.created", &row.slug(), &body.url).await.ok();
1706
    Ok((StatusCode::CREATED, Json(hook_of(&h))))
d23464c0 Andy McCall ↶ 1707
}
1708
b64e2537 Andy McCall ↶ 1709
async fn delete_hook(
1710
    State(app): State<Shared>,
1711
    headers: HeaderMap,
1712
    Path((owner, name, id)): Path<(String, String, i64)>,
1713
) -> Result<StatusCode, ApiError> {
1714
    let c = caller(&app, &headers).await?;
1715
    c.require("hooks:admin").or_else(|_| c.require("repo:admin"))?;
1716
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Admin).await?;
1717
    if db::hooks::hook(&app.db, id).await?.is_some_and(|h| h.repo_id == Some(row.id)) {
1718
        db::hooks::delete_hook(&app.db, id).await?;
1719
    }
1720
    Ok(StatusCode::NO_CONTENT)
d23464c0 Andy McCall ↶ 1721
}
1722
b64e2537 Andy McCall ↶ 1723
pub fn check_of(c: &db::hooks::Check) -> Check {
1724
    Check {
1725
        state: c.state.clone(),
1726
        name: c.name.clone(),
1727
        status: CheckStatus::parse(&c.status).unwrap_or(CheckStatus::Queued),
1728
        summary: c.summary.clone(),
1729
        url: c.url.clone(),
1730
        reporter: c.reporter.clone(),
1731
        seal: if c.seal.is_empty() { None } else { Some(c.seal.clone()) },
1732
        started_ms: c.started_ms,
1733
        finished_ms: c.finished_ms,
1734
    }
961c10be Andy McCall ↶ 1735
}
1736
1737
/// `GET /repos/{o}/{n}/checks/required`.
1738
async fn required_checks(
1739
    State(app): State<Shared>,
1740
    headers: HeaderMap,
1741
    Path((owner, name)): Path<(String, String)>,
1742
) -> Result<Json<RequiredChecks>, ApiError> {
1743
    let c = caller(&app, &headers).await?;
1744
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1745
    Ok(Json(RequiredChecks { names: db::hooks::required_checks(&app.db, row.id).await? }))
1746
}
1747
1748
/// `PUT /repos/{o}/{n}/checks/required` (repository admin): the whole list.
1749
async fn set_required_checks(
1750
    State(app): State<Shared>,
1751
    headers: HeaderMap,
1752
    Path((owner, name)): Path<(String, String)>,
1753
    Json(body): Json<RequiredChecks>,
1754
) -> Result<Json<RequiredChecks>, ApiError> {
1755
    let c = caller(&app, &headers).await?;
1756
    c.require("repo:admin")?;
1757
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Admin).await?;
1758
    let mut names: Vec<String> = body.names.iter().map(|n| n.trim().to_string()).filter(|n| !n.is_empty()).collect();
1759
    names.sort();
1760
    names.dedup();
1761
    if names.len() > 32 || names.iter().any(|n| n.len() > 100 || n.contains(',')) {
1762
        return Err(ApiError(StatusCode::BAD_REQUEST, "at most 32 check names, each under 100 characters and without commas".into()));
1763
    }
1764
    db::hooks::set_required_checks(&app.db, row.id, &names).await?;
1765
    db::accounts::audit(&app.db, c.account.as_ref(), "repo.required_checks", &format!("{owner}/{name}"), &names.join(", ")).await.ok();
1766
    Ok(Json(RequiredChecks { names }))
1edac4b6 Andy McCall ↶ 1767
}
1768
bf3d0754 Andy McCall ↶ 1769
fn flow_run_of(
1770
    app: &Shared,
1771
    row: &db::repos::RepoRow,
1772
    r: &db::flow::Run,
1773
    jobs: Vec<db::flow::Job>,
1774
    queue: &[db::flow::QueueEntry],
1775
) -> FlowRun {
90326c96 Andy McCall ↶ 1776
    FlowRun {
bf3d0754 Andy McCall ↶ 1777
        queue_position: crate::flow::queue_info(queue, row.id, r.id).position.map(|p| p as i64),
90326c96 Andy McCall ↶ 1778
        number: r.number,
1779
        bookmark: r.bookmark.clone(),
1780
        state: r.state.clone(),
1781
        heads: r.head_list().into_iter().map(String::from).collect(),
1782
        status: r.status.clone(),
c889911b Andy McCall ↶ 1783
        trigger: r.trigger_label(),
90326c96 Andy McCall ↶ 1784
        actor: r.actor.clone(),
1785
        pipeline_hash: r.pipeline_hash.clone(),
1786
        error: r.error.clone(),
1787
        created_ms: r.created_ms,
1788
        finished_ms: r.finished_ms,
1789
        url: format!("{}/{}/{}/flow/{}", app.config.base_url(), row.owner, row.name, r.number),
1790
        jobs: jobs
1791
            .into_iter()
1792
            .map(|j| FlowJob {
1793
                depends_on: j.depends_on(),
1794
                name: j.name,
1795
                status: j.status,
1796
                runner: j.runner,
1797
                exit_code: j.exit_code,
1798
                error: j.error,
1799
                started_ms: j.started_ms,
1800
                finished_ms: j.finished_ms,
1801
                log_lines: j.log_count,
1802
            })
1803
            .collect(),
1804
    }
1805
}
1806
1edac4b6 Andy McCall ↶ 1807
#[derive(Deserialize)]
90326c96 Andy McCall ↶ 1808
struct RunsPage {
1809
    /// Runs numbered below this one (the next page).
1810
    before: Option<i64>,
1811
    limit: Option<i64>,
1812
}
1813
1814
/// `GET /repos/{o}/{n}/flow/runs`: newest first, `?before=N&limit=` (max 100).
1815
async fn flow_runs(
1816
    State(app): State<Shared>,
1817
    headers: HeaderMap,
1818
    Path((owner, name)): Path<(String, String)>,
1819
    Query(q): Query<RunsPage>,
1820
) -> Result<Json<Vec<FlowRun>>, ApiError> {
1821
    let c = caller(&app, &headers).await?;
1822
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1823
    let limit = q.limit.unwrap_or(30).clamp(1, 100);
1824
    let runs = db::flow::runs_by_number(&app.db, row.id, limit, q.before).await?;
bf3d0754 Andy McCall ↶ 1825
    let queue = if runs.iter().any(|r| r.live()) { db::flow::queue(&app.db).await? } else { vec![] };
1826
    Ok(Json(runs.iter().map(|r| flow_run_of(&app, &row, r, vec![], &queue)).collect()))
90326c96 Andy McCall ↶ 1827
}
1828
1829
/// `GET /repos/{o}/{n}/flow/runs/{number}`: a run with its jobs.
1830
async fn flow_run(
1831
    State(app): State<Shared>,
1832
    headers: HeaderMap,
1833
    Path((owner, name, number)): Path<(String, String, i64)>,
1834
) -> Result<Json<FlowRun>, ApiError> {
1835
    let c = caller(&app, &headers).await?;
1836
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1837
    let run = db::flow::run(&app.db, row.id, number).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
1838
    let jobs = db::flow::jobs(&app.db, run.id).await?;
bf3d0754 Andy McCall ↶ 1839
    let queue = if run.live() { db::flow::queue(&app.db).await? } else { vec![] };
1840
    Ok(Json(flow_run_of(&app, &row, &run, jobs, &queue)))
90326c96 Andy McCall ↶ 1841
}
1842
1843
#[derive(Deserialize)]
1844
struct LogPage {
1845
    /// Lines after this `seq`.
1846
    #[serde(default)]
1847
    after: i64,
1848
    limit: Option<i64>,
1849
}
1850
1851
/// `GET /repos/{o}/{n}/flow/runs/{number}/jobs/{job}/log`: `?after=seq&limit=` (max 5000).
1852
async fn flow_job_log(
1853
    State(app): State<Shared>,
1854
    headers: HeaderMap,
1855
    Path((owner, name, number, job)): Path<(String, String, i64, String)>,
1856
    Query(q): Query<LogPage>,
1857
) -> Result<Json<Vec<FlowLogLine>>, ApiError> {
1858
    let c = caller(&app, &headers).await?;
1859
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1860
    let run = db::flow::run(&app.db, row.id, number).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
1861
    let j = db::flow::jobs(&app.db, run.id)
1862
        .await?
1863
        .into_iter()
1864
        .find(|j| j.name == job)
1865
        .ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such job".into()))?;
1866
    let lines = db::flow::log(&app.db, j.id, q.after, q.limit.unwrap_or(1000).clamp(1, 5000)).await?;
1867
    Ok(Json(lines.into_iter().map(|l| FlowLogLine { seq: l.seq, t: l.t, stream: l.stream, text: l.text }).collect()))
1868
}
1869
1870
#[derive(Deserialize)]
1edac4b6 Andy McCall ↶ 1871
struct StartRun {
1872
    /// Default: the repository's default bookmark.
1873
    #[serde(default)]
1874
    bookmark: Option<String>,
4f692533 Andy McCall ↶ 1875
    /// A change's full hash: run the state whose only head it is, instead
1876
    /// of a bookmark's.
1877
    #[serde(default)]
1878
    change: Option<String>,
1edac4b6 Andy McCall ↶ 1879
}
1880
1881
fn started(app: &Shared, row: &db::repos::RepoRow, number: i64) -> (StatusCode, Json<serde_json::Value>) {
1882
    let url = format!("{}/{}/{}/flow/{number}", app.config.base_url(), row.owner, row.name);
1883
    (StatusCode::CREATED, Json(serde_json::json!({ "number": number, "url": url })))
1884
}
1885
1886
/// `POST /repos/{o}/{n}/flow/runs` (repo:write): run a bookmark's current
4f692533 Andy McCall ↶ 1887
/// state, or one change's, without moving anything (hub spec §13.2).
1edac4b6 Andy McCall ↶ 1888
async fn start_flow_run(
1889
    State(app): State<Shared>,
1890
    headers: HeaderMap,
1891
    Path((owner, name)): Path<(String, String)>,
1892
    Json(body): Json<StartRun>,
1893
) -> Result<(StatusCode, Json<serde_json::Value>), ApiError> {
1894
    let c = caller(&app, &headers).await?;
1895
    let me = c.require("repo:write")?.clone();
1896
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
4f692533 Andy McCall ↶ 1897
    let (n, what) = match body.change.filter(|c| !c.trim().is_empty()) {
1898
        Some(change) => {
1899
            let n = crate::flow::run_change(&app, &row, &change, &me.username).await.map_err(|m| ApiError(StatusCode::CONFLICT, m))?;
1900
            (n, format!("change {}", change.trim()))
1901
        }
1902
        None => {
1903
            let bookmark = body.bookmark.unwrap_or_else(|| row.default_bookmark.clone());
1904
            (crate::flow::run_bookmark(&app, &row, &bookmark, &me.username).await.map_err(|m| ApiError(StatusCode::CONFLICT, m))?, bookmark)
1905
        }
1906
    };
1907
    db::accounts::audit(&app.db, Some(&me), "flow.run", &format!("{owner}/{name}"), &format!("#{n} {what}")).await.ok();
1edac4b6 Andy McCall ↶ 1908
    Ok(started(&app, &row, n))
1909
}
1910
1911
/// `POST /repos/{o}/{n}/flow/runs/{number}/rerun` (repo:write).
1912
async fn rerun_flow_run(
1913
    State(app): State<Shared>,
1914
    headers: HeaderMap,
1915
    Path((owner, name, number)): Path<(String, String, i64)>,
1916
) -> Result<(StatusCode, Json<serde_json::Value>), ApiError> {
1917
    let c = caller(&app, &headers).await?;
1918
    let me = c.require("repo:write")?.clone();
1919
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
1920
    let run = db::flow::run(&app.db, row.id, number).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
1921
    let n = crate::flow::rerun(&app, &row, &run, &me.username).await.map_err(|m| ApiError(StatusCode::CONFLICT, m))?;
1922
    db::accounts::audit(&app.db, Some(&me), "flow.rerun", &format!("{owner}/{name}"), &format!("#{n} of #{number}")).await.ok();
1923
    Ok(started(&app, &row, n))
d23464c0 Andy McCall ↶ 1924
}
1925
745d225d Andy McCall ↶ 1926
/// `POST /repos/{o}/{n}/flow/runs/{number}/cancel` (repo:write): answers
1927
/// with the run as it now stands.
1928
async fn cancel_flow_run(
1929
    State(app): State<Shared>,
1930
    headers: HeaderMap,
1931
    Path((owner, name, number)): Path<(String, String, i64)>,
1932
) -> Result<Json<serde_json::Value>, ApiError> {
1933
    let c = caller(&app, &headers).await?;
1934
    let me = c.require("repo:write")?.clone();
1935
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Write).await?;
1936
    let run = db::flow::run(&app.db, row.id, number).await?.ok_or_else(|| ApiError(StatusCode::NOT_FOUND, "no such run".into()))?;
1937
    crate::flow::cancel(&app, &row, &run, &me.username).await.map_err(|m| ApiError(StatusCode::CONFLICT, m))?;
1938
    db::accounts::audit(&app.db, Some(&me), "flow.cancel", &format!("{owner}/{name}"), &format!("#{number}")).await.ok();
1939
    Ok(Json(serde_json::json!({ "number": number, "status": "cancelled" })))
1940
}
1941
b64e2537 Andy McCall ↶ 1942
/// `POST /repos/{o}/{n}/checks`: any `checks:write` (or write) token may
1943
/// report; the state hash names what was checked.
1944
async fn post_check(
1945
    State(app): State<Shared>,
1946
    headers: HeaderMap,
1947
    Path((owner, name)): Path<(String, String)>,
1948
    Json(body): Json<NewCheck>,
1949
) -> Result<(StatusCode, Json<Check>), ApiError> {
1950
    let c = caller(&app, &headers).await?;
1951
    let me = c.require("checks:write").or_else(|_| c.require("repo:write"))?.clone();
1952
    let (_, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1953
    if body.state.len() != 64 || !body.state.chars().all(|ch| ch.is_ascii_hexdigit()) {
1954
        return Err(ApiError(StatusCode::BAD_REQUEST, "state is a 64-character hex state hash".into()));
1955
    }
1956
    if body.name.trim().is_empty() || body.name.len() > 100 {
1957
        return Err(ApiError(StatusCode::BAD_REQUEST, "a check has a short name".into()));
1958
    }
1959
    let ch = db::hooks::upsert_check(
1960
        &app.db,
1961
        row.id,
1962
        &body.state,
1963
        body.name.trim(),
1964
        body.status.as_str(),
1965
        &body.summary,
1966
        &body.url,
1967
        Some((me.id, &me.username)),
1968
        body.seal.as_deref().unwrap_or(""),
1969
    )
1970
    .await?;
1971
    let api = check_of(&ch);
1972
    app.events.proposal(row.id, ProposalEvent { number: 0, kind: "check".into(), check: Some(api.clone()) });
1973
    crate::hooks::emit(&app, &row, "check", &me.username, serde_json::json!({ "check": api })).await;
1974
    Ok((StatusCode::CREATED, Json(api)))
d23464c0 Andy McCall ↶ 1975
}
1976
b64e2537 Andy McCall ↶ 1977
async fn checks_for_state(
1978
    State(app): State<Shared>,
1979
    headers: HeaderMap,
1980
    Path((owner, name, state)): Path<(String, String, String)>,
1981
) -> Result<Json<Vec<Check>>, ApiError> {
1982
    let c = caller(&app, &headers).await?;
90326c96 Andy McCall ↶ 1983
    let (repo, row, _) = reach(&app, &c, &owner, &name, Access::Read).await?;
1984
    let state = state_key(&app, &repo, &state).await?;
b64e2537 Andy McCall ↶ 1985
    Ok(Json(db::hooks::checks_for_state(&app.db, row.id, &state).await?.iter().map(check_of).collect()))
90326c96 Andy McCall ↶ 1986
}
1987
1988
/// The state hash checks are keyed by, from what a client has: a state
1989
/// hash, its heads (full change hashes joined with `+`, or the one head of
1990
/// a single-head state, which is what `oxy log` shows), or a bookmark.
1991
async fn state_key(app: &Shared, repo: &RepoName, s: &str) -> Result<String, ApiError> {
1992
    use oxy_core::hash::{hash_object, ChangeHash, ObjectType};
1993
    let hexes: Vec<&str> = s.split('+').collect();
1994
    let all_hashes = hexes.iter().all(|h| h.len() == 64 && h.bytes().all(|b| b.is_ascii_hexdigit()));
1995
    if all_hashes {
1996
        let row = db::repos::get(&app.db, &repo.owner, &repo.name).await?.ok_or_else(|| not_found("no such repository"))?;
1997
        if hexes.len() == 1 && !db::hooks::checks_for_state(&app.db, row.id, s).await?.is_empty() {
1998
            return Ok(s.to_string());
1999
        }
2000
        let heads: Vec<ChangeHash> = hexes.iter().filter_map(|h| ChangeHash::from_hex(h)).collect();
2001
        return Ok(hash_object(ObjectType::State, &oxy_core::objects::StateObject::new(heads).encode()).to_hex());
2002
    }
2003
    let b = s.to_string();
2004
    let found = app.repos.read(repo, move |r, _| Ok(r.view()?.bookmarks.get(&b).copied())).await?;
2005
    found.map(|st| st.to_hex()).ok_or_else(|| ApiError(StatusCode::NOT_FOUND, format!("{s:?} is not a state hash, heads or a bookmark")))
d23464c0 Andy McCall ↶ 2006
}
b66e70b7 Andy McCall ↶ 2007
2008
// ----------------------------------------------------------------- runners
2009
2010
/// Site administrators only, with any token of theirs (hub spec §13.2).
2011
fn require_site_admin(c: &Caller) -> Result<&Account, ApiError> {
2012
    match c.account.as_ref() {
2013
        Some(a) if a.is_admin => Ok(a),
2014
        _ => Err(not_found("no such API route")),
2015
    }
2016
}
2017
2018
async fn runner_of(app: &Shared, r: db::runners::Runner, running: i64) -> hub_api::Runner {
2019
    let serves = match r.scope_repo_id {
2020
        Some(id) => db::repos::get_by_id(&app.db, id).await.ok().flatten().map(|p| p.slug()).unwrap_or_default(),
2021
        None => r.scope_owner.clone(),
2022
    };
2023
    hub_api::Runner {
2024
        id: r.id,
2025
        status: r.status().to_string(),
2026
        serves,
2027
        labels: r.label_list().into_iter().map(String::from).collect(),
2028
        name: r.name,
2029
        arch: r.arch,
2030
        os: r.os,
2031
        version: r.version,
2032
        max_jobs: r.max_jobs,
2033
        memory_mib: r.memory_mib,
2034
        cpus: r.cpus,
2035
        key: r.key,
2036
        source: r.source,
2037
        last_seen_ms: r.last_seen_ms,
2038
        running,
2039
    }
2040
}
2041
2042
/// `GET /api/v1/runners`.
2043
async fn runners(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<Vec<hub_api::Runner>>, ApiError> {
2044
    let c = caller(&app, &headers).await?;
2045
    require_site_admin(&c)?;
2046
    let running: std::collections::HashMap<i64, i64> = db::runners::running(&app.db).await?.into_iter().collect();
2047
    let mut out = Vec::new();
2048
    for r in db::runners::list(&app.db).await? {
2049
        let n = running.get(&r.id).copied().unwrap_or(0);
2050
        out.push(runner_of(&app, r, n).await);
2051
    }
2052
    Ok(Json(out))
2053
}
2054
2055
#[derive(Deserialize)]
2056
struct BeforeQuery {
2057
    #[serde(default)]
2058
    before: Option<i64>,
2059
    #[serde(default)]
2060
    limit: Option<i64>,
2061
}
2062
2063
/// `GET /api/v1/runners/{id}/jobs?before=MS&limit=N`: newest first.
2064
async fn runner_jobs(
2065
    State(app): State<Shared>,
2066
    headers: HeaderMap,
2067
    Path(id): Path<i64>,
2068
    Query(q): Query<BeforeQuery>,
2069
) -> Result<Json<Vec<hub_api::RunnerJob>>, ApiError> {
2070
    let c = caller(&app, &headers).await?;
2071
    require_site_admin(&c)?;
2072
    db::runners::get(&app.db, id).await?.ok_or_else(|| not_found("no such runner"))?;
2073
    let jobs = db::runners::history(&app.db, id, q.limit.unwrap_or(50).clamp(1, 200), q.before).await?;
2074
    Ok(Json(
2075
        jobs.into_iter()
2076
            .map(|j| hub_api::RunnerJob {
2077
                repo: format!("{}/{}", j.owner, j.repo),
2078
                run: j.run_number,
2079
                job: j.job,
2080
                status: j.status,
2081
                started_ms: j.started_ms,
2082
                finished_ms: j.finished_ms,
2083
            })
2084
            .collect(),
2085
    ))
2086
}
2087
2088
/// `GET /api/v1/runners/queue`: running jobs, then queued ones in claim order.
2089
async fn runner_queue(State(app): State<Shared>, headers: HeaderMap) -> Result<Json<Vec<hub_api::QueueItem>>, ApiError> {
2090
    let c = caller(&app, &headers).await?;
2091
    require_site_admin(&c)?;
2092
    Ok(Json(
2093
        db::flow::queue(&app.db)
2094
            .await?
2095
            .into_iter()
2096
            .map(|e| hub_api::QueueItem {
2097
                repo: format!("{}/{}", e.owner, e.name),
2098
                run: e.run_number,
2099
                job: e.job,
2100
                status: e.status,
2101
                runner: e.runner,
2102
            })
2103
            .collect(),
2104
    ))
2105
}