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