razel 0.5.7

a command executor with caching for data processing pipelines
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

use crate::executors::Executor;
use crate::{config, Arena, Command, File, FileId, FileType};
use anyhow::Result;
use itertools::{chain, Itertools};
use std::collections::HashSet;
use std::path::Path;

pub fn write_graphs_html(
    commands: &Arena<Command>,
    excluded_commands_len: usize,
    files: &Arena<File>,
    path: &Path,
) -> Result<()> {
    let template = include_str!("graphs.in.html");
    let ignored_files = collect_ignored_files(files);
    let contents = if commands.len() - excluded_commands_len < 100
        && files.len() - ignored_files.len() < 100
    {
        template
            .replacen(
                "{{graph_with_subgraphs}}",
                &graph_with_subgraphs(commands, files, &ignored_files)?,
                1,
            )
            .replacen(
                "{{graph_simple}}",
                &graph_simple(commands, files, &ignored_files)?,
                1,
            )
    } else {
        "Skipped generating graphs because of too many commands/files.".into()
    };
    std::fs::write(path, contents)?;
    Ok(())
}

fn collect_ignored_files(files: &Arena<File>) -> HashSet<FileId> {
    HashSet::from_iter(
        files
            .iter()
            .filter(|x| {
                x.is_excluded
                    || x.file_type == FileType::SystemExecutable
                    || x.file_type == FileType::RazelExecutable
            })
            .map(|x| x.id),
    )
}

fn graph_with_subgraphs(
    commands: &Arena<Command>,
    files: &Arena<File>,
    ignored_files: &HashSet<FileId>,
) -> Result<String> {
    let path = |&x| files[x].path.strip_prefix(config::OUT_DIR).unwrap();
    let mut lines = vec![];
    for (id, arg) in files
        .iter()
        .filter(|x| x.file_type != FileType::OutputFile)
        .filter(|x| !ignored_files.contains(&x.id))
        .map(|x| (x.id, &x.arg))
    {
        lines.push(format!("f{id}([{arg}])"));
        lines.push(format!("style f{id} fill:#fff4dd"));
    }
    for command in commands.iter().filter(|c| !c.is_excluded) {
        let command_id = command.id;
        lines.push(format!("subgraph cg{command_id} [{}]", command.name));
        lines.push(format!("ce{command_id}[[{}]]", executable(command)));
        for (x, path) in command
            .outputs
            .iter()
            .filter(|&x| !ignored_files.contains(x))
            .map(|x| (x, path(x)))
        {
            lines.push(format!("f{x}([{path:?}])"));
            lines.push(format!("style f{x} fill:#fff4dd"));
        }
        lines.push("end".into());
        for x in chain(command.executables.iter(), command.inputs.iter())
            .filter(|&x| !ignored_files.contains(x))
        {
            lines.push(format!("f{x} --> cg{command_id}"));
        }
    }
    Ok(mermaid(&lines))
}

fn graph_simple(
    commands: &Arena<Command>,
    files: &Arena<File>,
    ignored_files: &HashSet<FileId>,
) -> Result<String> {
    let path = |&x| files[x].path.strip_prefix(config::OUT_DIR).unwrap();
    let mut lines = vec![];
    for (id, arg) in files
        .iter()
        .filter(|x| x.file_type == FileType::DataFile)
        .filter(|x| !ignored_files.contains(&x.id))
        .map(|x| (x.id, &x.arg))
    {
        lines.push(format!("f{id}[{arg}]"));
        lines.push(format!("style f{id} fill:#fff4dd"));
    }
    for command in commands.iter().filter(|c| !c.is_excluded) {
        let command_id = command.id;
        if command.inputs.len() == 1 && command.outputs.len() == 1 {
            let input_id = command.inputs.first().unwrap();
            let output_id = command.outputs.first().unwrap();
            lines.push(format!(
                "f{input_id}-- \"{}\" -->f{output_id}[{:?}]",
                executable(command),
                path(output_id)
            ));
            lines.push(format!("style f{output_id} fill:#fff4dd"));
        } else {
            lines.push(format!("c{command_id}([\"{}\"])", executable(command)));
            for x in command.inputs.iter() {
                lines.push(format!("f{x}---c{command_id}"));
            }
            for x in &command.outputs {
                lines.push(format!("c{command_id} --> f{x}[{:?}]", path(x)));
                lines.push(format!("style f{x} fill:#fff4dd"));
            }
        }
    }
    Ok(mermaid(&lines))
}

fn mermaid(lines: &[String]) -> String {
    // defaultRenderer is useless for non-tiny number of nodes
    // useMaxWidth breaks zooming/panning
    let config = r#"%%{init: {"flowchart": {"defaultRenderer": "elk", "useMaxWidth": false}} }%%"#;
    format!(
        r#"
<pre class="mermaid">
flowchart LR
{config}
{}
</pre>
    "#,
        lines.join("\n")
    )
}

fn executable(command: &Command) -> String {
    match &command.executor {
        Executor::CustomCommand(x) => x.executable.clone(),
        Executor::Wasi(x) => x.executable.clone(),
        Executor::AsyncTask(x) => x.args.iter().take(3).join(" "),
        Executor::BlockingTask(x) => x.args.iter().take(3).join(" "),
        Executor::HttpRemote(x) => x.args.iter().take(3).join(" "),
    }
}