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