fixup! feat: add option to output structured json

Author: GuillaumeLagrange

src/run/config.rs

@@ -139,7 +139,7 @@ mod tests {
             mode: RunnerMode::Instrumentation,
             instruments: vec!["mongodb".into()],
             mongo_uri_env_name: Some("MONGODB_URI".into()),
-            message_format: Some("json".into()),
+            message_format: Some(crate::run::MessageFormat::Json),
             skip_upload: true,
             skip_setup: true,
             command: vec!["cargo".into(), "codspeed".into(), "bench".into()],

src/run/mod.rs

@@ -37,14 +37,6 @@ fn show_banner() {
     debug!("codspeed v{}", VERSION);
 }
 
-#[derive(ValueEnum, Clone, Default, Debug, Serialize)]
-#[serde(rename_all = "lowercase")]
-pub enum RunnerMode {
-    #[default]
-    Instrumentation,
-    Walltime,
-}
-
 #[derive(Args, Debug)]
 pub struct RunArgs {
     /// The upload URL to use for uploading the results, useful for on-premises installations
@@ -87,8 +79,8 @@ pub struct RunArgs {
     #[arg(long)]
     pub mongo_uri_env_name: Option<String>,
 
-    #[arg(long)]
-    pub message_format: Option<String>,
+    #[arg(long, hide = true)]
+    pub message_format: Option<MessageFormat>,
 
     /// Only for debugging purposes, skips the upload of the results
     #[arg(
@@ -107,6 +99,19 @@ pub struct RunArgs {
     pub command: Vec<String>,
 }
 
+#[derive(ValueEnum, Clone, Default, Debug, Serialize)]
+#[serde(rename_all = "lowercase")]
+pub enum RunnerMode {
+    #[default]
+    Instrumentation,
+    Walltime,
+}
+
+#[derive(ValueEnum, Clone, Debug, PartialEq)]
+pub enum MessageFormat {
+    Json,
+}
+
 #[cfg(test)]
 impl RunArgs {
     /// Constructs a new `RunArgs` with default values for testing purposes
@@ -129,12 +134,7 @@ impl RunArgs {
 }
 
 pub async fn run(args: RunArgs, api_client: &CodSpeedAPIClient) -> Result<()> {
-    let output_json = args
-        .message_format
-        .as_ref()
-        .map(|format| format == "json")
-        .unwrap_or(false);
-
+    let output_json = args.message_format == Some(MessageFormat::Json);
     let mut config = Config::try_from(args)?;
     let provider = run_environment::get_provider(&config)?;
     let codspeed_config = CodSpeedConfig::load()?;
@@ -207,7 +207,8 @@ pub async fn run(args: RunArgs, api_client: &CodSpeedAPIClient) -> Result<()> {
             let run_id = upload_result.run_id.clone();
             poll_results::poll_results(api_client, &provider, upload_result.run_id).await?;
             if output_json {
-                // TODO: Refactor `log_json` to accept a serde_json::Value arguemnt
+                // TODO: Refactor `log_json` to avoid having to format the json manually
+                // We could make use of structured logging for this https://docs.rs/log/latest/log/#structured-logging
                 log_json!(format!(
                     "{{\"event\": \"run_finished\", \"run_id\": \"{}\"}}",
                     run_id

src/run/run_environment/buildkite/logger.rs

@@ -1,5 +1,5 @@
 use crate::{
-    logger::{get_group_event, GroupEvent},
+    logger::{get_group_event, get_json_event, GroupEvent},
     run::run_environment::logger::should_provider_logger_handle_record,
 };
 use log::*;
@@ -49,6 +49,10 @@ impl Log for BuildkiteLogger {
             return;
         }
 
+        if get_json_event(record).is_some() {
+            return;
+        }
+
         if level > self.log_level {
             return;
         }

src/run/run_environment/github_actions/logger.rs

@@ -1,5 +1,5 @@
 use crate::{
-    logger::{get_group_event, GroupEvent},
+    logger::{get_group_event, get_json_event, GroupEvent},
     run::run_environment::logger::should_provider_logger_handle_record,
 };
 use log::*;
@@ -36,6 +36,10 @@ impl Log for GithubActionLogger {
             return;
         }
 
+        if get_json_event(record).is_some() {
+            return;
+        }
+
         let prefix = match level {
             Level::Error => "::error::",
             Level::Warn => "::warning::",

src/run/run_environment/gitlab_ci/logger.rs

@@ -11,7 +11,7 @@ use std::{
 };
 
 use crate::{
-    logger::{get_group_event, GroupEvent},
+    logger::{get_group_event, get_json_event, GroupEvent},
     run::run_environment::logger::should_provider_logger_handle_record,
 };
 
@@ -108,6 +108,10 @@ impl Log for GitLabCILogger {
             return;
         }
 
+        if get_json_event(record).is_some() {
+            return;
+        }
+
         if level > self.log_level {
             return;
         }