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