feat(env): support auto-dumping conversation via FORGE_AUTO_DUMP env var (#2441)

Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com>

Author: tusharmath

crates/forge_app/src/orch_spec/orch_setup.rs

@@ -85,6 +85,7 @@ impl Default for TestContext {
                 stdout_max_line_length: 200, // 5 MB
                 max_line_length: 2000,
                 auto_open_dump: false,
+                auto_dump: None,
                 debug_requests: None,
                 custom_history_path: None,
                 max_conversations: 100,

crates/forge_domain/src/env.rs

@@ -1,5 +1,6 @@
 use std::hash::{DefaultHasher, Hash, Hasher};
 use std::path::PathBuf;
+use std::str::FromStr;
 
 use derive_more::Display;
 use derive_setters::Setters;
@@ -99,6 +100,33 @@ pub struct Environment {
     /// Maximum number of file extensions to include in the system prompt.
     /// Controlled by FORGE_MAX_EXTENSIONS environment variable.
     pub max_extensions: usize,
+    /// Format for automatically creating a dump when a task is completed.
+    /// Controlled by FORGE_AUTO_DUMP environment variable.
+    /// Set to "json" (or "true"/"1"/"yes") for JSON, "html" for HTML, or
+    /// unset/other to disable.
+    pub auto_dump: Option<AutoDumpFormat>,
+}
+
+/// The output format used when auto-dumping a conversation on task completion.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize, fake::Dummy)]
+#[serde(rename_all = "camelCase")]
+pub enum AutoDumpFormat {
+    /// Dump as a JSON file.
+    Json,
+    /// Dump as an HTML file.
+    Html,
+}
+
+impl FromStr for AutoDumpFormat {
+    type Err = ();
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        match s.to_lowercase().as_str() {
+            "html" => Ok(AutoDumpFormat::Html),
+            "json" | "true" | "1" | "yes" => Ok(AutoDumpFormat::Json),
+            _ => Err(()),
+        }
+    }
 }
 
 impl Environment {
@@ -316,6 +344,7 @@ fn test_command_path() {
         override_model: None,
         override_provider: None,
         max_extensions: 15,
+        auto_dump: None,
     };
 
     let actual = fixture.command_path();
@@ -358,6 +387,7 @@ fn test_command_cwd_path() {
         override_model: None,
         override_provider: None,
         max_extensions: 15,
+        auto_dump: None,
     };
 
     let actual = fixture.command_cwd_path();
@@ -400,6 +430,7 @@ fn test_command_cwd_path_independent_from_command_path() {
         override_model: None,
         override_provider: None,
         max_extensions: 15,
+        auto_dump: None,
     };
 
     let command_path = fixture.command_path();

crates/forge_infra/src/env.rs

@@ -3,7 +3,9 @@ use std::path::{Path, PathBuf};
 use std::str::FromStr;
 
 use forge_app::EnvironmentInfra;
-use forge_domain::{Environment, ModelId, ProviderId, RetryConfig, TlsBackend, TlsVersion};
+use forge_domain::{
+    AutoDumpFormat, Environment, ModelId, ProviderId, RetryConfig, TlsBackend, TlsVersion,
+};
 use reqwest::Url;
 
 #[derive(Clone)]
@@ -102,6 +104,7 @@ impl ForgeEnvironmentInfra {
             override_model,
             override_provider,
             max_extensions: parse_env::<usize>("FORGE_MAX_EXTENSIONS").unwrap_or(15),
+            auto_dump: parse_env::<AutoDumpFormat>("FORGE_AUTO_DUMP"),
         }
     }
 
@@ -183,6 +186,7 @@ impl_from_env_str_via_from_str! {
     String,
     forge_domain::TlsBackend,
     forge_domain::TlsVersion,
+    forge_domain::AutoDumpFormat,
 }
 
 /// Parse environment variable using custom FromEnvStr trait
@@ -633,6 +637,95 @@ mod tests {
         }
     }
 
+    #[test]
+    #[serial]
+    fn test_auto_dump_env_var() {
+        use forge_domain::AutoDumpFormat;
+        let cwd = tempdir().unwrap().path().to_path_buf();
+        let infra = ForgeEnvironmentInfra::new(false, cwd);
+
+        // Test default value when env var is not set
+        {
+            unsafe {
+                env::remove_var("FORGE_AUTO_DUMP");
+            }
+            let env = infra.get_environment();
+            assert_eq!(env.auto_dump, None);
+        }
+
+        // Test JSON with "json"
+        {
+            unsafe {
+                env::set_var("FORGE_AUTO_DUMP", "json");
+            }
+            let env = infra.get_environment();
+            assert_eq!(env.auto_dump, Some(AutoDumpFormat::Json));
+            unsafe {
+                env::remove_var("FORGE_AUTO_DUMP");
+            }
+        }
+
+        // Test JSON with "true"
+        {
+            unsafe {
+                env::set_var("FORGE_AUTO_DUMP", "true");
+            }
+            let env = infra.get_environment();
+            assert_eq!(env.auto_dump, Some(AutoDumpFormat::Json));
+            unsafe {
+                env::remove_var("FORGE_AUTO_DUMP");
+            }
+        }
+
+        // Test JSON with "1"
+        {
+            unsafe {
+                env::set_var("FORGE_AUTO_DUMP", "1");
+            }
+            let env = infra.get_environment();
+            assert_eq!(env.auto_dump, Some(AutoDumpFormat::Json));
+            unsafe {
+                env::remove_var("FORGE_AUTO_DUMP");
+            }
+        }
+
+        // Test HTML with "html"
+        {
+            unsafe {
+                env::set_var("FORGE_AUTO_DUMP", "html");
+            }
+            let env = infra.get_environment();
+            assert_eq!(env.auto_dump, Some(AutoDumpFormat::Html));
+            unsafe {
+                env::remove_var("FORGE_AUTO_DUMP");
+            }
+        }
+
+        // Test HTML case-insensitive "HTML"
+        {
+            unsafe {
+                env::set_var("FORGE_AUTO_DUMP", "HTML");
+            }
+            let env = infra.get_environment();
+            assert_eq!(env.auto_dump, Some(AutoDumpFormat::Html));
+            unsafe {
+                env::remove_var("FORGE_AUTO_DUMP");
+            }
+        }
+
+        // Test disabled with invalid value
+        {
+            unsafe {
+                env::set_var("FORGE_AUTO_DUMP", "invalid");
+            }
+            let env = infra.get_environment();
+            assert_eq!(env.auto_dump, None);
+            unsafe {
+                env::remove_var("FORGE_AUTO_DUMP");
+            }
+        }
+    }
+
     #[test]
     #[serial]
     fn test_tool_timeout_env_var() {

crates/forge_main/src/ui.rs

@@ -2883,6 +2883,10 @@ impl<A: API + ConsoleWriter + 'static, F: Fn() -> A + Send + Sync> UI<A, F> {
                         TitleFormat::debug("Finished").sub_title(conversation_id.into_string()),
                     )?;
                 }
+                if let Some(format) = self.api.environment().auto_dump {
+                    let html = matches!(format, forge_domain::AutoDumpFormat::Html);
+                    self.on_dump(html).await?;
+                }
             }
         }
         Ok(())