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