quelch 0.12.0

Ingest data from Jira, Confluence, and more directly into Azure AI Search
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

//! Deletion reconciliation.
//!
//! Compares the set of IDs in the source against the set in Cosmos, then
//! soft-deletes (`_deleted = true`) any document that exists in Cosmos but
//! not in the source.
//!
//! See `docs/sync.md` — "Deletions".

use std::collections::HashSet;

use chrono::Utc;
use serde_json::Value;

use crate::{
    cosmos::meta::CursorKey,
    cosmos::{CosmosBackend, meta},
    ingest::config::CycleConfig,
    sources::SourceConnector,
};

// ---------------------------------------------------------------------------
// Public API
// ---------------------------------------------------------------------------

/// Run one reconciliation pass for `(key.source_name, key.subsource)`.
///
/// Returns the number of documents that were newly soft-deleted, or an error
/// string on failure.
pub async fn run<C>(
    connector: &C,
    cosmos: &dyn CosmosBackend,
    key: &CursorKey,
    cfg: &CycleConfig,
) -> Result<u64, String>
where
    C: SourceConnector,
{
    // Collect all IDs currently visible in the source.
    let source_ids: HashSet<String> = match connector.list_all_ids(&key.subsource).await {
        Ok(ids) => ids.into_iter().collect(),
        Err(e) => return Err(format!("list_all_ids: {e}")),
    };

    // Collect all IDs currently in Cosmos for this subsource.
    let cosmos_ids =
        match list_cosmos_ids(cosmos, connector.primary_container(), &key.subsource).await {
            Ok(ids) => ids,
            Err(e) => return Err(format!("list cosmos ids: {e}")),
        };

    let now = Utc::now();
    let mut deleted = 0u64;

    for row in &cosmos_ids {
        if source_ids.contains(&row.id) || row.already_deleted {
            // Still in source, or already soft-deleted — nothing to do.
            continue;
        }

        // Read the existing doc, stamp it, and re-upsert.
        let doc = match cosmos
            .get(connector.primary_container(), &row.id, &row.partition_key)
            .await
        {
            Ok(Some(d)) => d,
            Ok(None) => continue, // race — doc was removed before we got here
            Err(e) => return Err(format!("get doc '{}': {e}", row.id)),
        };

        let mut doc = doc;
        if let Some(obj) = doc.as_object_mut() {
            obj.insert("_deleted".into(), Value::Bool(true));
            obj.insert("_deleted_at".into(), now.to_rfc3339().into());
        }

        if let Err(e) = cosmos.upsert(connector.primary_container(), doc).await {
            return Err(format!("mark deleted '{}': {e}", row.id));
        }

        deleted += 1;
    }

    // Update cursor with reconciliation metadata. Failures are non-fatal: the
    // soft-deletes already landed in Cosmos, but we want a record of when the
    // reconciliation last ran so the operator dashboard reflects it.
    let mut cursor = meta::load(cosmos, &cfg.meta_container, key)
        .await
        .unwrap_or_default();
    cursor.last_reconciliation_at = Some(now);
    cursor.last_reconciliation_deleted = deleted;
    if let Err(e) = meta::save(cosmos, &cfg.meta_container, key, &cursor).await {
        tracing::warn!(
            error = %e,
            key = %key.id(),
            "could not persist reconciliation cursor metadata"
        );
    }

    Ok(deleted)
}

// ---------------------------------------------------------------------------
// Internal helpers
// ---------------------------------------------------------------------------

/// A row returned by `list_cosmos_ids`.
struct CosmosIdRow {
    id: String,
    partition_key: String,
    already_deleted: bool,
}

/// List every `(id, partition_key, already_deleted)` triple in `container`
/// whose `_partition_key` equals `subsource`.
async fn list_cosmos_ids(
    cosmos: &dyn CosmosBackend,
    container: &str,
    subsource: &str,
) -> Result<Vec<CosmosIdRow>, String> {
    let sql = "SELECT * FROM c WHERE c._partition_key = @pk".to_string();
    let params = vec![("@pk".into(), subsource.into())];
    let mut stream = cosmos
        .query(container, &sql, params)
        .await
        .map_err(|e| format!("query: {e}"))?;

    let mut out = Vec::new();
    while let Some(page) = stream.next_page().await.map_err(|e| format!("page: {e}"))? {
        for doc in page {
            if let Some(obj) = doc.as_object() {
                let id = obj
                    .get("id")
                    .and_then(Value::as_str)
                    .unwrap_or("")
                    .to_string();
                let pk = obj
                    .get("_partition_key")
                    .and_then(Value::as_str)
                    .unwrap_or("")
                    .to_string();
                let already_deleted = obj
                    .get("_deleted")
                    .and_then(Value::as_bool)
                    .unwrap_or(false);
                out.push(CosmosIdRow {
                    id,
                    partition_key: pk,
                    already_deleted,
                });
            }
        }
    }
    Ok(out)
}

// ---------------------------------------------------------------------------
// Tests
// ---------------------------------------------------------------------------

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

    use crate::{
        cosmos::{CosmosBackend, InMemoryCosmos, meta::CursorKey},
        ingest::{config::CycleConfig, test_helpers::MockConnector},
    };

    fn make_key() -> CursorKey {
        CursorKey {
            source_name: "mock".into(),
            subsource: "DO".into(),
        }
    }

    /// Insert a document with the given id into the primary container.
    async fn insert_doc(cosmos: &InMemoryCosmos, container: &str, id: &str, pk: &str) {
        let doc = json!({
            "id": id,
            "_partition_key": pk,
            "title": format!("Doc {id}"),
        });
        cosmos.upsert(container, doc).await.unwrap();
    }

    /// Insert an already-soft-deleted document.
    async fn insert_deleted_doc(cosmos: &InMemoryCosmos, container: &str, id: &str, pk: &str) {
        let doc = json!({
            "id": id,
            "_partition_key": pk,
            "title": format!("Deleted {id}"),
            "_deleted": true,
            "_deleted_at": "2024-01-01T00:00:00Z",
        });
        cosmos.upsert(container, doc).await.unwrap();
    }

    // -------------------------------------------------------------------------
    // reconcile_marks_missing_docs_deleted
    // -------------------------------------------------------------------------
    #[tokio::test]
    async fn reconcile_marks_missing_docs_deleted() {
        let cosmos = InMemoryCosmos::new();
        let key = make_key();

        // Pre-populate: A, B, C in Cosmos.
        insert_doc(&cosmos, "jira-issues", "A", "DO").await;
        insert_doc(&cosmos, "jira-issues", "B", "DO").await;
        insert_doc(&cosmos, "jira-issues", "C", "DO").await;

        // Source only has A and C → B is missing.
        let connector = MockConnector::new("mock", "jira-issues");
        connector.set_list_ids(vec!["A".into(), "C".into()]);

        let cfg = CycleConfig::default();
        let deleted = run(&connector, &cosmos, &key, &cfg).await.unwrap();

        assert_eq!(deleted, 1, "expected 1 doc marked deleted");

        // B must be soft-deleted.
        let b = cosmos.get("jira-issues", "B", "DO").await.unwrap().unwrap();
        assert_eq!(b["_deleted"], json!(true));
        assert!(b.get("_deleted_at").is_some());

        // A and C must be untouched.
        let a = cosmos.get("jira-issues", "A", "DO").await.unwrap().unwrap();
        assert!(a.get("_deleted").is_none() || a["_deleted"] != json!(true));
        let c = cosmos.get("jira-issues", "C", "DO").await.unwrap().unwrap();
        assert!(c.get("_deleted").is_none() || c["_deleted"] != json!(true));
    }

    // -------------------------------------------------------------------------
    // reconcile_does_not_touch_already_deleted_docs
    // -------------------------------------------------------------------------
    #[tokio::test]
    async fn reconcile_does_not_touch_already_deleted_docs() {
        let cosmos = InMemoryCosmos::new();
        let key = make_key();

        // B is already soft-deleted.
        insert_doc(&cosmos, "jira-issues", "A", "DO").await;
        insert_deleted_doc(&cosmos, "jira-issues", "B", "DO").await;

        // Source only has A — B is absent but already marked deleted.
        let connector = MockConnector::new("mock", "jira-issues");
        connector.set_list_ids(vec!["A".into()]);

        let cfg = CycleConfig::default();
        let deleted = run(&connector, &cosmos, &key, &cfg).await.unwrap();

        // B was already deleted, so reconcile should not count it again.
        assert_eq!(
            deleted, 0,
            "expected 0 new deletions — B was already deleted"
        );
    }

    // -------------------------------------------------------------------------
    // reconcile_updates_cursor_state
    // -------------------------------------------------------------------------
    #[tokio::test]
    async fn reconcile_updates_cursor_state() {
        let cosmos = InMemoryCosmos::new();
        let key = make_key();

        insert_doc(&cosmos, "jira-issues", "X", "DO").await;
        insert_doc(&cosmos, "jira-issues", "Y", "DO").await;

        let connector = MockConnector::new("mock", "jira-issues");
        // X is gone.
        connector.set_list_ids(vec!["Y".into()]);

        let cfg = CycleConfig::default();
        let deleted = run(&connector, &cosmos, &key, &cfg).await.unwrap();
        assert_eq!(deleted, 1);

        // Cursor state must be updated.
        let cursor = meta::load(&cosmos, "quelch-meta", &key).await.unwrap();
        assert!(
            cursor.last_reconciliation_at.is_some(),
            "last_reconciliation_at must be set"
        );
        assert_eq!(
            cursor.last_reconciliation_deleted, 1,
            "last_reconciliation_deleted must be 1"
        );
    }

    // -------------------------------------------------------------------------
    // reconcile_empty_source_deletes_all
    // -------------------------------------------------------------------------
    #[tokio::test]
    async fn reconcile_empty_source_deletes_all() {
        let cosmos = InMemoryCosmos::new();
        let key = make_key();

        insert_doc(&cosmos, "jira-issues", "P", "DO").await;
        insert_doc(&cosmos, "jira-issues", "Q", "DO").await;

        let connector = MockConnector::new("mock", "jira-issues");
        connector.set_list_ids(vec![]); // source has nothing

        let cfg = CycleConfig::default();
        let deleted = run(&connector, &cosmos, &key, &cfg).await.unwrap();
        assert_eq!(deleted, 2);
    }

    // -------------------------------------------------------------------------
    // reconcile_no_op_when_cosmos_empty
    // -------------------------------------------------------------------------
    #[tokio::test]
    async fn reconcile_no_op_when_cosmos_empty() {
        let cosmos = InMemoryCosmos::new();
        let key = make_key();

        let connector = MockConnector::new("mock", "jira-issues");
        connector.set_list_ids(vec!["A".into()]);

        let cfg = CycleConfig::default();
        let deleted = run(&connector, &cosmos, &key, &cfg).await.unwrap();
        assert_eq!(deleted, 0);
    }
}