outlet-postgres 0.5.1

PostgreSQL logging handler for outlet HTTP request/response middleware
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
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
use bytes::Bytes;
use chrono::{DateTime, Utc};
use serde::de::Error;
use serde::{Deserialize, Serialize};
use serde_json::Value;
use sqlx::{QueryBuilder, Row};
use sqlx_pool_router::PoolProvider;
use uuid::Uuid;

use crate::error::PostgresHandlerError;

#[derive(Debug)]
pub struct HttpRequest<TReq> {
    pub id: i64,
    pub instance_id: Uuid,
    pub correlation_id: i64,
    pub timestamp: DateTime<Utc>,
    pub method: String,
    pub uri: String,
    pub headers: Value,
    pub body: Option<Result<TReq, Bytes>>,
    pub created_at: DateTime<Utc>,
    pub trace_id: Option<String>,
    pub span_id: Option<String>,
}

#[derive(Debug)]
pub struct HttpResponse<TRes> {
    pub id: i64,
    pub instance_id: Uuid,
    pub correlation_id: i64,
    pub timestamp: DateTime<Utc>,
    pub status_code: i32,
    pub headers: Value,
    pub body: Option<Result<TRes, Bytes>>,
    pub duration_to_first_byte_ms: i64,
    pub duration_ms: i64,
    pub created_at: DateTime<Utc>,
}

#[derive(Debug)]
pub struct RequestResponsePair<TReq, TRes> {
    pub request: HttpRequest<TReq>,
    pub response: Option<HttpResponse<TRes>>,
}

#[derive(Debug, Default)]
pub struct RequestFilter {
    pub instance_id: Option<Uuid>,
    pub correlation_id: Option<i64>,
    pub method: Option<String>,
    pub uri_pattern: Option<String>,
    pub status_code: Option<i32>,
    pub status_code_min: Option<i32>,
    pub status_code_max: Option<i32>,
    pub timestamp_after: Option<DateTime<Utc>>,
    pub timestamp_before: Option<DateTime<Utc>>,
    pub min_duration_ms: Option<i64>,
    pub max_duration_ms: Option<i64>,
    pub min_duration_to_first_byte_ms: Option<i64>,
    pub max_duration_to_first_byte_ms: Option<i64>,
    pub body_parsed: Option<bool>,
    pub limit: Option<i64>,
    pub offset: Option<i64>,
    pub order_by_timestamp_desc: bool,
}

impl RequestFilter {
    pub fn build_query(&self) -> QueryBuilder<'_, sqlx::Postgres> {
        let mut query = QueryBuilder::new(
            r#"
            SELECT 
                r.id as req_id, r.instance_id as req_instance_id, r.correlation_id as req_correlation_id, r.timestamp as req_timestamp, 
                r.method, r.uri, r.headers as req_headers, r.body as req_body, r.body_parsed as req_body_parsed, r.created_at as req_created_at,
                r.trace_id, r.span_id,
                res.id as res_id, res.instance_id as res_instance_id, res.correlation_id as res_correlation_id, res.timestamp as res_timestamp,
                res.status_code, res.headers as res_headers, res.body as res_body, res.body_parsed as res_body_parsed, res.duration_to_first_byte_ms, res.duration_ms, res.created_at as res_created_at
            FROM http_requests r
            LEFT JOIN http_responses res ON (r.instance_id = res.instance_id AND r.correlation_id = res.correlation_id)
            "#,
        );

        let mut where_added = false;

        if let Some(instance_id) = self.instance_id {
            query.push(" WHERE r.instance_id = ");
            query.push_bind(instance_id);
            where_added = true;
        }

        if let Some(correlation_id) = self.correlation_id {
            if where_added {
                query.push(" AND ");
            } else {
                query.push(" WHERE ");
                where_added = true;
            }
            query.push("r.correlation_id = ");
            query.push_bind(correlation_id);
        }

        if let Some(method) = &self.method {
            if where_added {
                query.push(" AND ");
            } else {
                query.push(" WHERE ");
                where_added = true;
            }
            query.push("r.method = ");
            query.push_bind(method);
        }

        if let Some(uri_pattern) = &self.uri_pattern {
            if where_added {
                query.push(" AND ");
            } else {
                query.push(" WHERE ");
                where_added = true;
            }
            query.push("r.uri ILIKE ");
            query.push_bind(uri_pattern);
        }

        if let Some(status_code) = self.status_code {
            if where_added {
                query.push(" AND ");
            } else {
                query.push(" WHERE ");
                where_added = true;
            }
            query.push("res.status_code = ");
            query.push_bind(status_code);
        }

        if let Some(min_status) = self.status_code_min {
            if where_added {
                query.push(" AND ");
            } else {
                query.push(" WHERE ");
                where_added = true;
            }
            query.push("res.status_code >= ");
            query.push_bind(min_status);
        }

        if let Some(max_status) = self.status_code_max {
            if where_added {
                query.push(" AND ");
            } else {
                query.push(" WHERE ");
                where_added = true;
            }
            query.push("res.status_code <= ");
            query.push_bind(max_status);
        }

        if let Some(timestamp_after) = self.timestamp_after {
            if where_added {
                query.push(" AND ");
            } else {
                query.push(" WHERE ");
                where_added = true;
            }
            query.push("r.timestamp >= ");
            query.push_bind(timestamp_after);
        }

        if let Some(timestamp_before) = self.timestamp_before {
            if where_added {
                query.push(" AND ");
            } else {
                query.push(" WHERE ");
                where_added = true;
            }
            query.push("r.timestamp <= ");
            query.push_bind(timestamp_before);
        }

        if let Some(min_duration) = self.min_duration_ms {
            if where_added {
                query.push(" AND ");
            } else {
                query.push(" WHERE ");
                where_added = true;
            }
            query.push("res.duration_ms >= ");
            query.push_bind(min_duration);
        }

        if let Some(max_duration) = self.max_duration_ms {
            if where_added {
                query.push(" AND ");
            } else {
                query.push(" WHERE ");
                where_added = true;
            }
            query.push("res.duration_ms <= ");
            query.push_bind(max_duration);
        }

        if let Some(min_duration_to_first_byte) = self.min_duration_to_first_byte_ms {
            if where_added {
                query.push(" AND ");
            } else {
                query.push(" WHERE ");
                where_added = true;
            }
            query.push("res.duration_to_first_byte_ms >= ");
            query.push_bind(min_duration_to_first_byte);
        }

        if let Some(max_duration_to_first_byte) = self.max_duration_to_first_byte_ms {
            if where_added {
                query.push(" AND ");
            } else {
                query.push(" WHERE ");
            }
            query.push("res.duration_to_first_byte_ms <= ");
            query.push_bind(max_duration_to_first_byte);
        }

        if self.order_by_timestamp_desc {
            query.push(" ORDER BY r.timestamp DESC");
        } else {
            query.push(" ORDER BY r.timestamp ASC");
        }

        if let Some(limit) = self.limit {
            query.push(" LIMIT ");
            query.push_bind(limit);
        }

        if let Some(offset) = self.offset {
            query.push(" OFFSET ");
            query.push_bind(offset);
        }

        query
    }
}

#[derive(Clone)]
pub struct RequestRepository<P, TReq, TRes>
where
    P: PoolProvider,
{
    pool: P,
    _phantom_req: std::marker::PhantomData<TReq>,
    _phantom_res: std::marker::PhantomData<TRes>,
}

impl<P, TReq, TRes> RequestRepository<P, TReq, TRes>
where
    P: PoolProvider,
    TReq: for<'de> Deserialize<'de> + Serialize + Send + Sync + 'static,
    TRes: for<'de> Deserialize<'de> + Serialize + Send + Sync + 'static,
{
    pub fn new(pool: P) -> Self {
        Self {
            pool,
            _phantom_req: std::marker::PhantomData,
            _phantom_res: std::marker::PhantomData,
        }
    }

    pub async fn query(
        &self,
        filter: RequestFilter,
    ) -> Result<Vec<RequestResponsePair<TReq, TRes>>, PostgresHandlerError> {
        let rows = filter
            .build_query()
            .build()
            .fetch_all(self.pool.read())
            .await
            .map_err(PostgresHandlerError::Query)?;

        let mut pairs = Vec::new();
        for row in rows {
            let req_body = row.try_get::<Option<Value>, _>("req_body").unwrap_or(None);
            let req_body_parsed = row
                .try_get::<Option<bool>, _>("req_body_parsed")
                .unwrap_or(Some(false));

            let request_body = match req_body {
                Some(json_value) => {
                    if req_body_parsed == Some(true) {
                        // Body was successfully parsed as TReq when stored
                        Some(Ok(serde_json::from_value::<TReq>(json_value)
                            .map_err(PostgresHandlerError::Json)?))
                    } else {
                        // Body is stored as UTF-8 string (raw content that failed to parse)
                        if let Value::String(utf8_str) = json_value {
                            Some(Err(Bytes::from(utf8_str.into_bytes())))
                        } else {
                            return Err(PostgresHandlerError::Json(Error::custom(
                                "Invalid body format",
                            )));
                        }
                    }
                }
                None => None,
            };

            let request = HttpRequest {
                id: row.get("req_id"),
                instance_id: row.get("req_instance_id"),
                correlation_id: row.get("req_correlation_id"),
                timestamp: row.get("req_timestamp"),
                method: row.get("method"),
                uri: row.get("uri"),
                headers: row.get("req_headers"),
                body: request_body,
                created_at: row.get("req_created_at"),
                trace_id: row.try_get("trace_id").unwrap_or(None),
                span_id: row.try_get("span_id").unwrap_or(None),
            };

            let response = if let Ok(res_id) = row.try_get::<Option<i64>, _>("res_id") {
                res_id
                    .map(|_| -> Result<HttpResponse<TRes>, PostgresHandlerError> {
                        let res_body = row.try_get::<Option<Value>, _>("res_body").unwrap_or(None);
                        let res_body_parsed = row
                            .try_get::<Option<bool>, _>("res_body_parsed")
                            .unwrap_or(Some(false));

                        let response_body = match res_body {
                            Some(json_value) => {
                                if res_body_parsed == Some(true) {
                                    // Body was successfully parsed as TRes when stored
                                    Some(Ok(serde_json::from_value::<TRes>(json_value)
                                        .map_err(PostgresHandlerError::Json)?))
                                } else {
                                    // Body is stored as UTF-8 string (raw content that failed to parse)
                                    if let Value::String(utf8_str) = json_value {
                                        Some(Err(Bytes::from(utf8_str.into_bytes())))
                                    } else {
                                        return Err(PostgresHandlerError::Json(Error::custom(
                                            "Invalid body format",
                                        )));
                                    }
                                }
                            }
                            None => None,
                        };

                        Ok(HttpResponse {
                            id: row.get("res_id"),
                            instance_id: row.get("res_instance_id"),
                            correlation_id: row.get("res_correlation_id"),
                            timestamp: row.get("res_timestamp"),
                            status_code: row.get("status_code"),
                            headers: row.get("res_headers"),
                            body: response_body,
                            duration_to_first_byte_ms: row.get("duration_to_first_byte_ms"),
                            duration_ms: row.get("duration_ms"),
                            created_at: row.get("res_created_at"),
                        })
                    })
                    .transpose()?
            } else {
                None
            };

            pairs.push(RequestResponsePair { request, response });
        }

        Ok(pairs)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use chrono::DateTime;
    use sqlparser::{dialect::PostgreSqlDialect, parser::Parser};

    fn validate_sql(sql: &str) -> Result<(), String> {
        let dialect = PostgreSqlDialect {};
        Parser::parse_sql(&dialect, sql)
            .map_err(|e| format!("SQL parse error: {e}"))
            .map(|_| ())
    }

    #[test]
    fn test_default_filter_generates_valid_sql() {
        let filter = RequestFilter::default();
        let query = filter.build_query();
        let sql = query.sql();

        validate_sql(sql).unwrap();
        assert!(sql.contains("ORDER BY r.timestamp ASC"));
        assert!(!sql.contains("WHERE"));
    }

    #[test]
    fn test_correlation_id_filter() {
        let filter = RequestFilter {
            correlation_id: Some(123),
            ..Default::default()
        };
        let query = filter.build_query();
        let sql = query.sql();

        validate_sql(sql).unwrap();
        assert!(sql.contains("WHERE r.correlation_id = $1"));
    }

    #[test]
    fn test_method_filter() {
        let filter = RequestFilter {
            method: Some("POST".to_string()),
            ..Default::default()
        };
        let query = filter.build_query();
        let sql = query.sql();

        validate_sql(sql).unwrap();
        assert!(sql.contains("WHERE r.method = $1"));
    }

    #[test]
    fn test_uri_pattern_filter() {
        let filter = RequestFilter {
            uri_pattern: Some("/api/%".to_string()),
            ..Default::default()
        };
        let query = filter.build_query();
        let sql = query.sql();

        validate_sql(sql).unwrap();
        assert!(sql.contains("WHERE r.uri ILIKE $1"));
    }

    #[test]
    fn test_status_code_exact_filter() {
        let filter = RequestFilter {
            status_code: Some(404),
            ..Default::default()
        };
        let query = filter.build_query();
        let sql = query.sql();

        validate_sql(sql).unwrap();
        assert!(sql.contains("WHERE res.status_code = $1"));
    }

    #[test]
    fn test_status_code_range_filters() {
        let filter = RequestFilter {
            status_code_min: Some(400),
            status_code_max: Some(499),
            ..Default::default()
        };
        let query = filter.build_query();
        let sql = query.sql();

        validate_sql(sql).unwrap();
        assert!(sql.contains("WHERE res.status_code >= $1"));
        assert!(sql.contains("AND res.status_code <= $2"));
    }

    #[test]
    fn test_timestamp_filters() {
        let after = DateTime::parse_from_rfc3339("2023-01-01T00:00:00Z")
            .unwrap()
            .with_timezone(&Utc);
        let before = DateTime::parse_from_rfc3339("2023-12-31T23:59:59Z")
            .unwrap()
            .with_timezone(&Utc);

        let filter = RequestFilter {
            timestamp_after: Some(after),
            timestamp_before: Some(before),
            ..Default::default()
        };
        let query = filter.build_query();
        let sql = query.sql();

        validate_sql(sql).unwrap();
        assert!(sql.contains("WHERE r.timestamp >= $1"));
        assert!(sql.contains("AND r.timestamp <= $2"));
    }

    #[test]
    fn test_duration_filters() {
        let filter = RequestFilter {
            min_duration_ms: Some(100),
            max_duration_ms: Some(5000),
            ..Default::default()
        };
        let query = filter.build_query();
        let sql = query.sql();

        validate_sql(sql).unwrap();
        assert!(sql.contains("WHERE res.duration_ms >= $1"));
        assert!(sql.contains("AND res.duration_ms <= $2"));
    }

    #[test]
    fn test_ordering_desc() {
        let filter = RequestFilter {
            order_by_timestamp_desc: true,
            ..Default::default()
        };
        let query = filter.build_query();
        let sql = query.sql();

        validate_sql(sql).unwrap();
        assert!(sql.contains("ORDER BY r.timestamp DESC"));
    }

    #[test]
    fn test_ordering_asc() {
        let filter = RequestFilter {
            order_by_timestamp_desc: false,
            ..Default::default()
        };
        let query = filter.build_query();
        let sql = query.sql();

        validate_sql(sql).unwrap();
        assert!(sql.contains("ORDER BY r.timestamp ASC"));
    }

    #[test]
    fn test_pagination() {
        let filter = RequestFilter {
            limit: Some(10),
            offset: Some(20),
            ..Default::default()
        };
        let query = filter.build_query();
        let sql = query.sql();

        validate_sql(sql).unwrap();
        assert!(sql.contains("LIMIT $1"));
        assert!(sql.contains("OFFSET $2"));
    }

    #[test]
    fn test_multiple_filters_use_and() {
        let filter = RequestFilter {
            correlation_id: Some(123),
            method: Some("POST".to_string()),
            status_code: Some(200),
            ..Default::default()
        };
        let query = filter.build_query();
        let sql = query.sql();

        validate_sql(sql).unwrap();
        assert!(sql.contains("WHERE r.correlation_id = $1"));
        assert!(sql.contains("AND r.method = $2"));
        assert!(sql.contains("AND res.status_code = $3"));

        // Should not have multiple WHERE clauses
        assert_eq!(sql.matches("WHERE").count(), 1);
        assert!(sql.matches("AND").count() >= 2);
    }

    #[test]
    fn test_complex_filter_combination() {
        let after = DateTime::parse_from_rfc3339("2023-01-01T00:00:00Z")
            .unwrap()
            .with_timezone(&Utc);

        let filter = RequestFilter {
            correlation_id: Some(456),
            method: Some("GET".to_string()),
            uri_pattern: Some("/api/users%".to_string()),
            status_code_min: Some(200),
            status_code_max: Some(299),
            timestamp_after: Some(after),
            min_duration_ms: Some(50),
            max_duration_ms: Some(1000),
            limit: Some(100),
            offset: Some(0),
            order_by_timestamp_desc: true,
            ..Default::default()
        };
        let query = filter.build_query();
        let sql = query.sql();

        validate_sql(sql).unwrap();

        // Check all filters are present
        assert!(sql.contains("WHERE r.correlation_id = $1"));
        assert!(sql.contains("AND r.method = $2"));
        assert!(sql.contains("AND r.uri ILIKE $3"));
        assert!(sql.contains("AND res.status_code >= $4"));
        assert!(sql.contains("AND res.status_code <= $5"));
        assert!(sql.contains("AND r.timestamp >= $6"));
        assert!(sql.contains("AND res.duration_ms >= $7"));
        assert!(sql.contains("AND res.duration_ms <= $8"));
        assert!(sql.contains("ORDER BY r.timestamp DESC"));
        assert!(sql.contains("LIMIT $9"));
        assert!(sql.contains("OFFSET $10"));

        // Should have exactly one WHERE
        assert_eq!(sql.matches("WHERE").count(), 1);
    }

    #[test]
    fn test_no_filters_only_has_base_query() {
        let filter = RequestFilter::default();
        let query = filter.build_query();
        let sql = query.sql();

        validate_sql(sql).unwrap();

        // Should contain base SELECT and JOIN
        assert!(sql.contains("SELECT"));
        assert!(sql.contains("FROM http_requests r"));
        assert!(
            sql.contains("LEFT JOIN http_responses res ON (r.instance_id = res.instance_id AND r.correlation_id = res.correlation_id)")
        );

        // Should not contain WHERE clause
        assert!(!sql.contains("WHERE"));

        // Should have default ordering
        assert!(sql.contains("ORDER BY r.timestamp ASC"));
    }
}