bsql-macros 0.27.0

//! Shared compile-time database connection for proc macro validation.
//!
//! Uses `OnceLock` to maintain a single connection across all `query!`
//! invocations within one `cargo build`. The first invocation pays ~5ms
//! for the connection. Subsequent invocations reuse it at ~0 cost.
//!
//! # Backend detection
//!
//! The URL scheme in `BSQL_DATABASE_URL` / `DATABASE_URL` determines the backend:
//! - `postgres://` or `postgresql://` -> PostgreSQL (synchronous)
//! - `sqlite:` -> SQLite (synchronous)
//!   - `sqlite:///absolute/path` -> absolute path
//!   - `sqlite:./relative/path` or `sqlite:relative/path` -> relative to CARGO_MANIFEST_DIR
//!   - `sqlite::memory:` -> in-memory (for tests)
//!
//! # TLS support (PostgreSQL only)
//!
//! When the `tls` feature is enabled on `bsql`, the compile-time connection
//! uses `rustls` for encrypted connections. The connection URL can include
//! `?sslmode=require` to enforce TLS:
//!
//! ```text
//! BSQL_DATABASE_URL=postgres://user:pass@host/db?sslmode=require
//! ```
//!
//! Without the `tls` feature, connections use `NoTls` and `sslmode=require`
//! will fail with a connection error.

use std::sync::OnceLock;

use bsql_driver_postgres::Connection;

/// Detected backend from the database URL scheme.
#[cfg(feature = "sqlite")]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Backend {
    Postgres,
    Sqlite,
}

/// Detect the backend from the database URL.
///
/// Returns `None` if no URL is set (offline mode handles this separately).
#[cfg(feature = "sqlite")]
pub fn detect_backend_from_url(url: &str) -> Result<Backend, String> {
    if url.starts_with("postgres://") || url.starts_with("postgresql://") {
        return Ok(Backend::Postgres);
    }

    if url.starts_with("sqlite:") {
        return Ok(Backend::Sqlite);
    }

    Err(format!(
        "bsql: unrecognized database URL scheme. Expected 'postgres://', \
         'postgresql://', or 'sqlite:'. Got: {url}"
    ))
}

/// Detect the backend from environment variables.
///
/// Returns `None` if no database URL is set.
#[cfg(feature = "sqlite")]
pub fn detect_backend() -> Result<Option<Backend>, String> {
    let url = match std::env::var("BSQL_DATABASE_URL").or_else(|_| std::env::var("DATABASE_URL")) {
        Ok(url) => url,
        Err(_) => return Ok(None), // no URL -> offline mode
    };
    detect_backend_from_url(&url).map(Some)
}

// ---------------------------------------------------------------------------
// PostgreSQL connection
// ---------------------------------------------------------------------------

/// The shared PG connection state, initialized once per compilation.
struct MacroConnection {
    conn: std::sync::Mutex<Connection>,
}

/// The global shared PG connection. Initialized on first access.
static MACRO_CONN: OnceLock<Result<MacroConnection, String>> = OnceLock::new();

fn init_macro_conn() -> Result<MacroConnection, String> {
    let database_url = std::env::var("BSQL_DATABASE_URL")
        .or_else(|_| std::env::var("DATABASE_URL"))
        .map_err(|_| {
            "bsql: BSQL_DATABASE_URL or DATABASE_URL must be set for compile-time \
             SQL validation. Set one of these environment variables to a PostgreSQL \
             connection URL (e.g. postgres://user:pass@localhost/mydb)."
                .to_string()
        })?;

    // Parse URL and configure TLS via our driver's Config
    let mut config = bsql_driver_postgres::Config::from_url(&database_url)
        .map_err(|e| format!("bsql: invalid DATABASE_URL: {e}"))?;

    // TLS: when the `tls` feature is not enabled, force SslMode::Disable
    // so our driver does not attempt a TLS upgrade.
    #[cfg(not(feature = "tls"))]
    {
        config.ssl = bsql_driver_postgres::SslMode::Disable;
    }

    // Compile-time queries should time out, not hang the build.
    config.statement_timeout_secs = 30;

    let conn = Connection::connect(&config).map_err(|e| {
        format!(
            "bsql: failed to connect to PostgreSQL at compile time: {e}. \
                 Check that BSQL_DATABASE_URL or DATABASE_URL is set correctly \
                 and the database is running."
        )
    })?;

    Ok(MacroConnection {
        conn: std::sync::Mutex::new(conn),
    })
}

/// Run a synchronous operation on the shared compile-time PG connection.
///
/// Returns a `syn::Error` if the connection is not available.
pub fn with_connection<F, T>(f: F) -> Result<T, syn::Error>
where
    F: FnOnce(&mut Connection) -> Result<T, String>,
{
    let mc = MACRO_CONN
        .get_or_init(init_macro_conn)
        .as_ref()
        .map_err(|msg| syn::Error::new(proc_macro2::Span::call_site(), msg))?;
    let mut conn = mc.conn.lock().unwrap_or_else(|e| e.into_inner());
    f(&mut conn).map_err(|msg| syn::Error::new(proc_macro2::Span::call_site(), msg))
}

// ---------------------------------------------------------------------------
// SQLite connection
// ---------------------------------------------------------------------------

/// Resolve a SQLite URL (`sqlite:...`) to a filesystem path.
///
/// - `sqlite:///absolute/path` -> `/absolute/path`
/// - `sqlite:./relative/path` -> `{CARGO_MANIFEST_DIR}/./relative/path`
/// - `sqlite:relative/path` -> `{CARGO_MANIFEST_DIR}/relative/path`
/// - `sqlite::memory:` -> `:memory:`
#[cfg(feature = "sqlite")]
pub fn resolve_sqlite_path(url: &str) -> Result<String, String> {
    let rest = url
        .strip_prefix("sqlite:")
        .ok_or_else(|| format!("bsql: not a sqlite URL: {url}"))?;

    if rest == ":memory:" {
        return Ok(":memory:".to_owned());
    }

    if let Some(path) = rest.strip_prefix("//") {
        // sqlite:///absolute/path -> /absolute/path
        return Ok(path.to_owned());
    }

    // Relative path: resolve from CARGO_MANIFEST_DIR
    let manifest_dir = std::env::var("CARGO_MANIFEST_DIR").map_err(|_| {
        "bsql: CARGO_MANIFEST_DIR not set (required for relative sqlite paths)".to_owned()
    })?;
    let full_path = std::path::Path::new(&manifest_dir).join(rest);
    Ok(full_path.to_string_lossy().into_owned())
}

/// Run a synchronous operation on the compile-time SQLite connection.
///
/// Opens the connection on first use and caches it in a thread-local.
/// `SqliteConnection` is `!Send + !Sync` (raw FFI handle), so it cannot
/// live in a `static`. Thread-local storage is correct here because proc
/// macro expansion is single-threaded per compilation unit.
///
/// Returns a `syn::Error` if the connection cannot be opened.
#[cfg(feature = "sqlite")]
pub fn with_sqlite_connection<F, T>(f: F) -> Result<T, syn::Error>
where
    F: FnOnce(&mut bsql_driver_sqlite::conn::SqliteConnection) -> Result<T, String>,
{
    use std::cell::RefCell;

    thread_local! {
        static SQLITE_CONN: RefCell<Option<Result<bsql_driver_sqlite::conn::SqliteConnection, String>>> = const { RefCell::new(None) };
    }

    SQLITE_CONN.with(|cell| {
        let mut borrow = cell.borrow_mut();

        // Initialize on first access
        if borrow.is_none() {
            let result = (|| -> Result<bsql_driver_sqlite::conn::SqliteConnection, String> {
                let database_url = std::env::var("BSQL_DATABASE_URL")
                    .or_else(|_| std::env::var("DATABASE_URL"))
                    .map_err(|_| {
                        "bsql: BSQL_DATABASE_URL or DATABASE_URL must be set for compile-time \
                         SQL validation. Set one of these environment variables to a SQLite \
                         connection URL (e.g. sqlite:./mydb.db or sqlite::memory:)."
                            .to_string()
                    })?;

                let path = resolve_sqlite_path(&database_url)?;

                bsql_driver_sqlite::conn::SqliteConnection::open(&path).map_err(|e| {
                    format!(
                        "bsql: failed to open SQLite database at compile time: {e}. \
                         Path: {path}"
                    )
                })
            })();
            *borrow = Some(result);
        }

        let conn = borrow
            .as_mut()
            .unwrap()
            .as_mut()
            .map_err(|msg| syn::Error::new(proc_macro2::Span::call_site(), msg.clone()))?;

        f(conn).map_err(|msg| syn::Error::new(proc_macro2::Span::call_site(), msg))
    })
}

#[cfg(test)]
#[cfg(feature = "sqlite")]
mod tests {
    use super::*;

    // --- detect_backend_from_url ---

    #[test]
    fn detect_postgres_url() {
        assert_eq!(
            detect_backend_from_url("postgres://user:pass@localhost/db").unwrap(),
            Backend::Postgres
        );
    }

    #[test]
    fn detect_postgresql_url() {
        assert_eq!(
            detect_backend_from_url("postgresql://user:pass@localhost/db").unwrap(),
            Backend::Postgres
        );
    }

    #[test]
    fn detect_sqlite_url() {
        assert_eq!(
            detect_backend_from_url("sqlite:./test.db").unwrap(),
            Backend::Sqlite
        );
    }

    #[test]
    fn detect_sqlite_memory_url() {
        assert_eq!(
            detect_backend_from_url("sqlite::memory:").unwrap(),
            Backend::Sqlite
        );
    }

    #[test]
    fn detect_unknown_scheme_errors() {
        let result = detect_backend_from_url("mysql://localhost/db");
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(
            err.contains("unrecognized database URL scheme"),
            "error: {err}"
        );
    }

    #[test]
    fn detect_empty_url_errors() {
        let result = detect_backend_from_url("");
        assert!(result.is_err());
    }

    #[test]
    fn detect_http_url_errors() {
        let result = detect_backend_from_url("http://localhost");
        assert!(result.is_err());
    }

    // --- resolve_sqlite_path ---

    #[test]
    fn resolve_memory_path() {
        assert_eq!(resolve_sqlite_path("sqlite::memory:").unwrap(), ":memory:");
    }

    #[test]
    fn resolve_absolute_path() {
        assert_eq!(
            resolve_sqlite_path("sqlite:///tmp/test.db").unwrap(),
            "/tmp/test.db"
        );
    }

    #[test]
    fn resolve_absolute_path_nested() {
        assert_eq!(
            resolve_sqlite_path("sqlite:///var/data/myapp/db.sqlite").unwrap(),
            "/var/data/myapp/db.sqlite"
        );
    }

    #[test]
    fn resolve_relative_path() {
        // CARGO_MANIFEST_DIR is set by cargo during `cargo test`
        let manifest_dir = std::env::var("CARGO_MANIFEST_DIR")
            .expect("CARGO_MANIFEST_DIR should be set during cargo test");
        let result = resolve_sqlite_path("sqlite:./data/test.db").unwrap();
        let expected = format!("{manifest_dir}/./data/test.db");
        assert_eq!(result, expected);
    }

    #[test]
    fn resolve_relative_path_no_dot() {
        let manifest_dir = std::env::var("CARGO_MANIFEST_DIR")
            .expect("CARGO_MANIFEST_DIR should be set during cargo test");
        let result = resolve_sqlite_path("sqlite:data/test.db").unwrap();
        let expected = format!("{manifest_dir}/data/test.db");
        assert_eq!(result, expected);
    }

    #[test]
    fn resolve_not_sqlite_url_errors() {
        let result = resolve_sqlite_path("postgres://localhost/db");
        assert!(result.is_err());
        let err = result.unwrap_err();
        assert!(err.contains("not a sqlite URL"), "error: {err}");
    }

    #[test]
    fn resolve_empty_sqlite_prefix() {
        // sqlite: with nothing after it resolves relative to CARGO_MANIFEST_DIR
        let result = resolve_sqlite_path("sqlite:");
        assert!(result.is_ok());
    }
}