vespertide_loader/

migrations.rs

use std::env;
use std::fs;
use std::path::{Path, PathBuf};

use anyhow::{Context, Result};
use vespertide_config::VespertideConfig;
use vespertide_core::MigrationPlan;
use vespertide_planner::validate_migration_plan;

use crate::parallel_config::map_paths_with_threshold;

/// Load all migration plans from the migrations directory, sorted by version.
pub fn load_migrations(config: &VespertideConfig) -> Result<Vec<MigrationPlan>> {
    let migrations_dir = config.migrations_dir();
    if !migrations_dir.exists() {
        return Ok(Vec::new());
    }

    let paths = collect_migration_paths(migrations_dir)?;
    let results = map_paths_with_threshold(&paths, load_migration_file);

    let mut plans = Vec::with_capacity(results.len());
    for result in results {
        plans.push(result?);
    }

    // Sort by version number
    plans.sort_by_key(|p| p.version);
    Ok(plans)
}

/// Load migrations from a specific directory (for compile-time use in macros).
pub fn load_migrations_from_dir(
    project_root: Option<PathBuf>,
) -> Result<Vec<MigrationPlan>, Box<dyn std::error::Error>> {
    // Locate project root from CARGO_MANIFEST_DIR or use provided path
    let project_root = if let Some(root) = project_root {
        root
    } else {
        let manifest_dir = env::var("CARGO_MANIFEST_DIR")
            .map_err(|_| "CARGO_MANIFEST_DIR environment variable not set")?;
        PathBuf::from(manifest_dir)
    };

    // Read vespertide.json or use defaults
    let config = crate::config::load_config_or_default(Some(project_root.clone()))
        .map_err(|e| format!("Failed to load config: {e}"))?;

    // Read migrations directory
    let migrations_dir = project_root.join(config.migrations_dir());
    if !migrations_dir.exists() {
        return Ok(Vec::new());
    }

    let paths = collect_migration_paths(&migrations_dir).map_err(|e| e.to_string())?;
    let results = map_paths_with_threshold(&paths, load_migration_file_internal);

    let mut plans = Vec::with_capacity(results.len());
    for result in results {
        plans.push(result.map_err(|e| -> Box<dyn std::error::Error> { e.into() })?);
    }

    // Sort by version
    plans.sort_by_key(|p| p.version);
    Ok(plans)
}

fn collect_migration_paths(dir: &Path) -> Result<Vec<PathBuf>> {
    let entries = fs::read_dir(dir).context("read migrations directory")?;
    let mut paths = Vec::new();

    for entry in entries {
        let entry = entry.context("read directory entry")?;
        let path = entry.path();
        if path.is_file() && crate::has_supported_extension(&path) {
            paths.push(path);
        }
    }

    Ok(paths)
}

fn load_migration_file(path: &Path) -> Result<MigrationPlan> {
    let ext = path.extension().and_then(|s| s.to_str());
    let content = fs::read_to_string(path)
        .with_context(|| format!("read migration file: {}", path.display()))?;

    let plan: MigrationPlan = if ext == Some("json") {
        serde_json::from_str(&content)
            .with_context(|| format!("parse migration: {}", path.display()))?
    } else {
        serde_yaml::from_str(&content)
            .with_context(|| format!("parse migration: {}", path.display()))?
    };

    validate_migration_plan(&plan)
        .with_context(|| format!("validate migration: {}", path.display()))?;

    Ok(plan)
}

fn load_migration_file_internal(path: &Path) -> Result<MigrationPlan, String> {
    let ext = path.extension().and_then(|s| s.to_str());
    let content = fs::read_to_string(path)
        .map_err(|e| format!("Failed to read migration file {}: {}", path.display(), e))?;

    let plan: MigrationPlan = if ext == Some("json") {
        serde_json::from_str(&content)
            .map_err(|e| format!("Failed to parse JSON migration {}: {}", path.display(), e))?
    } else {
        serde_yaml::from_str(&content)
            .map_err(|e| format!("Failed to parse YAML migration {}: {}", path.display(), e))?
    };

    validate_migration_plan(&plan)
        .map_err(|e| format!("Failed to validate migration {}: {}", path.display(), e))?;

    Ok(plan)
}

/// Load migrations at compile time (for macro use).
pub fn load_migrations_at_compile_time() -> Result<Vec<MigrationPlan>, Box<dyn std::error::Error>> {
    load_migrations_from_dir(None)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::test_support::{CwdGuard, write_default_config};
    use serial_test::serial;
    use std::env;
    use std::fs;
    use tempfile::TempDir;

    #[test]
    #[serial]
    fn test_load_migrations_returns_empty_when_no_migrations_dir() {
        let temp_dir = TempDir::new().unwrap();
        let _guard = CwdGuard::new(temp_dir.path());
        write_default_config(temp_dir.path().join("vespertide.json"));

        let result = load_migrations(&VespertideConfig::default()).unwrap();
        assert!(result.is_empty());
    }

    #[test]
    #[serial]
    fn test_load_migrations_reads_json_and_sorts_versions() {
        let temp_dir = TempDir::new().unwrap();
        let _guard = CwdGuard::new(temp_dir.path());
        write_default_config(temp_dir.path().join("vespertide.json"));
        fs::create_dir_all("migrations").unwrap();
        fs::write(
            "migrations/0002_second.json",
            r#"{"version": 2, "actions": []}"#,
        )
        .unwrap();
        fs::write(
            "migrations/0001_first.json",
            r#"{"version": 1, "actions": []}"#,
        )
        .unwrap();

        let plans = load_migrations(&VespertideConfig::default()).unwrap();
        assert_eq!(
            plans.iter().map(|plan| plan.version).collect::<Vec<_>>(),
            vec![1, 2]
        );
    }

    // A non-migration-extension file (e.g. `.txt`) must be ignored by the
    // collector. Pins `path.is_file() && has_migration_extension(&path)`: a
    // `&& -> ||` mutant would pick the `.txt` up, then fail to parse it as a
    // migration plan and surface an error instead of an empty load.
    #[test]
    #[serial]
    fn load_migrations_ignores_non_migration_extension_files() {
        let temp_dir = TempDir::new().unwrap();
        let _guard = CwdGuard::new(temp_dir.path());
        write_default_config(temp_dir.path().join("vespertide.json"));
        fs::create_dir_all("migrations").unwrap();
        fs::write("migrations/notes.txt", "not a migration: {{{ invalid").unwrap();

        let plans = load_migrations(&VespertideConfig::default()).unwrap();
        assert_eq!(plans.len(), 0, "the .txt file must be skipped");
    }

    #[test]
    fn load_migrations_from_dir_ignores_non_migration_extension_files() {
        let temp_dir = TempDir::new().unwrap();
        let migrations_dir = temp_dir.path().join("migrations");
        fs::create_dir_all(&migrations_dir).unwrap();
        fs::write(
            migrations_dir.join("notes.txt"),
            "not a migration: {{{ invalid",
        )
        .unwrap();

        let result = load_migrations_from_dir(Some(temp_dir.path().to_path_buf()));
        assert!(
            result.is_ok(),
            "the .txt file must be skipped, not parsed: {result:?}"
        );
        assert_eq!(result.unwrap().len(), 0);
    }

    #[test]
    fn test_load_migrations_from_dir_with_no_migrations_dir() {
        let temp_dir = TempDir::new().unwrap();
        let result = load_migrations_from_dir(Some(temp_dir.path().to_path_buf()));
        assert!(result.is_ok());
        assert_eq!(result.unwrap().len(), 0);
    }

    #[test]
    fn test_load_migrations_from_dir_with_empty_migrations_dir() {
        let temp_dir = TempDir::new().unwrap();
        let migrations_dir = temp_dir.path().join("migrations");
        fs::create_dir_all(&migrations_dir).unwrap();

        let result = load_migrations_from_dir(Some(temp_dir.path().to_path_buf()));
        assert!(result.is_ok());
        assert_eq!(result.unwrap().len(), 0);
    }

    #[test]
    fn test_load_migrations_from_dir_with_json_migration() {
        let temp_dir = TempDir::new().unwrap();
        let migrations_dir = temp_dir.path().join("migrations");
        fs::create_dir_all(&migrations_dir).unwrap();

        let migration_content = r#"{
            "version": 1,
            "actions": [
                {
                    "type": "create_table",
                    "table": "users",
                    "columns": [
                        {
                            "name": "id",
                            "type": "integer",
                            "nullable": false
                        }
                    ],
                    "constraints": []
                }
            ]
        }"#;

        fs::write(migrations_dir.join("0001_test.json"), migration_content).unwrap();

        let result = load_migrations_from_dir(Some(temp_dir.path().to_path_buf()));
        assert!(result.is_ok());
        let plans = result.unwrap();
        assert_eq!(plans.len(), 1);
        assert_eq!(plans[0].version, 1);
    }

    #[test]
    fn test_load_migrations_from_dir_sorts_by_version() {
        let temp_dir = TempDir::new().unwrap();
        let migrations_dir = temp_dir.path().join("migrations");
        fs::create_dir_all(&migrations_dir).unwrap();

        let migration1 = r#"{"version": 2, "actions": []}"#;
        let migration2 = r#"{"version": 1, "actions": []}"#;
        let migration3 = r#"{"version": 3, "actions": []}"#;

        fs::write(migrations_dir.join("0002_second.json"), migration1).unwrap();
        fs::write(migrations_dir.join("0001_first.json"), migration2).unwrap();
        fs::write(migrations_dir.join("0003_third.json"), migration3).unwrap();

        let result = load_migrations_from_dir(Some(temp_dir.path().to_path_buf()));
        assert!(result.is_ok());
        let plans = result.unwrap();
        assert_eq!(plans.len(), 3);
        assert_eq!(plans[0].version, 1);
        assert_eq!(plans[1].version, 2);
        assert_eq!(plans[2].version, 3);
    }

    #[test]
    fn test_load_migrations_from_dir_with_yaml_migration() {
        let temp_dir = TempDir::new().unwrap();
        let migrations_dir = temp_dir.path().join("migrations");
        fs::create_dir_all(&migrations_dir).unwrap();

        let migration_content = r"---
version: 1
actions:
  - type: create_table
    table: users
    columns:
      - name: id
        type: integer
        nullable: false
    constraints: []
";

        fs::write(migrations_dir.join("0001_test.yaml"), migration_content).unwrap();

        let result = load_migrations_from_dir(Some(temp_dir.path().to_path_buf()));
        assert!(result.is_ok());
        let plans = result.unwrap();
        assert_eq!(plans.len(), 1);
        assert_eq!(plans[0].version, 1);
    }

    #[test]
    fn test_load_migrations_from_dir_with_yml_migration() {
        let temp_dir = TempDir::new().unwrap();
        let migrations_dir = temp_dir.path().join("migrations");
        fs::create_dir_all(&migrations_dir).unwrap();

        let migration_content = r"---
version: 1
actions:
  - type: create_table
    table: users
    columns:
      - name: id
        type: integer
        nullable: false
    constraints: []
";

        fs::write(migrations_dir.join("0001_test.yml"), migration_content).unwrap();

        let result = load_migrations_from_dir(Some(temp_dir.path().to_path_buf()));
        assert!(result.is_ok());
        let plans = result.unwrap();
        assert_eq!(plans.len(), 1);
        assert_eq!(plans[0].version, 1);
    }

    #[test]
    #[serial]
    fn test_load_migrations_reads_yaml_for_runtime_loader() {
        let temp_dir = TempDir::new().unwrap();
        let _guard = CwdGuard::new(temp_dir.path());
        write_default_config(temp_dir.path().join("vespertide.json"));
        fs::create_dir_all("migrations").unwrap();

        let migration_content = r"---
version: 1
actions:
  - type: create_table
    table: users
    columns:
      - name: id
        type: integer
        nullable: false
    constraints: []
";
        fs::write("migrations/0001_test.yaml", migration_content).unwrap();

        let plans = load_migrations(&VespertideConfig::default()).unwrap();
        assert_eq!(plans.len(), 1);
        assert_eq!(plans[0].version, 1);
    }

    #[test]
    fn test_load_migrations_from_dir_with_invalid_json() {
        let temp_dir = TempDir::new().unwrap();
        let migrations_dir = temp_dir.path().join("migrations");
        fs::create_dir_all(&migrations_dir).unwrap();

        let invalid_json = r#"{"version": 1, "actions": [invalid]}"#;
        fs::write(migrations_dir.join("0001_invalid.json"), invalid_json).unwrap();

        let result = load_migrations_from_dir(Some(temp_dir.path().to_path_buf()));
        assert!(result.is_err());
        let err_msg = result.unwrap_err().to_string();
        assert!(err_msg.contains("Failed to parse JSON migration"));
    }

    #[test]
    fn test_load_migrations_from_dir_with_invalid_yaml() {
        let temp_dir = TempDir::new().unwrap();
        let migrations_dir = temp_dir.path().join("migrations");
        fs::create_dir_all(&migrations_dir).unwrap();

        let invalid_yaml = r"---
version: 1
actions:
  - invalid: [syntax
";
        fs::write(migrations_dir.join("0001_invalid.yaml"), invalid_yaml).unwrap();

        let result = load_migrations_from_dir(Some(temp_dir.path().to_path_buf()));
        assert!(result.is_err());
        let err_msg = result.unwrap_err().to_string();
        assert!(err_msg.contains("Failed to parse YAML migration"));
    }

    #[test]
    fn test_load_migrations_from_dir_rejects_invalid_plan_with_file_path() {
        let temp_dir = TempDir::new().unwrap();
        let migrations_dir = temp_dir.path().join("migrations");
        fs::create_dir_all(&migrations_dir).unwrap();

        let migration_path = migrations_dir.join("0001_invalid_plan.json");
        let invalid_plan = r#"{
            "version": 1,
            "actions": [
                {
                    "type": "add_column",
                    "table": "nonexistent",
                    "column": {
                        "name": "required_value",
                        "type": "integer",
                        "nullable": false
                    }
                }
            ]
        }"#;
        fs::write(&migration_path, invalid_plan).unwrap();

        let result = load_migrations_from_dir(Some(temp_dir.path().to_path_buf()));
        assert!(result.is_err());
        let err_msg = result.unwrap_err().to_string();
        assert!(
            err_msg.contains(&migration_path.display().to_string()),
            "error did not include file path {migration_path:?}: {err_msg}"
        );
    }

    #[test]
    fn test_load_migrations_from_dir_with_unreadable_file() {
        // Note: Testing file read errors (line 85) is extremely difficult in unit tests
        // because it requires actual I/O errors like:
        // - Disk failures
        // - Permission issues
        // - File locks from other processes
        // - Network filesystem issues
        //
        // The error handling code path at line 85 exists and will be executed
        // in real-world scenarios when file read errors occur.
        // The format! macro and error message construction are tested through
        // other error paths (invalid JSON/YAML parsing).
        //
        // For now, we verify the function works correctly with valid files.
        let temp_dir = TempDir::new().unwrap();
        let migrations_dir = temp_dir.path().join("migrations");
        fs::create_dir_all(&migrations_dir).unwrap();

        let file_path = migrations_dir.join("0001_test.json");
        fs::write(&file_path, r#"{"version": 1, "actions": []}"#).unwrap();

        let result = load_migrations_from_dir(Some(temp_dir.path().to_path_buf()));
        assert!(result.is_ok());
    }

    #[test]
    #[serial]
    fn test_load_migrations_from_dir_without_project_root() {
        // Save the original value
        let original = env::var("CARGO_MANIFEST_DIR").ok();

        // Remove CARGO_MANIFEST_DIR to test the error path
        // Note: remove_var is unsafe in multi-threaded environments,
        // but serial_test ensures tests run sequentially
        unsafe {
            env::remove_var("CARGO_MANIFEST_DIR");
        }

        let result = load_migrations_from_dir(None);
        assert!(result.is_err());
        let err_msg = result.unwrap_err().to_string();
        assert!(err_msg.contains("CARGO_MANIFEST_DIR environment variable not set"));

        // Restore the original value if it existed
        if let Some(val) = original {
            unsafe {
                env::set_var("CARGO_MANIFEST_DIR", val);
            }
        }
    }

    #[test]
    fn test_load_migrations_at_compile_time() {
        // This function just calls load_migrations_from_dir(None)
        // We can't easily test it without CARGO_MANIFEST_DIR, but we can verify
        // it doesn't panic
        let result = load_migrations_at_compile_time();
        // This might succeed if CARGO_MANIFEST_DIR is set (like in cargo test)
        // or fail if it's not set
        // Either way, we're testing the code path
        let _ = result;
    }
}