Merge pull request #96 from jonasehrlich/je/include-references

Include references in API and show in Git Dialog

Author: jonasehrlich

Cargo.lock

@@ -27,3 +27,4 @@ utoipa-axum = { version = "^0.2.0" }
 utoipa-rapidoc = { version = "^6.0.0", features = ["axum"] }
 chrono = { version = "^0.4.41", features = ["serde"] }
 hannibal = "^0.12"
+axum-extra = { version = "0.10.1", features = ["query"] }

backend/app/Cargo.toml

@@ -1,3 +1,4 @@
+use git2_ox::ReferenceKindFilter;
 use hannibal::prelude::*;
 use std::path::Path;
 
@@ -17,7 +18,10 @@ impl GitActor {
         Ok(Self { repository })
     }
 
-    fn filter_commit(filter: &str, commit: &git2_ox::Commit) -> bool {
+    fn filter_commit<CommitLikeT>(filter: &str, commit: &CommitLikeT) -> bool
+    where
+        CommitLikeT: git2_ox::CommitProperties,
+    {
         let id_matches = commit
             .id()
             .to_string()
@@ -31,7 +35,7 @@ impl GitActor {
     }
 }
 
-#[message(response = Result<git2_ox::Commit, git2_ox::error::Error>)]
+#[message(response = Result<git2_ox::CommitWithReferences, git2_ox::error::Error>)]
 pub struct GetRevision {
     pub revision: String,
 }
@@ -41,12 +45,12 @@ impl Handler<GetRevision> for GitActor {
         &mut self,
         _ctx: &mut Context<Self>,
         msg: GetRevision,
-    ) -> Result<git2_ox::Commit, git2_ox::error::Error> {
+    ) -> Result<git2_ox::CommitWithReferences, git2_ox::error::Error> {
         self.repository.get_commit_for_revision(&msg.revision)
     }
 }
 
-#[message(response = Result<git2_ox::Commit, git2_ox::error::Error>)]
+#[message(response = Result<git2_ox::CommitWithReferences, git2_ox::error::Error>)]
 pub struct CheckoutRevision {
     pub revision: String,
 }
@@ -56,12 +60,12 @@ impl Handler<CheckoutRevision> for GitActor {
         &mut self,
         _ctx: &mut Context<Self>,
         msg: CheckoutRevision,
-    ) -> Result<git2_ox::Commit, git2_ox::error::Error> {
+    ) -> Result<git2_ox::CommitWithReferences, git2_ox::error::Error> {
         self.repository.checkout_revision(&msg.revision)
     }
 }
 
-#[message(response = Result<Vec<git2_ox::Commit>, git2_ox::error::Error>)]
+#[message(response = Result<Vec<git2_ox::CommitWithReferences>, git2_ox::error::Error>)]
 pub struct ListCommits {
     pub base_rev: Option<String>,
     pub head_rev: Option<String>,
@@ -73,7 +77,7 @@ impl Handler<ListCommits> for GitActor {
         &mut self,
         _ctx: &mut Context<Self>,
         msg: ListCommits,
-    ) -> Result<Vec<git2_ox::Commit>, git2_ox::error::Error> {
+    ) -> Result<Vec<git2_ox::CommitWithReferences>, git2_ox::error::Error> {
         let commits_iter = self
             .repository
             .iter_commits(msg.base_rev.as_deref(), msg.head_rev.as_deref())?;
@@ -118,11 +122,12 @@ impl Handler<ListTags> for GitActor {
         _ctx: &mut Context<Self>,
         msg: ListTags,
     ) -> Result<Vec<git2_ox::TaggedCommit>, git2_ox::error::Error> {
-        let tags_iter = self.repository.iter_tags(msg.filter.as_deref())?;
-        let mut tags = Vec::new();
-        for tag_result in tags_iter {
-            tags.push(tag_result?);
-        }
+        let filter = msg.filter.unwrap_or("".to_string());
+        let tags = self
+            .repository
+            .iter_tags()?
+            .filter(|tag| tag.name().to_lowercase().contains(&filter.to_lowercase()))
+            .collect();
         Ok(tags)
     }
 }
@@ -156,9 +161,16 @@ impl Handler<ListBranches> for GitActor {
         _ctx: &mut Context<Self>,
         msg: ListBranches,
     ) -> Result<Vec<git2_ox::Branch>, git2_ox::error::Error> {
+        let filter = msg.filter.unwrap_or("".to_string());
         let branches = self
             .repository
-            .iter_branches(msg.filter.as_deref())?
+            .iter_branches()?
+            .filter(|branch| {
+                branch
+                    .name()
+                    .to_lowercase()
+                    .contains(&filter.to_lowercase())
+            })
             .collect();
         Ok(branches)
     }
@@ -184,7 +196,7 @@ impl Handler<CreateBranch> for GitActor {
 
 #[derive(Debug, Clone)]
 pub struct RepositoryStatus {
-    pub head: git2_ox::Commit,
+    pub head: git2_ox::CommitWithReferences,
     pub current_branch: Option<String>,
 }
 
@@ -205,3 +217,45 @@ impl Handler<GetRepositoryStatus> for GitActor {
         })
     }
 }
+
+#[message(response = Result<Vec<git2_ox::ResolvedReference>, git2_ox::error::Error>)]
+pub struct ListReferences {
+    pub filter: Option<String>,
+    pub filter_kinds: Option<ReferenceKindFilter>,
+}
+
+impl Handler<ListReferences> for GitActor {
+    async fn handle(
+        &mut self,
+        _ctx: &mut Context<Self>,
+        msg: ListReferences,
+    ) -> Result<Vec<git2_ox::ResolvedReference>, git2_ox::error::Error> {
+        let filter = msg.filter.as_deref().unwrap_or("");
+
+        let references = self
+            .repository
+            .iter_references()?
+            .filter_map(|r| {
+                let ref_kind = r.kind();
+
+                let ref_kind_ok = match &msg.filter_kinds {
+                    None => true,
+                    Some(ReferenceKindFilter::Include {
+                        include: include_kinds,
+                    }) => include_kinds.contains(&ref_kind),
+                    Some(ReferenceKindFilter::Exclude {
+                        exclude: exclude_kinds,
+                    }) => !exclude_kinds.contains(&ref_kind),
+                };
+                if !ref_kind_ok {
+                    return None;
+                }
+                if !r.name().contains(filter) {
+                    return None;
+                }
+                Some(r)
+            })
+            .collect();
+        Ok(references)
+    }
+}

backend/app/src/actors/git.rs

@@ -2,7 +2,7 @@ use crate::{actors, web, web::api};
 
 use axum::extract::{Path, Query, State};
 use axum::{Json, routing};
-use git2_ox::commit;
+use git2_ox::{ReferenceKind, ReferenceKindFilter, ResolvedReference, commit};
 use serde::{Deserialize, Serialize};
 use utoipa::{IntoParams, ToSchema};
 
@@ -17,10 +17,19 @@ pub fn router() -> routing::Router<web::AppState> {
         .route("/tags", routing::get(list_tags).post(create_tag))
         .route("/branches", routing::get(list_branches).post(create_branch))
         .route("/repository/status", routing::get(get_repository_status))
+        .route("/references", routing::get(list_references))
 }
 
 #[derive(utoipa::OpenApi)]
-#[openapi(paths(get_revision, checkout_revision, list_commits,  list_tags, create_tag, list_branches, create_branch, get_repository_status, get_diff), tags((name = "Git Repository", description="Git Repository related endpoints")) )]
+#[openapi(
+    paths(
+        get_revision, checkout_revision, list_commits,  list_tags, create_tag, list_branches, create_branch,
+        get_repository_status, get_diff, list_references
+    ),
+    tags(
+        (name = "Git Repository", description="Git Repository related endpoints")
+    )
+)]
 pub(super) struct ApiDoc;
 
 #[utoipa::path(
@@ -44,7 +53,7 @@ pub(super) struct ApiDoc;
 async fn get_revision(
     State(state): State<web::AppState>,
     Path(commit_id): Path<String>,
-) -> Result<Json<commit::Commit>, api::AppError> {
+) -> Result<Json<commit::CommitWithReferences>, api::AppError> {
     let actor = state.git_actor();
     let msg = actors::git::GetRevision {
         revision: commit_id,
@@ -76,7 +85,7 @@ async fn get_revision(
 async fn checkout_revision(
     State(state): State<web::AppState>,
     Path(commit_id): Path<String>,
-) -> Result<Json<commit::Commit>, api::AppError> {
+) -> Result<Json<commit::CommitWithReferences>, api::AppError> {
     let actor = state.git_actor();
     let msg = actors::git::CheckoutRevision {
         revision: commit_id,
@@ -89,14 +98,17 @@ async fn checkout_revision(
 #[serde(rename_all = "camelCase")]
 struct ListCommitsQuery {
     /// string filter for the commits. Filters commits by their ID or summary.
+    #[param(nullable = false)]
     filter: Option<String>,
 
     // serde(flatten) does not work here, see https://github.com/juhaku/utoipa/issues/841
     /// The base revision of the range, this can be short hash, full hash, a tag,
     /// or any other reference such a branch name. If empty, the first commit is used.
+    #[param(nullable = false)]
     base_rev: Option<String>,
     /// The head revision of the range, this can be short hash, full hash, a tag,
     /// or any other reference such a branch name. If empty, the current HEAD is used.
+    #[param(nullable = false)]
     head_rev: Option<String>,
 }
 
@@ -105,7 +117,7 @@ struct ListCommitsQuery {
 struct ListCommitsResponse {
     /// Array of commits between the base and head commit IDs
     /// in reverse chronological order.
-    commits: Vec<git2_ox::Commit>,
+    commits: Vec<git2_ox::CommitWithReferences>,
 }
 
 #[utoipa::path(
@@ -139,9 +151,11 @@ async fn list_commits(
 struct CommitRangeQuery {
     /// The base revision of the range, this can be short hash, full hash, a tag,
     /// or any other reference such a branch name. If empty, the first commit is used.
+    #[param(nullable = false)]
     base_rev: Option<String>,
     /// The head revision of the range, this can be short hash, full hash, a tag,
     /// or any other reference such a branch name. If empty, the current HEAD is used.
+    #[param(nullable = false)]
     head_rev: Option<String>,
 }
 
@@ -183,6 +197,7 @@ async fn get_diff(
 #[serde(rename_all = "camelCase")]
 struct ListTagsQuery {
     /// String filter against which the tag name is matched.
+    #[param(nullable = false)]
     filter: Option<String>,
 }
 
@@ -260,6 +275,7 @@ struct ListBranchesResponse {
 #[serde(rename_all = "camelCase")]
 struct ListBranchesQuery {
     /// string filter against with the branch name is matched
+    #[param(nullable = false)]
     filter: Option<String>,
 }
 
@@ -326,7 +342,7 @@ async fn create_branch(
 #[serde(rename_all = "camelCase")]
 struct RepositoryStatusResponse {
     /// The current HEAD commit
-    head: git2_ox::Commit,
+    head: git2_ox::CommitWithReferences,
     /// The current branch name, not set if in a detached HEAD state
     current_branch: Option<String>,
 }
@@ -352,3 +368,61 @@ async fn get_repository_status(
         current_branch: status.current_branch,
     }))
 }
+
+#[derive(Deserialize, IntoParams)]
+#[serde(rename_all = "camelCase")]
+struct ListReferencesQuery {
+    /// String filter against with the reference name
+    #[param(nullable = false)]
+    filter: Option<String>,
+    // Ideally, we would use ReferenceKindFilter with serde(flatten) here,
+    // but IntoParams does not does not respect it,
+    // see https://github.com/juhaku/utoipa/issues/841
+    /// Reference kinds to include, mutually exclusive with `exclude`
+    #[param(min_items = 1, nullable = false)]
+    include: Option<Vec<ReferenceKind>>,
+    /// Reference kinds to exclude, mutually exclusive with `include`
+    #[param(min_items = 1, nullable = false)]
+    exclude: Option<Vec<ReferenceKind>>,
+}
+
+#[derive(ToSchema, Serialize, IntoParams)]
+#[serde(rename_all = "camelCase")]
+struct ListReferencesResponse {
+    /// Array of references
+    references: Vec<ResolvedReference>,
+}
+
+/// List references in the repository
+#[utoipa::path(
+    get,
+    path = "/references",
+    summary = "List references",
+    description = "List all references in the repository, optionally filtered by a glob pattern and type.",
+    params(ListReferencesQuery),
+    responses(
+        (status = http::StatusCode::OK, description = "List of references", body = ListReferencesResponse),
+        (status = http::StatusCode::INTERNAL_SERVER_ERROR, description = "Internal server error", body = api::ApiStatusDetailResponse),
+    )
+)]
+async fn list_references(
+    State(state): State<web::AppState>,
+    axum_extra::extract::Query(query): axum_extra::extract::Query<ListReferencesQuery>,
+) -> Result<Json<ListReferencesResponse>, api::AppError> {
+    let filter_kinds = match (query.include, query.exclude) {
+        (Some(_), Some(_)) => Err(api::AppError::BadRequest(
+            "Include and exclude filters are mutually exclusive".to_string(),
+        )),
+        (Some(include), None) => Ok(Some(ReferenceKindFilter::include(include))),
+        (None, Some(exclude)) => Ok(Some(ReferenceKindFilter::exclude(exclude))),
+        (None, None) => Ok(None),
+    }?;
+
+    let actor = state.git_actor();
+    let msg = actors::git::ListReferences {
+        filter: query.filter,
+        filter_kinds,
+    };
+    let references = actor.call(msg).await??;
+    Ok(Json(ListReferencesResponse { references }))
+}