execution_context.rs

use super::Config;
use crate::api_client::CodSpeedAPIClient;
use crate::cli::run::logger::Logger;
use crate::config::CodSpeedConfig;
use crate::prelude::*;
use crate::run_environment::{self, RunEnvironment};
use crate::runner_mode::RunnerMode;
use crate::system::{self, SystemInfo};
use std::path::PathBuf;

use super::create_profile_folder;

/// Runtime context for benchmark execution.
///
/// This struct contains all the necessary information and dependencies needed to execute
/// benchmarks, including the execution configuration, system information, environment provider,
/// and logging facilities. It is constructed from a [`Config`] and [`CodSpeedConfig`] and
/// serves as the primary context passed to executors during the benchmark run lifecycle.
pub struct ExecutionContext {
    pub config: Config,
    /// Directory path where profiling data and results are stored
    pub profile_folder: PathBuf,
    pub system_info: SystemInfo,
    /// The run environment provider (GitHub Actions, GitLab CI, local, etc.)
    pub provider: Box<dyn crate::run_environment::RunEnvironmentProvider>,
    pub logger: Logger,
}

impl ExecutionContext {
    pub fn is_local(&self) -> bool {
        self.provider.get_run_environment() == RunEnvironment::Local
    }

    pub async fn new(
        mut config: Config,
        codspeed_config: &CodSpeedConfig,
        api_client: &CodSpeedAPIClient,
    ) -> Result<Self> {
        let provider = run_environment::get_provider(&config, api_client).await?;
        let system_info = SystemInfo::new()?;
        system::check_system(&system_info)?;
        let logger = Logger::new(provider.as_ref())?;

        let profile_folder = if let Some(profile_folder) = &config.profile_folder {
            profile_folder.clone()
        } else {
            create_profile_folder()?
        };

        if provider.get_run_environment() == RunEnvironment::Local {
            if codspeed_config.auth.token.is_none() {
                bail!("You have to authenticate the CLI first. Run `codspeed auth login`.");
            }
            debug!("Using the token from the CodSpeed configuration file");
            config.set_token(codspeed_config.auth.token.clone());
        }

        #[allow(deprecated)]
        if config.mode == RunnerMode::Instrumentation {
            warn!(
                "The 'instrumentation' runner mode is deprecated and will be removed in a future version. \
                Please use 'simulation' instead."
            );
        }

        Ok(ExecutionContext {
            config,
            profile_folder,
            system_info,
            provider,
            logger,
        })
    }
}