Some refactoring in votes processor (#557)

Signed-off-by: Sergio Castaño Arteaga <[email protected]>

Author: tegioz

Cargo.lock

@@ -47,6 +47,7 @@ tokio-postgres = { version = "0.7.12", features = [
     "with-serde_json-1",
     "with-time-0_3",
 ] }
+tokio-util = { version = "0.7.12", features = ["rt"] }
 tower = { version = "0.5.1", features = ["util"] }
 tower-http = { version = "0.6.1", features = ["trace"] }
 tracing = "0.1.40"

Cargo.toml

@@ -1,10 +1,14 @@
-use crate::github::{DynGH, File, TeamSlug, UserName};
+//! This module defines some types to represent the configuration.
+
+use std::{collections::HashMap, time::Duration};
+
 use anyhow::{bail, Result};
 use ignore::gitignore::GitignoreBuilder;
 use serde::{Deserialize, Serialize};
-use std::{collections::HashMap, time::Duration};
 use thiserror::Error;
 
+use crate::github::{DynGH, File, TeamSlug, UserName};
+
 /// Default configuration profile.
 const DEFAULT_PROFILE: &str = "default";
 
@@ -15,7 +19,7 @@ const ERR_TEAMS_NOT_ALLOWED: &str = "teams in allowed voters can only be used in
 /// Type alias to represent a profile name.
 type ProfileName = String;
 
-/// GitVote configuration.
+/// `GitVote` configuration.
 #[derive(Debug, Clone, Default, Serialize, Deserialize, PartialEq)]
 pub(crate) struct Cfg {
     #[serde(skip_serializing_if = "Option::is_none")]
@@ -24,7 +28,7 @@ pub(crate) struct Cfg {
 }
 
 impl Cfg {
-    /// Get the GitVote configuration for the repository provided.
+    /// Get the `GitVote` configuration for the repository provided.
     pub(crate) async fn get<'a>(
         gh: DynGH,
         inst_id: u64,
@@ -165,12 +169,15 @@ pub(crate) enum CfgError {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
-    use crate::github::MockGH;
-    use crate::testutil::*;
+    use std::sync::Arc;
+
     use futures::future;
     use mockall::predicate::eq;
-    use std::sync::Arc;
+
+    use crate::github::MockGH;
+    use crate::testutil::*;
+
+    use super::*;
 
     #[test]
     fn automation_rule_matches() {

src/cfg.rs

@@ -1,13 +1,19 @@
-use crate::{
-    cfg::{Cfg, CfgError},
-    github::*,
-};
+//! This module defines the commands supported and the logic to parse them from
+//! GitHub events.
+
 use anyhow::Result;
 use lazy_static::lazy_static;
 use regex::Regex;
 use serde::{Deserialize, Serialize};
 use tracing::error;
 
+use crate::{
+    cfg::{Cfg, CfgError},
+    github::{
+        split_full_name, DynGH, Event, IssueCommentEventAction, IssueEventAction, PullRequestEventAction,
+    },
+};
+
 /// Available commands.
 const CMD_CREATE_VOTE: &str = "vote";
 const CMD_CANCEL_VOTE: &str = "cancel-vote";
@@ -147,7 +153,7 @@ pub(crate) struct CreateVoteInput {
 }
 
 impl CreateVoteInput {
-    /// Create a new CreateVoteInput instance from the profile and event
+    /// Create a new `CreateVoteInput` instance from the profile and event
     /// provided.
     pub(crate) fn new(profile_name: Option<&str>, event: &Event) -> Self {
         match event {
@@ -199,7 +205,7 @@ pub(crate) struct CancelVoteInput {
 }
 
 impl CancelVoteInput {
-    /// Create a new CancelVoteInput instance from the event provided.
+    /// Create a new `CancelVoteInput` instance from the event provided.
     pub(crate) fn new(event: &Event) -> Self {
         match event {
             Event::Issue(event) => Self {
@@ -235,7 +241,7 @@ pub(crate) struct CheckVoteInput {
 }
 
 impl CheckVoteInput {
-    /// Create a new CheckVoteInput instance from the event provided.
+    /// Create a new `CheckVoteInput` instance from the event provided.
     pub(crate) fn new(event: &Event) -> Self {
         match event {
             Event::Issue(event) => Self {
@@ -256,11 +262,17 @@ impl CheckVoteInput {
 
 #[cfg(test)]
 mod tests {
-    use super::*;
-    use crate::testutil::*;
+    use std::{sync::Arc, vec};
+
     use futures::future;
     use mockall::predicate::eq;
-    use std::{sync::Arc, vec};
+
+    use crate::{
+        github::{File, MockGH},
+        testutil::*,
+    };
+
+    use super::*;
 
     #[test]
     fn manual_command_from_issue_event_unsupported_action() {

src/cmd.rs

@@ -1,18 +1,22 @@
-use crate::{
-    cfg::CfgProfile,
-    cmd::{CheckVoteInput, CreateVoteInput},
-    github::{self, split_full_name, DynGH},
-    results::{self, Vote, VoteResults},
-};
+//! This module defines an abstraction layer over the database.
+
+use std::sync::Arc;
+
 use anyhow::Result;
 use async_trait::async_trait;
 use deadpool_postgres::{Pool, Transaction};
 #[cfg(test)]
 use mockall::automock;
-use std::sync::Arc;
 use tokio_postgres::types::Json;
 use uuid::Uuid;
 
+use crate::{
+    cfg::CfgProfile,
+    cmd::{CheckVoteInput, CreateVoteInput},
+    github::{self, split_full_name, DynGH},
+    results::{self, Vote, VoteResults},
+};
+
 /// Type alias to represent a DB trait object.
 pub(crate) type DynDB = Arc<dyn DB + Send + Sync>;
 
@@ -56,13 +60,13 @@ pub(crate) trait DB {
     async fn update_vote_last_check(&self, vote_id: Uuid) -> Result<()>;
 }
 
-/// DB implementation backed by PostgreSQL.
+/// DB implementation backed by `PostgreSQL`.
 pub(crate) struct PgDB {
     pool: Pool,
 }
 
 impl PgDB {
-    /// Create a new PgDB instance.
+    /// Create a new `PgDB` instance.
     pub(crate) fn new(pool: Pool) -> Self {
         Self { pool }
     }
@@ -91,7 +95,7 @@ impl PgDB {
     async fn store_vote_results(
         tx: &Transaction<'_>,
         vote_id: Uuid,
-        results: &Option<VoteResults>,
+        results: Option<&VoteResults>,
     ) -> Result<()> {
         tx.execute(
             "
@@ -154,7 +158,7 @@ impl DB for PgDB {
         };
 
         // Store results in database
-        PgDB::store_vote_results(&tx, vote.vote_id, &results).await?;
+        PgDB::store_vote_results(&tx, vote.vote_id, results.as_ref()).await?;
         tx.commit().await?;
 
         Ok(Some((vote, results)))

src/db.rs

@@ -1,4 +1,7 @@
-use crate::cfg::CfgProfile;
+//! This module defines an abstraction layer over the GitHub API.
+
+use std::sync::Arc;
+
 use anyhow::{bail, Context, Error, Result};
 use async_trait::async_trait;
 use axum::http::HeaderValue;
@@ -9,9 +12,10 @@ use mockall::automock;
 use octocrab::{models::InstallationId, Octocrab, Page};
 use serde::{Deserialize, Serialize};
 use serde_json::{json, Value};
-use std::sync::Arc;
 use thiserror::Error;
 
+use crate::cfg::CfgProfile;
+
 /// GitHub API base url.
 const GITHUB_API_URL: &str = "https://api.github.com";
 
@@ -56,6 +60,7 @@ pub struct CreateDiscussion;
 
 /// Trait that defines some operations a GH implementation must support.
 #[async_trait]
+#[allow(clippy::ref_option_ref)]
 #[cfg_attr(test, automock)]
 pub(crate) trait GH {
     /// Add labels to the provided issue.
@@ -96,7 +101,7 @@ pub(crate) trait GH {
         cfg: &CfgProfile,
         owner: &str,
         repo: &str,
-        org: &Option<String>,
+        org: Option<&String>,
     ) -> Result<Vec<UserName>>;
 
     /// Get all repository collaborators.
@@ -169,7 +174,7 @@ pub(crate) struct GHApi {
 }
 
 impl GHApi {
-    /// Create a new GHApi instance.
+    /// Create a new `GHApi` instance.
     pub(crate) fn new(app_client: Octocrab) -> Self {
         Self { app_client }
     }
@@ -270,7 +275,7 @@ impl GH for GHApi {
         cfg: &CfgProfile,
         owner: &str,
         repo: &str,
-        org: &Option<String>,
+        org: Option<&String>,
     ) -> Result<Vec<UserName>> {
         let mut allowed_voters: Vec<UserName> = vec![];