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