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