nodedb 0.2.1

Local-first, real-time, edge-to-cloud hybrid database for multi-modal workloads
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
// SPDX-License-Identifier: BUSL-1.1

//! CDC event router: matches WriteEvents to registered change streams.
//!
//! For each WriteEvent, finds all matching change streams (by tenant,
//! collection, and operation filter), formats the event as a CdcEvent,
//! and pushes it into the stream's retention buffer.

use std::collections::HashMap;
use std::sync::Arc;
use std::time::{SystemTime, UNIX_EPOCH};

use sonic_rs;
use tracing::trace;

use super::buffer::StreamBuffer;
use super::event::CdcEvent;
use super::lag_warner::{CdcLagWarner, DEFAULT_THRESHOLD};
use super::registry::StreamRegistry;
use super::stream_def::LateDataPolicy;
use crate::control::metrics::system::SystemMetrics;
use crate::event::types::WriteEvent;
use crate::event::watermark_tracker::WatermarkTracker;

/// Manages per-stream buffers and routes events to matching streams.
pub struct CdcRouter {
    /// Stream registry (shared with DDL handlers).
    registry: Arc<StreamRegistry>,
    /// Per-stream retention buffers, keyed by `(tenant_id, stream_name)`.
    buffers: std::sync::RwLock<HashMap<(u64, String), Arc<StreamBuffer>>>,
    /// Per-stream drop rate tracker — emits `warn!` when threshold is crossed.
    lag_warner: CdcLagWarner,
    /// System metrics for per-stream Prometheus counters. `None` in unit tests
    /// that construct a router without a full metrics registry.
    metrics: Option<Arc<SystemMetrics>>,
}

impl CdcRouter {
    pub fn new(registry: Arc<StreamRegistry>) -> Self {
        Self {
            registry,
            buffers: std::sync::RwLock::new(HashMap::new()),
            lag_warner: CdcLagWarner::new(DEFAULT_THRESHOLD),
            metrics: None,
        }
    }

    /// Attach system metrics so the router can update
    /// `nodedb_cdc_events_dropped_total{tenant, stream}` on each eviction.
    pub fn with_metrics(mut self, metrics: Arc<SystemMetrics>) -> Self {
        self.metrics = Some(metrics);
        self
    }

    /// Route a WriteEvent to all matching change streams.
    ///
    /// Called from the Event Plane consumer for every event (after trigger dispatch).
    /// `watermark_tracker` is used to enforce late-data policies.
    pub fn route_event(&self, event: &WriteEvent, watermark_tracker: &WatermarkTracker) {
        let matching = self
            .registry
            .find_matching(event.tenant_id.as_u64(), &event.collection);

        if matching.is_empty() {
            return;
        }

        let op_str = event.op.to_string();
        let now_ms = SystemTime::now()
            .duration_since(UNIX_EPOCH)
            .unwrap_or_default()
            .as_millis() as u64;

        // Deserialize row data once (shared across all matching streams).
        let new_value = event
            .new_value
            .as_ref()
            .and_then(|v| deserialize_to_json(v));
        let old_value = event
            .old_value
            .as_ref()
            .and_then(|v| deserialize_to_json(v));

        // Compute the UPDATE field diffs once per WriteEvent (shared across fan-out).
        let field_diffs = if op_str == "UPDATE" {
            match (&old_value, &new_value) {
                (Some(old), Some(new)) => {
                    let diffs = crate::event::field_diff::compute_field_diffs(old, new);
                    if diffs.is_empty() { None } else { Some(diffs) }
                }
                _ => None,
            }
        } else {
            None
        };

        // Build the CdcEvent once and share the same Arc across every matching
        // stream. Fan-out to N streams becomes N refcount bumps, not N deep
        // copies of the payload + diffs.
        let cdc_event = Arc::new(CdcEvent {
            sequence: event.sequence,
            partition: event.vshard_id.as_u32(),
            collection: event.collection.to_string(),
            op: op_str.clone(),
            row_id: event.row_id.as_str().to_string(),
            event_time: now_ms,
            lsn: event.lsn.as_u64(),
            tenant_id: event.tenant_id.as_u64(),
            new_value: new_value.clone(),
            old_value: old_value.clone(),
            schema_version: 0,
            field_diffs,
            system_time_ms: event.system_time_ms,
            valid_time_ms: event.valid_time_ms,
        });

        // RECOMPUTE correction (only built if any stream actually needs it).
        let mut recompute: Option<Arc<CdcEvent>> = None;

        for def in &matching {
            if !def.op_filter.matches(&op_str) {
                continue;
            }

            let partition_wm = watermark_tracker.partition_watermark(event.vshard_id.as_u32());
            let is_late = event.lsn.as_u64() <= partition_wm && partition_wm > 0;

            if is_late {
                match def.late_data {
                    LateDataPolicy::Drop => {
                        trace!(
                            stream = %def.name,
                            lsn = event.lsn.as_u64(),
                            watermark = partition_wm,
                            "late event dropped by LATE_DATA = DROP policy"
                        );
                        continue;
                    }
                    LateDataPolicy::Allow => {}
                    LateDataPolicy::Recompute => {}
                }
            }

            let buffer = self.get_or_create_buffer(def.tenant_id, &def.name, &def.retention);
            let evictions = buffer.push(Arc::clone(&cdc_event));
            if evictions > 0 {
                let oldest_lsn = buffer.earliest_lsn().unwrap_or(0);
                self.lag_warner
                    .record_drops(def.tenant_id, &def.name, evictions, oldest_lsn);
                if let Some(m) = &self.metrics {
                    m.record_cdc_stream_drop(def.tenant_id, &def.name, evictions);
                }
            }

            if is_late && def.late_data == LateDataPolicy::Recompute {
                let correction = recompute
                    .get_or_insert_with(|| {
                        Arc::new(CdcEvent {
                            sequence: event.sequence,
                            partition: event.vshard_id.as_u32(),
                            collection: event.collection.to_string(),
                            op: "RECOMPUTE".to_string(),
                            row_id: event.row_id.as_str().to_string(),
                            event_time: now_ms,
                            lsn: event.lsn.as_u64(),
                            tenant_id: event.tenant_id.as_u64(),
                            new_value: new_value.clone(),
                            old_value: None,
                            schema_version: 0,
                            field_diffs: None,
                            system_time_ms: event.system_time_ms,
                            valid_time_ms: event.valid_time_ms,
                        })
                    })
                    .clone();
                let correction_evictions = buffer.push(correction);
                if correction_evictions > 0 {
                    let oldest_lsn = buffer.earliest_lsn().unwrap_or(0);
                    self.lag_warner.record_drops(
                        def.tenant_id,
                        &def.name,
                        correction_evictions,
                        oldest_lsn,
                    );
                    if let Some(m) = &self.metrics {
                        m.record_cdc_stream_drop(def.tenant_id, &def.name, correction_evictions);
                    }
                }
                trace!(
                    stream = %def.name,
                    lsn = event.lsn.as_u64(),
                    "RECOMPUTE correction emitted for late event"
                );
            }

            trace!(
                stream = %def.name,
                collection = %event.collection,
                op = %op_str,
                lsn = event.lsn.as_u64(),
                "CDC event routed"
            );
        }
    }

    /// Get or create a buffer for a stream.
    fn get_or_create_buffer(
        &self,
        tenant_id: u64,
        stream_name: &str,
        retention: &super::stream_def::RetentionConfig,
    ) -> Arc<StreamBuffer> {
        let key = (tenant_id, stream_name.to_string());

        // Fast path: read lock.
        {
            let buffers = self.buffers.read().unwrap_or_else(|p| p.into_inner());
            if let Some(buf) = buffers.get(&key) {
                return Arc::clone(buf);
            }
        }

        // Slow path: write lock + create.
        let mut buffers = self.buffers.write().unwrap_or_else(|p| p.into_inner());
        buffers
            .entry(key)
            .or_insert_with(|| {
                Arc::new(StreamBuffer::new(
                    stream_name.to_string(),
                    retention.clone(),
                ))
            })
            .clone()
    }

    /// Ensure a buffer exists for a given key (stream or topic). Creates if missing.
    pub fn ensure_buffer(
        &self,
        tenant_id: u64,
        name: &str,
        retention: &super::stream_def::RetentionConfig,
    ) -> Arc<StreamBuffer> {
        self.get_or_create_buffer(tenant_id, name, retention)
    }

    /// Get a buffer for a stream (if it exists). Used by consumers to poll events.
    pub fn get_buffer(&self, tenant_id: u64, stream_name: &str) -> Option<Arc<StreamBuffer>> {
        let key = (tenant_id, stream_name.to_string());
        let buffers = self.buffers.read().unwrap_or_else(|p| p.into_inner());
        buffers.get(&key).cloned()
    }

    /// Remove a buffer when a stream is dropped.
    pub fn remove_buffer(&self, tenant_id: u64, stream_name: &str) {
        let key = (tenant_id, stream_name.to_string());
        let mut buffers = self.buffers.write().unwrap_or_else(|p| p.into_inner());
        buffers.remove(&key);
        self.lag_warner.remove_stream(tenant_id, stream_name);
    }

    /// Snapshot of all buffer stats (for SHOW CHANGE STREAMS).
    pub fn buffer_stats(&self) -> Vec<BufferStats> {
        let buffers = self.buffers.read().unwrap_or_else(|p| p.into_inner());
        buffers
            .iter()
            .map(|((tid, name), buf)| BufferStats {
                tenant_id: *tid,
                stream_name: name.clone(),
                buffered_events: buf.len(),
                total_pushed: buf.total_pushed(),
                total_evicted: buf.total_evicted(),
                earliest_lsn: buf.earliest_lsn(),
                latest_lsn: buf.latest_lsn(),
            })
            .collect()
    }
}

/// Buffer statistics for observability.
pub struct BufferStats {
    pub tenant_id: u64,
    pub stream_name: String,
    pub buffered_events: usize,
    pub total_pushed: u64,
    pub total_evicted: u64,
    pub earliest_lsn: Option<u64>,
    pub latest_lsn: Option<u64>,
}

/// Deserialize bytes (MessagePack or JSON) to serde_json::Value.
fn deserialize_to_json(bytes: &[u8]) -> Option<serde_json::Value> {
    nodedb_types::json_from_msgpack(bytes)
        .ok()
        .or_else(|| sonic_rs::from_slice::<serde_json::Value>(bytes).ok())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::event::cdc::stream_def::*;
    use crate::event::types::{EventSource, RowId, WriteOp};
    use crate::event::watermark_tracker::WatermarkTracker;
    use crate::types::{Lsn, TenantId, VShardId};

    fn test_tracker() -> WatermarkTracker {
        WatermarkTracker::new()
    }

    fn make_write_event(collection: &str, seq: u64) -> WriteEvent {
        WriteEvent {
            sequence: seq,
            collection: Arc::from(collection),
            op: WriteOp::Insert,
            row_id: RowId::new(format!("row-{seq}")),
            lsn: Lsn::new(seq * 10),
            tenant_id: TenantId::new(1),
            vshard_id: VShardId::new(0),
            source: EventSource::User,
            new_value: Some(Arc::from(
                serde_json::to_vec(&serde_json::json!({"id": seq}))
                    .unwrap()
                    .as_slice(),
            )),
            old_value: None,
            system_time_ms: None,
            valid_time_ms: None,
            user_id: None,
            statement_digest: None,
        }
    }

    fn sample_def(name: &str, collection: &str) -> ChangeStreamDef {
        ChangeStreamDef {
            tenant_id: 1,
            name: name.into(),
            collection: collection.into(),
            op_filter: OpFilter::all(),
            format: StreamFormat::Json,
            retention: RetentionConfig {
                max_events: 1000,
                max_age_secs: 3600,
            },
            compaction: CompactionConfig::default(),
            webhook: crate::event::webhook::WebhookConfig::default(),
            late_data: LateDataPolicy::default(),
            kafka: crate::event::kafka::KafkaDeliveryConfig::default(),
            owner: "admin".into(),
            created_at: 0,
        }
    }

    #[test]
    fn routes_to_matching_stream() {
        let registry = Arc::new(StreamRegistry::new());
        registry.register(sample_def("orders_stream", "orders"));
        let router = CdcRouter::new(registry);

        let wt = test_tracker();
        router.route_event(&make_write_event("orders", 1), &wt);

        let buf = router.get_buffer(1, "orders_stream").unwrap();
        assert_eq!(buf.len(), 1);
        let events = buf.read_from_lsn(0, 10);
        assert_eq!(events[0].collection, "orders");
    }

    #[test]
    fn skips_unmatched_collection() {
        let registry = Arc::new(StreamRegistry::new());
        registry.register(sample_def("orders_stream", "orders"));
        let router = CdcRouter::new(registry);

        let wt = test_tracker();
        router.route_event(&make_write_event("users", 1), &wt);

        assert!(router.get_buffer(1, "orders_stream").is_none());
    }

    #[test]
    fn wildcard_catches_all() {
        let registry = Arc::new(StreamRegistry::new());
        registry.register(sample_def("all_changes", "*"));
        let router = CdcRouter::new(registry);

        let wt = test_tracker();
        router.route_event(&make_write_event("orders", 1), &wt);
        router.route_event(&make_write_event("users", 2), &wt);

        let buf = router.get_buffer(1, "all_changes").unwrap();
        assert_eq!(buf.len(), 2);
    }

    #[test]
    fn op_filter_skips_non_matching() {
        let registry = Arc::new(StreamRegistry::new());
        let mut def = sample_def("inserts_only", "orders");
        def.op_filter = OpFilter {
            insert: true,
            update: false,
            delete: false,
        };
        registry.register(def);
        let router = CdcRouter::new(registry);

        let wt = test_tracker();
        // Insert matches.
        router.route_event(&make_write_event("orders", 1), &wt);

        // DELETE does not match.
        let delete_event = WriteEvent {
            op: WriteOp::Delete,
            ..make_write_event("orders", 2)
        };
        router.route_event(&delete_event, &wt);

        let buf = router.get_buffer(1, "inserts_only").unwrap();
        assert_eq!(buf.len(), 1); // Only the insert.
    }

    #[test]
    fn remove_buffer_on_drop() {
        let registry = Arc::new(StreamRegistry::new());
        registry.register(sample_def("s1", "orders"));
        let router = CdcRouter::new(registry);

        let wt = test_tracker();
        router.route_event(&make_write_event("orders", 1), &wt);
        assert!(router.get_buffer(1, "s1").is_some());

        router.remove_buffer(1, "s1");
        assert!(router.get_buffer(1, "s1").is_none());
    }
}