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