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