splashboard 2.10.2

//! `gitlab_review_requests` — open MRs where the authenticated GitLab user is a reviewer.
//! Resolves `@me` to a username via `/api/v4/user` (cached per host) and then queries
//! `/api/v4/merge_requests?reviewer_username=<me>&state=opened`.

use async_trait::async_trait;
use serde::Deserialize;

use crate::fetcher::forge_items::{self, LIST_SHAPES};
use crate::options::OptionSchema;
use crate::payload::{Body, Payload};
use crate::render::Shape;

use super::super::{FetchContext, FetchError, Fetcher, Safety};
use super::client::{resolve_authenticated_username, rest_get};
use super::common::{cache_key, parse_options, payload};
use super::items::{GitlabIssueLike, sample_rows, to_forge_rows};
use super::my_mrs::resolve_host;

const DEFAULT_LIMIT: u32 = 10;

const OPTION_SCHEMAS: &[OptionSchema] = &[
    OptionSchema {
        name: "host",
        type_hint: "hostname",
        required: false,
        default: Some("gitlab.com"),
        description: "GitLab instance host. Use this for self-hosted GitLab.",
    },
    OptionSchema {
        name: "limit",
        type_hint: "integer (1..=30)",
        required: false,
        default: Some("10"),
        description: "Maximum number of MRs to show.",
    },
];

pub struct GitlabReviewRequests;

#[derive(Debug, Default, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Options {
    #[serde(default)]
    pub host: Option<String>,
    #[serde(default)]
    pub limit: Option<u32>,
}

#[async_trait]
impl Fetcher for GitlabReviewRequests {
    fn name(&self) -> &str {
        "gitlab_review_requests"
    }
    fn safety(&self) -> Safety {
        Safety::Safe
    }
    fn description(&self) -> &'static str {
        "Open merge requests where the authenticated GitLab user is a reviewer. Mirror of `github_review_requests` for GitLab."
    }
    fn refresh_interval(&self) -> u64 {
        60 * 5
    }
    fn shapes(&self) -> &[Shape] {
        LIST_SHAPES
    }
    fn option_schemas(&self) -> &[OptionSchema] {
        OPTION_SCHEMAS
    }
    fn cache_key(&self, ctx: &FetchContext) -> String {
        cache_key(self.name(), ctx, &host_for_key(ctx))
    }
    fn sample_body(&self, shape: Shape) -> Option<Body> {
        let rows = sample_rows(&[
            (
                "g/splashboard!54",
                "feat(docs): generate widget catalogue",
                Some("https://gitlab.com/g/splashboard/-/merge_requests/54"),
                7,
                1_774_000_000,
            ),
            (
                "other/proj!12",
                "fix(auth): rotate session token",
                Some("https://gitlab.com/other/proj/-/merge_requests/12"),
                1,
                1_773_800_000,
            ),
        ]);
        forge_items::dispatch_sample(&rows, shape, "to review", "to review")
    }
    async fn fetch(&self, ctx: &FetchContext) -> Result<Payload, FetchError> {
        let opts: Options = parse_options(ctx.options.as_ref()).map_err(FetchError::Failed)?;
        let host = resolve_host(opts.host.as_deref())?;
        let limit = opts.limit.unwrap_or(DEFAULT_LIMIT).clamp(1, 30);
        let username = resolve_authenticated_username(&host).await?;
        let path = format!(
            "/merge_requests?reviewer_username={username}&state=opened&per_page={limit}&order_by=updated_at"
        );
        let items: Vec<GitlabIssueLike> = rest_get(&host, &path).await?;
        let rows = to_forge_rows(&items, true);
        let shape = ctx.shape.unwrap_or(Shape::LinkedTextBlock);
        let body = forge_items::dispatch_rows_async(rows, shape, "to review", "to review").await;
        Ok(payload(body))
    }
}

fn host_for_key(ctx: &FetchContext) -> String {
    ctx.options
        .as_ref()
        .and_then(|v| v.get("host"))
        .and_then(|v| v.as_str())
        .unwrap_or(super::client::default_host())
        .to_string()
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::payload::{BadgeData, Status};

    #[test]
    fn options_deserialize_and_reject_unknown_keys() {
        let opts: Options = toml::from_str("host = \"git.example.org\"\nlimit = 3").unwrap();
        assert_eq!(opts.host.as_deref(), Some("git.example.org"));
        assert_eq!(opts.limit, Some(3));
        assert!(toml::from_str::<Options>("bogus = 1").is_err());
    }

    #[test]
    fn shapes_table_matches_shared_list() {
        let fetcher = GitlabReviewRequests;
        assert_eq!(fetcher.shapes(), LIST_SHAPES);
        assert_eq!(fetcher.default_shape(), Shape::LinkedTextBlock);
        assert_eq!(fetcher.safety(), Safety::Safe);
    }

    #[test]
    fn sample_badge_uses_to_review_noun_without_pluralising() {
        let Some(Body::Badge(BadgeData { status, label })) =
            GitlabReviewRequests.sample_body(Shape::Badge)
        else {
            panic!("expected badge");
        };
        assert_eq!(status, Status::Warn);
        assert_eq!(label, "2 to review");
    }

    #[test]
    fn sample_body_covers_every_list_shape() {
        let fetcher = GitlabReviewRequests;
        for shape in LIST_SHAPES {
            assert!(fetcher.sample_body(*shape).is_some(), "missing {shape:?}");
        }
    }

    #[test]
    fn cache_key_changes_with_host() {
        let fetcher = GitlabReviewRequests;
        let a = fetcher.cache_key(&FetchContext::default());
        let b = fetcher.cache_key(&FetchContext {
            options: Some(toml::from_str("host = \"git.example.org\"").unwrap()),
            ..Default::default()
        });
        assert_ne!(a, b);
    }
}