cruding_pg_source 0.4.1

core for the cruding crate
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
// tests/filter_postgres.rs
#![allow(clippy::disallowed_types, clippy::float_cmp)]

use std::sync::Arc;

use cruding_core::{
    Crudable,
    list::{
        CrudableSourceListExt, CrudingListFilter, CrudingListFilterOperators as Op,
        CrudingListPagination, CrudingListParams, CrudingListSortOrder,
    },
};
use cruding_pg_source::{
    // <-- change to your crate name
    CrudablePostgresSource,
    PostgresCrudableConnection,
    PostgresCrudableConnectionInner,
    PostgresCrudableTable,
};

use sea_orm::{
    Database, DatabaseBackend, DatabaseConnection, IntoActiveModel, Iterable, QueryOrder, Schema,
    Statement, TransactionTrait,
    entity::prelude::*,
    sea_query::{IntoCondition, PostgresQueryBuilder},
};
use serde_json::json;
use serial_test::serial;
use uuid::Uuid;

// ---------- config ----------

fn db_url() -> String {
    std::env::var("DATABASE_URL")
        .unwrap_or_else(|_| "postgres://postgres:postgres@localhost:5432/postgres".to_string())
}

// ---------- test entity (Postgres) ----------

#[derive(Clone, Debug, PartialEq, DeriveEntityModel)]
#[sea_orm(table_name = "items_filter")]
pub struct Model {
    #[sea_orm(primary_key)]
    pub id: i32,
    pub mono: i64,

    // Fields we will filter on:
    pub i: i32,                    // integer
    pub s: String,                 // text
    pub uid: Uuid,                 // uuid
    pub dt: chrono::NaiveDateTime, // datetime
    pub js: serde_json::Value,     // json
    pub ia: Option<Vec<i32>>, // int array (not used by ops directly; present to ensure schema ok)
}

#[derive(Copy, Clone, Debug, EnumIter, DeriveRelation)]
pub enum Relation {}

impl ActiveModelBehavior for ActiveModel {}

impl Crudable for Model {
    type Pkey = i32;
    type MonoField = i64;

    fn pkey(&self) -> Self::Pkey {
        self.id
    }
    fn mono_field(&self) -> Self::MonoField {
        self.mono
    }
}

// SeaORM Column doesn't implement PartialEq by default—use discriminant compare
impl PartialEq for Column {
    fn eq(&self, other: &Self) -> bool {
        core::mem::discriminant(self) == core::mem::discriminant(other)
    }
}

// Hook the entity into your PostgresCrudableTable
impl PostgresCrudableTable for Entity
where
    <Self as EntityTrait>::Model: Crudable,
    <Self as EntityTrait>::Column: Iterable + PartialEq,
{
    fn get_pkey_filter(keys: &[<Self::Model as Crudable>::Pkey]) -> impl IntoCondition {
        Column::Id.is_in(keys.to_vec())
    }
    fn get_pkey_columns() -> Vec<Self::Column> {
        vec![Column::Id]
    }
}

// ---------- helpers ----------

#[derive(thiserror::Error, Debug)]
pub enum LiveErr {
    #[error(transparent)]
    Db(#[from] sea_orm::DbErr),
}

async fn connect_and_prepare() -> DatabaseConnection {
    let conn = Database::connect(&db_url())
        .await
        .expect("connect postgres");

    // Create table if not exists
    let schema = Schema::new(DatabaseBackend::Postgres);
    let stmt = schema.create_table_from_entity(Entity);
    conn.execute(Statement::from_string(
        DatabaseBackend::Postgres,
        stmt.to_string(PostgresQueryBuilder),
    ))
    .await
    .ok(); // ignore if exists

    // Truncate between tests
    conn.execute(Statement::from_string(
        DatabaseBackend::Postgres,
        "TRUNCATE TABLE items_filter RESTART IDENTITY".to_string(),
    ))
    .await
    .expect("truncate items_filter");

    conn
}

fn source(
    lock_for_update: bool,
    conn: DatabaseConnection,
) -> CrudablePostgresSource<Entity, (), LiveErr> {
    CrudablePostgresSource::new(conn, lock_for_update)
}

async fn seed(conn: &DatabaseConnection) {
    let now = chrono::NaiveDate::from_ymd_opt(2024, 12, 31)
        .unwrap()
        .and_hms_milli_opt(23, 59, 59, 0)
        .unwrap();

    let rows = vec![
        Model {
            id: 1,
            mono: 100,
            i: 10,
            s: "alpha".into(),
            uid: Uuid::new_v4(),
            dt: now,
            js: json!({"k": 1}),
            ia: Some(vec![1, 2]),
        },
        Model {
            id: 2,
            mono: 200,
            i: 20,
            s: "beta".into(),
            uid: Uuid::new_v4(),
            dt: now,
            js: json!({"k": 2}),
            ia: Some(vec![2, 3]),
        },
        Model {
            id: 3,
            mono: 300,
            i: 30,
            s: "beta".into(),
            uid: Uuid::new_v4(),
            dt: now,
            js: json!({"k": 3}),
            ia: None,
        },
        Model {
            id: 4,
            mono: 400,
            i: 40,
            s: "gamma".into(),
            uid: Uuid::new_v4(),
            dt: now,
            js: json!([1, 2, 3]),
            ia: Some(vec![]),
        },
        Model {
            id: 5,
            mono: 500,
            i: 100,
            s: "delta".into(),
            uid: Uuid::new_v4(),
            dt: now,
            js: json!("x"),
            ia: None,
        },
    ];

    let ams: Vec<_> = rows.into_iter().map(|m| m.into_active_model()).collect();
    Entity::insert_many(ams)
        .exec(conn)
        .await
        .expect("seed insert");
}

fn params(
    filters: Vec<CrudingListFilter<Column>>,
    sorts: Vec<(Column, CrudingListSortOrder)>,
    page: u32,
    size: u32,
) -> CrudingListParams<Column> {
    CrudingListParams {
        filters,
        sorts: sorts
            .into_iter()
            .map(|(column, order)| cruding_core::list::CrudingListSort { column, order })
            .collect(),
        pagination: CrudingListPagination { page, size },
    }
}

// ---------- tests ----------

#[tokio::test]
#[serial]
async fn eq_and_neq_filters() {
    let conn = connect_and_prepare().await;
    seed(&conn).await;
    let src = source(false, conn);
    let handle = src.new_source_handle();

    // Eq on integer: i == 20 -> id 2
    let p = params(
        vec![CrudingListFilter {
            column: Column::I,
            op: Op::Eq(json!(20)),
        }],
        vec![],
        0,
        50,
    );
    let ids = CrudableSourceListExt::<Model, Column>::read_list_to_ids(&src, p, handle.clone())
        .await
        .unwrap();
    assert_eq!(ids, vec![2]);

    // Neq on text: s != "beta" -> ids [1,4,5] (order unspecified without sort; we’ll sort asc)
    let p = params(
        vec![CrudingListFilter {
            column: Column::S,
            op: Op::Neq(json!("beta")),
        }],
        vec![(Column::Id, CrudingListSortOrder::Asc)],
        0,
        50,
    );
    let ids = CrudableSourceListExt::<Model, Column>::read_list_to_ids(&src, p, handle.clone())
        .await
        .unwrap();
    assert_eq!(ids, vec![1, 4, 5]);
}

#[tokio::test]
#[serial]
async fn comparison_filters_gt_ge_lt_le() {
    let conn = connect_and_prepare().await;
    seed(&conn).await;
    let src = source(false, conn);
    let handle = src.new_source_handle();

    // Gt: i > 30 -> ids [4,5]
    let p = params(
        vec![CrudingListFilter {
            column: Column::I,
            op: Op::Gt(json!(30)),
        }],
        vec![(Column::Id, CrudingListSortOrder::Asc)],
        0,
        50,
    );
    let ids = CrudableSourceListExt::<Model, Column>::read_list_to_ids(&src, p, handle.clone())
        .await
        .unwrap();
    assert_eq!(ids, vec![4, 5]);

    // Ge: i >= 30 -> [3,4,5]
    let p = params(
        vec![CrudingListFilter {
            column: Column::I,
            op: Op::Ge(json!(30)),
        }],
        vec![(Column::Id, CrudingListSortOrder::Asc)],
        0,
        50,
    );
    let ids = CrudableSourceListExt::<Model, Column>::read_list_to_ids(&src, p, handle.clone())
        .await
        .unwrap();
    assert_eq!(ids, vec![3, 4, 5]);

    // Lt: i < 20 -> [1]
    let p = params(
        vec![CrudingListFilter {
            column: Column::I,
            op: Op::Lt(json!(20)),
        }],
        vec![(Column::Id, CrudingListSortOrder::Asc)],
        0,
        50,
    );
    let ids = CrudableSourceListExt::<Model, Column>::read_list_to_ids(&src, p, handle.clone())
        .await
        .unwrap();
    assert_eq!(ids, vec![1]);

    // Le: i <= 20 -> [1,2]
    let p = params(
        vec![CrudingListFilter {
            column: Column::I,
            op: Op::Le(json!(20)),
        }],
        vec![(Column::Id, CrudingListSortOrder::Asc)],
        0,
        50,
    );
    let ids = CrudableSourceListExt::<Model, Column>::read_list_to_ids(&src, p, handle)
        .await
        .unwrap();
    assert_eq!(ids, vec![1, 2]);
}

#[tokio::test]
#[serial]
async fn in_and_notin_filters_uuid_and_text() {
    let conn = connect_and_prepare().await;
    seed(&conn).await;
    let src = source(false, conn.clone());
    let handle = src.new_source_handle();

    // Fetch all to learn the UUIDs
    let all: Vec<Model> = Entity::find()
        .order_by_asc(Column::Id)
        .all(&conn)
        .await
        .unwrap();
    let uid_pick = [all[1].uid, all[3].uid]; // ids 2 and 4

    // In: uid IN [uid2, uid4] -> [2,4]
    let p = params(
        vec![CrudingListFilter {
            column: Column::Uid,
            op: Op::In(vec![
                json!(uid_pick[0].to_string()),
                json!(uid_pick[1].to_string()),
            ]),
        }],
        vec![(Column::Id, CrudingListSortOrder::Asc)],
        0,
        50,
    );
    let ids = CrudableSourceListExt::<Model, Column>::read_list_to_ids(&src, p, handle.clone())
        .await
        .unwrap();
    assert_eq!(ids, vec![2, 4]);

    // NotIn on text: s NOT IN ("beta","gamma") -> [1,5]
    let p = params(
        vec![CrudingListFilter {
            column: Column::S,
            op: Op::NotIn(vec![json!("beta"), json!("gamma")]),
        }],
        vec![(Column::Id, CrudingListSortOrder::Asc)],
        0,
        50,
    );
    let ids = CrudableSourceListExt::<Model, Column>::read_list_to_ids(&src, p, handle)
        .await
        .unwrap();
    assert_eq!(ids, vec![1, 5]);
}

#[tokio::test]
#[serial]
async fn combined_filters_and_sorting() {
    let conn = connect_and_prepare().await;
    seed(&conn).await;
    let src = source(false, conn);
    let handle = src.new_source_handle();

    // WHERE s = 'beta' AND i >= 20 ORDER BY i DESC -> ids [3,2]
    let p = params(
        vec![
            CrudingListFilter {
                column: Column::S,
                op: Op::Eq(json!("beta")),
            },
            CrudingListFilter {
                column: Column::I,
                op: Op::Ge(json!(20)),
            },
        ],
        vec![(Column::I, CrudingListSortOrder::Desc)],
        0,
        50,
    );
    let ids = CrudableSourceListExt::<Model, Column>::read_list_to_ids(&src, p, handle)
        .await
        .unwrap();
    assert_eq!(ids, vec![3, 2]);
}

#[tokio::test]
#[serial]
async fn pagination_with_sort() {
    let conn = connect_and_prepare().await;
    seed(&conn).await;
    let src = source(false, conn);
    let handle = src.new_source_handle();

    // ORDER BY id ASC, page size 2:
    // page 0 -> [1,2], page 1 -> [3,4], page 2 -> [5]
    let common_filters = vec![]; // no filter
    let sort = vec![(Column::Id, CrudingListSortOrder::Asc)];

    let p0 = params(common_filters.clone(), sort.clone(), 0, 2);
    let p1 = params(common_filters.clone(), sort.clone(), 1, 2);
    let p2 = params(common_filters, sort, 2, 2);

    let ids0 = CrudableSourceListExt::<Model, Column>::read_list_to_ids(&src, p0, handle.clone())
        .await
        .unwrap();
    let ids1 = CrudableSourceListExt::<Model, Column>::read_list_to_ids(&src, p1, handle.clone())
        .await
        .unwrap();
    let ids2 = CrudableSourceListExt::<Model, Column>::read_list_to_ids(&src, p2, handle)
        .await
        .unwrap();

    assert_eq!(ids0, vec![1, 2]);
    assert_eq!(ids1, vec![3, 4]);
    assert_eq!(ids2, vec![5]);
}

#[tokio::test]
#[serial]
async fn read_list_to_ids_inside_borrowed_tx() {
    let conn = connect_and_prepare().await;
    seed(&conn).await;
    let src = source(false, conn.clone());

    let tx = conn.begin().await.unwrap();
    let handle = PostgresCrudableConnection::new(
        PostgresCrudableConnectionInner::BorrowedTransaction(Arc::new(tx)),
    );
    let p = params(
        vec![CrudingListFilter {
            column: Column::I,
            op: Op::Gt(json!(15)),
        }],
        vec![(Column::Id, CrudingListSortOrder::Asc)],
        0,
        50,
    );
    let ids = CrudableSourceListExt::<Model, Column>::read_list_to_ids(&src, p, handle.clone())
        .await
        .unwrap();
    assert_eq!(ids, vec![2, 3, 4, 5]);

    // ensure handle remains borrowed
    match &*handle.get_conn().read().await {
        PostgresCrudableConnectionInner::BorrowedTransaction(_) => {}
        _ => panic!("expected borrowed transaction"),
    }
}