rullst-orm-macros 4.0.1

Procedural macros for the rullst-orm ORM.
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
use crate::parser::ParsedModel;
use proc_macro2::TokenStream;
use quote::quote;

pub fn generate(parsed: &ParsedModel, relationship_methods: &[TokenStream]) -> TokenStream {
    let name = &parsed.name;
    let table_name = &parsed.table_name;
    let builder_name = quote::format_ident!("{}QueryBuilder", name);
    let observer_trait_name = quote::format_ident!("{}Observer", name);

    let normal_fields = &parsed.normal_fields;
    let hidden_fields = &parsed.hidden_fields;
    let has_soft_deletes = parsed.has_soft_deletes;

    let mut relation_field_idents = vec![];
    for rel in &parsed.relations {
        relation_field_idents.push(rel.field_name.clone());
    }

    let hook_before_save = if !parsed.before_save.is_empty() {
        let method = syn::Ident::new(&parsed.before_save, name.span());
        quote! { self.#method().await?; }
    } else {
        quote! {}
    };
    let hook_after_save = if !parsed.after_save.is_empty() {
        let method = syn::Ident::new(&parsed.after_save, name.span());
        quote! { self.#method().await?; }
    } else {
        quote! {}
    };
    let hook_before_delete = if !parsed.before_delete.is_empty() {
        let method = syn::Ident::new(&parsed.before_delete, name.span());
        quote! { self.#method().await?; }
    } else {
        quote! {}
    };
    let hook_after_delete = if !parsed.after_delete.is_empty() {
        let method = syn::Ident::new(&parsed.after_delete, name.span());
        quote! { self.#method().await?; }
    } else {
        quote! {}
    };

    let global_scope_logic = if !parsed.global_scope.is_empty() {
        let method = syn::Ident::new(&parsed.global_scope, name.span());
        quote! { builder = builder.#method(); }
    } else {
        quote! {}
    };

    let tenant_scope_logic = if !parsed.tenant_column.is_empty() {
        let col = &parsed.tenant_column;
        quote! {
            if let Some(tenant) = rullst_orm::tenant::get_tenant_id() {
                builder = builder.where_eq(#col, tenant);
            }
        }
    } else {
        quote! {}
    };

    let tenant_set_logic = if !parsed.tenant_column.is_empty() {
        let col_ident = syn::Ident::new(&parsed.tenant_column, name.span());
        quote! {
            if let Some(tenant) = rullst_orm::tenant::get_tenant_id() {
                if let Ok(val) = tenant.try_into() {
                    self.#col_ident = val;
                }
            }
        }
    } else {
        quote! {}
    };

    let audit_before_update = if parsed.auditable {
        quote! {
            let old_model_for_audit = if !is_new {
                let pool = rullst_orm::Orm::read_pool();
                rullst_orm::_sqlx::query_as::<_, Self>(rullst_orm::_sqlx::AssertSqlSafe(format!("SELECT * FROM {} WHERE id = ?", #table_name).as_str()))
                    .bind(self.id)
                    .fetch_optional(pool)
                    .await
                    .unwrap_or(None)
            } else {
                None
            };
        }
    } else {
        quote! {}
    };

    let audit_after_save = if parsed.auditable {
        quote! {
            if is_new {
                let _ = rullst_orm::audit::log_audit(
                    #table_name,
                    self.id,
                    "created",
                    None,
                    Some(self.to_json())
                ).await;
            } else if let Some(old_model) = old_model_for_audit {
                let _ = rullst_orm::audit::log_audit_diff(
                    #table_name,
                    self.id,
                    "updated",
                    &old_model.to_json(),
                    &self.to_json()
                ).await;
            }
        }
    } else {
        quote! {}
    };

    let audit_after_delete = if parsed.auditable {
        quote! {
            let _ = rullst_orm::audit::log_audit(
                #table_name,
                self.id,
                "deleted",
                Some(self.to_json()),
                None
            ).await;
        }
    } else {
        quote! {}
    };

    let scout_update = if parsed.searchable {
        quote! {
            if let Some(engine) = rullst_orm::scout::get_search_engine() {
                let payload: rullst_orm::_serde_json::Value = rullst_orm::_serde_json::from_str(&self.to_json()).unwrap_or(rullst_orm::_serde_json::Value::Null);
                let _ = engine.update(#table_name, self.id, payload).await;
            }
        }
    } else {
        quote! {}
    };

    let scout_delete = if parsed.searchable {
        quote! {
            if let Some(engine) = rullst_orm::scout::get_search_engine() {
                let _ = engine.delete(#table_name, self.id).await;
            }
        }
    } else {
        quote! {}
    };

    let search_method = if parsed.searchable {
        let cols = parsed
            .normal_fields
            .iter()
            .map(|f| f.to_string())
            .collect::<Vec<_>>();
        quote! {
            pub async fn search(query: &str) -> #builder_name {
                let mut base_builder = #builder_name::new();
                if let Some(engine) = rullst_orm::scout::get_search_engine() {
                    let ids = engine.search(#table_name, query).await.unwrap_or_default();
                    if ids.is_empty() {
                        base_builder = base_builder.where_eq("id", 0); // impossible match
                    } else {
                        let mut sql_ids = String::new();
                        for (i, id) in ids.iter().enumerate() {
                            sql_ids.push_str(&id.to_string());
                            if i < ids.len() - 1 {
                                sql_ids.push_str(",");
                            }
                        }
                        base_builder = base_builder.where_raw(format!("id IN ({})", sql_ids).as_str());
                    }
                    return base_builder;
                }

                let driver = rullst_orm::Orm::driver();
                let cast_type = if driver == "mysql" { "CHAR" } else { "TEXT" };
                // Build parameterized LIKE conditions — the search value goes into
                // bindings, never interpolated into the SQL string directly.
                let like_query = format!("%{}%", query);

                let cols = vec![#(#cols),*];
                let mut raw_parts: Vec<String> = Vec::with_capacity(cols.len());
                for col in &cols {
                    // Template uses a `?` placeholder; value added to bindings below.
                    raw_parts.push(format!("CAST({} AS {}) LIKE ?", col, cast_type));
                }
                let raw_where = raw_parts.join(" OR ");

                // Add one binding per column (all use the same like_query value).
                for _ in &cols {
                    base_builder.bindings.push(rullst_orm::RullstValue::String(like_query.clone()));
                }

                base_builder.where_raw(raw_where.as_str())
            }
        }
    } else {
        quote! {}
    };

    let mut insert_columns = vec![];
    let mut insert_placeholders = vec![];
    let mut bind_inserts = vec![];

    let mut update_sets = vec![];
    let mut bind_updates = vec![];

    let mut to_json_fields = vec![];

    for field_name in normal_fields {
        let field_name_str = field_name.to_string();

        if field_name_str != "id" {
            insert_columns.push(field_name_str.clone());
            insert_placeholders.push("?");
            bind_inserts.push(quote! { .bind(self.#field_name.clone()) });

            update_sets.push(format!("{} = ?", field_name_str));
            bind_updates.push(quote! { .bind(self.#field_name.clone()) });
        }

        if !hidden_fields.contains(field_name) {
            to_json_fields.push(quote! {
                map.insert(#field_name_str.to_string(), rullst_orm::_serde_json::json!(self.#field_name));
            });
        }
    }

    let insert_columns_str = insert_columns.join(", ");
    let insert_placeholders_str = insert_placeholders.join(", ");
    let update_sets_str = update_sets.join(", ");

    let delete_logic = if has_soft_deletes {
        quote! {
            let query = format!("UPDATE {} SET deleted_at = CURRENT_TIMESTAMP WHERE id = ?", #table_name);
        }
    } else {
        quote! {
            let query = format!("DELETE FROM {} WHERE id = ?", #table_name);
        }
    };

    let column_enum_name = quote::format_ident!("{}Column", name);
    let column_variants: Vec<_> = normal_fields
        .iter()
        .map(|ident| {
            let name_str = ident.to_string();
            let mut chars = name_str.chars();
            let mut camel = match chars.next() {
                None => String::new(),
                Some(f) => f.to_uppercase().collect::<String>() + chars.as_str(),
            };
            camel = camel
                .split('_')
                .map(|s| {
                    let mut c = s.chars();
                    match c.next() {
                        None => String::new(),
                        Some(f) => f.to_uppercase().collect::<String>() + c.as_str(),
                    }
                })
                .collect();
            quote::format_ident!("{}", camel)
        })
        .collect();

    let column_to_string: Vec<_> = normal_fields
        .iter()
        .zip(column_variants.iter())
        .map(|(ident, variant)| {
            let field_name_str = ident.to_string();
            quote! { #column_enum_name::#variant => #field_name_str }
        })
        .collect();

    let enum_def = quote! {
        #[derive(Debug, Clone, Copy, PartialEq, Eq)]
        pub enum #column_enum_name {
            #(#column_variants),*
        }
        impl #column_enum_name {
            pub fn as_str(&self) -> &'static str {
                match self {
                    #(#column_to_string),*
                }
            }
        }
    };

    quote! {
        #enum_def

        #[rullst_orm::async_trait]
        impl rullst_orm::RullstModel for #name {
            fn table_name() -> &'static str {
                #table_name
            }
        }

        impl #name {
            #(#relationship_methods)*

            pub fn from_json(json_str: &str) -> Result<Self, rullst_orm::_serde_json::Error> {
                let value: rullst_orm::_serde_json::Value = rullst_orm::_serde_json::from_str(json_str)?;
                Self::from_json_value(value)
            }

            pub fn from_json_value(value: rullst_orm::_serde_json::Value) -> Result<Self, rullst_orm::_serde_json::Error> {
                Ok(Self {
                    #(
                        #normal_fields: rullst_orm::_serde_json::from_value(value[stringify!(#normal_fields)].clone())?,
                    )*
                    #(
                        #relation_field_idents: None,
                    )*
                })
            }

            pub fn from_json_array(json_str: &str) -> Result<Vec<Self>, rullst_orm::_serde_json::Error> {
                let value: rullst_orm::_serde_json::Value = rullst_orm::_serde_json::from_str(json_str)?;
                let mut results = vec![];
                if let Some(arr) = value.as_array() {
                    for item in arr {
                        results.push(Self::from_json_value(item.clone())?);
                    }
                }
                Ok(results)
            }

            pub fn to_cache_json(&self) -> String {
                let mut map = rullst_orm::_serde_json::Map::new();
                #(
                    map.insert(stringify!(#normal_fields).to_string(), rullst_orm::_serde_json::json!(self.#normal_fields));
                )*
                rullst_orm::_serde_json::Value::Object(map).to_string()
            }

            pub fn to_cache_json_array(models: &[Self]) -> String {
                let json_values: Vec<rullst_orm::_serde_json::Value> = models.iter().map(|m| {
                    let mut map = rullst_orm::_serde_json::Map::new();
                    #(
                        map.insert(stringify!(#normal_fields).to_string(), rullst_orm::_serde_json::json!(m.#normal_fields));
                    )*
                    rullst_orm::_serde_json::Value::Object(map)
                }).collect();
                rullst_orm::_serde_json::Value::Array(json_values).to_string()
            }

            pub fn from_cache_json(json_str: &str) -> Result<Self, rullst_orm::_serde_json::Error> {
                Self::from_json(json_str)
            }

            pub fn from_cache_json_array(json_str: &str) -> Result<Vec<Self>, rullst_orm::_serde_json::Error> {
                Self::from_json_array(json_str)
            }

            pub fn observe(observer: std::sync::Arc<dyn #observer_trait_name + Send + Sync>) {
                let list = Self::observers();
                let mut writer = list.write().expect("Failed to acquire write lock on observers - possible poisoning");
                writer.push(observer);
            }

            fn observers() -> &'static std::sync::RwLock<Vec<std::sync::Arc<dyn #observer_trait_name + Send + Sync>>> {
                static LIST: std::sync::OnceLock<std::sync::RwLock<Vec<std::sync::Arc<dyn #observer_trait_name + Send + Sync>>>> = std::sync::OnceLock::new();
                LIST.get_or_init(|| std::sync::RwLock::new(vec![]))
            }

            #search_method

            pub fn query() -> #builder_name {
                let mut builder = #builder_name::new();
                #global_scope_logic
                #tenant_scope_logic
                builder
            }

            pub async fn find(id: i32) -> Result<Option<Self>, rullst_orm::Error> {
                Self::query().where_eq("id", id).first().await
            }

            pub async fn find_with_tx(id: i32, tx: &mut rullst_orm::db::Transaction<'static>) -> Result<Option<Self>, rullst_orm::Error> {
                Self::query().where_eq("id", id).first_with_tx(tx).await
            }

            pub async fn all() -> Result<Vec<Self>, rullst_orm::Error> {
                Self::query().get().await
            }

            pub async fn all_with_tx(tx: &mut rullst_orm::db::Transaction<'static>) -> Result<Vec<Self>, rullst_orm::Error> {
                Self::query().get_with_tx(tx).await
            }

            pub async fn save(&mut self) -> Result<(), rullst_orm::Error> {
                let pool = rullst_orm::Orm::pool();
                self.save_with_tx_internal(pool).await
            }

            pub async fn save_with_tx(&mut self, tx: &mut rullst_orm::db::Transaction<'static>) -> Result<(), rullst_orm::Error> {
                self.save_with_tx_internal(&mut **tx).await
            }

            async fn save_with_tx_internal<'e, E>(&mut self, executor: E) -> Result<(), rullst_orm::Error>
            where E: rullst_orm::_sqlx::Executor<'e, Database = rullst_orm::RullstDatabase>
            {
                let is_new = self.id == 0;
                if is_new {
                    #tenant_set_logic
                }
                #audit_before_update
                #hook_before_save
                // Acquire the observer list once per operation. Cloning here avoids
                // holding the RwLock across async await points (not allowed in Tokio)
                // while eliminating 5 redundant lock acquisitions per save.
                let observers = {
                    let list = Self::observers().read().expect("Failed to acquire read lock on observers - possible poisoning");
                    list.clone()
                };
                for obs in &observers {
                    obs.saving(self).await?;
                }
                if self.id == 0 {
                    for obs in &observers {
                        obs.creating(self).await?;
                    }
                    let driver = rullst_orm::Orm::driver();
                    if driver == "postgres" || driver == "sqlite" {
                        use rullst_orm::_sqlx::query_builder::QueryBuilder;
                        use rullst_orm::_sqlx::Execute;
                        let mut query_builder = QueryBuilder::new("INSERT INTO ");
                        query_builder.push(#table_name);
                        query_builder.push(" (");
                        query_builder.push(#insert_columns_str);
                        query_builder.push(") VALUES (");
                        query_builder.push(#insert_placeholders_str);
                        query_builder.push(") RETURNING id");
                        if rullst_orm::schema::is_query_log_enabled() {
                            println!("[SQL Debug] {:?}", query_builder.sql());
                        }
                        let query = query_builder.build();
                        let row = query
                            #(#bind_inserts)*
                            .fetch_one(executor)
                            .await?;
                        self.id = rullst_orm::_sqlx::Row::try_get(&row, "id")?;
                    } else {
                        use rullst_orm::_sqlx::query_builder::QueryBuilder;
                        use rullst_orm::_sqlx::Execute;
                        let mut query_builder = QueryBuilder::new("INSERT INTO ");
                        query_builder.push(#table_name);
                        query_builder.push(" (");
                        query_builder.push(#insert_columns_str);
                        query_builder.push(") VALUES (");
                        query_builder.push(#insert_placeholders_str);
                        query_builder.push(")");
                        if rullst_orm::schema::is_query_log_enabled() {
                            println!("[SQL Debug] {:?}", query_builder.sql());
                        }
                        let query = query_builder.build();
                        let result = query
                            #(#bind_inserts)*
                            .execute(executor)
                            .await?;
                        self.id = {
                            use rullst_orm::database::QueryResultExt;
                            result.get_last_insert_id() as i32
                        }
                    }
                    for obs in &observers {
                        obs.created(self).await?;
                    }
                } else {
                    for obs in &observers {
                        obs.updating(self).await?;
                    }
                    use rullst_orm::_sqlx::query_builder::QueryBuilder;
                    use rullst_orm::_sqlx::Execute;
                    let mut query_builder = QueryBuilder::new("UPDATE ");
                    query_builder.push(#table_name);
                    query_builder.push(" SET ");
                    query_builder.push(#update_sets_str);
                    query_builder.push(" WHERE id = ?");
                    if rullst_orm::schema::is_query_log_enabled() {
                        println!("[SQL Debug] {:?} | ID: {}", query_builder.sql(), self.id);
                    }
                    let query = query_builder.build();
                    query
                        #(#bind_updates)*
                        .bind(self.id)
                        .execute(executor)
                        .await?;
                    for obs in &observers {
                        obs.updated(self).await?;
                    }
                }
                for obs in &observers {
                    obs.saved(self).await?;
                }
                #[cfg(feature = "redis")]
                {
                    use rullst_orm::_redis::AsyncCommands;
                    let mut conn = rullst_orm::Orm::redis_manager();
                    let payload = self.to_json();
                    if is_new {
                        let topic = format!("orm:events:{}:created", #table_name);
                        let publish_result: Result<usize, rullst_orm::_redis::RedisError> = conn.publish(&topic, &payload).await;
                        if let Err(e) = publish_result {
                            eprintln!("[Redis Error] Failed to publish created event: {}", e);
                        }
                    } else {
                        let topic = format!("orm:events:{}:updated", #table_name);
                        let publish_result: Result<usize, rullst_orm::_redis::RedisError> = conn.publish(&topic, &payload).await;
                        if let Err(e) = publish_result {
                            eprintln!("[Redis Error] Failed to publish updated event: {}", e);
                        }
                    }
                    let topic = format!("orm:events:{}:saved", #table_name);
                    let publish_result: Result<usize, rullst_orm::_redis::RedisError> = conn.publish(&topic, &payload).await;
                    if let Err(e) = publish_result {
                        eprintln!("[Redis Error] Failed to publish saved event: {}", e);
                    }
                }
                #audit_after_save
                #scout_update
                #hook_after_save
                Ok(())
            }

            pub async fn delete(&self) -> Result<(), rullst_orm::Error> {
                let pool = rullst_orm::Orm::pool();
                self.delete_with_tx_internal(pool).await
            }

            pub async fn delete_with_tx(&self, tx: &mut rullst_orm::db::Transaction<'static>) -> Result<(), rullst_orm::Error> {
                self.delete_with_tx_internal(&mut **tx).await
            }

            async fn delete_with_tx_internal<'e, E>(&self, executor: E) -> Result<(), rullst_orm::Error>
            where E: rullst_orm::_sqlx::Executor<'e, Database = rullst_orm::RullstDatabase>
            {
                #hook_before_delete
                // Acquire observer list once per delete operation.
                let observers = {
                    let list = Self::observers().read().expect("Failed to acquire read lock on observers - possible poisoning");
                    list.clone()
                };
                for obs in &observers {
                    obs.deleting(self).await?;
                }
                #delete_logic
                if rullst_orm::schema::is_query_log_enabled() {
                    println!("[SQL Debug] {:?} | ID: {}", query, self.id);
                }
                rullst_orm::_sqlx::query(rullst_orm::_sqlx::AssertSqlSafe(query.as_str())).bind(self.id).execute(executor).await?;
                for obs in &observers {
                    obs.deleted(self).await?;
                }
                #[cfg(feature = "redis")]
                {
                    use rullst_orm::_redis::AsyncCommands;
                    let mut conn = rullst_orm::Orm::redis_manager();
                    let payload = self.to_json();
                    let topic = format!("orm:events:{}:deleted", #table_name);
                    let publish_result: Result<usize, rullst_orm::_redis::RedisError> = conn.publish(&topic, &payload).await;
                    if let Err(e) = publish_result {
                        eprintln!("[Redis Error] Failed to publish deleted event: {}", e);
                    }
                }
                #audit_after_delete
                #scout_delete
                #hook_after_delete
                Ok(())
            }

            pub async fn restore(&self) -> Result<(), rullst_orm::Error> {
                if #has_soft_deletes {
                    let pool = rullst_orm::Orm::pool();
                    use rullst_orm::_sqlx::query_builder::QueryBuilder;
                    let mut query_builder = QueryBuilder::new("UPDATE ");
                    query_builder.push(#table_name);
                    query_builder.push(" SET deleted_at = NULL WHERE id = ?");
                    let query = query_builder.build();
                    query.bind(self.id).execute(pool).await?;
                }
                Ok(())
            }

            pub async fn force_delete(&self) -> Result<(), rullst_orm::Error> {
                let pool = rullst_orm::Orm::pool();
                use rullst_orm::_sqlx::query_builder::QueryBuilder;
                let mut query_builder = QueryBuilder::new("DELETE FROM ");
                query_builder.push(#table_name);
                query_builder.push(" WHERE id = ?");
                let query = query_builder.build();
                query.bind(self.id).execute(pool).await?;
                Ok(())
            }

            pub fn to_json(&self) -> String {
                let mut map = rullst_orm::_serde_json::Map::new();
                #(#to_json_fields)*
                rullst_orm::_serde_json::Value::Object(map).to_string()
            }
        }
    }
}