Add audit page (#656)

Signed-off-by: Sergio Castaño Arteaga <tegioz@icloud.com>
Signed-off-by: Cintia Sánchez García <cynthiasg@icloud.com>
Co-authored-by: Cintia Sánchez García <cynthiasg@icloud.com>

Author: tegioz

Cargo.lock

@@ -12,6 +12,7 @@ askama = { version = "0.14.0", features = ["serde_json"] }
 async-channel = "2.5.0"
 async-trait = "0.1.89"
 axum = { version = "0.8.4", features = ["macros"] }
+cached = { version = "0.56.0", features = ["async"] }
 clap = { version = "4.5.48", features = ["derive"] }
 deadpool-postgres = { version = "0.14.1", features = ["serde"] }
 figment = { version = "0.10.19", features = ["yaml", "env"] }

Cargo.toml

@@ -6,6 +6,29 @@
 #   - At the root of the .github repository, for organization wide configuration
 #
 
+# Audit (optional)
+#
+# The audit page lists all the votes recorded for the repository. It can be
+# useful to provide transparency on the voting history of a repository. By
+# default, the audit page is disabled. To enable it, the audit section must be
+# included in the configuration file, with the `enabled` field set to true.
+#
+# Please note that this page is publicly accessible, so anyone will be able
+# to see all votes recorded for the repository.
+#
+# Once you have enabled it, the audit page will be available at:
+#
+#   https://gitvote.com/audit/OWNER/REPO
+#
+# (it can take up to 15 minutes for the audit page to be available after
+# enabling it)
+#
+# audit:
+#   enabled: true
+#
+audit:
+  enabled: false
+
 # Automation (optional)
 #
 # Create votes automatically on PRs when any of the files affected by the PR

docs/config/.gitvote.yml

@@ -24,9 +24,12 @@ type ProfileName = String;
 /// `GitVote` configuration.
 #[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]
 pub(crate) struct Cfg {
+    pub profiles: HashMap<ProfileName, CfgProfile>,
+
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub audit: Option<Audit>,
     #[serde(skip_serializing_if = "Option::is_none")]
     pub automation: Option<Automation>,
-    pub profiles: HashMap<ProfileName, CfgProfile>,
 }
 
 impl Cfg {
@@ -48,6 +51,12 @@ impl Cfg {
     }
 }
 
+/// Audit configuration.
+#[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]
+pub(crate) struct Audit {
+    pub enabled: bool,
+}
+
 /// Automation configuration.
 #[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]
 pub(crate) struct Automation {

src/cfg_repo.rs

@@ -45,6 +45,9 @@ pub(crate) trait DB {
     /// Check if the issue/pr provided already has a vote open.
     async fn has_vote_open(&self, repository_full_name: &str, issue_number: i64) -> Result<bool>;
 
+    /// List all votes stored for the provided repository.
+    async fn list_votes(&self, repository_full_name: &str) -> Result<Vec<Vote>>;
+
     /// Store the vote provided in the database.
     async fn store_vote(
         &self,
@@ -280,6 +283,26 @@ impl DB for PgDB {
         Ok(has_vote_open)
     }
 
+    /// [`DB::list_votes`]
+    async fn list_votes(&self, repository_full_name: &str) -> Result<Vec<Vote>> {
+        let db = self.pool.get().await?;
+        let votes = db
+            .query(
+                "
+                select *
+                from vote
+                where repository_full_name = $1::text
+                order by created_at desc
+                ",
+                &[&repository_full_name],
+            )
+            .await?
+            .iter()
+            .map(Vote::from)
+            .collect();
+        Ok(votes)
+    }
+
     /// [`DB::store_vote`]
     async fn store_vote(
         &self,

src/db.rs

@@ -123,6 +123,9 @@ pub(crate) trait GH {
     /// Get pull request files.
     async fn get_pr_files(&self, inst_id: u64, owner: &str, repo: &str, pr_number: i64) -> Result<Vec<File>>;
 
+    /// Get repository installation identifier.
+    async fn get_repository_installation_id(&self, owner: &str, repo: &str) -> Result<u64>;
+
     /// Get all members of the provided team.
     #[allow(dead_code)]
     async fn get_team_members(
@@ -378,6 +381,12 @@ impl GH for GHApi {
         Ok(files)
     }
 
+    /// [`GH::get_repository_installation_id`]
+    async fn get_repository_installation_id(&self, owner: &str, repo: &str) -> Result<u64> {
+        let inst = self.app_client.apps().get_repository_installation(owner, repo).await?;
+        Ok(inst.id.0)
+    }
+
     /// [`GH::get_team_members`]
     async fn get_team_members(
         &self,