dpcs 0.7.0

Reference implementation of the Data Pipeline Contract Standard (DPCS)
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

//! Control-flow validation phase.

use std::collections::{BTreeMap, BTreeSet};

use crate::diagnostics::{categories, Diagnostic, ValidationReport};
use crate::model::{data_flow_step_dependency, PipelineContract};

/// Validate control-flow dependencies against known steps and other models.
pub fn validate(contract: &PipelineContract) -> ValidationReport {
    let mut report = ValidationReport::new();
    let step_ids: BTreeSet<&str> = contract.steps.iter().map(|s| s.id.as_str()).collect();

    let mut deps: BTreeSet<(String, String)> = BTreeSet::new();
    for edge in &contract.graph.edges {
        if edge.from.trim().is_empty() || edge.to.trim().is_empty() {
            continue;
        }
        if step_ids.contains(edge.from.as_str()) && step_ids.contains(edge.to.as_str()) {
            deps.insert((edge.from.clone(), edge.to.clone()));
        }
    }
    for flow in &contract.data_flow {
        if let Some((from_step, to_step)) =
            data_flow_step_dependency(contract, &flow.from, &flow.to)
        {
            deps.insert((from_step, to_step));
        }
    }

    let mut seen: BTreeMap<(String, String, Option<String>), usize> = BTreeMap::new();

    for (index, flow) in contract.control_flow.iter().enumerate() {
        let object_ref = format!("controlFlow[{index}]");

        if flow.from.trim().is_empty() || flow.to.trim().is_empty() {
            report.push(
                Diagnostic::error(
                    "DPCS-CF-001",
                    categories::CONTROL_FLOW,
                    "control flow endpoints must not be empty",
                )
                .with_object_ref(object_ref.clone()),
            );
            continue;
        }

        if !step_ids.contains(flow.from.as_str()) {
            report.push(
                Diagnostic::error(
                    "DPCS-CF-002",
                    categories::CONTROL_FLOW,
                    format!("control flow references unknown step `{}`", flow.from),
                )
                .with_object_ref(object_ref.clone()),
            );
        }

        if !step_ids.contains(flow.to.as_str()) {
            report.push(
                Diagnostic::error(
                    "DPCS-CF-003",
                    categories::CONTROL_FLOW,
                    format!("control flow references unknown step `{}`", flow.to),
                )
                .with_object_ref(object_ref.clone()),
            );
        }

        let key = (flow.from.clone(), flow.to.clone(), flow.kind.clone());
        if let Some(first_index) = seen.get(&key) {
            report.push(
                Diagnostic::error(
                    "DPCS-CF-005",
                    categories::CONTROL_FLOW,
                    format!(
                        "duplicate control flow from `{}` to `{}`",
                        flow.from, flow.to
                    ),
                )
                .with_object_ref(object_ref.clone())
                .with_remediation(format!(
                    "Remove the duplicate of controlFlow[{first_index}]"
                )),
            );
        } else {
            seen.insert(key, index);
        }

        // Conflict when a uni-directional graph/data edge points the opposite way.
        // Bidirectional graph cycles are already covered by GRP-004 without CF noise.
        let forward = (flow.to.clone(), flow.from.clone());
        let same = (flow.from.clone(), flow.to.clone());
        if step_ids.contains(flow.from.as_str())
            && step_ids.contains(flow.to.as_str())
            && deps.contains(&forward)
            && !deps.contains(&same)
        {
            report.push(
                Diagnostic::error(
                    "DPCS-CF-004",
                    categories::CONTROL_FLOW,
                    format!(
                        "control flow from `{}` to `{}` conflicts with an opposite graph or data-flow dependency",
                        flow.from, flow.to
                    ),
                )
                .with_object_ref(object_ref)
                .with_remediation(
                    "Align controlFlow with graph.edges and dataFlow dependency directions",
                ),
            );
        }
    }

    report
}