Add support for json log format + some refactoring (#264)

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

Author: tegioz

Cargo.lock

@@ -48,7 +48,7 @@ tokio-postgres = { version = "0.7.7", features = [
 tower = "0.4.13"
 tower-http = { version = "0.4.0", features = ["trace"] }
 tracing = "0.1.37"
-tracing-subscriber = "0.3.16"
+tracing-subscriber = { version = "0.3.16", features = ["env-filter", "json"] }
 uuid = { version = "1.3.0", features = ["serde", "v4"] }
 
 [dev-dependencies]

Cargo.toml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: gitvote
 description: GitVote is a GitHub application that allows holding a vote on issues and pull requests
 type: application
-version: 0.2.1-0
+version: 0.2.1-1
 appVersion: 0.2.0
 kubeVersion: ">= 1.19.0-0"
 home: https://gitvote.dev

charts/gitvote/Chart.yaml

@@ -12,6 +12,8 @@ stringData:
       dbname: {{ .Values.db.dbname }}
       user: {{ .Values.db.user }}
       password: {{ .Values.db.password }}
+    log:
+      format: {{ .Values.log.format }}
     github:
       appID: {{ .Values.gitvote.github.appID }}
       appPrivateKey: {{ .Values.gitvote.github.appPrivateKey | quote }}

charts/gitvote/templates/gitvote_secret.yaml

@@ -26,6 +26,11 @@ db:
   user: postgres
   password: postgres
 
+# Log configuration
+log:
+  # Output format [json|pretty]
+  format: json
+
 # Database migrator configuration
 dbmigrator:
   job:

charts/gitvote/values.yaml

@@ -267,7 +267,7 @@ mod tests {
     #[test]
     fn manual_command_from_issue_event_unsupported_action() {
         let mut event = setup_test_issue_event();
-        event.action = IssueEventAction::Assigned;
+        event.action = IssueEventAction::Other;
         event.issue.body = Some(format!("/{CMD_CREATE_VOTE}"));
         let event = Event::Issue(event);
 
@@ -316,7 +316,7 @@ mod tests {
     #[test]
     fn manual_command_from_issue_comment_event_unsupported_action() {
         let mut event = setup_test_issue_comment_event();
-        event.action = IssueCommentEventAction::Edited;
+        event.action = IssueCommentEventAction::Other;
         event.issue.body = Some(CMD_CREATE_VOTE.to_string());
         let event = Event::IssueComment(event);
 
@@ -352,7 +352,7 @@ mod tests {
     #[test]
     fn manual_command_from_pr_event_unsupported_action() {
         let mut event = setup_test_pr_event();
-        event.action = PullRequestEventAction::Edited;
+        event.action = PullRequestEventAction::Other;
         event.pull_request.body = Some(CMD_CREATE_VOTE.to_string());
         let event = Event::PullRequest(event);
 

src/cmd.rs

@@ -167,7 +167,7 @@ impl GH for GHApi {
         if let Some(conclusion) = &check_details.conclusion {
             body["conclusion"] = json!(conclusion);
         };
-        let _: Value = client.post(url, Some(&body)).await?; // Do not remove let _: Value
+        let _: Value = client.post(url, Some(&body)).await?;
         Ok(())
     }
 
@@ -428,21 +428,8 @@ pub(crate) struct IssueEvent {
 #[serde(rename_all = "lowercase")]
 pub(crate) enum IssueEventAction {
     Opened,
-    Edited,
-    Deleted,
-    Pinned,
-    Unpinned,
-    Closed,
-    Reopened,
-    Assigned,
-    Unassigned,
-    Labeled,
-    Unlabeled,
-    Locked,
-    Unlocked,
-    Transferred,
-    Milestoned,
-    Demilestoned,
+    #[serde(other)]
+    Other,
 }
 
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
@@ -460,8 +447,8 @@ pub(crate) struct IssueCommentEvent {
 #[serde(rename_all = "lowercase")]
 pub(crate) enum IssueCommentEventAction {
     Created,
-    Deleted,
-    Edited,
+    #[serde(other)]
+    Other,
 }
 
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
@@ -477,23 +464,10 @@ pub(crate) struct PullRequestEvent {
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
 #[serde(rename_all = "snake_case")]
 pub(crate) enum PullRequestEventAction {
-    Assigned,
-    AutoMergeDisabled,
-    AutoMergeEnabled,
-    Closed,
-    ConvertedToDraft,
-    Edited,
-    Labeled,
-    Locked,
     Opened,
-    ReadyForReview,
-    Reopened,
-    ReviewRequestRemoved,
-    ReviewRequested,
     Synchronize,
-    Unassigned,
-    Unlabeled,
-    Unlocked,
+    #[serde(other)]
+    Other,
 }
 
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]

src/github.rs

@@ -467,7 +467,7 @@ mod tests {
         let db = Arc::new(MockDB::new());
         let gh = Arc::new(MockGH::new());
         let mut event = setup_test_pr_event();
-        event.action = PullRequestEventAction::ReadyForReview;
+        event.action = PullRequestEventAction::Other;
 
         assert!(set_check_status(db, gh, &event).await.is_ok());
     }

src/handlers.rs

@@ -9,6 +9,7 @@ use postgres_openssl::MakeTlsConnector;
 use std::{net::SocketAddr, path::PathBuf, sync::Arc};
 use tokio::{signal, sync::broadcast};
 use tracing::{debug, info};
+use tracing_subscriber::EnvFilter;
 
 mod cfg;
 mod cmd;
@@ -35,6 +36,7 @@ async fn main() -> Result<()> {
 
     // Setup configuration
     let cfg = Config::builder()
+        .set_default("log.format", "pretty")?
         .set_default("addr", "127.0.0.1:9000")?
         .add_source(File::from(args.config))
         .build()
@@ -45,7 +47,11 @@ async fn main() -> Result<()> {
     if std::env::var_os("RUST_LOG").is_none() {
         std::env::set_var("RUST_LOG", "gitvote=debug")
     }
-    tracing_subscriber::fmt::init();
+    let s = tracing_subscriber::fmt().with_env_filter(EnvFilter::from_default_env());
+    match cfg.get_string("log.format").as_deref() {
+        Ok("json") => s.json().init(),
+        _ => s.init(),
+    };
 
     // Setup database
     let mut builder = SslConnector::builder(SslMethod::tls())?;

src/main.rs

@@ -128,6 +128,8 @@ impl Processor {
                         _ = stop_rx.recv() => break,
                     },
                     Err(_) => {
+                        // Something went wrong closing finished vote, pause
+                        // unless we've been asked to stop
                         tokio::select! {
                             _ = sleep(VOTES_CLOSER_PAUSE_ON_ERROR) => {},
                             _ = stop_rx.recv() => break,