OXYGENHUB

Coverage / crates/hub/src/api/projects.rs 93.6%

307 of 328 lines run, 63 of 144 functions · run #503 on main · run missed

1
//! Projects over the API (hub spec §8.2, §12.1): the same rules as the
2
//! pages, through the functions they use.
3
4
use super::{caller, forbidden, not_found, ApiError, Caller};
5
use crate::db::projects as pdb;
6
use crate::web::projects as wp;
7
use crate::Shared;
8
use axum::extract::{Path, Query, State};
9
use axum::http::{HeaderMap, StatusCode};
10
use axum::Json;
11
use hub_api::{
12
    Board, CardMove, CardsArchive, CardsArchived, CardsMove, CardsMoved, NewCard, NewProject, Project, ProjectCard, ProjectColumn,
13
    ProjectEdit,
14
};
15
1617×
fn project_of(app: &Shared, p: &pdb::Project) -> Project {
1717×
    Project {
1817×
        owner: p.owner.clone(),
1917×
        number: p.number,
2017×
        title: p.title.clone(),
2117×
        description: p.description.clone(),
2217×
        public: p.public,
2317×
        closed: p.closed,
2417×
        updated_ms: p.updated_ms,
2517×
        url: format!("{}/projects/{}/{}", app.config.base_url().trim_end_matches('/'), p.owner, p.number),
2617×
    }
2717×
}
28
2946×
fn card_of(v: &wp::CardView) -> ProjectCard {
30
    ProjectCard {
3146×
        id: v.card.id,
3246×
        kind: v.card.kind.clone(),
3346×
        reference: v.reference.clone(),
3446×
        title: v.title.clone(),
3546×
        state: v.state.clone(),
3646×
        labels: v.labels.iter().map(|l| l.name.clone()).collect(),
3746×
        assignees: v.assignees.clone(),
3846×
        archived_ms: v.card.archived_ms,
39
    }
4046×
}
41
4251×
async fn rights(app: &Shared, c: &Caller, owner: &str) -> Result<wp::Rights, ApiError> {
4351×
    wp::rights_of(app, c.account.as_ref(), owner).await?.ok_or_else(|| not_found("no such owner"))
4451×
}
45
46
/// A project the caller may see.
4744×
async fn visible(app: &Shared, c: &Caller, owner: &str, number: i64) -> Result<(wp::Rights, pdb::Project), ApiError> {
4844×
    let r = rights(app, c, owner).await?;
4944×
    let p = pdb::get(&app.db, owner, number).await?.filter(|p| p.public || r.member).ok_or_else(|| not_found("no such project"))?;
5043×
    Ok((r, p))
5144×
}
52
53
/// A project the caller may change: a write token, edit rights, and open unless `closed_ok`.
5433×
async fn changeable(
5533×
    app: &Shared,
5633×
    headers: &HeaderMap,
5733×
    owner: &str,
5833×
    number: i64,
5933×
    closed_ok: bool,
6033×
) -> Result<(Caller, pdb::Project), ApiError> {
6133×
    let c = caller(app, headers).await?;
6233×
    c.require("repo:write")?;
6333×
    let (r, p) = visible(app, &c, owner, number).await?;
6433×
    if !r.edit {
653×
        return Err(forbidden("only the owner (or the organisation's members) may change this project"));
6630×
    }
6730×
    if p.closed && !closed_ok {
681×
        return Err(ApiError(StatusCode::CONFLICT, "this project is closed; reopen it to change it".into()));
6929×
    }
7029×
    Ok((c, p))
7133×
}
72
73
/// A column by id or by name (case-insensitive); the first when absent.
7424×
async fn column(app: &Shared, project_id: i64, spec: Option<&str>) -> Result<pdb::Column, ApiError> {
7524×
    let cols = pdb::columns(&app.db, project_id).await?;
7624×
    let found = match spec.map(str::trim).filter(|s| !s.is_empty()) {
776×
        None => cols.into_iter().next(),
7847×
        Some(s) => cols.into_iter().find(|c| c.id.to_string() == s || c.name.eq_ignore_ascii_case(s)),
79
    };
8024×
    found.ok_or_else(|| ApiError(StatusCode::BAD_REQUEST, "no such column".into()))
8124×
}
82
83
/// `GET /projects/{owner}`.
842×
pub async fn list(State(app): State<Shared>, headers: HeaderMap, Path(owner): Path<String>) -> Result<Json<Vec<Project>>, ApiError> {
852×
    let c = caller(&app, &headers).await?;
862×
    let r = rights(&app, &c, &owner).await?;
872×
    let list = pdb::of_owner(&app.db, &owner).await?;
882×
    Ok(Json(list.iter().filter(|p| p.public || r.member).map(|p| project_of(&app, p)).collect()))
892×
}
90
91
/// `POST /projects/{owner}`.
925×
pub async fn create(
935×
    State(app): State<Shared>,
945×
    headers: HeaderMap,
955×
    Path(owner): Path<String>,
965×
    Json(body): Json<NewProject>,
975×
) -> Result<(StatusCode, Json<Project>), ApiError> {
985×
    let c = caller(&app, &headers).await?;
995×
    c.require("repo:write")?;
1005×
    if !rights(&app, &c, &owner).await?.edit {
1011×
        return Err(forbidden("only the owner (or the organisation's members) may create projects"));
1023×
    }
1033×
    let title = body.title.trim();
1043×
    if title.is_empty() || title.chars().count() > 100 {
1050×
        return Err(ApiError(StatusCode::BAD_REQUEST, "a project needs a title of up to 100 characters".into()));
1063×
    }
1073×
    let p = pdb::create(&app.db, &owner, title, body.description.trim(), !body.private).await?;
1083×
    crate::db::accounts::audit(&app.db, c.account.as_ref(), "project.created", &format!("{owner}/{}", p.number), title).await.ok();
1093×
    Ok((StatusCode::CREATED, Json(project_of(&app, &p))))
1105×
}
111
112
/// `GET /projects/{owner}/{n}`.
11310×
pub async fn board(
11410×
    State(app): State<Shared>,
11510×
    headers: HeaderMap,
11610×
    Path((owner, number)): Path<(String, i64)>,
11710×
) -> Result<Json<Board>, ApiError> {
11810×
    let c = caller(&app, &headers).await?;
11910×
    let (_, p) = visible(&app, &c, &owner, number).await?;
1209×
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p, false).await?;
121
    Ok(Json(Board {
1229×
        project: project_of(&app, &p),
1239×
        columns: columns
1249×
            .iter()
12527×
            .map(|col| ProjectColumn { id: col.column.id, name: col.column.name.clone(), cards: col.cards.iter().map(card_of).collect() })
1269×
            .collect(),
127
    }))
12810×
}
129
130
/// `PATCH /projects/{owner}/{n}`.
1314×
pub async fn edit(
1324×
    State(app): State<Shared>,
1334×
    headers: HeaderMap,
1344×
    Path((owner, number)): Path<(String, i64)>,
1354×
    Json(body): Json<ProjectEdit>,
1364×
) -> Result<Json<Project>, ApiError> {
1374×
    let (c, p) = changeable(&app, &headers, &owner, number, true).await?;
138
    // A transfer (#125) first: the other fields then apply where it went.
1394×
    let (owner, number) = match body.owner.as_deref().map(str::trim).filter(|to| !to.is_empty() && *to != owner) {
1400×
        Some(to) => match wp::rights_of(&app, c.account.as_ref(), to).await? {
1410×
            Some(r) if r.edit => {
1420×
                let moved = pdb::transfer(&app.db, p.id, to).await?;
1430×
                let detail = format!("{owner}/{number} to {to}/{}", moved.number);
1440×
                crate::db::accounts::audit(&app.db, c.account.as_ref(), "project.transferred", &detail, &p.title).await.ok();
1450×
                (moved.owner, moved.number)
146
            }
1470×
            _ => return Err(ApiError(StatusCode::FORBIDDEN, format!("you cannot make projects under {to}"))),
148
        },
1494×
        None => (owner, number),
150
    };
1514×
    let p = pdb::get(&app.db, &owner, number).await?.unwrap_or(p);
1524×
    let title = body.title.as_deref().map(str::trim).filter(|t| !t.is_empty()).unwrap_or(&p.title).chars().take(100).collect::<String>();
1534×
    pdb::set(
1544×
        &app.db,
1554×
        p.id,
1564×
        &title,
1574×
        body.description.as_deref().map(str::trim).unwrap_or(&p.description),
1584×
        body.private.map(|x| !x).unwrap_or(p.public),
1594×
        body.closed.unwrap_or(p.closed),
160
    )
1614×
    .await?;
1624×
    let fresh = pdb::get(&app.db, &owner, number).await?.unwrap_or(p);
1634×
    Ok(Json(project_of(&app, &fresh)))
1644×
}
165
166
/// `GET /projects/{owner}/{n}/cards`: the cards by column, as the board
167
/// has them.
168
#[derive(serde::Deserialize, Default)]
169
pub struct CardsQuery {
170
    /// The archived cards instead (#293).
171
    #[serde(default)]
172
    archived: bool,
173
}
174
175
/// `GET /projects/{owner}/{n}/cards`, `?archived=true` for the archived ones.
1762×
pub async fn cards(
1772×
    State(app): State<Shared>,
1782×
    headers: HeaderMap,
1792×
    Path((owner, number)): Path<(String, i64)>,
1802×
    Query(q): Query<CardsQuery>,
1812×
) -> Result<Json<Vec<ProjectColumn>>, ApiError> {
1822×
    if !q.archived {
1831×
        return Ok(Json(board(State(app), headers, Path((owner, number))).await?.0.columns));
1841×
    }
1851×
    let c = caller(&app, &headers).await?;
1861×
    let (_, p) = visible(&app, &c, &owner, number).await?;
1871×
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p, true).await?;
188
    Ok(Json(
1891×
        columns
1901×
            .iter()
1913×
            .map(|col| ProjectColumn { id: col.column.id, name: col.column.name.clone(), cards: col.cards.iter().map(card_of).collect() })
1921×
            .collect(),
193
    ))
1942×
}
195
196
/// `POST /projects/{owner}/{n}/cards`.
19713×
pub async fn add_card(
19813×
    State(app): State<Shared>,
19913×
    headers: HeaderMap,
20013×
    Path((owner, number)): Path<(String, i64)>,
20113×
    Json(body): Json<NewCard>,
20213×
) -> Result<(StatusCode, Json<ProjectCard>), ApiError> {
20313×
    let (c, p) = changeable(&app, &headers, &owner, number, false).await?;
20411×
    let col = column(&app, p.id, body.column.as_deref()).await?;
20510×
    let actor = c.account.as_ref().map(|a| a.username.clone()).unwrap_or_default();
20610×
    let card = match wp::add_card(&app, c.account.as_ref(), &owner, p.id, col.id, &body.reference, "", &body.note, &actor).await? {
2076×
        Ok(card) => card,
2084×
        Err(why) => return Err(ApiError(StatusCode::BAD_REQUEST, why)),
209
    };
210
    // Answer with the card as the board shows it.
2116×
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p, false).await?;
2126×
    let view = columns
2136×
        .iter()
21410×
        .flat_map(|col| col.cards.iter())
2159×
        .find(|v| v.card.id == card.id)
2166×
        .map(card_of)
2176×
        .ok_or_else(|| not_found("no such card"))?;
2186×
    Ok((StatusCode::CREATED, Json(view)))
21913×
}
220
221
/// `PATCH /projects/{owner}/{n}/cards/{id}`: move to another column.
2222×
pub async fn move_card(
2232×
    State(app): State<Shared>,
2242×
    headers: HeaderMap,
2252×
    Path((owner, number, id)): Path<(String, i64, i64)>,
2262×
    Json(body): Json<CardMove>,
2272×
) -> Result<StatusCode, ApiError> {
2282×
    let (_, p) = changeable(&app, &headers, &owner, number, false).await?;
2292×
    let col = column(&app, p.id, Some(&body.column)).await?;
2302×
    if !pdb::cards(&app.db, p.id).await?.iter().any(|c| c.id == id) {
2310×
        return Err(not_found("no such card"));
2322×
    }
2332×
    pdb::move_card(&app.db, p.id, id, col.id).await?;
2342×
    Ok(StatusCode::NO_CONTENT)
2352×
}
236
237
/// Whether `card` is the one `name` names: its id, or its issue or
238
/// proposal as `12`, `#12`, `name#12` or `owner/name#12`.
2394×
fn names_card(name: &str, card: &ProjectCard) -> bool {
2404×
    let name = name.trim();
2414×
    if name.is_empty() {
2420×
        return false;
2434×
    }
2444×
    if name.parse::<i64>().is_ok_and(|id| id == card.id) {
2450×
        return true;
2464×
    }
2474×
    let Some((_, number)) = card.reference.rsplit_once('#') else { return false };
2484×
    match name.rsplit_once('#') {
2490×
        None => name == number,
2504×
        Some(("", n)) => n == number,
2512×
        Some((repo, n)) => n == number && (card.reference == format!("{repo}#{n}") || card.reference.ends_with(&format!("/{repo}#{n}"))),
252
    }
2534×
}
254
255
/// `POST /projects/{owner}/{n}/cards/move` (#289): a column's cards to
256
/// another at once, with exceptions and a state filter; one audit entry.
2575×
pub async fn move_cards(
2585×
    State(app): State<Shared>,
2595×
    headers: HeaderMap,
2605×
    Path((owner, number)): Path<(String, i64)>,
2615×
    Json(body): Json<CardsMove>,
2625×
) -> Result<Json<CardsMoved>, ApiError> {
2635×
    let (c, p) = changeable(&app, &headers, &owner, number, false).await?;
2644×
    let from = column(&app, p.id, Some(&body.from)).await?;
2654×
    let to = column(&app, p.id, Some(&body.column)).await?;
2664×
    if from.id == to.id {
2671×
        return Err(ApiError(StatusCode::BAD_REQUEST, "the cards are in that column already".into()));
2683×
    }
2693×
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p, false).await?;
2703×
    let cards: Vec<ProjectCard> =
2719×
        columns.iter().filter(|col| col.column.id == from.id).flat_map(|col| col.cards.iter().map(card_of)).collect();
2723×
    let states: Vec<String> = body.state.iter().map(|s| s.trim().to_ascii_lowercase()).filter(|s| !s.is_empty()).collect();
2736×
    let (moved, kept): (Vec<ProjectCard>, Vec<ProjectCard>) = cards.into_iter().partition(|card| {
2746×
        !body.except.iter().any(|e| names_card(e, card)) && (states.is_empty() || states.iter().any(|s| card.state.eq_ignore_ascii_case(s)))
2756×
    });
2763×
    if !body.dry_run && !moved.is_empty() {
2771×
        let ids: Vec<i64> = moved.iter().map(|c| c.id).collect();
2781×
        pdb::move_cards(&app.db, p.id, &ids, to.id).await?;
2791×
        let detail = format!("{} card(s) from {} to {}", moved.len(), from.name, to.name);
2801×
        crate::db::accounts::audit(&app.db, c.account.as_ref(), "project.cards_moved", &format!("{owner}/{number}"), &detail).await.ok();
2812×
    }
2823×
    Ok(Json(CardsMoved { moved, kept, dry_run: body.dry_run }))
2835×
}
284
285
/// `POST /projects/{owner}/{n}/cards/archive` (#293): a column's cards off
286
/// the board at once, kept, with #289's exceptions and state filter and an
287
/// age; one audit entry.
2883×
pub async fn archive_cards(
2893×
    State(app): State<Shared>,
2903×
    headers: HeaderMap,
2913×
    Path((owner, number)): Path<(String, i64)>,
2923×
    Json(body): Json<CardsArchive>,
2933×
) -> Result<Json<CardsArchived>, ApiError> {
2943×
    let (c, p) = changeable(&app, &headers, &owner, number, false).await?;
2953×
    let from = column(&app, p.id, Some(&body.from)).await?;
2963×
    if body.older_days.is_some_and(|d| !(0..=3650).contains(&d)) {
2971×
        return Err(ApiError(StatusCode::BAD_REQUEST, "older_days is 0 to 3650".into()));
2982×
    }
2992×
    let (columns, _) = wp::board_columns(&app, c.account.as_ref(), &owner, &p, false).await?;
3002×
    let now = crate::db::now_ms();
3012×
    let states: Vec<String> = body.state.iter().map(|s| s.trim().to_ascii_lowercase()).filter(|s| !s.is_empty()).collect();
3022×
    let (archived, kept): (Vec<&wp::CardView>, Vec<&wp::CardView>) =
3036×
        columns.iter().filter(|col| col.column.id == from.id).flat_map(|col| col.cards.iter()).partition(|v| {
3044×
            let card = card_of(v);
3054×
            !body.except.iter().any(|e| names_card(e, &card))
3064×
                && (states.is_empty() || states.iter().any(|s| card.state.eq_ignore_ascii_case(s)))
3074×
                && body.older_days.is_none_or(|d| pdb::older_than(&v.card, d, now))
3084×
        });
3092×
    if !body.dry_run && !archived.is_empty() {
3101×
        let ids: Vec<i64> = archived.iter().map(|v| v.card.id).collect();
3111×
        pdb::archive_cards(&app.db, p.id, &ids).await?;
3121×
        let detail = format!("{} card(s) of {}", ids.len(), from.name);
3131×
        crate::db::accounts::audit(&app.db, c.account.as_ref(), "project.cards_archived", &format!("{owner}/{number}"), &detail).await.ok();
3141×
    }
3152×
    let stamp = |v: &wp::CardView| ProjectCard { archived_ms: (!body.dry_run).then_some(now), ..card_of(v) };
3162×
    Ok(Json(CardsArchived {
3172×
        archived: archived.into_iter().map(stamp).collect(),
3182×
        kept: kept.into_iter().map(card_of).collect(),
3192×
        dry_run: body.dry_run,
3202×
    }))
3213×
}
322
323
/// `POST /projects/{owner}/{n}/cards/{id}/restore` (#293): an archived
324
/// card back on the board, at the end of its column.
3253×
pub async fn restore_card(
3263×
    State(app): State<Shared>,
3273×
    headers: HeaderMap,
3283×
    Path((owner, number, id)): Path<(String, i64, i64)>,
3293×
) -> Result<StatusCode, ApiError> {
3303×
    let (_, p) = changeable(&app, &headers, &owner, number, false).await?;
3318×
    if !pdb::cards(&app.db, p.id).await?.iter().any(|c| c.id == id && c.archived_ms.is_some()) {
3321×
        return Err(not_found("no such archived card"));
3331×
    }
3341×
    pdb::restore_card(&app.db, p.id, id).await?;
3351×
    Ok(StatusCode::NO_CONTENT)
3363×
}
337
338
/// `DELETE /projects/{owner}/{n}/cards/{id}`.
3393×
pub async fn remove_card(
3403×
    State(app): State<Shared>,
3413×
    headers: HeaderMap,
3423×
    Path((owner, number, id)): Path<(String, i64, i64)>,
3433×
) -> Result<StatusCode, ApiError> {
3443×
    let (_, p) = changeable(&app, &headers, &owner, number, false).await?;
3455×
    if !pdb::cards(&app.db, p.id).await?.iter().any(|c| c.id == id) {
3461×
        return Err(not_found("no such card"));
3472×
    }
3482×
    pdb::remove_card(&app.db, p.id, id).await?;
3492×
    Ok(StatusCode::NO_CONTENT)
3503×
}