ormer 0.2.8

A minimalist ORM framework that supports SQLite, PostgreSQL, MySQL, and SqlServer
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
#[cfg(feature = "sqlite")]
use ormer::{
    AfterDelete, AfterInsert, AfterUpdate, BeforeDelete, BeforeInsert, BeforeUpdate, Database,
    DbType, HookContext, HookOperation, Model,
};
#[cfg(not(feature = "sqlite"))]
use ormer::{
    AfterDelete, AfterInsert, AfterUpdate, BeforeDelete, BeforeInsert, BeforeUpdate, HookContext,
    HookOperation, Model,
};
use std::sync::atomic::{AtomicUsize, Ordering};
use tokio::sync::Mutex;

// 全局计数器用于验证钩子是否被调用
static BEFORE_INSERT_COUNT: AtomicUsize = AtomicUsize::new(0);
static AFTER_INSERT_COUNT: AtomicUsize = AtomicUsize::new(0);
static BEFORE_UPDATE_COUNT: AtomicUsize = AtomicUsize::new(0);
static AFTER_UPDATE_COUNT: AtomicUsize = AtomicUsize::new(0);
static BEFORE_DELETE_COUNT: AtomicUsize = AtomicUsize::new(0);
static AFTER_DELETE_COUNT: AtomicUsize = AtomicUsize::new(0);
static TRANSACTION_INSERT_COUNT: AtomicUsize = AtomicUsize::new(0);
static UPDATE_BATCH_INDEX_SUM: AtomicUsize = AtomicUsize::new(0);
static DELETE_BATCH_INDEX_SUM: AtomicUsize = AtomicUsize::new(0);

// 互斥锁确保使用全局计数器的测试串行执行,避免并行时 reset_counters 互相干扰
static HOOKS_TEST_MUTEX: Mutex<()> = Mutex::const_new(());

#[derive(Debug, Model)]
#[table = "hook_test_users"]
struct HookTestUser {
    #[primary(auto)]
    id: i32,
    name: String,
    email: String,
}

#[async_trait::async_trait]
impl BeforeInsert for HookTestUser {
    async fn before_insert(&mut self, ctx: &mut HookContext<'_>) -> ormer::Result<()> {
        BEFORE_INSERT_COUNT.fetch_add(1, Ordering::SeqCst);
        if ctx.in_transaction() {
            TRANSACTION_INSERT_COUNT.fetch_add(1, Ordering::SeqCst);
        }
        if self.email == "reject@example.com" {
            return Err(ormer::ormer_error!("email rejected by hook"));
        }
        Ok(())
    }
}

#[async_trait::async_trait]
impl AfterInsert for HookTestUser {
    async fn after_insert(&self, _ctx: &mut HookContext<'_>) -> ormer::Result<()> {
        AFTER_INSERT_COUNT.fetch_add(1, Ordering::SeqCst);
        Ok(())
    }
}

#[async_trait::async_trait]
impl BeforeUpdate for HookTestUser {
    async fn before_update(&mut self, ctx: &mut HookContext<'_>) -> ormer::Result<()> {
        BEFORE_UPDATE_COUNT.fetch_add(1, Ordering::SeqCst);
        if let Some(index) = ctx.batch_index() {
            UPDATE_BATCH_INDEX_SUM.fetch_add(index, Ordering::SeqCst);
        }
        Ok(())
    }
}

#[async_trait::async_trait]
impl AfterUpdate for HookTestUser {
    async fn after_update(&self, _ctx: &mut HookContext<'_>) -> ormer::Result<()> {
        AFTER_UPDATE_COUNT.fetch_add(1, Ordering::SeqCst);
        Ok(())
    }
}

#[async_trait::async_trait]
impl BeforeDelete for HookTestUser {
    async fn before_delete(&self, ctx: &mut HookContext<'_>) -> ormer::Result<()> {
        BEFORE_DELETE_COUNT.fetch_add(1, Ordering::SeqCst);
        if let Some(index) = ctx.batch_index() {
            DELETE_BATCH_INDEX_SUM.fetch_add(index, Ordering::SeqCst);
        }
        Ok(())
    }
}

#[async_trait::async_trait]
impl AfterDelete for HookTestUser {
    async fn after_delete(&self, _ctx: &mut HookContext<'_>) -> ormer::Result<()> {
        AFTER_DELETE_COUNT.fetch_add(1, Ordering::SeqCst);
        Ok(())
    }
}

fn reset_counters() {
    BEFORE_INSERT_COUNT.store(0, Ordering::SeqCst);
    AFTER_INSERT_COUNT.store(0, Ordering::SeqCst);
    BEFORE_UPDATE_COUNT.store(0, Ordering::SeqCst);
    AFTER_UPDATE_COUNT.store(0, Ordering::SeqCst);
    BEFORE_DELETE_COUNT.store(0, Ordering::SeqCst);
    AFTER_DELETE_COUNT.store(0, Ordering::SeqCst);
    TRANSACTION_INSERT_COUNT.store(0, Ordering::SeqCst);
    UPDATE_BATCH_INDEX_SUM.store(0, Ordering::SeqCst);
    DELETE_BATCH_INDEX_SUM.store(0, Ordering::SeqCst);
}

#[tokio::test]
async fn test_hooks_trait_definition() -> ormer::Result<()> {
    let _guard = HOOKS_TEST_MUTEX.lock().await;
    reset_counters();

    let mut user = HookTestUser {
        id: 0,
        name: "Test User".to_string(),
        email: "test@example.com".to_string(),
    };

    let mut ctx = HookContext::new(HookOperation::Insert);
    user.before_insert(&mut ctx).await?;
    assert_eq!(BEFORE_INSERT_COUNT.load(Ordering::SeqCst), 1);

    user.after_insert(&mut ctx).await?;
    assert_eq!(AFTER_INSERT_COUNT.load(Ordering::SeqCst), 1);

    let mut ctx = HookContext::new(HookOperation::Update);
    user.before_update(&mut ctx).await?;
    assert_eq!(BEFORE_UPDATE_COUNT.load(Ordering::SeqCst), 1);

    user.after_update(&mut ctx).await?;
    assert_eq!(AFTER_UPDATE_COUNT.load(Ordering::SeqCst), 1);

    let mut ctx = HookContext::new(HookOperation::Delete);
    user.before_delete(&mut ctx).await?;
    assert_eq!(BEFORE_DELETE_COUNT.load(Ordering::SeqCst), 1);

    user.after_delete(&mut ctx).await?;
    assert_eq!(AFTER_DELETE_COUNT.load(Ordering::SeqCst), 1);
    Ok(())
}

#[cfg(feature = "sqlite")]
#[tokio::test]
async fn test_hooks_with_database_insert() {
    // 测试使用数据库时的钩子调用
    let _guard = HOOKS_TEST_MUTEX.lock().await;
    reset_counters();

    #[cfg(feature = "sqlite")]
    {
        let db = Database::connect(DbType::Sqlite, ":memory:").await.unwrap();

        // 创建表
        db.create_table::<HookTestUser>().execute().await.unwrap();

        // 插入数据
        let mut user = HookTestUser {
            id: 0,
            name: "Alice".to_string(),
            email: "alice@example.com".to_string(),
        };

        db.insert(&mut user).execute().await.unwrap();
        assert_eq!(BEFORE_INSERT_COUNT.load(Ordering::SeqCst), 1);
        assert_eq!(AFTER_INSERT_COUNT.load(Ordering::SeqCst), 1);
    }
}

#[cfg(feature = "sqlite")]
#[tokio::test]
async fn test_without_hooks_skips_write_hooks() {
    let _guard = HOOKS_TEST_MUTEX.lock().await;
    reset_counters();

    let db = Database::connect(DbType::Sqlite, ":memory:").await.unwrap();
    db.create_table::<HookTestUser>().execute().await.unwrap();

    let mut user = HookTestUser {
        id: 0,
        name: "No Hooks".to_string(),
        email: "no-hooks@example.com".to_string(),
    };

    user.id = db
        .insert(&mut user)
        .without_hooks()
        .execute()
        .await
        .unwrap();

    assert_eq!(BEFORE_INSERT_COUNT.load(Ordering::SeqCst), 0);
    assert_eq!(AFTER_INSERT_COUNT.load(Ordering::SeqCst), 0);
    assert_eq!(
        db.select::<HookTestUser>()
            .collect::<Vec<_>>()
            .await
            .unwrap()
            .len(),
        1
    );

    user.name = "No Hooks Updated".to_string();
    db.update::<HookTestUser>()
        .set_model(&user)
        .without_hooks()
        .execute()
        .await
        .unwrap();

    db.delete::<HookTestUser>()
        .filter(|fields| fields.id.eq(user.id))
        .without_hooks()
        .execute()
        .await
        .unwrap();

    assert_eq!(BEFORE_UPDATE_COUNT.load(Ordering::SeqCst), 0);
    assert_eq!(AFTER_UPDATE_COUNT.load(Ordering::SeqCst), 0);
    assert_eq!(BEFORE_DELETE_COUNT.load(Ordering::SeqCst), 0);
    assert_eq!(AFTER_DELETE_COUNT.load(Ordering::SeqCst), 0);
}

#[cfg(feature = "sqlite")]
#[tokio::test]
async fn test_hooks_with_database_batch_insert() {
    // 测试批量插入时的钩子
    let _guard = HOOKS_TEST_MUTEX.lock().await;
    reset_counters();

    #[cfg(feature = "sqlite")]
    {
        let db = Database::connect(DbType::Sqlite, ":memory:").await.unwrap();
        db.create_table::<HookTestUser>().execute().await.unwrap();

        let mut users = vec![
            HookTestUser {
                id: 0,
                name: "Bob".to_string(),
                email: "bob@example.com".to_string(),
            },
            HookTestUser {
                id: 0,
                name: "Charlie".to_string(),
                email: "charlie@example.com".to_string(),
            },
        ];

        db.insert(&mut users).execute().await.unwrap();
        assert_eq!(BEFORE_INSERT_COUNT.load(Ordering::SeqCst), 2);
        assert_eq!(AFTER_INSERT_COUNT.load(Ordering::SeqCst), 2);
    }
}

#[cfg(feature = "sqlite")]
#[tokio::test]
async fn test_hooks_with_update_and_delete_executors() {
    let _guard = HOOKS_TEST_MUTEX.lock().await;
    reset_counters();

    let db = Database::connect(DbType::Sqlite, ":memory:").await.unwrap();
    db.create_table::<HookTestUser>().execute().await.unwrap();

    let mut user = HookTestUser {
        id: 0,
        name: "Dana".to_string(),
        email: "dana@example.com".to_string(),
    };
    user.id = db.insert(&mut user).execute().await.unwrap();

    user.name = "Dana Updated".to_string();
    let updated = db
        .update::<HookTestUser>()
        .set_model(&user)
        .execute_with_hooks(&mut user)
        .await
        .unwrap();
    assert_eq!(updated, 1);
    assert_eq!(BEFORE_UPDATE_COUNT.load(Ordering::SeqCst), 1);
    assert_eq!(AFTER_UPDATE_COUNT.load(Ordering::SeqCst), 1);

    let deleted = db
        .delete::<HookTestUser>()
        .filter(|fields| fields.id.eq(user.id))
        .execute_with_hooks(&user)
        .await
        .unwrap();
    assert_eq!(deleted, 1);
    assert_eq!(BEFORE_DELETE_COUNT.load(Ordering::SeqCst), 1);
    assert_eq!(AFTER_DELETE_COUNT.load(Ordering::SeqCst), 1);
}

#[cfg(feature = "sqlite")]
#[tokio::test]
async fn test_without_hooks_skips_current_write_chain() {
    let _guard = HOOKS_TEST_MUTEX.lock().await;
    reset_counters();

    let db = Database::connect(DbType::Sqlite, ":memory:").await.unwrap();
    db.create_table::<HookTestUser>().execute().await.unwrap();

    let mut user = HookTestUser {
        id: 0,
        name: "Without Hooks".to_string(),
        email: "without-hooks@example.com".to_string(),
    };

    db.insert(&mut user).execute().await.unwrap();
    assert_eq!(BEFORE_INSERT_COUNT.load(Ordering::SeqCst), 1);
    assert_eq!(AFTER_INSERT_COUNT.load(Ordering::SeqCst), 1);

    db.update::<HookTestUser>()
        .set_model(&user)
        .without_hooks()
        .execute()
        .await
        .unwrap();
    db.delete::<HookTestUser>()
        .model(&user)
        .without_hooks()
        .execute()
        .await
        .unwrap();

    assert_eq!(BEFORE_UPDATE_COUNT.load(Ordering::SeqCst), 0);
    assert_eq!(AFTER_UPDATE_COUNT.load(Ordering::SeqCst), 0);
    assert_eq!(BEFORE_DELETE_COUNT.load(Ordering::SeqCst), 0);
    assert_eq!(AFTER_DELETE_COUNT.load(Ordering::SeqCst), 0);
}

#[cfg(feature = "sqlite")]
#[tokio::test]
async fn test_hooks_with_batch_update_and_delete_executors() {
    let _guard = HOOKS_TEST_MUTEX.lock().await;
    reset_counters();

    let db = Database::connect(DbType::Sqlite, ":memory:").await.unwrap();
    db.create_table::<HookTestUser>().execute().await.unwrap();

    let mut users = vec![
        HookTestUser {
            id: 0,
            name: "Batch A".to_string(),
            email: "batch-a@example.com".to_string(),
        },
        HookTestUser {
            id: 0,
            name: "Batch B".to_string(),
            email: "batch-b@example.com".to_string(),
        },
    ];
    db.insert(&mut users).execute().await.unwrap();

    let updated = db
        .update::<HookTestUser>()
        .filter(|fields| fields.id.gt(0))
        .set(|fields| fields.name = fields.name.set("Batch Updated".to_string()))
        .execute_models_with_hooks(&mut users)
        .await
        .unwrap();
    assert_eq!(updated, 2);
    assert_eq!(BEFORE_UPDATE_COUNT.load(Ordering::SeqCst), 2);
    assert_eq!(AFTER_UPDATE_COUNT.load(Ordering::SeqCst), 2);
    assert_eq!(UPDATE_BATCH_INDEX_SUM.load(Ordering::SeqCst), 1);

    let deleted = db
        .delete::<HookTestUser>()
        .filter(|fields| fields.id.gt(0))
        .execute_models_with_hooks(&users)
        .await
        .unwrap();
    assert_eq!(deleted, 2);
    assert_eq!(BEFORE_DELETE_COUNT.load(Ordering::SeqCst), 2);
    assert_eq!(AFTER_DELETE_COUNT.load(Ordering::SeqCst), 2);
    assert_eq!(DELETE_BATCH_INDEX_SUM.load(Ordering::SeqCst), 1);
}

#[cfg(feature = "sqlite")]
#[tokio::test]
async fn test_hooks_with_transaction_insert() {
    let _guard = HOOKS_TEST_MUTEX.lock().await;
    reset_counters();

    let db = Database::connect(DbType::Sqlite, ":memory:").await.unwrap();
    db.create_table::<HookTestUser>().execute().await.unwrap();

    let mut user = HookTestUser {
        id: 0,
        name: "Eve".to_string(),
        email: "eve@example.com".to_string(),
    };
    let mut txn = db.begin().await.unwrap();
    txn.insert(&mut user).execute().await.unwrap();
    txn.commit().await.unwrap();

    assert_eq!(BEFORE_INSERT_COUNT.load(Ordering::SeqCst), 1);
    assert_eq!(AFTER_INSERT_COUNT.load(Ordering::SeqCst), 1);
    assert_eq!(TRANSACTION_INSERT_COUNT.load(Ordering::SeqCst), 1);
}

#[cfg(feature = "sqlite")]
#[tokio::test]
async fn test_before_insert_error_prevents_sql_execution() {
    let _guard = HOOKS_TEST_MUTEX.lock().await;
    reset_counters();

    let db = Database::connect(DbType::Sqlite, ":memory:").await.unwrap();
    db.create_table::<HookTestUser>().execute().await.unwrap();

    let mut user = HookTestUser {
        id: 0,
        name: "Rejected".to_string(),
        email: "reject@example.com".to_string(),
    };
    let error = db.insert(&mut user).execute().await.unwrap_err();
    assert!(error.to_string().contains("email rejected by hook"));
    assert_eq!(BEFORE_INSERT_COUNT.load(Ordering::SeqCst), 1);
    assert_eq!(AFTER_INSERT_COUNT.load(Ordering::SeqCst), 0);

    let users: Vec<HookTestUser> = db.select::<HookTestUser>().collect().await.unwrap();
    assert!(users.is_empty());
}