dlin-core 0.2.0-beta.1

Core library for dbt model lineage analysis
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
use std::collections::{HashMap, HashSet, VecDeque};

use path_slash::PathExt as _;
use petgraph::Direction;
use petgraph::stable_graph::NodeIndex;
use petgraph::visit::EdgeRef;
use serde::Serialize;

use super::types::*;

/// Severity level of impact
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Serialize)]
#[serde(rename_all = "lowercase")]
pub enum ImpactSeverity {
    Low,
    Medium,
    High,
    Critical,
}

impl ImpactSeverity {
    pub fn label(&self) -> &'static str {
        match self {
            ImpactSeverity::Low => "low",
            ImpactSeverity::Medium => "medium",
            ImpactSeverity::High => "high",
            ImpactSeverity::Critical => "critical",
        }
    }
}

/// Path from source model to an exposure
#[derive(Debug, Clone, Serialize)]
pub struct ExposurePath {
    pub exposure: String,
    pub path: Vec<String>,
}

/// A single impacted node with its severity
#[derive(Debug, Clone, Serialize)]
pub struct ImpactedNode {
    pub unique_id: String,
    pub label: String,
    pub node_type: String,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file_path: Option<String>,
    pub severity: ImpactSeverity,
    /// Number of edges from the source model (also known as "degree" in dbt terminology)
    pub distance: usize,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sql_content: Option<String>,
}

/// Full impact analysis report
#[derive(Debug, Clone, Serialize)]
pub struct ImpactReport {
    pub source_model: String,
    pub overall_severity: ImpactSeverity,
    pub affected_models: usize,
    pub affected_tests: usize,
    pub affected_exposures: usize,
    pub exposure_paths: Vec<ExposurePath>,
    /// True if any exposure had more paths than the enumeration cap
    pub exposure_paths_truncated: bool,
    pub impacted_nodes: Vec<ImpactedNode>,
}

/// Classify the severity of a single node
pub fn classify_severity(node: &NodeData) -> ImpactSeverity {
    match node.node_type {
        NodeType::Exposure => ImpactSeverity::Critical,
        NodeType::Test => ImpactSeverity::Low,
        NodeType::Model => {
            // Check for mart-like indicators
            let is_mart = node
                .materialization
                .as_deref()
                .is_some_and(|m| m == "table" || m == "incremental")
                || node
                    .file_path
                    .as_ref()
                    .is_some_and(|p| p.to_string_lossy().contains("mart"));

            if is_mart {
                return ImpactSeverity::High;
            }

            ImpactSeverity::Medium
        }
        _ => ImpactSeverity::Medium,
    }
}

/// Compute the full impact report for a given model
pub fn compute_impact(graph: &LineageGraph, source_idx: NodeIndex) -> ImpactReport {
    let source_node = &graph[source_idx];
    let source_model = source_node.label.clone();

    // BFS downstream to find all impacted nodes with distances
    let mut visited: HashSet<NodeIndex> = HashSet::new();
    let mut queue: VecDeque<(NodeIndex, usize)> = VecDeque::new();
    visited.insert(source_idx);
    queue.push_back((source_idx, 0));

    let mut impacted_nodes: Vec<ImpactedNode> = Vec::new();
    let mut affected_models = 0usize;
    let mut affected_tests = 0usize;
    let mut affected_exposures = 0usize;
    let mut exposure_indices: Vec<NodeIndex> = Vec::new();

    while let Some((current, distance)) = queue.pop_front() {
        for edge in graph.edges_directed(current, Direction::Outgoing) {
            let neighbor = edge.target();
            if visited.insert(neighbor) {
                let node = &graph[neighbor];
                let severity = classify_severity(node);
                let next_distance = distance + 1;

                match node.node_type {
                    NodeType::Model => affected_models += 1,
                    NodeType::Test => affected_tests += 1,
                    NodeType::Exposure => {
                        affected_exposures += 1;
                        exposure_indices.push(neighbor);
                    }
                    _ => {}
                }

                impacted_nodes.push(ImpactedNode {
                    unique_id: node.unique_id.clone(),
                    label: node.label.clone(),
                    node_type: node.node_type.label().to_string(),
                    file_path: node
                        .file_path
                        .as_ref()
                        .map(|p| p.to_slash_lossy().into_owned()),
                    severity,
                    distance: next_distance,
                    sql_content: None,
                });

                queue.push_back((neighbor, next_distance));
            }
        }
    }

    // Find all simple paths to exposures via single DFS (capped per exposure)
    const MAX_PATHS_PER_EXPOSURE: usize = 10;
    let exposure_set: HashSet<NodeIndex> = exposure_indices.iter().copied().collect();
    let mut exposure_paths: Vec<ExposurePath> = Vec::new();
    let mut path_counts: HashMap<NodeIndex, usize> = HashMap::new();

    if !exposure_set.is_empty() {
        let mut stack: Vec<(NodeIndex, Vec<NodeIndex>, HashSet<NodeIndex>)> =
            vec![(source_idx, vec![source_idx], HashSet::from([source_idx]))];
        while let Some((current, path, path_set)) = stack.pop() {
            // Early termination: stop when all exposures have reached the cap
            if path_counts.len() == exposure_set.len()
                && path_counts.values().all(|&c| c >= MAX_PATHS_PER_EXPOSURE)
            {
                break;
            }
            if exposure_set.contains(&current) {
                let count = path_counts.entry(current).or_insert(0);
                if *count < MAX_PATHS_PER_EXPOSURE {
                    *count += 1;
                    exposure_paths.push(ExposurePath {
                        exposure: graph[current].label.clone(),
                        path: path.iter().map(|&idx| graph[idx].label.clone()).collect(),
                    });
                }
                // Exposures are leaf nodes in dbt; don't traverse beyond them
                continue;
            }
            for edge in graph.edges_directed(current, Direction::Outgoing) {
                let neighbor = edge.target();
                if !path_set.contains(&neighbor) {
                    let mut new_path = path.clone();
                    new_path.push(neighbor);
                    let mut new_set = path_set.clone();
                    new_set.insert(neighbor);
                    stack.push((neighbor, new_path, new_set));
                }
            }
        }
    }
    let exposure_paths_truncated = path_counts
        .values()
        .any(|&count| count >= MAX_PATHS_PER_EXPOSURE);
    exposure_paths.sort_by(|a, b| a.exposure.cmp(&b.exposure).then(a.path.cmp(&b.path)));

    // Sort by severity (descending), then distance
    impacted_nodes.sort_by(|a, b| {
        b.severity
            .cmp(&a.severity)
            .then(a.distance.cmp(&b.distance))
    });

    let overall_severity = impacted_nodes
        .iter()
        .map(|n| n.severity)
        .max()
        .unwrap_or(ImpactSeverity::Low);

    ImpactReport {
        source_model,
        overall_severity,
        affected_models,
        affected_tests,
        affected_exposures,
        exposure_paths,
        exposure_paths_truncated,
        impacted_nodes,
    }
}

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

    fn make_node(
        unique_id: &str,
        label: &str,
        node_type: NodeType,
        materialization: Option<&str>,
        file_path: Option<&str>,
    ) -> NodeData {
        NodeData {
            unique_id: unique_id.into(),
            label: label.into(),
            node_type,
            file_path: file_path.map(PathBuf::from),
            description: None,
            materialization: materialization.map(|s| s.to_string()),
            tags: vec![],
            columns: vec![],
            exposure: None,
        }
    }

    fn make_test_graph() -> (LineageGraph, NodeIndex) {
        let mut g = LineageGraph::new();
        let src = g.add_node(make_node(
            "source.raw.orders",
            "raw.orders",
            NodeType::Source,
            None,
            None,
        ));
        let stg = g.add_node(make_node(
            "model.stg_orders",
            "stg_orders",
            NodeType::Model,
            Some("view"),
            Some("models/staging/stg_orders.sql"),
        ));
        let mart = g.add_node(make_node(
            "model.orders",
            "orders",
            NodeType::Model,
            Some("table"),
            Some("models/marts/orders.sql"),
        ));
        let test = g.add_node(make_node(
            "test.orders_positive",
            "orders_positive",
            NodeType::Test,
            None,
            None,
        ));
        let exp = g.add_node(make_node(
            "exposure.dashboard",
            "dashboard",
            NodeType::Exposure,
            None,
            None,
        ));

        g.add_edge(src, stg, EdgeData::direct(EdgeType::Source));
        g.add_edge(stg, mart, EdgeData::direct(EdgeType::Ref));
        g.add_edge(mart, test, EdgeData::direct(EdgeType::Test));
        g.add_edge(mart, exp, EdgeData::direct(EdgeType::Exposure));

        (g, stg)
    }

    #[test]
    fn test_classify_severity_exposure() {
        let node = make_node("exposure.x", "x", NodeType::Exposure, None, None);
        assert_eq!(classify_severity(&node), ImpactSeverity::Critical);
    }

    #[test]
    fn test_classify_severity_test() {
        let node = make_node("test.x", "x", NodeType::Test, None, None);
        assert_eq!(classify_severity(&node), ImpactSeverity::Low);
    }

    #[test]
    fn test_classify_severity_mart_table() {
        let node = make_node(
            "model.orders",
            "orders",
            NodeType::Model,
            Some("table"),
            None,
        );
        assert_eq!(classify_severity(&node), ImpactSeverity::High);
    }

    #[test]
    fn test_classify_severity_mart_incremental() {
        let node = make_node(
            "model.orders",
            "orders",
            NodeType::Model,
            Some("incremental"),
            None,
        );
        assert_eq!(classify_severity(&node), ImpactSeverity::High);
    }

    #[test]
    fn test_classify_severity_mart_path() {
        let node = make_node(
            "model.orders",
            "orders",
            NodeType::Model,
            None,
            Some("models/marts/orders.sql"),
        );
        assert_eq!(classify_severity(&node), ImpactSeverity::High);
    }

    #[test]
    fn test_classify_severity_staging() {
        let node = make_node(
            "model.stg_orders",
            "stg_orders",
            NodeType::Model,
            Some("view"),
            Some("models/staging/stg_orders.sql"),
        );
        assert_eq!(classify_severity(&node), ImpactSeverity::Medium);
    }

    #[test]
    fn test_compute_impact() {
        let (g, stg) = make_test_graph();
        let report = compute_impact(&g, stg);

        assert_eq!(report.source_model, "stg_orders");
        assert_eq!(report.affected_models, 1); // orders
        assert_eq!(report.affected_tests, 1); // orders_positive
        assert_eq!(report.affected_exposures, 1); // dashboard
        assert_eq!(report.overall_severity, ImpactSeverity::Critical);
        assert_eq!(report.impacted_nodes.len(), 3);

        // Exposure path: stg_orders -> orders -> dashboard
        assert_eq!(report.exposure_paths.len(), 1);
        assert_eq!(report.exposure_paths[0].exposure, "dashboard");
        assert_eq!(
            report.exposure_paths[0].path,
            vec!["stg_orders", "orders", "dashboard"]
        );
    }

    #[test]
    fn test_compute_impact_leaf_node() {
        let (g, _) = make_test_graph();
        let exp = g
            .node_indices()
            .find(|&i| g[i].label == "dashboard")
            .unwrap();
        let report = compute_impact(&g, exp);

        assert_eq!(report.source_model, "dashboard");
        assert_eq!(report.affected_models, 0);
        assert_eq!(report.affected_tests, 0);
        assert_eq!(report.affected_exposures, 0);
        assert!(report.impacted_nodes.is_empty());
        assert!(report.exposure_paths.is_empty());
    }

    #[test]
    fn test_impact_severity_ordering() {
        assert!(ImpactSeverity::Low < ImpactSeverity::Medium);
        assert!(ImpactSeverity::Medium < ImpactSeverity::High);
        assert!(ImpactSeverity::High < ImpactSeverity::Critical);
    }

    #[test]
    fn test_impact_isolated_node() {
        let mut g = LineageGraph::new();
        let n = g.add_node(make_node("model.x", "x", NodeType::Model, None, None));
        let report = compute_impact(&g, n);
        assert_eq!(report.affected_models, 0);
        assert_eq!(report.affected_tests, 0);
        assert_eq!(report.affected_exposures, 0);
        assert!(report.impacted_nodes.is_empty());
    }

    #[test]
    fn test_exposure_paths_multiple_exposures() {
        // Diamond graph: src -> A -> exp1, src -> B -> exp2
        let mut g = LineageGraph::new();
        let src = g.add_node(make_node(
            "model.src",
            "src",
            NodeType::Model,
            Some("view"),
            None,
        ));
        let a = g.add_node(make_node(
            "model.a",
            "a",
            NodeType::Model,
            Some("view"),
            None,
        ));
        let b = g.add_node(make_node(
            "model.b",
            "b",
            NodeType::Model,
            Some("view"),
            None,
        ));
        let exp1 = g.add_node(make_node(
            "exposure.dashboard",
            "dashboard",
            NodeType::Exposure,
            None,
            None,
        ));
        let exp2 = g.add_node(make_node(
            "exposure.report",
            "report",
            NodeType::Exposure,
            None,
            None,
        ));

        g.add_edge(src, a, EdgeData::direct(EdgeType::Ref));
        g.add_edge(src, b, EdgeData::direct(EdgeType::Ref));
        g.add_edge(a, exp1, EdgeData::direct(EdgeType::Exposure));
        g.add_edge(b, exp2, EdgeData::direct(EdgeType::Exposure));

        let report = compute_impact(&g, src);
        assert_eq!(report.affected_exposures, 2);
        assert_eq!(report.exposure_paths.len(), 2);

        // Sorted by exposure name
        assert_eq!(report.exposure_paths[0].exposure, "dashboard");
        assert_eq!(report.exposure_paths[0].path, vec!["src", "a", "dashboard"]);
        assert_eq!(report.exposure_paths[1].exposure, "report");
        assert_eq!(report.exposure_paths[1].path, vec!["src", "b", "report"]);
    }

    #[test]
    fn test_exposure_paths_diamond_convergent() {
        // Diamond: src -> A -> C -> exp, src -> B -> C -> exp
        // BFS finds shortest path (through whichever of A/B is visited first)
        let mut g = LineageGraph::new();
        let src = g.add_node(make_node(
            "model.src",
            "src",
            NodeType::Model,
            Some("view"),
            None,
        ));
        let a = g.add_node(make_node(
            "model.a",
            "a",
            NodeType::Model,
            Some("view"),
            None,
        ));
        let b = g.add_node(make_node(
            "model.b",
            "b",
            NodeType::Model,
            Some("view"),
            None,
        ));
        let c = g.add_node(make_node(
            "model.c",
            "c",
            NodeType::Model,
            Some("table"),
            None,
        ));
        let exp = g.add_node(make_node(
            "exposure.dashboard",
            "dashboard",
            NodeType::Exposure,
            None,
            None,
        ));

        g.add_edge(src, a, EdgeData::direct(EdgeType::Ref));
        g.add_edge(src, b, EdgeData::direct(EdgeType::Ref));
        g.add_edge(a, c, EdgeData::direct(EdgeType::Ref));
        g.add_edge(b, c, EdgeData::direct(EdgeType::Ref));
        g.add_edge(c, exp, EdgeData::direct(EdgeType::Exposure));

        let report = compute_impact(&g, src);
        assert_eq!(report.affected_exposures, 1);
        // Both paths should be found: src->a->c->dashboard and src->b->c->dashboard
        assert_eq!(report.exposure_paths.len(), 2);
        assert_eq!(
            report.exposure_paths[0].path,
            vec!["src", "a", "c", "dashboard"]
        );
        assert_eq!(
            report.exposure_paths[1].path,
            vec!["src", "b", "c", "dashboard"]
        );
    }

    #[test]
    fn test_classify_severity_source_seed_snapshot() {
        // Covers the wildcard arm (line 76): Source, Seed, Snapshot → Medium
        let source = make_node("source.raw.o", "raw.o", NodeType::Source, None, None);
        assert_eq!(classify_severity(&source), ImpactSeverity::Medium);

        let seed = make_node("seed.countries", "countries", NodeType::Seed, None, None);
        assert_eq!(classify_severity(&seed), ImpactSeverity::Medium);

        let snap = make_node("snapshot.snap", "snap", NodeType::Snapshot, None, None);
        assert_eq!(classify_severity(&snap), ImpactSeverity::Medium);
    }
}