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