pgorm 0.3.0

A model-definition-first, AI-friendly PostgreSQL ORM for Rust
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

use super::*;
use crate::GenericClient;
use crate::error::{OrmError, OrmResult};
use crate::monitor::{QueryContext, QueryMonitor, QueryResult};
use std::time::Duration;
use tokio_postgres::Row;
use tokio_postgres::types::ToSql;

#[test]
fn test_config_defaults() {
    let config = PgClientConfig::default();
    assert_eq!(config.check_mode, CheckMode::WarnOnly);
    assert_eq!(
        config.sql_policy.select_without_limit,
        SelectWithoutLimitPolicy::Allow
    );
    assert_eq!(
        config.sql_policy.delete_without_where,
        DangerousDmlPolicy::Allow
    );
    assert_eq!(
        config.sql_policy.update_without_where,
        DangerousDmlPolicy::Allow
    );
    assert!(config.stats_enabled);
    assert!(!config.logging_enabled);
    assert!(!config.statement_cache.enabled);
    assert_eq!(config.statement_cache.capacity, 0);
}

#[test]
fn test_config_builder() {
    let config = PgClientConfig::new()
        .strict()
        .timeout(Duration::from_secs(30))
        .with_logging()
        .statement_cache(64);

    assert_eq!(config.check_mode, CheckMode::Strict);
    assert_eq!(config.query_timeout, Some(Duration::from_secs(30)));
    assert!(config.logging_enabled);
    assert!(config.statement_cache.enabled);
    assert_eq!(config.statement_cache.capacity, 64);
}

#[test]
fn test_config_no_statement_cache() {
    let config = PgClientConfig::new()
        .statement_cache(16)
        .no_statement_cache();
    assert!(!config.statement_cache.enabled);
}

#[tokio::test]
async fn sql_policy_select_without_limit_errors() {
    #[derive(Default)]
    struct Capture(std::sync::Mutex<Option<String>>);

    #[derive(Clone)]
    struct DummyClient(std::sync::Arc<Capture>);

    impl GenericClient for DummyClient {
        async fn query(&self, sql: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Vec<Row>> {
            *self.0.0.lock().unwrap() = Some(sql.to_string());
            Ok(vec![])
        }
        async fn query_one(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Row> {
            Err(OrmError::not_found("no rows"))
        }
        async fn query_opt(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Option<Row>> {
            Ok(None)
        }
        async fn execute(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<u64> {
            Ok(0)
        }
    }

    let capture = std::sync::Arc::new(Capture::default());
    let config = PgClientConfig::new()
        .no_check()
        .select_without_limit(SelectWithoutLimitPolicy::Error);
    let pg = PgClient::with_config(DummyClient(capture.clone()), config);

    let err = pg.query("SELECT * FROM users", &[]).await.unwrap_err();
    assert!(matches!(err, OrmError::Validation(_)));
    assert!(capture.0.lock().unwrap().is_none());
}

#[tokio::test]
async fn sql_policy_select_without_limit_auto_limit_rewrites_exec_sql() {
    #[derive(Default)]
    struct Capture(std::sync::Mutex<Option<String>>);

    #[derive(Clone)]
    struct DummyClient(std::sync::Arc<Capture>);

    impl GenericClient for DummyClient {
        async fn query(&self, sql: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Vec<Row>> {
            *self.0.0.lock().unwrap() = Some(sql.to_string());
            Ok(vec![])
        }
        async fn query_one(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Row> {
            Err(OrmError::not_found("no rows"))
        }
        async fn query_opt(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Option<Row>> {
            Ok(None)
        }
        async fn execute(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<u64> {
            Ok(0)
        }
    }

    let capture = std::sync::Arc::new(Capture::default());
    let config = PgClientConfig::new()
        .no_check()
        .select_without_limit(SelectWithoutLimitPolicy::AutoLimit(10));
    let pg = PgClient::with_config(DummyClient(capture.clone()), config);

    pg.query("SELECT * FROM users", &[]).await.unwrap();

    let executed = capture.0.lock().unwrap().clone().unwrap();
    assert!(executed.to_uppercase().contains("LIMIT 10"));
}

#[tokio::test]
async fn sql_policy_delete_without_where_errors() {
    #[derive(Default)]
    struct Capture(std::sync::Mutex<Option<String>>);

    #[derive(Clone)]
    struct DummyClient(std::sync::Arc<Capture>);

    impl GenericClient for DummyClient {
        async fn query(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Vec<Row>> {
            Ok(vec![])
        }
        async fn query_one(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Row> {
            Err(OrmError::not_found("no rows"))
        }
        async fn query_opt(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Option<Row>> {
            Ok(None)
        }
        async fn execute(&self, sql: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<u64> {
            *self.0.0.lock().unwrap() = Some(sql.to_string());
            Ok(0)
        }
    }

    let capture = std::sync::Arc::new(Capture::default());
    let config = PgClientConfig::new()
        .no_check()
        .delete_without_where(DangerousDmlPolicy::Error);
    let pg = PgClient::with_config(DummyClient(capture.clone()), config);

    let err = pg.execute("DELETE FROM users", &[]).await.unwrap_err();
    assert!(matches!(err, OrmError::Validation(_)));
    assert!(capture.0.lock().unwrap().is_none());
}

// ── I-12: SQL policy combination tests ──

#[tokio::test]
async fn sql_policy_update_without_where_errors() {
    struct DummyClient;
    impl GenericClient for DummyClient {
        async fn query(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Vec<Row>> {
            Ok(vec![])
        }
        async fn query_one(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Row> {
            Err(OrmError::not_found("no rows"))
        }
        async fn query_opt(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Option<Row>> {
            Ok(None)
        }
        async fn execute(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<u64> {
            Ok(0)
        }
    }

    let config = PgClientConfig::new()
        .no_check()
        .update_without_where(DangerousDmlPolicy::Error);
    let pg = PgClient::with_config(DummyClient, config);

    let err = pg
        .execute("UPDATE users SET status = 'inactive'", &[])
        .await
        .unwrap_err();
    assert!(matches!(err, OrmError::Validation(_)));

    // With WHERE should succeed
    let result = pg
        .execute("UPDATE users SET status = 'inactive' WHERE id = 1", &[])
        .await;
    assert!(result.is_ok());
}

#[tokio::test]
async fn sql_policy_multiple_policies_all_enforced() {
    struct DummyClient;
    impl GenericClient for DummyClient {
        async fn query(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Vec<Row>> {
            Ok(vec![])
        }
        async fn query_one(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Row> {
            Err(OrmError::not_found("no rows"))
        }
        async fn query_opt(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Option<Row>> {
            Ok(None)
        }
        async fn execute(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<u64> {
            Ok(0)
        }
    }

    // Enable multiple policies at once
    let config = PgClientConfig::new()
        .no_check()
        .select_without_limit(SelectWithoutLimitPolicy::Error)
        .delete_without_where(DangerousDmlPolicy::Error)
        .update_without_where(DangerousDmlPolicy::Error);
    let pg = PgClient::with_config(DummyClient, config);

    // SELECT without LIMIT should error
    let err = pg.query("SELECT * FROM users", &[]).await.unwrap_err();
    assert!(matches!(err, OrmError::Validation(_)));

    // DELETE without WHERE should error
    let err = pg.execute("DELETE FROM users", &[]).await.unwrap_err();
    assert!(matches!(err, OrmError::Validation(_)));

    // UPDATE without WHERE should error
    let err = pg.execute("UPDATE users SET x = 1", &[]).await.unwrap_err();
    assert!(matches!(err, OrmError::Validation(_)));

    // SELECT with LIMIT should succeed
    let result = pg.query("SELECT * FROM users LIMIT 10", &[]).await;
    assert!(result.is_ok());
}

#[tokio::test]
async fn tagged_queries_propagate_to_custom_monitor() {
    #[derive(Default)]
    struct TagCapture(std::sync::Mutex<Option<String>>);

    impl QueryMonitor for TagCapture {
        fn on_query_complete(&self, ctx: &QueryContext, _: Duration, _: &QueryResult) {
            *self.0.lock().unwrap() = ctx.tag.clone();
        }
    }

    struct DummyClient;
    impl GenericClient for DummyClient {
        async fn query(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Vec<Row>> {
            Ok(vec![])
        }
        async fn query_one(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Row> {
            Err(OrmError::not_found("no rows"))
        }
        async fn query_opt(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<Option<Row>> {
            Ok(None)
        }
        async fn execute(&self, _: &str, _: &[&(dyn ToSql + Sync)]) -> OrmResult<u64> {
            Ok(0)
        }
    }

    let capture = std::sync::Arc::new(TagCapture::default());
    let pg = PgClient::with_config(DummyClient, PgClientConfig::new().no_check())
        .with_monitor_arc(capture.clone());

    pg.query_tagged("test-tag", "SELECT 1", &[]).await.unwrap();

    assert_eq!(capture.0.lock().unwrap().as_deref(), Some("test-tag"));
}