use quote::quote;
use crate::model::{self, TableModel};
struct InsertContext<'a> {
table_name: &'a str,
column_names: String,
placeholders: String,
all: Vec<&'a model::Column>,
return_type: Option<&'a syn::Type>,
return_fields: Option<&'a str>,
}
fn generate_method(
ctx: &InsertContext<'_>,
method_name: &syn::Ident,
targets: &[&model::Column],
) -> proc_macro2::TokenStream {
let InsertContext {
table_name,
column_names,
placeholders,
all,
return_type,
return_fields,
} = ctx;
let bind_args = model::self_bind_tokens(all);
let query = format!("INSERT INTO {table_name} ({column_names})\nVALUES ({placeholders})");
let query = match model::upsert_clause(all, targets) {
Some(clause) => format!("{query}{clause}"),
None => query,
};
let returning = return_fields.unwrap_or("*");
if let Some(return_type) = return_type {
let query = format!("{query}\nRETURNING {returning}");
let doc = model::sql_doc(&query);
quote! {
#[doc = #doc]
pub async fn #method_name<'e, E>(&self, executor: E) -> Result<#return_type, sqlx::Error>
where
E: sqlx::PgExecutor<'e>,
{
let object = sqlx::query_as!(
#return_type,
#query,
#bind_args
)
.fetch_one(executor)
.await?;
Ok(object)
}
}
} else {
let doc = model::sql_doc(&query);
quote! {
#[doc = #doc]
pub async fn #method_name<'e, E>(&self, executor: E) -> Result<sqlx::any::AnyQueryResult, sqlx::Error>
where
E: sqlx::PgExecutor<'e>,
{
let query_result = sqlx::query!(
#query,
#bind_args
)
.execute(executor)
.await?;
Ok(query_result.into())
}
}
}
}
pub fn expand(model: &TableModel) -> darling::Result<proc_macro2::TokenStream> {
let struct_name = &model.struct_name;
let all: Vec<&model::Column> = model.columns.iter().collect();
let idents = model::idents(&all);
let placeholders = (1..=idents.len())
.map(|i| format!("${i}"))
.collect::<Vec<_>>()
.join(",");
let ctx = InsertContext {
table_name: &model.table_name,
column_names: model.column_names(),
placeholders,
all,
return_type: model.return_type.as_ref(),
return_fields: model.return_fields.as_deref(),
};
let mut errors = darling::Error::accumulator();
let mut methods = Vec::new();
let default_method_name = syn::Ident::new("insert", struct_name.span());
methods.push(generate_method(&ctx, &default_method_name, &[]));
for column in model.upsert_targets() {
let method_name = syn::Ident::new(&format!("upsert_by_{}", column.ident), column.ident.span());
methods.push(generate_method(&ctx, &method_name, &[column]));
}
if let Some(customs) = errors.handle(model.custom_upsert_methods()) {
for custom in customs {
methods.push(generate_method(&ctx, &custom.method_name, &custom.targets));
}
}
errors.finish()?;
Ok(quote! {
impl #struct_name {
#(#methods)*
}
})
}
#[cfg(test)]
mod tests {
use super::*;
use quote::quote as q;
fn parse(tokens: proc_macro2::TokenStream) -> syn::DeriveInput {
syn::parse2(tokens).expect("failed to parse test struct")
}
#[test]
fn plain_insert_has_no_on_conflict_clause() {
let input = parse(q! {
struct CreateUser { email: String }
});
let model = TableModel::from_derive_input(&input).unwrap();
let tokens = expand(&model).unwrap().to_string();
assert!(!tokens.contains("ON CONFLICT"));
}
#[test]
fn plain_columns_bind_without_a_cast() {
let input = parse(q! {
struct CreateUser { email: String, is_active: bool }
});
let model = TableModel::from_derive_input(&input).unwrap();
let tokens = expand(&model).unwrap().to_string();
assert!(!tokens.contains("as _"));
}
#[test]
fn as_type_column_binds_with_a_cast_others_do_not() {
let input = parse(q! {
struct CreateUser {
email: String,
#[table(as_type = "role!: Role")]
role: Role,
}
});
let model = TableModel::from_derive_input(&input).unwrap();
let tokens = expand(&model).unwrap().to_string();
assert!(tokens.contains("self . email"));
assert!(!tokens.contains("self . email as _"));
assert!(tokens.contains("self . role as _"));
}
#[test]
fn insert_column_list_has_no_as_annotation() {
let input = parse(q! {
struct CreateUser {
#[table(as_type = "role!: Role")]
role: Role,
}
});
let model = TableModel::from_derive_input(&input).unwrap();
let tokens = expand(&model).unwrap().to_string();
assert!(tokens.contains("INSERT INTO create_users (role)"));
}
#[test]
fn bare_upsert_field_generates_its_own_upsert_by_method() {
let input = parse(q! {
struct CreateUser {
#[table(upsert)]
email: String,
is_active: bool,
}
});
let model = TableModel::from_derive_input(&input).unwrap();
let tokens = expand(&model).unwrap().to_string();
assert!(tokens.contains("fn insert <"));
assert!(tokens.contains("fn upsert_by_email"));
assert!(tokens.contains("ON CONFLICT (email) DO UPDATE SET is_active=EXCLUDED.is_active"));
}
#[test]
fn insert_only_field_is_excluded_from_the_upsert_set_clause() {
let input = parse(q! {
struct CreateUser {
#[table(upsert)]
email: String,
#[table(insert_only)]
created_by: i32,
is_active: bool,
}
});
let model = TableModel::from_derive_input(&input).unwrap();
let tokens = expand(&model).unwrap().to_string();
assert!(tokens.contains("INSERT INTO create_users (email, created_by, is_active)"));
assert!(tokens.contains("ON CONFLICT (email) DO UPDATE SET is_active=EXCLUDED.is_active"));
assert!(!tokens.contains("created_by=EXCLUDED.created_by"));
}
#[test]
fn upsert_with_every_field_as_target_does_nothing_on_conflict() {
let input = parse(q! {
struct CreateUser {
#[table(upsert)]
email: String,
}
});
let model = TableModel::from_derive_input(&input).unwrap();
let tokens = expand(&model).unwrap().to_string();
assert!(tokens.contains("ON CONFLICT (email) DO NOTHING"));
}
#[test]
fn two_bare_upsert_fields_generate_two_independent_methods() {
let input = parse(q! {
struct AddMember {
#[table(upsert)]
org_id: i32,
#[table(upsert)]
user_id: i32,
role: String,
}
});
let model = TableModel::from_derive_input(&input).unwrap();
let tokens = expand(&model).unwrap().to_string();
assert!(tokens.contains("fn upsert_by_org_id"));
assert!(tokens.contains("ON CONFLICT (org_id) DO UPDATE SET user_id=EXCLUDED.user_id, role=EXCLUDED.role"));
assert!(tokens.contains("fn upsert_by_user_id"));
assert!(tokens.contains("ON CONFLICT (user_id) DO UPDATE SET org_id=EXCLUDED.org_id, role=EXCLUDED.role"));
}
#[test]
fn composite_upsert_generates_an_additional_named_method() {
let input = parse(q! {
#[table(upsert = insert_or_update_member(org_id, user_id))]
struct AddMember {
org_id: i32,
user_id: i32,
role: String,
}
});
let model = TableModel::from_derive_input(&input).unwrap();
let tokens = expand(&model).unwrap().to_string();
assert!(tokens.contains("fn insert <"));
assert!(tokens.contains("fn insert_or_update_member"));
assert!(tokens.contains("ON CONFLICT (org_id, user_id) DO UPDATE SET role=EXCLUDED.role"));
}
#[test]
fn composite_upsert_with_single_field_is_a_spanned_error() {
let input = parse(q! {
#[table(upsert = touch(org_id))]
struct AddMember {
org_id: i32,
role: String,
}
});
let model = TableModel::from_derive_input(&input);
let err = model.unwrap_err();
assert!(err.to_string().contains("at least two field names"));
}
}