sqlx_gen/codegen/

struct_gen.rs

use std::collections::{BTreeSet, HashMap};

use heck::{ToSnakeCase, ToUpperCamelCase};
use proc_macro2::TokenStream;
use quote::{format_ident, quote};

use crate::cli::{DatabaseKind, TimeCrate};
use crate::codegen::naming::singularize;
use crate::codegen::{imports_for_derives, is_rust_keyword};
use crate::introspect::{SchemaInfo, TableInfo};
use crate::typemap;

pub fn generate_struct(
    table: &TableInfo,
    db_kind: DatabaseKind,
    schema_info: &SchemaInfo,
    extra_derives: &[String],
    type_overrides: &HashMap<String, String>,
    is_view: bool,
    time_crate: TimeCrate,
) -> (TokenStream, BTreeSet<String>) {
    let mut imports = BTreeSet::new();
    for imp in imports_for_derives(extra_derives) {
        imports.insert(imp);
    }
    // Tables are conventionally plural ("users"), structs singular ("User"),
    // matching the Rust ORM ecosystem (Diesel, SeaORM) and ActiveRecord.
    let struct_name = format_ident!("{}", singularize(&table.name).to_upper_camel_case());

    // Build derive list
    imports.insert("use serde::{Serialize, Deserialize};".to_string());
    imports.insert("use sqlx_gen::SqlxGen;".to_string());
    let mut derive_tokens = vec![
        quote! { Debug },
        quote! { Clone },
        quote! { PartialEq },
        quote! { Eq },
        quote! { Serialize },
        quote! { Deserialize },
        quote! { sqlx::FromRow },
        quote! { SqlxGen },
    ];
    for d in extra_derives {
        let ident = format_ident!("{}", d);
        derive_tokens.push(quote! { #ident });
    }

    // Build fields
    let fields: Vec<TokenStream> = table
        .columns
        .iter()
        .map(|col| {
            let rust_type =
                resolve_column_type(col, db_kind, table, schema_info, type_overrides, time_crate);
            if let Some(imp) = &rust_type.needs_import {
                imports.insert(imp.clone());
            }

            let field_name_snake = sanitize_rust_ident(&col.name.to_snake_case());
            // If the field name is a Rust keyword, prefix with the singular
            // form of the table name so column "type" on table "products"
            // becomes "product_type", not "products_type".
            let (effective_name, needs_rename) = if is_rust_keyword(&field_name_snake) {
                let prefix = singularize(&table.name).to_snake_case();
                let prefixed = format!("{}_{}", prefix, field_name_snake);
                (prefixed, true)
            } else {
                let changed = field_name_snake != col.name;
                (field_name_snake, changed)
            };

            let field_ident = format_ident!("{}", effective_name);
            let type_tokens: TokenStream = rust_type.path.parse().unwrap_or_else(|_| {
                let fallback = format_ident!("String");
                quote! { #fallback }
            });

            let rename = if needs_rename {
                let original = &col.name;
                quote! { #[sqlx(rename = #original)] }
            } else {
                quote! {}
            };

            // Build #[sqlx_gen(...)] attribute with optional primary_key, sql_type, is_array, column_default
            let (sql_type, is_sql_array) = detect_custom_sql_type(&col.udt_name, schema_info);
            let has_pk = col.is_primary_key;
            let has_sql_type = sql_type.is_some();
            let has_default = col.column_default.is_some();

            let sqlx_gen_attr = if has_pk || has_sql_type || has_default {
                let pk_part = if has_pk {
                    quote! { primary_key, }
                } else {
                    quote! {}
                };
                let sql_type_part = match &sql_type {
                    Some(t) => quote! { sql_type = #t, },
                    None => quote! {},
                };
                let array_part = if is_sql_array {
                    quote! { is_array, }
                } else {
                    quote! {}
                };
                let default_part = match &col.column_default {
                    Some(d) => quote! { column_default = #d, },
                    None => quote! {},
                };
                quote! { #[sqlx_gen(#pk_part #sql_type_part #array_part #default_part)] }
            } else {
                quote! {}
            };

            quote! {
                #sqlx_gen_attr
                #rename
                pub #field_ident: #type_tokens,
            }
        })
        .collect();

    let table_name_str = &table.name;
    let schema_name_str = &table.schema_name;
    let kind_str = if is_view { "view" } else { "table" };

    let tokens = quote! {
        #[derive(#(#derive_tokens),*)]
        #[sqlx_gen(kind = #kind_str, schema = #schema_name_str, table = #table_name_str)]
        pub struct #struct_name {
            #(#fields)*
        }
    };

    (tokens, imports)
}

/// Sanitize a candidate Rust identifier:
/// - replace any character that is not ascii-alphanumeric or '_' with '_'
/// - prefix with '_' if the result starts with a digit
/// - fall back to "_field" if the input is empty
///
/// Lets sqlx-gen survive columns named `user-id`, `created at`, `123`, etc.
/// — they still need a `#[sqlx(rename = "<original>")]` to roundtrip the DB
/// column, which the caller handles via the `changed` flag.
pub(crate) fn sanitize_rust_ident(name: &str) -> String {
    if name.is_empty() {
        return "_field".to_string();
    }
    let mut out: String = name
        .chars()
        .map(|c| {
            if c.is_ascii_alphanumeric() || c == '_' {
                c
            } else {
                '_'
            }
        })
        .collect();
    if out.starts_with(|c: char| c.is_ascii_digit()) {
        out.insert(0, '_');
    }
    out
}

/// Detect if a column uses a custom SQL type (enum or composite) and return the qualified
/// SQL type name for casting, plus whether it's an array.
/// Returns `(Some("type_name"), true)` for arrays of custom types,
/// `(Some("type_name"), false)` for scalar custom types, or `(None, false)` for built-in types.
fn detect_custom_sql_type(udt_name: &str, schema_info: &SchemaInfo) -> (Option<String>, bool) {
    let (base_name, is_array) = match udt_name.strip_prefix('_') {
        Some(inner) => (inner, true),
        None => (udt_name, false),
    };

    // Check enums
    if schema_info.enums.iter().any(|e| e.name == base_name) {
        return (Some(base_name.to_string()), is_array);
    }

    // Check composite types
    if schema_info
        .composite_types
        .iter()
        .any(|c| c.name == base_name)
    {
        return (Some(base_name.to_string()), is_array);
    }

    // Check if this is a non-builtin type that would hit the typemap fallback
    // (e.g. range types like "timerange", "tsrange", etc.)
    // Domains resolve to their base type, so they don't need marking.
    let is_domain = schema_info.domains.iter().any(|d| d.name == base_name);
    if !is_domain && !typemap::postgres::is_builtin(base_name) {
        return (Some(base_name.to_string()), is_array);
    }

    // Native arrays of builtin types (e.g. `_text` → `text[]`) need sql_type annotation
    // so that codegen falls back to runtime mode — `query_as!` macro doesn't support
    // `Vec<T>` without `PgHasArrayType`.
    if is_array {
        return (Some(base_name.to_string()), true);
    }

    (None, false)
}

fn resolve_column_type(
    col: &crate::introspect::ColumnInfo,
    db_kind: DatabaseKind,
    table: &TableInfo,
    schema_info: &SchemaInfo,
    type_overrides: &HashMap<String, String>,
    time_crate: TimeCrate,
) -> typemap::RustType {
    // For MySQL ENUM columns, resolve to the generated enum type
    if db_kind == DatabaseKind::Mysql && col.udt_name.starts_with("enum(") {
        let enum_type_name = typemap::mysql::resolve_enum_type(&table.name, &col.name);
        let rt = typemap::RustType::with_import(
            &enum_type_name,
            &format!("use super::types::{};", enum_type_name),
        );
        return if col.is_nullable {
            rt.wrap_option()
        } else {
            rt
        };
    }

    typemap::map_column(col, db_kind, schema_info, type_overrides, time_crate)
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::codegen::parse_and_format;
    use crate::introspect::ColumnInfo;

    fn make_table(name: &str, columns: Vec<ColumnInfo>) -> TableInfo {
        TableInfo {
            schema_name: "public".to_string(),
            name: name.to_string(),
            columns,
        }
    }

    fn make_col(name: &str, udt_name: &str, nullable: bool) -> ColumnInfo {
        ColumnInfo {
            name: name.to_string(),
            data_type: udt_name.to_string(),
            udt_name: udt_name.to_string(),
            is_nullable: nullable,
            is_primary_key: false,
            ordinal_position: 0,
            schema_name: "public".to_string(),
            udt_schema: None,
            column_default: None,
        }
    }

    fn gen(table: &TableInfo) -> String {
        let schema = SchemaInfo::default();
        let (tokens, _) = generate_struct(
            table,
            DatabaseKind::Postgres,
            &schema,
            &[],
            &HashMap::new(),
            false,
            TimeCrate::Chrono,
        );
        parse_and_format(&tokens).unwrap()
    }

    fn gen_with(
        table: &TableInfo,
        schema: &SchemaInfo,
        db: DatabaseKind,
        derives: &[String],
        overrides: &HashMap<String, String>,
    ) -> (String, BTreeSet<String>) {
        let (tokens, imports) = generate_struct(
            table,
            db,
            schema,
            derives,
            overrides,
            false,
            TimeCrate::Chrono,
        );
        (parse_and_format(&tokens).unwrap(), imports)
    }

    // --- basic structure ---

    #[test]
    fn test_simple_table() {
        let table = make_table(
            "users",
            vec![
                make_col("id", "int4", false),
                make_col("name", "text", false),
            ],
        );
        let code = gen(&table);
        assert!(code.contains("pub id: i32"));
        assert!(code.contains("pub name: String"));
    }

    #[test]
    fn test_struct_name_pascal_case_and_singular() {
        let table = make_table("user_roles", vec![make_col("id", "int4", false)]);
        let code = gen(&table);
        // Plural table → singular struct, snake_case → PascalCase.
        assert!(
            code.contains("pub struct UserRole"),
            "expected singular PascalCase struct name, got:\n{}",
            code
        );
        assert!(!code.contains("pub struct UserRoles"));
    }

    #[test]
    fn test_struct_name_is_singular() {
        let table = make_table("users", vec![make_col("id", "int4", false)]);
        let code = gen(&table);
        assert!(
            code.contains("pub struct User"),
            "table 'users' must produce singular 'User' struct, got:\n{}",
            code
        );
        assert!(!code.contains("pub struct Users"));
    }

    #[test]
    fn test_struct_name_already_singular_unchanged() {
        let table = make_table("agent_connector", vec![make_col("id", "int4", false)]);
        let code = gen(&table);
        assert!(code.contains("pub struct AgentConnector"));
    }

    #[test]
    fn test_struct_name_uncountable_unchanged() {
        let table = make_table("news", vec![make_col("id", "int4", false)]);
        let code = gen(&table);
        assert!(code.contains("pub struct News"));
    }

    #[test]
    fn test_reserved_keyword_column_prefixed_with_singular_table() {
        // table "products", column "type" → "product_type", NOT "products_type".
        let table = make_table(
            "products",
            vec![
                make_col("id", "int4", false),
                make_col("type", "text", false),
            ],
        );
        let code = gen(&table);
        assert!(
            code.contains("pub product_type:"),
            "expected singularized prefix 'product_type', got:\n{}",
            code
        );
        assert!(
            !code.contains("pub products_type:"),
            "must not use plural-form prefix, got:\n{}",
            code
        );
        // The actual SQL column name must still be carried via #[sqlx(rename)].
        assert!(code.contains("sqlx(rename = \"type\")"));
    }

    #[test]
    fn test_reserved_keyword_column_on_already_singular_table() {
        let table = make_table(
            "connector",
            vec![
                make_col("id", "int4", false),
                make_col("type", "text", false),
            ],
        );
        let code = gen(&table);
        assert!(code.contains("pub connector_type:"));
    }

    // --- nullable ---

    #[test]
    fn test_nullable_column() {
        let table = make_table("users", vec![make_col("email", "text", true)]);
        let code = gen(&table);
        assert!(code.contains("pub email: Option<String>"));
    }

    #[test]
    fn test_non_nullable_column() {
        let table = make_table("users", vec![make_col("name", "text", false)]);
        let code = gen(&table);
        assert!(code.contains("pub name: String"));
        assert!(!code.contains("Option"));
    }

    #[test]
    fn test_mix_nullable() {
        let table = make_table(
            "users",
            vec![make_col("id", "int4", false), make_col("bio", "text", true)],
        );
        let code = gen(&table);
        assert!(code.contains("pub id: i32"));
        assert!(code.contains("pub bio: Option<String>"));
    }

    // --- keyword renaming ---

    #[test]
    fn test_keyword_type_renamed() {
        let table = make_table("connector", vec![make_col("type", "text", false)]);
        let code = gen(&table);
        assert!(code.contains("pub connector_type: String"));
        assert!(code.contains("sqlx(rename = \"type\")"));
    }

    #[test]
    fn test_keyword_fn_renamed() {
        let table = make_table("item", vec![make_col("fn", "text", false)]);
        let code = gen(&table);
        assert!(code.contains("pub item_fn: String"));
        assert!(code.contains("sqlx(rename = \"fn\")"));
    }

    #[test]
    fn test_keyword_match_renamed() {
        let table = make_table("game", vec![make_col("match", "text", false)]);
        let code = gen(&table);
        assert!(code.contains("pub game_match: String"));
    }

    #[test]
    fn test_non_keyword_no_rename() {
        let table = make_table("users", vec![make_col("name", "text", false)]);
        let code = gen(&table);
        assert!(!code.contains("sqlx(rename"));
    }

    // --- snake_case renaming ---

    #[test]
    fn test_camel_case_column_renamed() {
        let table = make_table("users", vec![make_col("CreatedAt", "text", false)]);
        let code = gen(&table);
        assert!(code.contains("pub created_at: String"));
        assert!(code.contains("sqlx(rename = \"CreatedAt\")"));
    }

    #[test]
    fn test_mixed_case_column_renamed() {
        let table = make_table("users", vec![make_col("firstName", "text", false)]);
        let code = gen(&table);
        assert!(code.contains("pub first_name: String"));
        assert!(code.contains("sqlx(rename = \"firstName\")"));
    }

    #[test]
    fn test_already_snake_case_no_rename() {
        let table = make_table("users", vec![make_col("created_at", "text", false)]);
        let code = gen(&table);
        assert!(code.contains("pub created_at: String"));
        assert!(!code.contains("sqlx(rename"));
    }

    // --- derives ---

    #[test]
    fn test_default_derives() {
        let table = make_table("users", vec![make_col("id", "int4", false)]);
        let code = gen(&table);
        assert!(code.contains("Debug"));
        assert!(code.contains("Clone"));
        assert!(code.contains("sqlx::FromRow") || code.contains("sqlx :: FromRow"));
    }

    #[test]
    fn test_extra_derive_serialize() {
        let table = make_table("users", vec![make_col("id", "int4", false)]);
        let schema = SchemaInfo::default();
        let derives = vec!["Serialize".to_string()];
        let (code, _) = gen_with(
            &table,
            &schema,
            DatabaseKind::Postgres,
            &derives,
            &HashMap::new(),
        );
        assert!(code.contains("Serialize"));
    }

    #[test]
    fn test_extra_derives_both_serde() {
        let table = make_table("users", vec![make_col("id", "int4", false)]);
        let schema = SchemaInfo::default();
        let derives = vec!["Serialize".to_string(), "Deserialize".to_string()];
        let (_, imports) = gen_with(
            &table,
            &schema,
            DatabaseKind::Postgres,
            &derives,
            &HashMap::new(),
        );
        assert!(imports.iter().any(|i| i.contains("serde")));
    }

    // --- imports ---

    #[test]
    fn test_uuid_import() {
        let table = make_table("users", vec![make_col("id", "uuid", false)]);
        let schema = SchemaInfo::default();
        let (_, imports) = gen_with(
            &table,
            &schema,
            DatabaseKind::Postgres,
            &[],
            &HashMap::new(),
        );
        assert!(imports.iter().any(|i| i.contains("uuid::Uuid")));
    }

    #[test]
    fn test_timestamptz_import() {
        let table = make_table("users", vec![make_col("created_at", "timestamptz", false)]);
        let schema = SchemaInfo::default();
        let (_, imports) = gen_with(
            &table,
            &schema,
            DatabaseKind::Postgres,
            &[],
            &HashMap::new(),
        );
        assert!(imports.iter().any(|i| i.contains("chrono")));
    }

    #[test]
    fn test_int4_only_serde_import() {
        let table = make_table("users", vec![make_col("id", "int4", false)]);
        let schema = SchemaInfo::default();
        let (_, imports) = gen_with(
            &table,
            &schema,
            DatabaseKind::Postgres,
            &[],
            &HashMap::new(),
        );
        assert_eq!(imports.len(), 2);
        assert!(imports.iter().any(|i| i.contains("serde")));
        assert!(imports.iter().any(|i| i.contains("sqlx_gen::SqlxGen")));
    }

    #[test]
    fn test_multiple_imports_collected() {
        let table = make_table(
            "users",
            vec![
                make_col("id", "uuid", false),
                make_col("created_at", "timestamptz", false),
            ],
        );
        let schema = SchemaInfo::default();
        let (_, imports) = gen_with(
            &table,
            &schema,
            DatabaseKind::Postgres,
            &[],
            &HashMap::new(),
        );
        assert!(imports.iter().any(|i| i.contains("uuid")));
        assert!(imports.iter().any(|i| i.contains("chrono")));
    }

    // --- MySQL enum ---

    #[test]
    fn test_mysql_enum_column() {
        let table = make_table(
            "users",
            vec![ColumnInfo {
                name: "status".to_string(),
                data_type: "enum".to_string(),
                udt_name: "enum('active','inactive')".to_string(),
                is_nullable: false,
                is_primary_key: false,
                ordinal_position: 0,
                schema_name: "test_db".to_string(),
                udt_schema: None,
                column_default: None,
            }],
        );
        let schema = SchemaInfo::default();
        let (code, imports) = gen_with(&table, &schema, DatabaseKind::Mysql, &[], &HashMap::new());
        assert!(code.contains("UsersStatus"));
        assert!(imports.iter().any(|i| i.contains("super::types::")));
    }

    #[test]
    fn test_mysql_enum_nullable() {
        let table = make_table(
            "users",
            vec![ColumnInfo {
                name: "status".to_string(),
                data_type: "enum".to_string(),
                udt_name: "enum('a','b')".to_string(),
                is_nullable: true,
                is_primary_key: false,
                ordinal_position: 0,
                schema_name: "test_db".to_string(),
                udt_schema: None,
                column_default: None,
            }],
        );
        let schema = SchemaInfo::default();
        let (code, _) = gen_with(&table, &schema, DatabaseKind::Mysql, &[], &HashMap::new());
        assert!(code.contains("Option<UsersStatus>"));
    }

    // --- type overrides ---

    #[test]
    fn test_type_override() {
        let table = make_table("users", vec![make_col("data", "jsonb", false)]);
        let schema = SchemaInfo::default();
        let mut overrides = HashMap::new();
        overrides.insert("jsonb".to_string(), "MyJson".to_string());
        let (code, _) = gen_with(&table, &schema, DatabaseKind::Postgres, &[], &overrides);
        assert!(code.contains("pub data: MyJson"));
    }

    #[test]
    fn test_type_override_absent() {
        let table = make_table("users", vec![make_col("data", "jsonb", false)]);
        let schema = SchemaInfo::default();
        let (code, _) = gen_with(
            &table,
            &schema,
            DatabaseKind::Postgres,
            &[],
            &HashMap::new(),
        );
        assert!(code.contains("Value"));
    }

    #[test]
    fn test_type_override_nullable() {
        let table = make_table("users", vec![make_col("data", "jsonb", true)]);
        let schema = SchemaInfo::default();
        let mut overrides = HashMap::new();
        overrides.insert("jsonb".to_string(), "MyJson".to_string());
        let (code, _) = gen_with(&table, &schema, DatabaseKind::Postgres, &[], &overrides);
        assert!(code.contains("Option<MyJson>"));
    }

    // --- native array types ---

    #[test]
    fn test_native_array_text_gets_sql_type_annotation() {
        let table = make_table("posts", vec![make_col("tags", "_text", false)]);
        let code = gen(&table);
        assert!(code.contains("Vec<String>"));
        assert!(code.contains("sql_type = \"text\""));
        assert!(code.contains("is_array"));
    }

    #[test]
    fn test_native_array_int4_gets_sql_type_annotation() {
        let table = make_table("data", vec![make_col("values", "_int4", false)]);
        let code = gen(&table);
        assert!(code.contains("Vec<i32>"));
        assert!(code.contains("sql_type = \"int4\""));
        assert!(code.contains("is_array"));
    }

    #[test]
    fn test_native_array_nullable_gets_sql_type_annotation() {
        let table = make_table("posts", vec![make_col("tags", "_text", true)]);
        let code = gen(&table);
        assert!(code.contains("Option<Vec<String>>"));
        assert!(code.contains("sql_type = \"text\""));
        assert!(code.contains("is_array"));
    }

    #[test]
    fn test_scalar_builtin_no_sql_type_annotation() {
        let table = make_table("users", vec![make_col("name", "text", false)]);
        let code = gen(&table);
        assert!(code.contains("pub name: String"));
        assert!(!code.contains("sql_type"));
    }

    // ========== sanitize_rust_ident ==========

    #[test]
    fn test_sanitize_replaces_dash() {
        assert_eq!(sanitize_rust_ident("user-id"), "user_id");
    }

    #[test]
    fn test_sanitize_replaces_space() {
        assert_eq!(sanitize_rust_ident("created at"), "created_at");
    }

    #[test]
    fn test_sanitize_replaces_dot() {
        assert_eq!(sanitize_rust_ident("a.b"), "a_b");
    }

    #[test]
    fn test_sanitize_prefixes_leading_digit() {
        assert_eq!(sanitize_rust_ident("123abc"), "_123abc");
    }

    #[test]
    fn test_sanitize_empty_becomes_placeholder() {
        assert_eq!(sanitize_rust_ident(""), "_field");
    }

    #[test]
    fn test_sanitize_leaves_valid_ident_unchanged() {
        assert_eq!(sanitize_rust_ident("user_id"), "user_id");
        assert_eq!(sanitize_rust_ident("_private"), "_private");
    }

    #[test]
    fn test_column_with_dash_generates_valid_rust() {
        let table = make_table("users", vec![make_col("user-id", "int4", false)]);
        let code = gen(&table);
        // Must produce a Rust-legal identifier; renamed back to the original via #[sqlx(rename)]
        assert!(
            code.contains("pub user_id:") || code.contains("user_id:"),
            "expected sanitized identifier, got:\n{}",
            code
        );
        assert!(code.contains("sqlx(rename = \"user-id\")"));
    }
}