flowr 1.0.0

Runners for compiled 'flow' programs
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

#![allow(missing_docs)]

use std::path::PathBuf;

use flowcore::content::file_provider::FileProvider;
use flowcore::model::flow_manifest::FlowManifest;
use url::Url;

fn load_example_manifest(example_name: &str) -> FlowManifest {
    let sample_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"))
        .join("examples")
        .join(example_name);

    utilities::compile_example(&sample_dir, "flowrcli");

    let manifest_url =
        Url::from_file_path(sample_dir.join("manifest.json")).expect("Could not create URL");
    let provider = FileProvider;
    let (manifest, _) =
        FlowManifest::load(&provider, &manifest_url).expect("Could not load manifest");
    manifest
}

fn verify_basic_invariants(manifest: &FlowManifest, example_name: &str) {
    for function in manifest.functions().values() {
        for conn in function.get_output_connections() {
            let dst_fn = manifest
                .functions()
                .get(&conn.destination_id)
                .unwrap_or_else(|| {
                    panic!(
                        "{example_name}: destination fn#{} not found",
                        conn.destination_id
                    )
                });
            let src_parent = function.get_parent_id();
            let dst_parent = dst_fn.get_parent_id();

            // Self-loopbacks must always be internal
            if function.id() == conn.destination_id {
                assert!(
                    conn.internal,
                    "{example_name}: self-loopback fn#{} should be internal",
                    function.id()
                );
            }

            // Cross-flow connections must always be external
            if src_parent != dst_parent {
                assert!(
                    !conn.internal,
                    "{example_name}: cross-flow fn#{}(flow={}) -> fn#{}(flow={}) should be external",
                    function.id(),
                    src_parent,
                    conn.destination_id,
                    dst_parent
                );
            }
        }
    }
}

#[test]
fn factorial_all_internal() {
    let manifest = load_example_manifest("factorial");
    verify_basic_invariants(&manifest, "factorial");

    // Factorial has no sub-flows — all connections should be internal
    for function in manifest.functions().values() {
        for conn in function.get_output_connections() {
            assert!(
                conn.internal,
                "factorial: fn#{} -> fn#{}:io{} should be internal (single flow)",
                function.id(),
                conn.destination_id,
                conn.destination_io_number
            );
        }
    }
}

#[test]
fn sequence_of_sequences_classification() {
    let manifest = load_example_manifest("sequence-of-sequences");
    verify_basic_invariants(&manifest, "sequence-of-sequences");
}

#[test]
fn router_classification() {
    let manifest = load_example_manifest("router");
    verify_basic_invariants(&manifest, "router");

    // The restructured router routes forward_sum and cross_distance through the parent.
    // Verify those connections are external even though endpoints are in the same flow.
    let mut found_parent_routed = false;
    for function in manifest.functions().values() {
        for conn in function.get_output_connections() {
            let dst_fn = manifest
                .functions()
                .get(&conn.destination_id)
                .expect("destination not found");
            // Same flow but external means it was routed through parent
            if function.get_parent_id() == dst_fn.get_parent_id() && !conn.internal {
                found_parent_routed = true;
            }
        }
    }
    assert!(
        found_parent_routed,
        "router: should have at least one parent-routed (crossed boundary) connection"
    );
}

#[test]
fn prime_classification() {
    let manifest = load_example_manifest("prime");
    verify_basic_invariants(&manifest, "prime");

    // The composites sub-flow (flat state machine) should have all internal connections
    // within its flow, and external connections from the root flow
    let mut has_internal = false;
    let mut has_external = false;
    for function in manifest.functions().values() {
        for conn in function.get_output_connections() {
            if conn.internal {
                has_internal = true;
            } else {
                has_external = true;
            }
        }
    }
    assert!(has_internal, "prime: should have internal connections");
    assert!(has_external, "prime: should have external connections");
}

#[test]
fn running_average_classification() {
    let manifest = load_example_manifest("running-average");
    verify_basic_invariants(&manifest, "running-average");
}

#[test]
fn fibonacci_classification() {
    let manifest = load_example_manifest("fibonacci");
    verify_basic_invariants(&manifest, "fibonacci");

    // Fibonacci has no sub-flows — all connections should be internal
    for function in manifest.functions().values() {
        for conn in function.get_output_connections() {
            assert!(
                conn.internal,
                "fibonacci: fn#{} -> fn#{}:io{} should be internal",
                function.id(),
                conn.destination_id,
                conn.destination_io_number
            );
        }
    }
}