feat: enable cycle estimation and allocation exclusion by default

Graduate --cycle-estimation and --exclude-allocations out of the
experimental flag set. They are now normal, default-on options that
can be disabled with --cycle-estimation=false / --exclude-allocations=false
(env: CODSPEED_CYCLE_ESTIMATION, CODSPEED_EXCLUDE_ALLOCATIONS).

--experimental-fair-sched remains experimental.

Author: not-matthias

src/cli/exec/mod.rs

@@ -89,8 +89,8 @@ fn build_orchestrator_config(
         poll_results_options,
         extra_env: HashMap::new(),
         fair_sched: args.shared.experimental.experimental_fair_sched,
-        cycle_estimation: args.shared.experimental.experimental_cycle_estimation,
-        exclude_allocations: args.shared.experimental.experimental_exclude_allocations,
+        cycle_estimation: args.shared.cycle_estimation,
+        exclude_allocations: args.shared.exclude_allocations,
     })
 }
 

src/cli/experimental.rs

@@ -17,22 +17,12 @@ pub struct ExperimentalArgs {
     )]
     pub experimental_fair_sched: bool,
 
-    /// Enable Valgrind cycle estimation (--cycle-estimation) in simulation mode.
-    #[arg(
-        long,
-        default_value_t = false,
-        help_heading = "Experimental",
-        env = "CODSPEED_EXPERIMENTAL_CYCLE_ESTIMATION"
-    )]
+    /// Deprecated: cycle estimation is enabled by default and this flag has no effect.
+    #[arg(long, hide = true, env = "CODSPEED_EXPERIMENTAL_CYCLE_ESTIMATION")]
     pub experimental_cycle_estimation: bool,
 
-    /// Exclude memory allocation time from simulation results.
-    #[arg(
-        long,
-        default_value_t = false,
-        help_heading = "Experimental",
-        env = "CODSPEED_EXPERIMENTAL_EXCLUDE_ALLOCATIONS"
-    )]
+    /// Deprecated: allocation exclusion is enabled by default and this flag has no effect.
+    #[arg(long, hide = true, env = "CODSPEED_EXPERIMENTAL_EXCLUDE_ALLOCATIONS")]
     pub experimental_exclude_allocations: bool,
 }
 
@@ -43,12 +33,6 @@ impl ExperimentalArgs {
         if self.experimental_fair_sched {
             flags.push("--experimental-fair-sched");
         }
-        if self.experimental_cycle_estimation {
-            flags.push("--experimental-cycle-estimation");
-        }
-        if self.experimental_exclude_allocations {
-            flags.push("--experimental-exclude-allocations");
-        }
         flags
     }
 
@@ -74,4 +58,33 @@ impl ExperimentalArgs {
             style("https://github.com/CodSpeedHQ/codspeed/issues").underlined(),
         );
     }
+
+    /// Warns about deprecated flags that were graduated to default-on options and
+    /// no longer have any effect.
+    pub fn warn_if_deprecated(&self) {
+        let deprecated = [
+            (
+                self.experimental_cycle_estimation,
+                "--experimental-cycle-estimation",
+                "cycle estimation",
+                "--cycle-estimation=false",
+            ),
+            (
+                self.experimental_exclude_allocations,
+                "--experimental-exclude-allocations",
+                "allocation exclusion",
+                "--exclude-allocations=false",
+            ),
+        ];
+
+        for (_, flag, feature, disable) in deprecated.iter().filter(|(set, ..)| *set) {
+            eprintln!(
+                "  {} {} has no effect: {} is now enabled by default. Use {} to disable.",
+                style(Icon::Warning.to_string()).yellow(),
+                style(*flag).bold(),
+                feature,
+                style(*disable).bold(),
+            );
+        }
+    }
 }

src/cli/mod.rs

@@ -161,6 +161,7 @@ pub async fn run() -> Result<()> {
                 .upload_url
                 .get_or_insert_with(|| codspeed_config.upload_url.clone());
             args.shared.experimental.warn_if_active();
+            args.shared.experimental.warn_if_deprecated();
             run::run(
                 args,
                 &mut api_client,
@@ -175,6 +176,7 @@ pub async fn run() -> Result<()> {
                 .upload_url
                 .get_or_insert_with(|| codspeed_config.upload_url.clone());
             args.shared.experimental.warn_if_active();
+            args.shared.experimental.warn_if_deprecated();
             exec::run(
                 args,
                 &mut api_client,

src/cli/run/mod.rs

@@ -69,6 +69,8 @@ impl RunArgs {
                 go_runner_version: None,
                 show_full_output: false,
                 base: None,
+                cycle_estimation: true,
+                exclude_allocations: true,
                 profiler_run_args: ProfilerRunArgs {
                     enable_profiler: false,
                     enable_perf: None,
@@ -129,8 +131,8 @@ fn build_orchestrator_config(
         poll_results_options,
         extra_env: HashMap::new(),
         fair_sched: args.shared.experimental.experimental_fair_sched,
-        cycle_estimation: args.shared.experimental.experimental_cycle_estimation,
-        exclude_allocations: args.shared.experimental.experimental_exclude_allocations,
+        cycle_estimation: args.shared.cycle_estimation,
+        exclude_allocations: args.shared.exclude_allocations,
     })
 }
 

src/cli/shared.rs

@@ -113,6 +113,24 @@ pub struct ExecAndRunSharedArgs {
     #[arg(long)]
     pub base: Option<String>,
 
+    /// Enable Valgrind cycle estimation (--cycle-estimation) in simulation mode.
+    #[arg(
+        long,
+        env = "CODSPEED_CYCLE_ESTIMATION",
+        default_value_t = true,
+        action = clap::ArgAction::Set
+    )]
+    pub cycle_estimation: bool,
+
+    /// Exclude memory allocation time from simulation results.
+    #[arg(
+        long,
+        env = "CODSPEED_EXCLUDE_ALLOCATIONS",
+        default_value_t = true,
+        action = clap::ArgAction::Set
+    )]
+    pub exclude_allocations: bool,
+
     #[command(flatten)]
     pub profiler_run_args: ProfilerRunArgs,
 

src/executor/config.rs

@@ -235,8 +235,8 @@ impl OrchestratorConfig {
             poll_results_options: PollResultsOptions::new(false, None),
             extra_env: HashMap::new(),
             fair_sched: false,
-            cycle_estimation: false,
-            exclude_allocations: false,
+            cycle_estimation: true,
+            exclude_allocations: true,
         }
     }
 }