data-connector 2.3.0

Storage backends for conversations and responses
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
//! Storage backend configuration types.

use serde::{Deserialize, Serialize};
use url::Url;

use crate::schema::SchemaConfig;

/// History backend configuration
#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Default)]
#[serde(rename_all = "lowercase")]
pub enum HistoryBackend {
    #[default]
    Memory,
    None,
    Oracle,
    Postgres,
    Redis,
}

/// Oracle history backend configuration
#[derive(Clone, Serialize, Deserialize, PartialEq)]
pub struct OracleConfig {
    /// ATP wallet or TLS config files directory
    #[serde(skip_serializing_if = "Option::is_none")]
    pub wallet_path: Option<String>,
    /// DSN (e.g. `tcps://host:port/service`)
    pub connect_descriptor: String,
    #[serde(default)]
    pub external_auth: bool,
    pub username: String,
    pub password: String,
    #[serde(default = "default_pool_min")]
    pub pool_min: usize,
    #[serde(default = "default_pool_max")]
    pub pool_max: usize,
    #[serde(default = "default_pool_timeout_secs")]
    pub pool_timeout_secs: u64,
    /// Optional schema customization (table names, column names, extra columns).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub schema: Option<SchemaConfig>,
}

impl OracleConfig {
    pub fn default_pool_min() -> usize {
        default_pool_min()
    }

    pub fn default_pool_max() -> usize {
        default_pool_max()
    }

    pub fn default_pool_timeout_secs() -> u64 {
        default_pool_timeout_secs()
    }
}

fn default_pool_min() -> usize {
    1
}

fn default_pool_max() -> usize {
    16
}

fn default_pool_timeout_secs() -> u64 {
    30
}

impl std::fmt::Debug for OracleConfig {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("OracleConfig")
            .field("wallet_path", &self.wallet_path)
            .field("connect_descriptor", &self.connect_descriptor)
            .field("external_auth", &self.external_auth)
            .field("username", &self.username)
            .field("pool_min", &self.pool_min)
            .field("pool_max", &self.pool_max)
            .field("pool_timeout_secs", &self.pool_timeout_secs)
            .field("schema", &self.schema)
            .finish()
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct PostgresConfig {
    // Database connection URL,
    // postgres://[user[:password]@][netloc][:port][/dbname][?param1=value1&...]
    pub db_url: String,
    // Database pool max size
    pub pool_max: usize,
    /// Optional schema customization (table names, column names, extra columns).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub schema: Option<SchemaConfig>,
}

impl PostgresConfig {
    pub fn default_pool_max() -> usize {
        16
    }

    pub fn validate(&self) -> Result<(), String> {
        let s = self.db_url.trim();
        if s.is_empty() {
            return Err("db_url should not be empty".to_string());
        }

        let url = Url::parse(s).map_err(|e| format!("invalid db_url: {e}"))?;

        let scheme = url.scheme();
        if scheme != "postgres" && scheme != "postgresql" {
            return Err(format!("unsupported URL scheme: {scheme}"));
        }

        if url.host().is_none() {
            return Err("db_url must have a host".to_string());
        }

        let path = url.path();
        let dbname = path
            .strip_prefix('/')
            .filter(|p| !p.is_empty())
            .map(|s| s.to_string());
        if dbname.is_none() {
            return Err("db_url must include a database name".to_string());
        }

        if self.pool_max == 0 {
            return Err("pool_max must be greater than 0".to_string());
        }

        Ok(())
    }
}

#[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
pub struct RedisConfig {
    // Redis connection URL
    // redis://[:password@]host[:port][/db]
    pub url: String,
    // Connection pool max size
    #[serde(default = "default_redis_pool_max")]
    pub pool_max: usize,
    /// Optional schema customization (key prefix, field names, extra fields).
    #[serde(default, skip_serializing_if = "Option::is_none")]
    pub schema: Option<SchemaConfig>,
    // Data retention in days. If None, data persists indefinitely.
    #[serde(default = "default_redis_retention_days")]
    pub retention_days: Option<u64>,
}

fn default_redis_pool_max() -> usize {
    16
}

#[expect(
    clippy::unnecessary_wraps,
    reason = "serde default function must match field type Option<u64>"
)]
fn default_redis_retention_days() -> Option<u64> {
    Some(30)
}

impl RedisConfig {
    pub fn validate(&self) -> Result<(), String> {
        let s = self.url.trim();
        if s.is_empty() {
            return Err("redis url should not be empty".to_string());
        }

        let url = Url::parse(s).map_err(|e| format!("invalid redis url: {e}"))?;

        let scheme = url.scheme();
        if scheme != "redis" && scheme != "rediss" {
            return Err(format!("unsupported URL scheme: {scheme}"));
        }

        if url.host().is_none() {
            return Err("redis url must have a host".to_string());
        }

        if self.pool_max == 0 {
            return Err("pool_max must be greater than 0".to_string());
        }

        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    // ── PostgresConfig::validate ────────────────────────────────────────

    #[test]
    fn postgres_valid_url_succeeds() {
        let cfg = PostgresConfig {
            db_url: "postgres://user:pass@localhost:5432/mydb".to_string(),
            pool_max: 16,
            schema: None,
        };
        cfg.validate()
            .expect("valid postgres URL should pass validation");
    }

    #[test]
    fn postgres_postgresql_scheme_succeeds() {
        let cfg = PostgresConfig {
            db_url: "postgresql://user:pass@localhost/mydb".to_string(),
            pool_max: 8,
            schema: None,
        };
        cfg.validate()
            .expect("postgresql:// scheme should also be accepted");
    }

    #[test]
    fn postgres_empty_url_fails() {
        let cfg = PostgresConfig {
            db_url: "  ".to_string(),
            pool_max: 16,
            schema: None,
        };
        let err = cfg.validate().expect_err("empty URL should fail");
        assert!(
            err.contains("not be empty"),
            "unexpected error message: {err}"
        );
    }

    #[test]
    fn postgres_non_postgres_scheme_fails() {
        let cfg = PostgresConfig {
            db_url: "mysql://user:pass@localhost/mydb".to_string(),
            pool_max: 16,
            schema: None,
        };
        let err = cfg.validate().expect_err("mysql scheme should be rejected");
        assert!(
            err.contains("unsupported URL scheme"),
            "unexpected error message: {err}"
        );
    }

    #[test]
    fn postgres_missing_host_fails() {
        // `postgres:///mydb` is a valid URL with no host
        let cfg = PostgresConfig {
            db_url: "postgres:///mydb".to_string(),
            pool_max: 16,
            schema: None,
        };
        let err = cfg.validate().expect_err("missing host should fail");
        assert!(
            err.contains("must have a host"),
            "unexpected error message: {err}"
        );
    }

    #[test]
    fn postgres_missing_database_name_fails() {
        let cfg = PostgresConfig {
            db_url: "postgres://user:pass@localhost".to_string(),
            pool_max: 16,
            schema: None,
        };
        let err = cfg
            .validate()
            .expect_err("missing database name should fail");
        assert!(
            err.contains("database name"),
            "unexpected error message: {err}"
        );
    }

    #[test]
    fn postgres_pool_max_zero_fails() {
        let cfg = PostgresConfig {
            db_url: "postgres://user:pass@localhost/mydb".to_string(),
            pool_max: 0,
            schema: None,
        };
        let err = cfg.validate().expect_err("pool_max=0 should fail");
        assert!(
            err.contains("greater than 0"),
            "unexpected error message: {err}"
        );
    }

    // ── RedisConfig::validate ───────────────────────────────────────────

    #[test]
    fn redis_valid_url_succeeds() {
        let cfg = RedisConfig {
            url: "redis://:password@localhost:6379/0".to_string(),
            pool_max: 16,
            retention_days: Some(30),
            schema: None,
        };
        cfg.validate()
            .expect("valid redis URL should pass validation");
    }

    #[test]
    fn redis_rediss_scheme_succeeds() {
        let cfg = RedisConfig {
            url: "rediss://:password@redis.example.com:6380".to_string(),
            pool_max: 8,
            retention_days: None,
            schema: None,
        };
        cfg.validate()
            .expect("rediss:// scheme should also be accepted");
    }

    #[test]
    fn redis_empty_url_fails() {
        let cfg = RedisConfig {
            url: String::new(),
            pool_max: 16,
            retention_days: Some(30),
            schema: None,
        };
        let err = cfg.validate().expect_err("empty URL should fail");
        assert!(
            err.contains("not be empty"),
            "unexpected error message: {err}"
        );
    }

    #[test]
    fn redis_non_redis_scheme_fails() {
        let cfg = RedisConfig {
            url: "http://localhost:6379".to_string(),
            pool_max: 16,
            retention_days: Some(30),
            schema: None,
        };
        let err = cfg.validate().expect_err("http scheme should be rejected");
        assert!(
            err.contains("unsupported URL scheme"),
            "unexpected error message: {err}"
        );
    }

    #[test]
    fn redis_missing_host_fails() {
        let cfg = RedisConfig {
            url: "redis:///0".to_string(),
            pool_max: 16,
            retention_days: Some(30),
            schema: None,
        };
        let err = cfg.validate().expect_err("missing host should fail");
        assert!(
            err.contains("must have a host"),
            "unexpected error message: {err}"
        );
    }

    #[test]
    fn redis_pool_max_zero_fails() {
        let cfg = RedisConfig {
            url: "redis://localhost:6379".to_string(),
            pool_max: 0,
            retention_days: Some(30),
            schema: None,
        };
        let err = cfg.validate().expect_err("pool_max=0 should fail");
        assert!(
            err.contains("greater than 0"),
            "unexpected error message: {err}"
        );
    }

    // ── HistoryBackend ──────────────────────────────────────────────────

    #[test]
    fn history_backend_default_is_memory() {
        assert_eq!(HistoryBackend::default(), HistoryBackend::Memory);
    }

    #[test]
    fn history_backend_serde_roundtrip_memory() {
        let backend = HistoryBackend::Memory;
        let json = serde_json::to_string(&backend).expect("serialize Memory");
        assert_eq!(json, r#""memory""#);
        let deserialized: HistoryBackend = serde_json::from_str(&json).expect("deserialize Memory");
        assert_eq!(deserialized, HistoryBackend::Memory);
    }

    #[test]
    fn history_backend_serde_roundtrip_none() {
        let backend = HistoryBackend::None;
        let json = serde_json::to_string(&backend).expect("serialize None");
        assert_eq!(json, r#""none""#);
        let deserialized: HistoryBackend = serde_json::from_str(&json).expect("deserialize None");
        assert_eq!(deserialized, HistoryBackend::None);
    }

    #[test]
    fn history_backend_serde_roundtrip_oracle() {
        let backend = HistoryBackend::Oracle;
        let json = serde_json::to_string(&backend).expect("serialize Oracle");
        assert_eq!(json, r#""oracle""#);
        let deserialized: HistoryBackend = serde_json::from_str(&json).expect("deserialize Oracle");
        assert_eq!(deserialized, HistoryBackend::Oracle);
    }

    #[test]
    fn history_backend_serde_roundtrip_postgres() {
        let backend = HistoryBackend::Postgres;
        let json = serde_json::to_string(&backend).expect("serialize Postgres");
        assert_eq!(json, r#""postgres""#);
        let deserialized: HistoryBackend =
            serde_json::from_str(&json).expect("deserialize Postgres");
        assert_eq!(deserialized, HistoryBackend::Postgres);
    }

    #[test]
    fn history_backend_serde_roundtrip_redis() {
        let backend = HistoryBackend::Redis;
        let json = serde_json::to_string(&backend).expect("serialize Redis");
        assert_eq!(json, r#""redis""#);
        let deserialized: HistoryBackend = serde_json::from_str(&json).expect("deserialize Redis");
        assert_eq!(deserialized, HistoryBackend::Redis);
    }
}