sync-engine 0.2.19

High-performance tiered sync engine with L1/L2/L3 caching and Redis/SQL backends
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
// Copyright (c) 2025-2026 Adrian Robinson. Licensed under the AGPL-3.0.
// See LICENSE file in the project root for full license text.

//! Query Builder - AST for search queries
//!
//! Provides a type-safe way to build search queries that can be translated
//! to both RediSearch FT.SEARCH syntax and MySQL JSON_EXTRACT queries.
//!
//! # Example
//!
//! ```rust
//! use sync_engine::search::{Query, QueryBuilder};
//!
//! // Simple field query
//! let query = Query::field_eq("name", "Alice");
//!
//! // Complex query with builder
//! let query = QueryBuilder::new()
//!     .field_eq("name", "Alice")
//!     .numeric_range("age", Some(25.0), Some(40.0))
//!     .build_and();
//!
//! // Boolean combinations
//! let query = Query::field_eq("status", "active")
//!     .or(Query::field_eq("status", "pending"));
//! ```

use serde::{Deserialize, Serialize};

/// Search query AST
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct Query {
    /// Root query node
    pub root: QueryNode,
}

impl Query {
    /// Create a new query from a root node
    pub fn new(root: QueryNode) -> Self {
        Self { root }
    }

    /// Create a field equals query: @field:value
    pub fn field_eq(field: impl Into<String>, value: impl Into<String>) -> Self {
        Self::new(QueryNode::Field(FieldQuery {
            field: field.into(),
            operator: FieldOperator::Equals,
            value: QueryValue::Text(value.into()),
        }))
    }

    /// Create a tag query: @tags:{value1|value2}
    pub fn tags(field: impl Into<String>, values: Vec<String>) -> Self {
        Self::new(QueryNode::Field(FieldQuery {
            field: field.into(),
            operator: FieldOperator::In,
            value: QueryValue::Tags(values),
        }))
    }

    /// Create a numeric range query: @age:[min max]
    pub fn numeric_range(field: impl Into<String>, min: Option<f64>, max: Option<f64>) -> Self {
        Self::new(QueryNode::Field(FieldQuery {
            field: field.into(),
            operator: FieldOperator::Range,
            value: QueryValue::NumericRange { min, max },
        }))
    }

    /// Create a full-text search query (contains)
    pub fn text_search(field: impl Into<String>, text: impl Into<String>) -> Self {
        Self::new(QueryNode::Field(FieldQuery {
            field: field.into(),
            operator: FieldOperator::Contains,
            value: QueryValue::Text(text.into()),
        }))
    }

    /// Create a prefix match query: @field:prefix*
    pub fn prefix(field: impl Into<String>, prefix: impl Into<String>) -> Self {
        Self::new(QueryNode::Field(FieldQuery {
            field: field.into(),
            operator: FieldOperator::Prefix,
            value: QueryValue::Text(prefix.into()),
        }))
    }

    /// Create a fuzzy match query: @field:%value%
    pub fn fuzzy(field: impl Into<String>, text: impl Into<String>) -> Self {
        Self::new(QueryNode::Field(FieldQuery {
            field: field.into(),
            operator: FieldOperator::Fuzzy,
            value: QueryValue::Text(text.into()),
        }))
    }

    /// Create a vector similarity (KNN) search query.
    ///
    /// Returns the k nearest neighbors by vector similarity.
    ///
    /// # Arguments
    /// * `field` - The vector field name (must be indexed with vector_hnsw/vector_flat)
    /// * `vector` - Query embedding vector (must match field dimensionality)
    /// * `k` - Number of nearest neighbors to return
    ///
    /// # Example
    /// ```ignore
    /// let embedding = vec![0.1, 0.2, 0.3, /* ... 1536 dims for OpenAI */];
    /// let query = Query::vector("embedding", embedding, 10);
    /// let results = engine.search("documents", &query).await?;
    /// ```
    pub fn vector(field: impl Into<String>, vector: Vec<f32>, k: usize) -> Self {
        Self::new(QueryNode::Vector(VectorQuery {
            field: field.into(),
            vector,
            k,
        }))
    }

    /// Create a filtered vector search query.
    ///
    /// Combines a filter query with vector KNN search. The filter is applied
    /// first, then KNN is performed on the filtered results.
    ///
    /// # Example
    /// ```ignore
    /// let embedding = get_embedding("semantic search query");
    /// let query = Query::vector_filtered(
    ///     Query::tags("category", vec!["tech".into()]),
    ///     "embedding",
    ///     embedding,
    ///     10
    /// );
    /// ```
    pub fn vector_filtered(
        filter: Query,
        field: impl Into<String>,
        vector: Vec<f32>,
        k: usize,
    ) -> Self {
        // Combine filter with vector search using AND
        // The translator will handle the special KNN syntax
        Self::new(QueryNode::And(vec![
            filter.root,
            QueryNode::Vector(VectorQuery {
                field: field.into(),
                vector,
                k,
            }),
        ]))
    }

    /// Combine with AND
    pub fn and(self, other: Query) -> Self {
        Self::new(QueryNode::And(vec![self.root, other.root]))
    }

    /// Combine with OR
    pub fn or(self, other: Query) -> Self {
        Self::new(QueryNode::Or(vec![self.root, other.root]))
    }

    /// Negate query
    pub fn negate(self) -> Self {
        Self::new(QueryNode::Not(Box::new(self.root)))
    }
}

/// Query AST node
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum QueryNode {
    /// Field query: @field:value
    Field(FieldQuery),
    /// Boolean AND: (query1 query2)
    And(Vec<QueryNode>),
    /// Boolean OR: (query1 | query2)
    Or(Vec<QueryNode>),
    /// Boolean NOT: -query
    Not(Box<QueryNode>),
    /// Vector KNN search: [KNN k @field $blob]
    Vector(VectorQuery),
}

/// Vector similarity search query (KNN)
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct VectorQuery {
    /// Vector field name (e.g., "embedding")
    pub field: String,
    /// Query vector (will be serialized as FLOAT32 blob)
    pub vector: Vec<f32>,
    /// Number of nearest neighbors to return
    pub k: usize,
}

/// Field query
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub struct FieldQuery {
    /// Field name (e.g., "name", "age", "tags")
    pub field: String,
    /// Comparison operator
    pub operator: FieldOperator,
    /// Query value
    pub value: QueryValue,
}

/// Field comparison operator
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum FieldOperator {
    /// Exact match: @field:value
    Equals,
    /// Contains text: @field:*value*
    Contains,
    /// Numeric/date range: @field:[min max]
    Range,
    /// Tag membership: @tags:{value1|value2}
    In,
    /// Prefix match: @field:prefix*
    Prefix,
    /// Fuzzy match: @field:%value%
    Fuzzy,
}

/// Query value type
#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
pub enum QueryValue {
    /// Text value
    Text(String),
    /// Numeric value
    Numeric(f64),
    /// Numeric range [min, max]
    NumericRange { min: Option<f64>, max: Option<f64> },
    /// Tag values (OR semantics)
    Tags(Vec<String>),
    /// Boolean value
    Boolean(bool),
}

/// Builder for complex queries
#[derive(Default)]
pub struct QueryBuilder {
    nodes: Vec<QueryNode>,
}

impl QueryBuilder {
    /// Create a new query builder
    pub fn new() -> Self {
        Self { nodes: Vec::new() }
    }

    /// Add a field equals constraint
    pub fn field_eq(mut self, field: impl Into<String>, value: impl Into<String>) -> Self {
        self.nodes.push(QueryNode::Field(FieldQuery {
            field: field.into(),
            operator: FieldOperator::Equals,
            value: QueryValue::Text(value.into()),
        }));
        self
    }

    /// Add a numeric equals constraint
    pub fn numeric_eq(mut self, field: impl Into<String>, value: f64) -> Self {
        self.nodes.push(QueryNode::Field(FieldQuery {
            field: field.into(),
            operator: FieldOperator::Equals,
            value: QueryValue::Numeric(value),
        }));
        self
    }

    /// Add a numeric range constraint
    pub fn numeric_range(mut self, field: impl Into<String>, min: Option<f64>, max: Option<f64>) -> Self {
        self.nodes.push(QueryNode::Field(FieldQuery {
            field: field.into(),
            operator: FieldOperator::Range,
            value: QueryValue::NumericRange { min, max },
        }));
        self
    }

    /// Add a tag constraint
    pub fn tags(mut self, field: impl Into<String>, values: Vec<String>) -> Self {
        self.nodes.push(QueryNode::Field(FieldQuery {
            field: field.into(),
            operator: FieldOperator::In,
            value: QueryValue::Tags(values),
        }));
        self
    }

    /// Add a contains constraint
    pub fn contains(mut self, field: impl Into<String>, text: impl Into<String>) -> Self {
        self.nodes.push(QueryNode::Field(FieldQuery {
            field: field.into(),
            operator: FieldOperator::Contains,
            value: QueryValue::Text(text.into()),
        }));
        self
    }

    /// Add a prefix constraint
    pub fn prefix(mut self, field: impl Into<String>, prefix: impl Into<String>) -> Self {
        self.nodes.push(QueryNode::Field(FieldQuery {
            field: field.into(),
            operator: FieldOperator::Prefix,
            value: QueryValue::Text(prefix.into()),
        }));
        self
    }

    /// Add a fuzzy constraint
    pub fn fuzzy(mut self, field: impl Into<String>, text: impl Into<String>) -> Self {
        self.nodes.push(QueryNode::Field(FieldQuery {
            field: field.into(),
            operator: FieldOperator::Fuzzy,
            value: QueryValue::Text(text.into()),
        }));
        self
    }

    /// Build query with AND semantics (all constraints must match)
    pub fn build_and(self) -> Query {
        if self.nodes.is_empty() {
            // Empty query matches everything (RediSearch: *)
            Query::new(QueryNode::Field(FieldQuery {
                field: "*".to_string(),
                operator: FieldOperator::Equals,
                value: QueryValue::Text("*".to_string()),
            }))
        } else if self.nodes.len() == 1 {
            Query::new(self.nodes.into_iter().next().unwrap())
        } else {
            Query::new(QueryNode::And(self.nodes))
        }
    }

    /// Build query with OR semantics (any constraint can match)
    pub fn build_or(self) -> Query {
        if self.nodes.is_empty() {
            // Empty query matches everything
            Query::new(QueryNode::Field(FieldQuery {
                field: "*".to_string(),
                operator: FieldOperator::Equals,
                value: QueryValue::Text("*".to_string()),
            }))
        } else if self.nodes.len() == 1 {
            Query::new(self.nodes.into_iter().next().unwrap())
        } else {
            Query::new(QueryNode::Or(self.nodes))
        }
    }
}

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

    #[test]
    fn test_simple_field_query() {
        let query = Query::field_eq("name", "Alice");
        assert_eq!(
            query.root,
            QueryNode::Field(FieldQuery {
                field: "name".to_string(),
                operator: FieldOperator::Equals,
                value: QueryValue::Text("Alice".to_string()),
            })
        );
    }

    #[test]
    fn test_and_query() {
        let query = Query::field_eq("name", "Alice")
            .and(Query::numeric_range("age", Some(25.0), Some(40.0)));

        match query.root {
            QueryNode::And(nodes) => {
                assert_eq!(nodes.len(), 2);
            }
            _ => panic!("Expected And node"),
        }
    }

    #[test]
    fn test_or_query() {
        let query = Query::field_eq("status", "active")
            .or(Query::field_eq("status", "pending"));

        match query.root {
            QueryNode::Or(nodes) => {
                assert_eq!(nodes.len(), 2);
            }
            _ => panic!("Expected Or node"),
        }
    }

    #[test]
    fn test_not_query() {
        let query = Query::field_eq("deleted", "true").negate();

        match query.root {
            QueryNode::Not(_) => {}
            _ => panic!("Expected Not node"),
        }
    }

    #[test]
    fn test_tag_query() {
        let query = Query::tags("tags", vec!["rust".to_string(), "database".to_string()]);

        match query.root {
            QueryNode::Field(FieldQuery { field, operator, value }) => {
                assert_eq!(field, "tags");
                assert_eq!(operator, FieldOperator::In);
                assert_eq!(value, QueryValue::Tags(vec!["rust".to_string(), "database".to_string()]));
            }
            _ => panic!("Expected Field node"),
        }
    }

    #[test]
    fn test_query_builder_and() {
        let query = QueryBuilder::new()
            .field_eq("name", "Alice")
            .numeric_range("age", Some(25.0), Some(40.0))
            .tags("tags", vec!["rust".to_string()])
            .build_and();

        match query.root {
            QueryNode::And(nodes) => {
                assert_eq!(nodes.len(), 3);
            }
            _ => panic!("Expected And node"),
        }
    }

    #[test]
    fn test_query_builder_or() {
        let query = QueryBuilder::new()
            .field_eq("status", "active")
            .field_eq("status", "pending")
            .build_or();

        match query.root {
            QueryNode::Or(nodes) => {
                assert_eq!(nodes.len(), 2);
            }
            _ => panic!("Expected Or node"),
        }
    }

    #[test]
    fn test_complex_query() {
        // (name:Alice AND age:[25 40]) OR (name:Bob AND age:[30 50])
        let alice_query = Query::field_eq("name", "Alice")
            .and(Query::numeric_range("age", Some(25.0), Some(40.0)));

        let bob_query = Query::field_eq("name", "Bob")
            .and(Query::numeric_range("age", Some(30.0), Some(50.0)));

        let query = alice_query.or(bob_query);

        match query.root {
            QueryNode::Or(nodes) => {
                assert_eq!(nodes.len(), 2);
                // Each should be an And node
                for node in nodes {
                    match node {
                        QueryNode::And(inner_nodes) => {
                            assert_eq!(inner_nodes.len(), 2);
                        }
                        _ => panic!("Expected And node"),
                    }
                }
            }
            _ => panic!("Expected Or node"),
        }
    }

    #[test]
    fn test_prefix_query() {
        let query = Query::prefix("email", "admin@");
        match query.root {
            QueryNode::Field(FieldQuery { operator, .. }) => {
                assert_eq!(operator, FieldOperator::Prefix);
            }
            _ => panic!("Expected Field node"),
        }
    }

    #[test]
    fn test_fuzzy_query() {
        let query = Query::fuzzy("name", "alice");
        match query.root {
            QueryNode::Field(FieldQuery { operator, .. }) => {
                assert_eq!(operator, FieldOperator::Fuzzy);
            }
            _ => panic!("Expected Field node"),
        }
    }

    #[test]
    fn test_empty_builder_and() {
        let query = QueryBuilder::new().build_and();
        // Should produce a match-all query
        match query.root {
            QueryNode::Field(FieldQuery { field, .. }) => {
                assert_eq!(field, "*");
            }
            _ => panic!("Expected Field node"),
        }
    }
}