dlin-core 0.2.2

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
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
use super::*;

#[test]
fn test_build_graph_versioned_model_creates_version_nodes() {
    let tmp = tempfile::tempdir().unwrap();
    let project_dir = tmp.path().to_path_buf();
    let models_dir = project_dir.join("models");
    fs::create_dir_all(&models_dir).unwrap();

    // v1 and v2 SQL files (default naming: {name}_v{v}.sql)
    fs::write(models_dir.join("my_model_v1.sql"), "SELECT 1 as id").unwrap();
    fs::write(models_dir.join("my_model_v2.sql"), "SELECT 2 as id").unwrap();

    fs::write(
        models_dir.join("schema.yml"),
        r#"
version: 2
models:
  - name: my_model
    latest_version: 2
    versions:
      - v: 1
      - v: 2
"#,
    )
    .unwrap();

    let files = DiscoveredFiles {
        model_sql_files: vec![
            project_dir.join("models/my_model_v1.sql"),
            project_dir.join("models/my_model_v2.sql"),
        ],
        yaml_files: vec![project_dir.join("models/schema.yml")],
        ..Default::default()
    };

    let graph = build_graph(&project_dir, &files, None, true, false, &HashMap::new()).unwrap();

    // Two version nodes: my_model.v1 and my_model.v2
    assert_eq!(graph.node_count(), 2);
    let labels: Vec<&str> = graph
        .node_indices()
        .map(|i| graph[i].label.as_str())
        .collect();
    assert!(labels.contains(&"my_model.v1"));
    assert!(labels.contains(&"my_model.v2"));

    // unique_ids should use dotted form
    let ids: Vec<&str> = graph
        .node_indices()
        .map(|i| graph[i].unique_id.as_str())
        .collect();
    assert!(ids.contains(&"model.my_model.v1"));
    assert!(ids.contains(&"model.my_model.v2"));
}

#[test]
fn test_build_graph_versioned_ref_without_version_kwarg_resolves_to_latest() {
    let tmp = tempfile::tempdir().unwrap();
    let project_dir = tmp.path().to_path_buf();
    let models_dir = project_dir.join("models");
    fs::create_dir_all(&models_dir).unwrap();

    fs::write(models_dir.join("my_model_v1.sql"), "SELECT 1").unwrap();
    fs::write(models_dir.join("my_model_v2.sql"), "SELECT 2").unwrap();
    // downstream refs 'my_model' without version → should go to v2 (latest)
    fs::write(
        models_dir.join("downstream.sql"),
        "SELECT * FROM {{ ref('my_model') }}",
    )
    .unwrap();

    fs::write(
        models_dir.join("schema.yml"),
        r#"
version: 2
models:
  - name: my_model
    latest_version: 2
    versions:
      - v: 1
      - v: 2
"#,
    )
    .unwrap();

    let files = DiscoveredFiles {
        model_sql_files: vec![
            project_dir.join("models/my_model_v1.sql"),
            project_dir.join("models/my_model_v2.sql"),
            project_dir.join("models/downstream.sql"),
        ],
        yaml_files: vec![project_dir.join("models/schema.yml")],
        ..Default::default()
    };

    let graph = build_graph(&project_dir, &files, None, true, false, &HashMap::new()).unwrap();

    // 3 nodes (v1, v2, downstream) — no phantom
    assert_eq!(graph.node_count(), 3);
    assert_eq!(graph.edge_count(), 1);

    // The single edge should be my_model.v2 → downstream
    let downstream_idx = graph
        .node_indices()
        .find(|&i| graph[i].label == "downstream")
        .unwrap();
    let v2_idx = graph
        .node_indices()
        .find(|&i| graph[i].unique_id == "model.my_model.v2")
        .unwrap();
    assert!(graph.contains_edge(v2_idx, downstream_idx));
}

#[test]
fn test_build_graph_versioned_ref_with_version_kwarg_resolves_to_correct_version() {
    let tmp = tempfile::tempdir().unwrap();
    let project_dir = tmp.path().to_path_buf();
    let models_dir = project_dir.join("models");
    fs::create_dir_all(&models_dir).unwrap();

    fs::write(models_dir.join("my_model_v1.sql"), "SELECT 1").unwrap();
    fs::write(models_dir.join("my_model_v2.sql"), "SELECT 2").unwrap();
    // downstream explicitly refs version=1
    fs::write(
        models_dir.join("downstream.sql"),
        "SELECT * FROM {{ ref('my_model', version=1) }}",
    )
    .unwrap();

    fs::write(
        models_dir.join("schema.yml"),
        r#"
version: 2
models:
  - name: my_model
    latest_version: 2
    versions:
      - v: 1
      - v: 2
"#,
    )
    .unwrap();

    let files = DiscoveredFiles {
        model_sql_files: vec![
            project_dir.join("models/my_model_v1.sql"),
            project_dir.join("models/my_model_v2.sql"),
            project_dir.join("models/downstream.sql"),
        ],
        yaml_files: vec![project_dir.join("models/schema.yml")],
        ..Default::default()
    };

    let graph = build_graph(&project_dir, &files, None, true, false, &HashMap::new()).unwrap();

    // 3 nodes (v1, v2, downstream) — no phantom
    assert_eq!(graph.node_count(), 3);
    assert_eq!(graph.edge_count(), 1);

    // The single edge should be my_model.v1 → downstream
    let downstream_idx = graph
        .node_indices()
        .find(|&i| graph[i].label == "downstream")
        .unwrap();
    let v1_idx = graph
        .node_indices()
        .find(|&i| graph[i].unique_id == "model.my_model.v1")
        .unwrap();
    assert!(graph.contains_edge(v1_idx, downstream_idx));
}

#[test]
fn test_build_graph_versioned_model_sql_edges_processed() {
    // Regression: versioned SQL files must have their ref()/source() edges processed.
    // Earlier, process_sql_edges looked up "model.my_model_v1" (no dot) but nodes
    // were registered as "model.my_model.v1" (with dot), causing all edges to be skipped.
    let tmp = tempfile::tempdir().unwrap();
    let project_dir = tmp.path().to_path_buf();
    let models_dir = project_dir.join("models");
    fs::create_dir_all(&models_dir).unwrap();

    // v1 refs a source; v2 refs v1
    fs::write(
        models_dir.join("my_model_v1.sql"),
        "SELECT * FROM {{ source('raw', 'events') }}",
    )
    .unwrap();
    fs::write(
        models_dir.join("my_model_v2.sql"),
        "SELECT * FROM {{ ref('my_model', version=1) }}",
    )
    .unwrap();

    fs::write(
        models_dir.join("schema.yml"),
        r#"
version: 2
sources:
  - name: raw
    tables:
      - name: events
models:
  - name: my_model
    latest_version: 2
    versions:
      - v: 1
      - v: 2
"#,
    )
    .unwrap();

    let files = DiscoveredFiles {
        model_sql_files: vec![
            project_dir.join("models/my_model_v1.sql"),
            project_dir.join("models/my_model_v2.sql"),
        ],
        yaml_files: vec![project_dir.join("models/schema.yml")],
        ..Default::default()
    };

    let graph = build_graph(&project_dir, &files, None, true, false, &HashMap::new()).unwrap();

    // source + v1 + v2 = 3 nodes, no phantoms
    assert_eq!(graph.node_count(), 3);
    // source→v1 and v1→v2 = 2 edges
    assert_eq!(graph.edge_count(), 2);

    let v1_idx = graph
        .node_indices()
        .find(|&i| graph[i].unique_id == "model.my_model.v1")
        .expect("v1 node must exist");
    let v2_idx = graph
        .node_indices()
        .find(|&i| graph[i].unique_id == "model.my_model.v2")
        .expect("v2 node must exist");
    let src_idx = graph
        .node_indices()
        .find(|&i| graph[i].unique_id == "source.raw.events")
        .expect("source node must exist");

    assert!(
        graph.contains_edge(src_idx, v1_idx),
        "source→v1 edge missing"
    );
    assert!(graph.contains_edge(v1_idx, v2_idx), "v1→v2 edge missing");
}

#[test]
fn test_build_graph_versioned_phantom_for_missing_version() {
    // Regression: ref('name', version=N) when version N does not exist must
    // create a phantom model.name.vN, not link to the latest-version alias.
    let tmp = tempfile::tempdir().unwrap();
    let project_dir = tmp.path().to_path_buf();
    let models_dir = project_dir.join("models");
    fs::create_dir_all(&models_dir).unwrap();

    // Only v2 exists; downstream refs version=1 which is absent
    fs::write(models_dir.join("my_model_v2.sql"), "SELECT 2").unwrap();
    fs::write(
        models_dir.join("downstream.sql"),
        "SELECT * FROM {{ ref('my_model', version=1) }}",
    )
    .unwrap();

    fs::write(
        models_dir.join("schema.yml"),
        r#"
version: 2
models:
  - name: my_model
    latest_version: 2
    versions:
      - v: 2
"#,
    )
    .unwrap();

    let files = DiscoveredFiles {
        model_sql_files: vec![
            project_dir.join("models/my_model_v2.sql"),
            project_dir.join("models/downstream.sql"),
        ],
        yaml_files: vec![project_dir.join("models/schema.yml")],
        ..Default::default()
    };

    let graph = build_graph(&project_dir, &files, None, true, false, &HashMap::new()).unwrap();

    // v2 + downstream + phantom(v1) = 3 nodes
    assert_eq!(graph.node_count(), 3);

    let phantom = graph
        .node_indices()
        .find(|&i| graph[i].node_type == NodeType::Phantom)
        .expect("phantom v1 node must exist");
    assert_eq!(graph[phantom].unique_id, "model.my_model.v1");

    // Edge must be phantom_v1 → downstream, NOT v2 → downstream
    let downstream_idx = graph
        .node_indices()
        .find(|&i| graph[i].label == "downstream")
        .unwrap();
    assert!(
        graph.contains_edge(phantom, downstream_idx),
        "phantom.v1 → downstream edge missing"
    );
    let v2_idx = graph
        .node_indices()
        .find(|&i| graph[i].unique_id == "model.my_model.v2")
        .unwrap();
    assert!(
        !graph.contains_edge(v2_idx, downstream_idx),
        "v2 → downstream edge must not exist"
    );
}

#[test]
fn test_build_graph_versioned_model_custom_defined_in() {
    let tmp = tempfile::tempdir().unwrap();
    let project_dir = tmp.path().to_path_buf();
    let models_dir = project_dir.join("models");
    fs::create_dir_all(&models_dir).unwrap();

    // v1 uses default stem, v2 uses custom stem via defined_in
    fs::write(models_dir.join("my_model_v1.sql"), "SELECT 1").unwrap();
    fs::write(models_dir.join("custom_v2_file.sql"), "SELECT 2").unwrap();

    fs::write(
        models_dir.join("schema.yml"),
        r#"
version: 2
models:
  - name: my_model
    latest_version: 2
    versions:
      - v: 1
      - v: 2
        defined_in: custom_v2_file
"#,
    )
    .unwrap();

    let files = DiscoveredFiles {
        model_sql_files: vec![
            project_dir.join("models/my_model_v1.sql"),
            project_dir.join("models/custom_v2_file.sql"),
        ],
        yaml_files: vec![project_dir.join("models/schema.yml")],
        ..Default::default()
    };

    let graph = build_graph(&project_dir, &files, None, true, false, &HashMap::new()).unwrap();

    assert_eq!(graph.node_count(), 2);
    let ids: Vec<&str> = graph
        .node_indices()
        .map(|i| graph[i].unique_id.as_str())
        .collect();
    assert!(ids.contains(&"model.my_model.v1"));
    assert!(ids.contains(&"model.my_model.v2"));
}

#[test]
fn test_build_graph_versioned_defined_in_base_name_edges_correct_version() {
    // Regression: when defined_in equals the base model name (e.g. v1 lives in
    // my_model.sql), process_sql_edges must attach edges to the v1 node, not to
    // the latest-version alias (model.my_model → v2).
    let tmp = tempfile::tempdir().unwrap();
    let project_dir = tmp.path().to_path_buf();
    let models_dir = project_dir.join("models");
    fs::create_dir_all(&models_dir).unwrap();

    // v1 is in my_model.sql (defined_in: my_model), v2 is in my_model_v2.sql
    fs::write(
        models_dir.join("my_model.sql"),
        "SELECT * FROM {{ source('raw', 'events') }}",
    )
    .unwrap();
    fs::write(models_dir.join("my_model_v2.sql"), "SELECT 2").unwrap();

    fs::write(
        models_dir.join("schema.yml"),
        r#"
version: 2
sources:
  - name: raw
    tables:
      - name: events
models:
  - name: my_model
    latest_version: 2
    versions:
      - v: 1
        defined_in: my_model
      - v: 2
"#,
    )
    .unwrap();

    let files = DiscoveredFiles {
        model_sql_files: vec![
            project_dir.join("models/my_model.sql"),
            project_dir.join("models/my_model_v2.sql"),
        ],
        yaml_files: vec![project_dir.join("models/schema.yml")],
        ..Default::default()
    };

    let graph = build_graph(&project_dir, &files, None, true, false, &HashMap::new()).unwrap();

    // source + v1 + v2 = 3 nodes, no phantoms
    assert_eq!(graph.node_count(), 3);
    assert_eq!(graph.edge_count(), 1);

    let v1_idx = graph
        .node_indices()
        .find(|&i| graph[i].unique_id == "model.my_model.v1")
        .expect("v1 node must exist");
    let src_idx = graph
        .node_indices()
        .find(|&i| graph[i].unique_id == "source.raw.events")
        .expect("source node must exist");
    let v2_idx = graph
        .node_indices()
        .find(|&i| graph[i].unique_id == "model.my_model.v2")
        .expect("v2 node must exist");

    // Edge must be source → v1 (not source → v2)
    assert!(
        graph.contains_edge(src_idx, v1_idx),
        "source→v1 edge missing: edges in my_model.sql must attach to v1"
    );
    assert!(
        !graph.contains_edge(src_idx, v2_idx),
        "source→v2 edge must not exist"
    );
}

#[test]
fn test_build_graph_unversioned_ref_resolves_to_versioned_phantom_when_sql_missing() {
    // When the latest_version SQL file is absent, ref('name') (no version kwarg)
    // should resolve to a versioned phantom (model.name.vN), not an unversioned
    // phantom (model.name).
    let tmp = tempfile::tempdir().unwrap();
    let project_dir = tmp.path().to_path_buf();
    let models_dir = project_dir.join("models");
    fs::create_dir_all(&models_dir).unwrap();

    // Only v1 SQL exists; latest_version=2 is declared but its SQL is absent.
    fs::write(models_dir.join("my_model_v1.sql"), "SELECT 1").unwrap();
    fs::write(
        models_dir.join("downstream.sql"),
        "SELECT * FROM {{ ref('my_model') }}",
    )
    .unwrap();

    fs::write(
        models_dir.join("schema.yml"),
        r#"
version: 2
models:
  - name: my_model
    latest_version: 2
    versions:
      - v: 1
      - v: 2
"#,
    )
    .unwrap();

    let files = DiscoveredFiles {
        model_sql_files: vec![
            project_dir.join("models/my_model_v1.sql"),
            project_dir.join("models/downstream.sql"),
        ],
        yaml_files: vec![project_dir.join("models/schema.yml")],
        ..Default::default()
    };

    let graph = build_graph(&project_dir, &files, None, true, false, &HashMap::new()).unwrap();

    // v1 + downstream + phantom(v2) = 3 nodes
    assert_eq!(graph.node_count(), 3);

    let phantom = graph
        .node_indices()
        .find(|&i| graph[i].node_type == NodeType::Phantom)
        .expect("phantom v2 node must exist");
    // Phantom must be the versioned ID, not the unversioned fallback
    assert_eq!(graph[phantom].unique_id, "model.my_model.v2");

    let downstream_idx = graph
        .node_indices()
        .find(|&i| graph[i].label == "downstream")
        .unwrap();
    assert!(
        graph.contains_edge(phantom, downstream_idx),
        "phantom.v2 → downstream edge missing"
    );
}

#[test]
fn test_stem_to_versioned_no_duplicate_overwrite() {
    // When two YAML files define the same model, both stem_to_versioned and
    // version_aliases must use first-file-wins (entry().or_insert()) semantics.
    // Here schema_a (latest_version=2) is processed before schema_b (latest_version=1),
    // so an unversioned ref('orders') must resolve to v2, not v1.
    let tmp = tempfile::tempdir().unwrap();
    let project_dir = tmp.path().to_path_buf();

    let models_dir = project_dir.join("models");
    fs::create_dir_all(&models_dir).unwrap();

    // Same versioned model declared in two YAML files
    let yaml_a = r#"
models:
  - name: orders
    versions:
      - v: 1
      - v: 2
    latest_version: 2
"#;
    let yaml_b = r#"
models:
  - name: orders
    versions:
      - v: 1
      - v: 2
    latest_version: 1
"#;
    // SQL stubs so the model files exist
    fs::write(models_dir.join("orders_v1.sql"), "SELECT 1").unwrap();
    fs::write(models_dir.join("orders_v2.sql"), "SELECT 2").unwrap();
    // Downstream uses unversioned ref
    fs::write(
        models_dir.join("downstream.sql"),
        "SELECT * FROM {{ ref('orders') }}",
    )
    .unwrap();

    fs::write(models_dir.join("schema_a.yml"), yaml_a).unwrap();
    fs::write(models_dir.join("schema_b.yml"), yaml_b).unwrap();

    let files = DiscoveredFiles {
        model_sql_files: vec![
            project_dir.join("models/orders_v1.sql"),
            project_dir.join("models/orders_v2.sql"),
            project_dir.join("models/downstream.sql"),
        ],
        yaml_files: vec![
            project_dir.join("models/schema_a.yml"),
            project_dir.join("models/schema_b.yml"),
        ],
        ..Default::default()
    };

    let graph = build_graph(&project_dir, &files, None, true, false, &HashMap::new()).unwrap();
    // Two versioned nodes + downstream = 3
    assert_eq!(
        graph
            .node_indices()
            .filter(|&i| matches!(graph[i].node_type, NodeType::Model))
            .count(),
        3
    );

    // The unversioned ref('orders') must resolve to v2 (from schema_a, first file)
    let downstream_idx = graph
        .node_indices()
        .find(|&i| graph[i].label == "downstream")
        .unwrap();
    let v2_idx = graph
        .node_indices()
        .find(|&i| graph[i].unique_id == "model.orders.v2")
        .unwrap();
    let v1_idx = graph
        .node_indices()
        .find(|&i| graph[i].unique_id == "model.orders.v1")
        .unwrap();
    assert!(
        graph.contains_edge(v2_idx, downstream_idx),
        "unversioned ref should resolve to v2 (first file's latest_version)"
    );
    assert!(
        !graph.contains_edge(v1_idx, downstream_idx),
        "ref must not resolve to v1 (second file's latest_version)"
    );
}