tauri_typegen/build/

mod.rs

pub mod dependency_resolver;
pub mod generation_cache;
pub mod output_manager;
pub mod project_scanner;

use crate::analysis::CommandAnalyzer;
use crate::generators::create_generator;
use crate::interface::config::{ConfigError, GenerateConfig};
use crate::interface::output::{Logger, ProgressReporter};
use std::path::Path;

pub use dependency_resolver::*;
pub use generation_cache::*;
pub use output_manager::*;
pub use project_scanner::*;

/// Build-time code generation orchestrator.
///
/// Integrates TypeScript binding generation into Rust build scripts.
/// This allows automatic regeneration of bindings whenever the Rust code changes.
pub struct BuildSystem {
    logger: Logger,
}

impl BuildSystem {
    /// Create a new build system instance.
    ///
    /// # Arguments
    ///
    /// * `verbose` - Enable verbose output
    /// * `debug` - Enable debug logging
    pub fn new(verbose: bool, debug: bool) -> Self {
        Self {
            logger: Logger::new(verbose, debug),
        }
    }

    /// Generate TypeScript bindings at build time.
    ///
    /// This is the recommended way to integrate tauri-typegen into your build process.
    /// Call this from your `src-tauri/build.rs` file to automatically generate bindings
    /// whenever you run `cargo build` or `cargo tauri dev`.
    ///
    /// # Returns
    ///
    /// Returns `Ok(())` on success, or an error if generation fails.
    ///
    /// # Example
    ///
    /// In `src-tauri/build.rs`:
    ///
    /// ```rust,ignore
    /// fn main() {
    ///     // Generate TypeScript bindings before build
    ///     tauri_typegen::BuildSystem::generate_at_build_time()
    ///         .expect("Failed to generate TypeScript bindings");
    ///
    ///     tauri_build::build()
    /// }
    /// ```
    ///
    /// # Configuration
    ///
    /// Reads configuration from `tauri.conf.json` in the project root.
    /// If no configuration is found, uses default settings with vanilla TypeScript output.
    pub fn generate_at_build_time() -> Result<(), Box<dyn std::error::Error>> {
        let build_system = Self::new(false, false);
        build_system.run_generation()
    }

    /// Run the complete generation process
    pub fn run_generation(&self) -> Result<(), Box<dyn std::error::Error>> {
        let mut reporter = ProgressReporter::new(self.logger.clone(), 5);

        reporter.start_step("Detecting Tauri project");
        let project_scanner = ProjectScanner::new();
        let project_info = match project_scanner.detect_project()? {
            Some(info) => {
                reporter.complete_step(Some(&format!(
                    "Found project at {}",
                    info.root_path.display()
                )));
                info
            }
            None => {
                reporter.complete_step(Some("No Tauri project detected, skipping generation"));
                return Ok(());
            }
        };

        reporter.start_step("Loading configuration");
        let config = self.load_configuration(&project_info)?;
        reporter.complete_step(Some(&format!(
            "Using {} validation with output to {}",
            config.validation_library, config.output_path
        )));

        reporter.start_step("Setting up build dependencies");
        self.setup_build_dependencies(&config)?;
        reporter.complete_step(None);

        reporter.start_step("Analyzing and generating bindings");
        let generated_files = self.generate_bindings(&config)?;
        reporter.complete_step(Some(&format!("Generated {} files", generated_files.len())));

        reporter.start_step("Managing output");
        let mut output_manager = OutputManager::new(&config.output_path);
        output_manager.finalize_generation(&generated_files)?;
        reporter.complete_step(None);

        reporter.finish(&format!(
            "Successfully generated TypeScript bindings for {} commands",
            generated_files.len()
        ));

        Ok(())
    }

    fn load_configuration(
        &self,
        project_info: &ProjectInfo,
    ) -> Result<GenerateConfig, ConfigError> {
        // Try to load from tauri.conf.json first
        if let Some(tauri_config_path) = &project_info.tauri_config_path {
            if tauri_config_path.exists() {
                match GenerateConfig::from_tauri_config(tauri_config_path) {
                    Ok(Some(config)) => {
                        self.logger
                            .debug("Loaded configuration from tauri.conf.json");
                        return Ok(config);
                    }
                    Ok(None) => {}
                    Err(e) => {
                        self.logger.warning(&format!(
                            "Failed to load config from tauri.conf.json: {}. Using defaults.",
                            e
                        ));
                    }
                }
            }
        }

        // Try standalone config file
        let standalone_config = project_info.root_path.join("typegen.json");
        if standalone_config.exists() {
            match GenerateConfig::from_file(&standalone_config) {
                Ok(config) => {
                    self.logger.debug("Loaded configuration from typegen.json");
                    return Ok(config);
                }
                Err(e) => {
                    self.logger.warning(&format!(
                        "Failed to load config from typegen.json: {}. Using defaults.",
                        e
                    ));
                }
            }
        }

        // Use defaults
        self.logger.debug("Using default configuration");
        Ok(GenerateConfig::default())
    }

    fn setup_build_dependencies(
        &self,
        config: &GenerateConfig,
    ) -> Result<(), Box<dyn std::error::Error>> {
        // Set up cargo rerun directives
        println!("cargo:rerun-if-changed={}", config.project_path);

        // Watch for changes in configuration files
        if Path::new("tauri.conf.json").exists() {
            println!("cargo:rerun-if-changed=tauri.conf.json");
        }
        if Path::new("typegen.json").exists() {
            println!("cargo:rerun-if-changed=typegen.json");
        }

        // Watch output directory for cleanup detection
        if Path::new(&config.output_path).exists() {
            println!("cargo:rerun-if-changed={}", config.output_path);
        }

        Ok(())
    }

    fn generate_bindings(
        &self,
        config: &GenerateConfig,
    ) -> Result<Vec<String>, Box<dyn std::error::Error>> {
        let mut analyzer = CommandAnalyzer::new();
        // Seed the external-crate lookup memo from the previous run's cache so
        // warm builds skip the registry walk for already-resolved types (#87).
        if let Ok(prev_cache) = GenerationCache::load(&config.output_path) {
            analyzer.seed_external_type_cache(prev_cache.external_type_index().clone());
        }
        let commands = analyzer.analyze_project(&config.project_path)?;

        if commands.is_empty() {
            self.logger
                .info("No Tauri commands found. Skipping generation.");
            return Ok(vec![]);
        }

        // Check cache to see if regeneration is needed (unless force is set)
        let discovered_structs = analyzer.get_discovered_structs();
        let discovered_events = analyzer.get_discovered_events();
        if config.should_force() {
            self.logger.verbose("Force flag set, regenerating bindings");
        } else {
            match GenerationCache::needs_regeneration(
                &config.output_path,
                &commands,
                discovered_structs,
                discovered_events,
                config,
            ) {
                Ok(false) => {
                    self.logger
                        .verbose("Cache hit - no changes detected, skipping generation");
                    // Return list of existing files without regenerating
                    let output_manager = OutputManager::new(&config.output_path);
                    if let Ok(metadata) = output_manager.get_generation_metadata() {
                        return Ok(metadata.files.iter().map(|f| f.name.clone()).collect());
                    }
                    // If we can't get existing files, fall through to regenerate
                    self.logger
                        .debug("Could not get existing file list, regenerating");
                }
                Ok(true) => {
                    self.logger
                        .verbose("Cache miss - changes detected, regenerating");
                }
                Err(e) => {
                    self.logger
                        .debug(&format!("Cache check failed: {}, regenerating", e));
                }
            }
        }

        let validation = match config.validation_library.as_str() {
            "zod" | "none" => Some(config.validation_library.clone()),
            _ => return Err("Invalid validation library. Use 'zod' or 'none'".into()),
        };

        let mut generator = create_generator(validation);
        let generated_files = generator.generate_models(
            &commands,
            discovered_structs,
            &config.output_path,
            &analyzer,
            config,
        )?;

        // Generate dependency visualization if requested
        if config.should_visualize_deps() {
            self.generate_dependency_visualization(&analyzer, &commands, &config.output_path)?;
        }

        // Save cache after successful generation
        let cache = GenerationCache::new_with_external_index(
            &commands,
            discovered_structs,
            discovered_events,
            config,
            analyzer.external_type_lookup_cache().clone(),
        )?;
        if let Err(e) = cache.save(&config.output_path) {
            self.logger
                .warning(&format!("Failed to save generation cache: {}", e));
        }

        Ok(generated_files)
    }

    fn generate_dependency_visualization(
        &self,
        analyzer: &CommandAnalyzer,
        commands: &[crate::models::CommandInfo],
        output_path: &str,
    ) -> Result<(), Box<dyn std::error::Error>> {
        use std::fs;

        self.logger.debug("Generating dependency visualization");

        let text_viz = analyzer.visualize_dependencies(commands);
        let viz_file_path = Path::new(output_path).join("dependency-graph.txt");
        fs::write(&viz_file_path, text_viz)?;

        let dot_viz = analyzer.generate_dot_graph(commands);
        let dot_file_path = Path::new(output_path).join("dependency-graph.dot");
        fs::write(&dot_file_path, dot_viz)?;

        self.logger.verbose(&format!(
            "Generated dependency graphs: {} and {}",
            viz_file_path.display(),
            dot_file_path.display()
        ));

        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::interface::config::GenerateConfig;
    use std::path::Path;
    use tempfile::TempDir;

    fn create_build_config(project_path: &Path, output_path: &Path) -> GenerateConfig {
        GenerateConfig {
            project_path: project_path.to_string_lossy().to_string(),
            output_path: output_path.to_string_lossy().to_string(),
            validation_library: "none".to_string(),
            verbose: Some(false),
            visualize_deps: Some(false),
            include_private: Some(false),
            type_mappings: None,
            exclude_patterns: None,
            include_patterns: None,
            default_parameter_case: "camelCase".to_string(),
            default_field_case: "snake_case".to_string(),
            force: Some(false),
        }
    }

    fn run_generation(build_system: &BuildSystem, config: &GenerateConfig) -> Vec<String> {
        let generated_files = build_system.generate_bindings(config).unwrap();
        let mut output_manager = OutputManager::new(&config.output_path);
        output_manager
            .finalize_generation(&generated_files)
            .unwrap();
        generated_files
    }

    fn read_generated(output_path: &Path, file_name: &str) -> String {
        std::fs::read_to_string(output_path.join(file_name)).unwrap()
    }

    #[test]
    fn test_build_system_creation() {
        let build_system = BuildSystem::new(true, false);
        assert!(build_system
            .logger
            .should_log(crate::interface::output::LogLevel::Verbose));
    }

    #[test]
    fn test_load_default_configuration() {
        let temp_dir = TempDir::new().unwrap();
        let project_info = ProjectInfo {
            root_path: temp_dir.path().to_path_buf(),
            src_tauri_path: temp_dir.path().join("src-tauri"),
            tauri_config_path: None,
        };

        let build_system = BuildSystem::new(false, false);
        let config = build_system.load_configuration(&project_info).unwrap();

        assert_eq!(config.validation_library, "none");
        assert_eq!(config.project_path, "./src-tauri");
    }

    #[test]
    fn test_load_configuration_from_tauri_config() {
        let temp_dir = TempDir::new().unwrap();
        let tauri_config_path = temp_dir.path().join("tauri.conf.json");

        // Create the project path directory so validation passes
        let custom_src_path = temp_dir.path().join("custom-src");
        std::fs::create_dir_all(&custom_src_path).unwrap();

        // Create a tauri.conf.json with typegen plugin configuration
        let config_content = serde_json::json!({
            "plugins": {
                "typegen": {
                    "projectPath": custom_src_path.to_string_lossy().to_string(),
                    "outputPath": "./custom-output",
                    "validationLibrary": "zod"
                }
            }
        })
        .to_string();
        std::fs::write(&tauri_config_path, &config_content).unwrap();

        let project_info = ProjectInfo {
            root_path: temp_dir.path().to_path_buf(),
            src_tauri_path: temp_dir.path().join("src-tauri"),
            tauri_config_path: Some(tauri_config_path),
        };

        let build_system = BuildSystem::new(false, false);
        let config = build_system.load_configuration(&project_info).unwrap();

        assert_eq!(config.validation_library, "zod");
        assert_eq!(config.output_path, "./custom-output");
    }

    #[test]
    fn test_load_configuration_from_standalone_file() {
        let temp_dir = TempDir::new().unwrap();
        let typegen_config_path = temp_dir.path().join("typegen.json");

        // Create a project path that exists for validation
        let project_path = temp_dir.path().join("src-tauri");
        std::fs::create_dir_all(&project_path).unwrap();

        // Create a standalone typegen.json configuration
        let config_content = serde_json::json!({
            "project_path": project_path.to_string_lossy().to_string(),
            "output_path": "./standalone-output",
            "validation_library": "zod"
        })
        .to_string();
        std::fs::write(&typegen_config_path, config_content).unwrap();

        let project_info = ProjectInfo {
            root_path: temp_dir.path().to_path_buf(),
            src_tauri_path: project_path.clone(),
            tauri_config_path: None,
        };

        let build_system = BuildSystem::new(false, false);
        let config = build_system.load_configuration(&project_info).unwrap();

        assert_eq!(config.validation_library, "zod");
        assert_eq!(config.output_path, "./standalone-output");
    }

    #[test]
    fn test_load_configuration_falls_back_on_invalid_tauri_config() {
        let temp_dir = TempDir::new().unwrap();
        let tauri_config_path = temp_dir.path().join("tauri.conf.json");

        // Create an invalid tauri.conf.json (no typegen section)
        let config_content = r#"{"build": {}}"#;
        std::fs::write(&tauri_config_path, config_content).unwrap();

        let project_info = ProjectInfo {
            root_path: temp_dir.path().to_path_buf(),
            src_tauri_path: temp_dir.path().join("src-tauri"),
            tauri_config_path: Some(tauri_config_path),
        };

        let build_system = BuildSystem::new(false, false);
        let config = build_system.load_configuration(&project_info).unwrap();

        // Should fall back to defaults
        assert_eq!(config.validation_library, "none");
        assert_eq!(config.project_path, "./src-tauri");
    }

    #[test]
    fn test_build_system_with_verbose_logging() {
        let build_system = BuildSystem::new(true, true);
        assert!(build_system
            .logger
            .should_log(crate::interface::output::LogLevel::Verbose));
        assert!(build_system
            .logger
            .should_log(crate::interface::output::LogLevel::Debug));
    }

    #[test]
    fn test_build_system_without_verbose_logging() {
        let build_system = BuildSystem::new(false, false);
        assert!(!build_system
            .logger
            .should_log(crate::interface::output::LogLevel::Verbose));
        assert!(!build_system
            .logger
            .should_log(crate::interface::output::LogLevel::Debug));
    }

    #[test]
    fn test_generate_bindings_skips_unrelated_rust_changes() {
        let temp_dir = TempDir::new().unwrap();
        let project_path = temp_dir.path().join("src-tauri");
        let output_path = temp_dir.path().join("generated");
        std::fs::create_dir_all(&project_path).unwrap();

        let source_file = project_path.join("main.rs");
        std::fs::write(
            &source_file,
            r#"
            use serde::{Deserialize, Serialize};
            use tauri::Manager;

            #[derive(Debug, Clone, Serialize, Deserialize)]
            pub struct Payload {
                pub value: String,
            }

            fn helper_text() -> &'static str {
                "one"
            }

            #[tauri::command]
            pub fn fetch_payload() -> Result<Payload, String> {
                Ok(Payload {
                    value: helper_text().to_string(),
                })
            }

            #[tauri::command]
            pub fn emit_event(app: tauri::AppHandle) -> Result<(), String> {
                app.emit("stable-event", Payload {
                    value: helper_text().to_string(),
                }).ok();
                Ok(())
            }
        "#,
        )
        .unwrap();

        let config = create_build_config(&project_path, &output_path);
        let build_system = BuildSystem::new(false, false);

        run_generation(&build_system, &config);

        let commands_before = read_generated(&output_path, "commands.ts");
        let types_before = read_generated(&output_path, "types.ts");
        let events_before = read_generated(&output_path, "events.ts");
        let index_before = read_generated(&output_path, "index.ts");

        std::fs::write(
            &source_file,
            r#"
            use serde::{Deserialize, Serialize};
            use tauri::Manager;

            #[derive(Debug, Clone, Serialize, Deserialize)]
            pub struct Payload {
                pub value: String,
            }

            fn helper_text() -> &'static str {
                "two"
            }

            #[tauri::command]
            pub fn fetch_payload() -> Result<Payload, String> {
                Ok(Payload {
                    value: helper_text().to_string(),
                })
            }

            #[tauri::command]
            pub fn emit_event(app: tauri::AppHandle) -> Result<(), String> {
                app.emit("stable-event", Payload {
                    value: helper_text().to_string(),
                }).ok();
                Ok(())
            }
        "#,
        )
        .unwrap();

        run_generation(&build_system, &config);

        assert_eq!(commands_before, read_generated(&output_path, "commands.ts"));
        assert_eq!(types_before, read_generated(&output_path, "types.ts"));
        assert_eq!(events_before, read_generated(&output_path, "events.ts"));
        assert_eq!(index_before, read_generated(&output_path, "index.ts"));
    }

    #[test]
    fn test_generate_bindings_skips_source_location_only_changes() {
        let temp_dir = TempDir::new().unwrap();
        let project_path = temp_dir.path().join("src-tauri");
        let output_path = temp_dir.path().join("generated");
        std::fs::create_dir_all(&project_path).unwrap();

        let source_file = project_path.join("main.rs");
        std::fs::write(
            &source_file,
            r#"
            use serde::{Deserialize, Serialize};
            use tauri::Manager;

            #[derive(Debug, Clone, Serialize, Deserialize)]
            pub struct Payload {
                pub value: String,
            }

            #[tauri::command]
            pub fn fetch_payload() -> Result<Payload, String> {
                Ok(Payload {
                    value: "one".to_string(),
                })
            }

            #[tauri::command]
            pub fn emit_event(app: tauri::AppHandle) -> Result<(), String> {
                app.emit("stable-event", Payload {
                    value: "one".to_string(),
                }).ok();
                Ok(())
            }
        "#,
        )
        .unwrap();

        let config = create_build_config(&project_path, &output_path);
        let build_system = BuildSystem::new(false, false);

        run_generation(&build_system, &config);

        let commands_before = read_generated(&output_path, "commands.ts");
        let types_before = read_generated(&output_path, "types.ts");
        let events_before = read_generated(&output_path, "events.ts");

        std::fs::write(
            &source_file,
            r#"
            use serde::{Deserialize, Serialize};
            use tauri::Manager;

            // Unrelated comment that shifts every discovered item downward.
            // The generated bindings should stay byte-stable.

            #[derive(Debug, Clone, Serialize, Deserialize)]
            pub struct Payload {
                pub value: String,
            }

            #[tauri::command]
            pub fn fetch_payload() -> Result<Payload, String> {
                Ok(Payload {
                    value: "one".to_string(),
                })
            }

            #[tauri::command]
            pub fn emit_event(app: tauri::AppHandle) -> Result<(), String> {
                app.emit("stable-event", Payload {
                    value: "one".to_string(),
                }).ok();
                Ok(())
            }
        "#,
        )
        .unwrap();

        run_generation(&build_system, &config);

        assert_eq!(commands_before, read_generated(&output_path, "commands.ts"));
        assert_eq!(types_before, read_generated(&output_path, "types.ts"));
        assert_eq!(events_before, read_generated(&output_path, "events.ts"));
    }

    #[test]
    fn test_generate_bindings_regenerates_when_commands_change() {
        let temp_dir = TempDir::new().unwrap();
        let project_path = temp_dir.path().join("src-tauri");
        let output_path = temp_dir.path().join("generated");
        std::fs::create_dir_all(&project_path).unwrap();

        let source_file = project_path.join("main.rs");
        std::fs::write(
            &source_file,
            r#"
            #[tauri::command]
            pub fn first_command() -> Result<String, String> {
                Ok("one".to_string())
            }
        "#,
        )
        .unwrap();

        let config = create_build_config(&project_path, &output_path);
        let build_system = BuildSystem::new(false, false);

        run_generation(&build_system, &config);
        let commands_before = read_generated(&output_path, "commands.ts");

        std::fs::write(
            &source_file,
            r#"
            #[tauri::command]
            pub fn second_command() -> Result<String, String> {
                Ok("two".to_string())
            }
        "#,
        )
        .unwrap();

        run_generation(&build_system, &config);
        let commands_after = read_generated(&output_path, "commands.ts");

        assert_ne!(commands_before, commands_after);
        assert!(commands_after.contains("secondCommand"));
        assert!(!commands_after.contains("firstCommand"));
    }

    #[test]
    fn test_generate_bindings_regenerates_when_structs_change() {
        let temp_dir = TempDir::new().unwrap();
        let project_path = temp_dir.path().join("src-tauri");
        let output_path = temp_dir.path().join("generated");
        std::fs::create_dir_all(&project_path).unwrap();

        let source_file = project_path.join("main.rs");
        std::fs::write(
            &source_file,
            r#"
            use serde::{Deserialize, Serialize};

            #[derive(Debug, Clone, Serialize, Deserialize)]
            pub struct Payload {
                pub value: String,
            }

            #[tauri::command]
            pub fn fetch_payload() -> Result<Payload, String> {
                Ok(Payload {
                    value: "one".to_string(),
                })
            }
        "#,
        )
        .unwrap();

        let config = create_build_config(&project_path, &output_path);
        let build_system = BuildSystem::new(false, false);

        run_generation(&build_system, &config);
        let types_before = read_generated(&output_path, "types.ts");

        std::fs::write(
            &source_file,
            r#"
            use serde::{Deserialize, Serialize};

            #[derive(Debug, Clone, Serialize, Deserialize)]
            pub struct Payload {
                pub value: String,
                pub count: i32,
            }

            #[tauri::command]
            pub fn fetch_payload() -> Result<Payload, String> {
                Ok(Payload {
                    value: "one".to_string(),
                    count: 2,
                })
            }
        "#,
        )
        .unwrap();

        run_generation(&build_system, &config);
        let types_after = read_generated(&output_path, "types.ts");

        assert_ne!(types_before, types_after);
        assert!(types_after.contains("count: number"));
    }

    #[test]
    fn test_generate_bindings_regenerates_when_events_change() {
        let temp_dir = TempDir::new().unwrap();
        let project_path = temp_dir.path().join("src-tauri");
        let output_path = temp_dir.path().join("generated");
        std::fs::create_dir_all(&project_path).unwrap();

        let source_file = project_path.join("main.rs");
        std::fs::write(
            &source_file,
            r#"
            use serde::{Deserialize, Serialize};
            use tauri::Manager;

            #[derive(Debug, Clone, Serialize, Deserialize)]
            pub struct Payload {
                pub value: String,
            }

            #[tauri::command]
            pub fn emit_event(app: tauri::AppHandle) -> Result<(), String> {
                app.emit("first-event", Payload {
                    value: "one".to_string(),
                }).ok();
                Ok(())
            }
        "#,
        )
        .unwrap();

        let config = create_build_config(&project_path, &output_path);

        let build_system = BuildSystem::new(false, false);
        run_generation(&build_system, &config);
        let events_before = read_generated(&output_path, "events.ts");

        std::fs::write(
            &source_file,
            r#"
            use serde::{Deserialize, Serialize};
            use tauri::Manager;

            #[derive(Debug, Clone, Serialize, Deserialize)]
            pub struct Payload {
                pub value: String,
            }

            #[tauri::command]
            pub fn emit_event(app: tauri::AppHandle) -> Result<(), String> {
                app.emit("second-event", Payload {
                    value: "two".to_string(),
                }).ok();
                Ok(())
            }
        "#,
        )
        .unwrap();

        run_generation(&build_system, &config);

        let events_after = read_generated(&output_path, "events.ts");
        assert_ne!(events_before, events_after);
        assert!(events_after.contains("second-event"));
        assert!(!events_after.contains("first-event"));
    }
}