heliosdb-proxy 0.4.2

HeliosProxy - Intelligent connection router and failover manager for HeliosDB and PostgreSQL
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
//! Rewrite Rules
//!
//! Rule definitions for query rewriting.

use std::collections::HashSet;

/// A rewrite rule
#[derive(Debug, Clone)]
pub struct RewriteRule {
    /// Rule identifier
    pub id: String,

    /// Human-readable description
    pub description: String,

    /// Pattern to match
    pub pattern: QueryPattern,

    /// Transformation to apply
    pub transformation: Transformation,

    /// Condition for applying rule
    pub condition: Option<Condition>,

    /// Priority (higher = applied first)
    pub priority: i32,

    /// Enabled/disabled
    pub enabled: bool,

    /// Rule tags for grouping
    pub tags: HashSet<String>,
}

impl RewriteRule {
    /// Create a new rule
    pub fn new(id: impl Into<String>) -> RewriteRuleBuilder {
        RewriteRuleBuilder::new(id)
    }

    /// Check if rule matches query pattern
    pub fn matches(&self, fingerprint: u64, query: &str, tables: &[String]) -> bool {
        if !self.enabled {
            return false;
        }

        match &self.pattern {
            QueryPattern::Fingerprint(fp) => *fp == fingerprint,
            QueryPattern::Regex(pattern) => {
                regex::Regex::new(pattern)
                    .map(|re| re.is_match(query))
                    .unwrap_or(false)
            }
            QueryPattern::Table(table) => tables.contains(table),
            QueryPattern::TableAny(table_patterns) => {
                tables.iter().any(|t| table_patterns.contains(t))
            }
            QueryPattern::Ast(_ast_pattern) => {
                // AST matching is done by the matcher
                false
            }
            QueryPattern::All => true,
        }
    }
}

/// Builder for RewriteRule
pub struct RewriteRuleBuilder {
    rule: RewriteRule,
}

impl RewriteRuleBuilder {
    /// Create a new builder
    pub fn new(id: impl Into<String>) -> Self {
        Self {
            rule: RewriteRule {
                id: id.into(),
                description: String::new(),
                pattern: QueryPattern::All,
                transformation: Transformation::NoOp,
                condition: None,
                priority: 0,
                enabled: true,
                tags: HashSet::new(),
            },
        }
    }

    /// Set description
    pub fn description(mut self, desc: impl Into<String>) -> Self {
        self.rule.description = desc.into();
        self
    }

    /// Set pattern
    pub fn pattern(mut self, pattern: QueryPattern) -> Self {
        self.rule.pattern = pattern;
        self
    }

    /// Set transformation
    pub fn transform(mut self, transformation: Transformation) -> Self {
        self.rule.transformation = transformation;
        self
    }

    /// Set condition
    pub fn condition(mut self, condition: Condition) -> Self {
        self.rule.condition = Some(condition);
        self
    }

    /// Set priority
    pub fn priority(mut self, priority: i32) -> Self {
        self.rule.priority = priority;
        self
    }

    /// Enable/disable
    pub fn enabled(mut self, enabled: bool) -> Self {
        self.rule.enabled = enabled;
        self
    }

    /// Add a tag
    pub fn tag(mut self, tag: impl Into<String>) -> Self {
        self.rule.tags.insert(tag.into());
        self
    }

    /// Build the rule
    pub fn build(self) -> RewriteRule {
        self.rule
    }
}

impl From<RewriteRuleBuilder> for RewriteRule {
    fn from(builder: RewriteRuleBuilder) -> Self {
        builder.build()
    }
}

/// Query pattern for matching
#[derive(Debug, Clone)]
pub enum QueryPattern {
    /// Match by fingerprint hash
    Fingerprint(u64),

    /// Match by SQL pattern (regex)
    Regex(String),

    /// Match by table name
    Table(String),

    /// Match any of these tables
    TableAny(HashSet<String>),

    /// Match by AST pattern
    Ast(AstPattern),

    /// Match all queries
    All,
}

impl QueryPattern {
    /// Create a fingerprint pattern
    pub fn fingerprint(fp: u64) -> Self {
        Self::Fingerprint(fp)
    }

    /// Create a regex pattern
    pub fn regex(pattern: impl Into<String>) -> Self {
        Self::Regex(pattern.into())
    }

    /// Create a table pattern
    pub fn table(table: impl Into<String>) -> Self {
        Self::Table(table.into())
    }

    /// Create a table-any pattern
    pub fn table_any(tables: impl IntoIterator<Item = impl Into<String>>) -> Self {
        Self::TableAny(tables.into_iter().map(Into::into).collect())
    }

    /// Create an AST pattern
    pub fn ast(pattern: AstPattern) -> Self {
        Self::Ast(pattern)
    }

    /// Create an all pattern
    pub fn all() -> Self {
        Self::All
    }
}

/// AST-level pattern matching
#[derive(Debug, Clone)]
pub enum AstPattern {
    /// SELECT * query
    SelectStar,

    /// SELECT with specific table
    SelectFrom { table: String },

    /// Query without LIMIT
    NoLimit,

    /// Query without WHERE
    NoWhere,

    /// INSERT statement
    Insert,

    /// UPDATE statement
    Update,

    /// DELETE statement
    Delete,

    /// DDL statement (CREATE, ALTER, DROP)
    Ddl,

    /// N+1 query pattern
    NPlusOne { table: String },

    /// Full table scan
    FullTableScan,

    /// Compound pattern
    And(Vec<AstPattern>),

    /// Any of patterns
    Or(Vec<AstPattern>),
}

impl AstPattern {
    /// Create a SELECT * pattern
    pub fn select_star() -> Self {
        Self::SelectStar
    }

    /// Create a no-limit pattern
    pub fn no_limit() -> Self {
        Self::NoLimit
    }

    /// Create a no-where pattern
    pub fn no_where() -> Self {
        Self::NoWhere
    }
}

/// Query transformation
#[derive(Debug, Clone)]
pub enum Transformation {
    /// No operation (pass through)
    NoOp,

    /// Replace entire query
    Replace(String),

    /// Add index hint
    AddIndexHint {
        table: String,
        index: String,
    },

    /// Rewrite SELECT * to specific columns
    ExpandSelectStar {
        columns: Vec<String>,
    },

    /// Add LIMIT clause
    AddLimit(u32),

    /// Add WHERE condition
    AddWhereClause(String),

    /// Append to WHERE clause with AND
    AppendWhereAnd(String),

    /// Replace table name
    ReplaceTable {
        from: String,
        to: String,
    },

    /// Add ORDER BY clause
    AddOrderBy {
        column: String,
        descending: bool,
    },

    /// Add query hint comment
    AddHint(String),

    /// Add branch routing hint
    AddBranchHint(String),

    /// Add timeout hint
    AddTimeout(std::time::Duration),

    /// Custom transformation by name
    Custom(String),

    /// Chain multiple transformations
    Chain(Vec<Transformation>),
}

impl Transformation {
    /// Create a replace transformation
    pub fn replace(query: impl Into<String>) -> Self {
        Self::Replace(query.into())
    }

    /// Create an add-limit transformation
    pub fn add_limit(limit: u32) -> Self {
        Self::AddLimit(limit)
    }

    /// Create an add-where transformation
    pub fn add_where(condition: impl Into<String>) -> Self {
        Self::AddWhereClause(condition.into())
    }

    /// Create a replace-table transformation
    pub fn replace_table(from: impl Into<String>, to: impl Into<String>) -> Self {
        Self::ReplaceTable {
            from: from.into(),
            to: to.into(),
        }
    }

    /// Create an expand-select-star transformation
    pub fn expand_select_star(columns: Vec<impl Into<String>>) -> Self {
        Self::ExpandSelectStar {
            columns: columns.into_iter().map(Into::into).collect(),
        }
    }

    /// Create an add-index-hint transformation
    pub fn add_index_hint(table: impl Into<String>, index: impl Into<String>) -> Self {
        Self::AddIndexHint {
            table: table.into(),
            index: index.into(),
        }
    }

    /// Create a chain transformation
    pub fn chain(transformations: Vec<Transformation>) -> Self {
        Self::Chain(transformations)
    }
}

/// Condition for rule application
#[derive(Debug, Clone)]
pub enum Condition {
    /// Query has no LIMIT clause
    NoExistingLimit,

    /// Query has no ORDER BY clause
    NoExistingOrderBy,

    /// Query has SELECT *
    HasSelectStar,

    /// Session variable check
    SessionVar {
        name: String,
        exists: bool,
    },

    /// Client type check
    ClientType {
        client_type: String,
    },

    /// Table exists in schema
    TableExists {
        table: String,
    },

    /// All conditions must match
    And(Vec<Condition>),

    /// Any condition must match
    Or(Vec<Condition>),

    /// Negate condition
    Not(Box<Condition>),
}

impl Condition {
    /// No existing LIMIT
    pub fn no_limit() -> Self {
        Self::NoExistingLimit
    }

    /// No existing ORDER BY
    pub fn no_order_by() -> Self {
        Self::NoExistingOrderBy
    }

    /// Has SELECT *
    pub fn has_select_star() -> Self {
        Self::HasSelectStar
    }

    /// Session variable exists
    pub fn session_var(name: impl Into<String>) -> Self {
        Self::SessionVar {
            name: name.into(),
            exists: true,
        }
    }

    /// Client type matches
    pub fn client_type(client_type: impl Into<String>) -> Self {
        Self::ClientType {
            client_type: client_type.into(),
        }
    }

    /// AND conditions
    pub fn and(conditions: Vec<Condition>) -> Self {
        Self::And(conditions)
    }

    /// OR conditions
    pub fn or(conditions: Vec<Condition>) -> Self {
        Self::Or(conditions)
    }

    /// NOT condition
    pub fn not(condition: Condition) -> Self {
        Self::Not(Box::new(condition))
    }
}

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

    #[test]
    fn test_rule_builder() {
        let rule = RewriteRule::new("test")
            .description("Test rule")
            .pattern(QueryPattern::All)
            .transform(Transformation::AddLimit(100))
            .priority(50)
            .tag("safety")
            .build();

        assert_eq!(rule.id, "test");
        assert_eq!(rule.description, "Test rule");
        assert_eq!(rule.priority, 50);
        assert!(rule.enabled);
        assert!(rule.tags.contains("safety"));
    }

    #[test]
    fn test_query_pattern_table() {
        let pattern = QueryPattern::table("users");

        match pattern {
            QueryPattern::Table(t) => assert_eq!(t, "users"),
            _ => panic!("Expected Table pattern"),
        }
    }

    #[test]
    fn test_transformation_chain() {
        let transform = Transformation::chain(vec![
            Transformation::AddLimit(100),
            Transformation::AddOrderBy {
                column: "id".to_string(),
                descending: true,
            },
        ]);

        match transform {
            Transformation::Chain(t) => assert_eq!(t.len(), 2),
            _ => panic!("Expected Chain"),
        }
    }

    #[test]
    fn test_condition_and() {
        let condition = Condition::and(vec![
            Condition::NoExistingLimit,
            Condition::HasSelectStar,
        ]);

        match condition {
            Condition::And(c) => assert_eq!(c.len(), 2),
            _ => panic!("Expected And"),
        }
    }

    #[test]
    fn test_rule_matches() {
        let rule = RewriteRule::new("test")
            .pattern(QueryPattern::Table("users".to_string()))
            .transform(Transformation::AddLimit(100))
            .build();

        assert!(rule.matches(0, "", &["users".to_string()]));
        assert!(!rule.matches(0, "", &["orders".to_string()]));
    }
}