oximod 0.2.5

MongoDB ODM for Rust inspired by Mongoose
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
mod common;

use common::init;
use mongodb::bson::{doc, oid::ObjectId};
use oximod::{Hooks, Model};
use serde::{Deserialize, Serialize};
use std::sync::atomic::{AtomicUsize, Ordering};
use testresult::TestResult;

static PRE_SAVE_CALLS: AtomicUsize = AtomicUsize::new(0);
static POST_SAVE_CALLS: AtomicUsize = AtomicUsize::new(0);
static PRE_SAVE_MUT_CALLS: AtomicUsize = AtomicUsize::new(0);
static POST_SAVE_MUT_CALLS: AtomicUsize = AtomicUsize::new(0);
static PRE_FIND_CALLS: AtomicUsize = AtomicUsize::new(0);
static POST_FIND_CALLS: AtomicUsize = AtomicUsize::new(0);
static PRE_UPDATE_CALLS: AtomicUsize = AtomicUsize::new(0);
static POST_UPDATE_CALLS: AtomicUsize = AtomicUsize::new(0);
static PRE_DELETE_CALLS: AtomicUsize = AtomicUsize::new(0);
static POST_DELETE_CALLS: AtomicUsize = AtomicUsize::new(0);

fn reset_counters() {
    PRE_SAVE_CALLS.store(0, Ordering::SeqCst);
    POST_SAVE_CALLS.store(0, Ordering::SeqCst);
    PRE_SAVE_MUT_CALLS.store(0, Ordering::SeqCst);
    POST_SAVE_MUT_CALLS.store(0, Ordering::SeqCst);
    PRE_FIND_CALLS.store(0, Ordering::SeqCst);
    POST_FIND_CALLS.store(0, Ordering::SeqCst);
    PRE_UPDATE_CALLS.store(0, Ordering::SeqCst);
    POST_UPDATE_CALLS.store(0, Ordering::SeqCst);
    PRE_DELETE_CALLS.store(0, Ordering::SeqCst);
    POST_DELETE_CALLS.store(0, Ordering::SeqCst);
}

// Run test: cargo nextest run test_save_runs_pre_and_post_save_hooks
#[tokio::test]
async fn test_save_runs_pre_and_post_save_hooks() -> TestResult {
    init().await?;
    reset_counters();

    #[derive(Model, Serialize, Deserialize, Debug)]
    #[db("test")]
    #[collection("hooks_test_save_runs_pre_and_post_save_hooks")]
    #[hooks]
    struct Log {
        #[serde(skip_serializing_if = "Option::is_none")]
        _id: Option<ObjectId>,
        message: String,
        normalized: bool,
    }

    #[async_trait::async_trait]
    impl Hooks for Log {
        async fn pre_save(&self) -> Result<(), oximod::OxiModError> {
            PRE_SAVE_CALLS.fetch_add(1, Ordering::SeqCst);
            Ok(())
        }

        async fn post_save(&self) -> Result<(), oximod::OxiModError> {
            POST_SAVE_CALLS.fetch_add(1, Ordering::SeqCst);
            Ok(())
        }
    }

    Log::clear().await?;

    let log = Log::default().message("system started").normalized(false);

    let id = log.save().await?;
    assert_ne!(id, ObjectId::default());
    assert_eq!(PRE_SAVE_CALLS.load(Ordering::SeqCst), 1);
    assert_eq!(POST_SAVE_CALLS.load(Ordering::SeqCst), 1);

    Ok(())
}

// Run test: cargo nextest run test_save_mut_runs_mut_hooks_and_mutates_state
#[tokio::test]
async fn test_save_mut_runs_mut_hooks_and_mutates_state() -> TestResult {
    init().await?;
    reset_counters();

    #[derive(Model, Serialize, Deserialize, Debug)]
    #[db("test")]
    #[collection("hooks_test_save_mut_runs_mut_hooks_and_mutates_state")]
    #[hooks]
    struct Log {
        #[serde(skip_serializing_if = "Option::is_none")]
        _id: Option<ObjectId>,
        message: String,
        normalized: bool,
    }

    #[async_trait::async_trait]
    impl Hooks for Log {
        async fn pre_save_mut(&mut self) -> Result<(), oximod::OxiModError> {
            PRE_SAVE_MUT_CALLS.fetch_add(1, Ordering::SeqCst);
            self.message = self.message.trim().to_string();
            self.normalized = true;
            Ok(())
        }

        async fn post_save_mut(&mut self) -> Result<(), oximod::OxiModError> {
            POST_SAVE_MUT_CALLS.fetch_add(1, Ordering::SeqCst);
            Ok(())
        }
    }

    Log::clear().await?;

    let mut log = Log::default()
        .message("   background worker started   ")
        .normalized(false);

    let id = log.save_mut().await?;
    assert_ne!(id, ObjectId::default());

    assert_eq!(PRE_SAVE_MUT_CALLS.load(Ordering::SeqCst), 1);
    assert_eq!(POST_SAVE_MUT_CALLS.load(Ordering::SeqCst), 1);
    assert_eq!(log.message, "background worker started");
    assert!(log.normalized);

    let found = Log::find_by_id(id).await?.expect("log should exist");
    assert_eq!(found.message, "background worker started");
    assert!(found.normalized);

    Ok(())
}

// Run test: cargo nextest run test_find_by_id_runs_pre_and_post_find_hooks
#[tokio::test]
async fn test_find_by_id_runs_pre_and_post_find_hooks() -> TestResult {
    init().await?;
    reset_counters();

    #[derive(Model, Serialize, Deserialize, Debug)]
    #[db("test")]
    #[collection("hooks_test_find_by_id_runs_pre_and_post_find_hooks")]
    #[hooks]
    struct Log {
        #[serde(skip_serializing_if = "Option::is_none")]
        _id: Option<ObjectId>,
        message: String,
    }

    #[async_trait::async_trait]
    impl Hooks for Log {
        async fn pre_find(id: ObjectId) -> Result<(), oximod::OxiModError> {
            assert_ne!(id, ObjectId::default());
            PRE_FIND_CALLS.fetch_add(1, Ordering::SeqCst);
            Ok(())
        }

        async fn post_find(result: &Option<Self>) -> Result<(), oximod::OxiModError> {
            assert!(result.is_some());
            POST_FIND_CALLS.fetch_add(1, Ordering::SeqCst);
            Ok(())
        }
    }

    Log::clear().await?;

    let id = Log::default().message("hello").save().await?;
    let found = Log::find_by_id(id).await?;

    assert!(found.is_some());
    assert_eq!(PRE_FIND_CALLS.load(Ordering::SeqCst), 1);
    assert_eq!(POST_FIND_CALLS.load(Ordering::SeqCst), 1);

    Ok(())
}

// Run test: cargo nextest run test_update_by_id_runs_pre_and_post_update_hooks
#[tokio::test]
async fn test_update_by_id_runs_pre_and_post_update_hooks() -> TestResult {
    init().await?;
    reset_counters();

    #[derive(Model, Serialize, Deserialize, Debug)]
    #[db("test")]
    #[collection("hooks_test_update_by_id_runs_pre_and_post_update_hooks")]
    #[hooks]
    struct Log {
        #[serde(skip_serializing_if = "Option::is_none")]
        _id: Option<ObjectId>,
        message: String,
    }

    #[async_trait::async_trait]
    impl Hooks for Log {
        async fn pre_update(
            id: ObjectId,
            update: &mongodb::bson::Document,
        ) -> Result<(), oximod::OxiModError> {
            assert_ne!(id, ObjectId::default());
            assert!(update.contains_key("$set"));
            PRE_UPDATE_CALLS.fetch_add(1, Ordering::SeqCst);
            Ok(())
        }

        async fn post_update(
            id: ObjectId,
            update: &mongodb::bson::Document,
        ) -> Result<(), oximod::OxiModError> {
            assert_ne!(id, ObjectId::default());
            assert!(update.contains_key("$set"));
            POST_UPDATE_CALLS.fetch_add(1, Ordering::SeqCst);
            Ok(())
        }
    }

    Log::clear().await?;

    let id = Log::default().message("before").save().await?;

    let result = Log::update_by_id(
        id,
        doc! {
            "$set": {
                "message": "after"
            }
        },
    )
    .await?;

    assert_eq!(result.matched_count, 1);
    assert_eq!(PRE_UPDATE_CALLS.load(Ordering::SeqCst), 1);
    assert_eq!(POST_UPDATE_CALLS.load(Ordering::SeqCst), 1);

    let found = Log::find_by_id(id).await?.expect("log should exist");
    assert_eq!(found.message, "after");

    Ok(())
}

// Run test: cargo nextest run test_delete_by_id_runs_pre_and_post_delete_hooks
#[tokio::test]
async fn test_delete_by_id_runs_pre_and_post_delete_hooks() -> TestResult {
    init().await?;
    reset_counters();

    #[derive(Model, Serialize, Deserialize, Debug)]
    #[db("test")]
    #[collection("hooks_test_delete_by_id_runs_pre_and_post_delete_hooks")]
    #[hooks]
    struct Log {
        #[serde(skip_serializing_if = "Option::is_none")]
        _id: Option<ObjectId>,
        message: String,
    }

    #[async_trait::async_trait]
    impl Hooks for Log {
        async fn pre_delete(id: ObjectId) -> Result<(), oximod::OxiModError> {
            assert_ne!(id, ObjectId::default());
            PRE_DELETE_CALLS.fetch_add(1, Ordering::SeqCst);
            Ok(())
        }

        async fn post_delete(id: ObjectId) -> Result<(), oximod::OxiModError> {
            assert_ne!(id, ObjectId::default());
            POST_DELETE_CALLS.fetch_add(1, Ordering::SeqCst);
            Ok(())
        }
    }

    Log::clear().await?;

    let id = Log::default().message("to be deleted").save().await?;

    let result = Log::delete_by_id(id).await?;
    assert_eq!(result.deleted_count, 1);
    assert_eq!(PRE_DELETE_CALLS.load(Ordering::SeqCst), 1);
    assert_eq!(POST_DELETE_CALLS.load(Ordering::SeqCst), 1);

    let found = Log::find_by_id(id).await?;
    assert!(found.is_none());

    Ok(())
}

// Run test: cargo nextest run test_pre_save_hook_error_aborts_save
#[tokio::test]
async fn test_pre_save_hook_error_aborts_save() -> TestResult {
    init().await?;

    #[derive(Model, Serialize, Deserialize, Debug)]
    #[db("test")]
    #[collection("hooks_test_pre_save_hook_error_aborts_save")]
    #[hooks]
    struct Log {
        #[serde(skip_serializing_if = "Option::is_none")]
        _id: Option<ObjectId>,
        message: String,
    }

    #[async_trait::async_trait]
    impl Hooks for Log {
        async fn pre_save(&self) -> Result<(), oximod::OxiModError> {
            Err(oximod::OxiModError::custom(
                "pre_save rejected the operation",
            ))
        }
    }

    Log::clear().await?;

    let log = Log::default().message("should fail");
    let err = log.save().await;

    assert!(err.is_err());
    assert!(format!("{:?}", err).contains("pre_save rejected the operation"));

    let count = Log::count(doc! {}).await?;
    assert_eq!(count, 0);

    Ok(())
}

// Run test: cargo nextest run test_pre_save_custom_error_aborts_save
#[tokio::test]
async fn test_pre_save_custom_error_aborts_save() -> TestResult {
    init().await?;

    #[derive(Model, Serialize, Deserialize, Debug)]
    #[db("test")]
    #[collection("hooks_test_pre_save_custom_error_aborts_save")]
    #[hooks]
    struct Log {
        #[serde(skip_serializing_if = "Option::is_none")]
        _id: Option<ObjectId>,
        message: String,
    }

    #[async_trait::async_trait]
    impl Hooks for Log {
        async fn pre_save(&self) -> Result<(), oximod::OxiModError> {
            Err(oximod::OxiModError::custom(
                "pre_save rejected the operation with a custom error",
            ))
        }
    }

    Log::clear().await?;

    let log = Log::default().message("should fail");
    let err = log.save().await;

    assert!(err.is_err());
    assert!(format!("{:?}", err).contains("pre_save rejected the operation with a custom error"));

    let count = Log::count(doc! {}).await?;
    assert_eq!(count, 0);

    Ok(())
}

// Run test: cargo nextest run test_pre_update_custom_error_aborts_update
#[tokio::test]
async fn test_pre_update_custom_error_aborts_update() -> TestResult {
    init().await?;

    #[derive(Model, Serialize, Deserialize, Debug)]
    #[db("test")]
    #[collection("hooks_test_pre_update_custom_error_aborts_update")]
    #[hooks]
    struct Log {
        #[serde(skip_serializing_if = "Option::is_none")]
        _id: Option<ObjectId>,
        message: String,
    }

    #[async_trait::async_trait]
    impl Hooks for Log {
        async fn pre_update(
            id: ObjectId,
            update: &mongodb::bson::Document,
        ) -> Result<(), oximod::OxiModError> {
            assert_ne!(id, ObjectId::default());
            assert!(update.contains_key("$set"));

            Err(oximod::OxiModError::custom(
                "pre_update rejected the operation with a custom error",
            ))
        }
    }

    Log::clear().await?;

    let id = Log::default().message("before").save().await?;

    let result = Log::update_by_id(
        id,
        doc! {
            "$set": {
                "message": "after"
            }
        },
    )
    .await;

    assert!(result.is_err());
    assert!(
        format!("{:?}", result).contains("pre_update rejected the operation with a custom error")
    );

    let found = Log::find_by_id(id).await?.expect("log should exist");
    assert_eq!(found.message, "before");

    Ok(())
}