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