zebflow 0.11.14

Reactive web automation platform — pipelines, templates, and real-time collaboration in a single binary.
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

use std::sync::Arc;

use serde_json::{Value, json};

use super::*;

fn platform() -> crate::pipeline::nodes::shared::test_platform::TestPlatform {
    crate::pipeline::nodes::shared::test_platform::test_platform()
}

fn store(platform: &Arc<PlatformService>) -> NodeStore {
    open_store(platform, "demo", "demo", None).expect("store")
}

async fn run(platform: &Arc<PlatformService>, kind: &str, config: Value, payload: Value) -> Result<Value, PipelineError> {
    let config: Config = serde_json::from_value(config).expect("config");
    let node = Node::new(config, platform.clone(), Operation::for_kind(kind).expect("a kind here"))?;
    let out = node
        .execute_async(NodeExecutionInput {
            node_id: "n0".to_string(),
            input_pin: "in".to_string(),
            payload,
            metadata: json!({ "owner": "demo", "project": "demo", "pipeline": "test", "request_id": "r1" }),
            bus: None,
        })
        .await?;
    Ok(out.payload)
}

/// The payload's keys, sorted: the answer is one key beside what came in.
fn keys(payload: &Value) -> Vec<String> {
    let mut keys: Vec<String> = payload.as_object().expect("an object").keys().cloned().collect();
    keys.sort();
    keys
}

#[tokio::test]
async fn every_file_node_needs_from() {
    let p = platform();
    for kind in [GET_NODE_KIND, HEAD_NODE_KIND, DELETE_NODE_KIND, COPY_NODE_KIND, MOVE_NODE_KIND] {
        let op = Operation::for_kind(kind).unwrap();
        let none = run(&p, kind, json!({ "folder": "x" }), json!({})).await.unwrap_err();
        assert_eq!(none.code, op.source_code(), "{kind}");
        assert!(none.message.contains("--from is required"), "{kind}: {}", none.message);
        let list = run(&p, kind, json!({ "from": ["a.txt"] }), json!({})).await.unwrap_err();
        assert_eq!(list.code, op.source_code(), "{kind}");
        assert_eq!(run(&p, kind, json!({ "from": { "name": "x" } }), json!({})).await.unwrap_err().code, op.source_code());
        assert_eq!(run(&p, kind, json!({ "from": "../x.txt" }), json!({})).await.unwrap_err().code, op.source_code());
    }
}

#[tokio::test]
async fn get_and_head_answer_file_and_keep_the_payload() {
    let p = platform();
    store(&p).fs.put("docs/notes.md", b"# Notes").unwrap();
    let out = run(&p, GET_NODE_KIND, json!({ "from": "docs/notes.md" }), json!({ "keep": 1 })).await.unwrap();
    assert_eq!(keys(&out), vec!["file", "keep"]);
    assert_eq!((out["file"]["path"].as_str(), out["file"]["content"].as_str()), (Some("docs/notes.md"), Some("# Notes")));
    assert!(out["file"]["base64"].is_null());

    let out = run(&p, GET_NODE_KIND, json!({ "from": "docs/notes.md", "encoding": "base64" }), json!({})).await.unwrap();
    assert_eq!(out["file"]["base64"], "IyBOb3Rlcw==");
    let bad = run(&p, GET_NODE_KIND, json!({ "from": "docs/notes.md", "encoding": "hex" }), json!({})).await.unwrap_err();
    assert_eq!(bad.code, "FW_NODE_FS_FILE_GET_CONFIG");

    store(&p).fs.put("bin/a.bin", &[0xff, 0xfe]).unwrap();
    assert_eq!(run(&p, GET_NODE_KIND, json!({ "from": "bin/a.bin" }), json!({})).await.unwrap_err().code, GET_UTF8_CODE);

    // A FileRef is read from the store it names.
    let file = store(&p).file_ref("docs/notes.md", "notes.md", "text/markdown", b"# Notes", "fs.file.put", "generated");
    let out = run(&p, HEAD_NODE_KIND, json!({ "from": file }), json!({ "file": file })).await.unwrap();
    assert_eq!(keys(&out), vec!["file"]);
    assert_eq!((out["file"]["path"].as_str(), out["file"]["size"].as_u64()), (Some("docs/notes.md"), Some(7)));
    assert_eq!(run(&p, HEAD_NODE_KIND, json!({ "from": "docs/none.md" }), json!({})).await.unwrap_err().code, "FW_NODE_FS_FILE_HEAD");
}

/// `--return file` answers the stored file's FileRef — store, digest, size —
/// and puts none of its bytes in the payload.
#[tokio::test]
async fn get_can_answer_a_file_ref_instead_of_the_content() {
    let p = platform();
    store(&p).fs.put("reports/a1.pdf", b"%PDF-1.7 demo").unwrap();
    let out = run(&p, GET_NODE_KIND, json!({ "from": "reports/a1.pdf", "return": "file" }), json!({})).await.unwrap();
    let file = &out["file"];
    crate::pipeline::nodes::shared::file_ref::validate_file_ref(file).expect("a whole FileRef");
    assert_eq!((file["ref"].as_str(), file["store"].as_str(), file["size"].as_u64()), (Some("reports/a1.pdf"), Some("local"), Some(13)));
    assert_eq!((file["mime"].as_str(), file["kind"].as_str()), (Some("application/pdf"), Some("pdf")));
    assert!(file.get("content").is_none() && file.get("base64").is_none(), "no bytes in the run: {file}");
    let bad = run(&p, GET_NODE_KIND, json!({ "from": "reports/a1.pdf", "return": "process" }), json!({})).await.unwrap_err();
    assert_eq!(bad.code, "FW_NODE_FS_FILE_GET_CONFIG");
    let gone = run(&p, GET_NODE_KIND, json!({ "from": "reports/none.pdf", "return": "file" }), json!({})).await.unwrap_err();
    assert_eq!(gone.code, "FW_NODE_FS_FILE_GET");
}

#[tokio::test]
async fn delete_answers_the_ref_it_removed() {
    let p = platform();
    store(&p).fs.put("uploads/a.txt", b"a").unwrap();
    let out = run(&p, DELETE_NODE_KIND, json!({ "from": "uploads/a.txt" }), json!({ "keep": true })).await.unwrap();
    assert_eq!(keys(&out), vec!["file", "keep"]);
    assert_eq!(out["file"], json!({ "ref": "uploads/a.txt", "deleted": true }));
    assert!(store(&p).fs.head("uploads/a.txt").is_err());
}

#[tokio::test]
async fn a_folder_is_deleted_only_with_recursive() {
    let p = platform();
    store(&p).fs.put("exports/2026/a.csv", b"a").unwrap();
    store(&p).fs.put("exports/2026/b.csv", b"b").unwrap();
    let refused = run(&p, DELETE_NODE_KIND, json!({ "from": "exports/2026" }), json!({})).await.unwrap_err();
    assert_eq!(refused.code, DELETE_FOLDER_CODE);
    assert!(refused.message.contains("--recursive"), "{}", refused.message);
    assert!(store(&p).fs.head("exports/2026/a.csv").is_ok(), "nothing was removed");

    // A FileRef names one file, whatever the switch says.
    let mut file = store(&p).stored_ref("exports/2026/a.csv", "fs.file.put", "generated", "T").unwrap();
    file["ref"] = json!("exports/2026");
    let by_ref = run(&p, DELETE_NODE_KIND, json!({ "from": file, "recursive": true }), json!({})).await.unwrap_err();
    assert_eq!(by_ref.code, DELETE_FOLDER_CODE);

    // A file is a file with or without the switch.
    let one = run(&p, DELETE_NODE_KIND, json!({ "from": "exports/2026/b.csv", "recursive": true }), json!({})).await.unwrap();
    assert_eq!(one["file"], json!({ "ref": "exports/2026/b.csv", "deleted": true }));
    assert!(store(&p).fs.head("exports/2026/a.csv").is_ok());

    let out = run(&p, DELETE_NODE_KIND, json!({ "from": "exports/2026", "recursive": true }), json!({ "keep": 1 })).await.unwrap();
    assert_eq!(keys(&out), vec!["file", "keep"]);
    assert_eq!(out["file"], json!({ "ref": "exports/2026", "deleted": true, "recursive": true }));
    assert!(store(&p).fs.head("exports/2026").is_err());
}

#[tokio::test]
async fn copy_and_move_answer_the_stored_file() {
    let p = platform();
    store(&p).fs.put("inbox/a.csv", b"a,b\n").unwrap();
    let input = json!({ "body": { "note": "x" } });
    let out = run(&p, COPY_NODE_KIND, json!({ "from": "inbox/a.csv", "folder": "copies" }), input.clone()).await.unwrap();
    assert_eq!(keys(&out), vec!["body", "file"]);
    crate::pipeline::nodes::shared::file_ref::validate_file_ref(&out["file"]).expect("a contract FileRef");
    assert_eq!((out["file"]["ref"].as_str(), out["file"]["origin"].as_str()), (Some("copies/a.csv"), Some(COPY_NODE_KIND)));

    // A destination that exists is an error unless told; a skip answers it as it is.
    let again = run(&p, COPY_NODE_KIND, json!({ "from": "inbox/a.csv", "folder": "copies" }), json!({})).await.unwrap_err();
    assert!(again.message.contains("already exists"), "{}", again.message);
    let moved = run(&p, MOVE_NODE_KIND, json!({ "from": "inbox/a.csv", "path": "copies/a.csv", "on_conflict": "skip" }), json!({})).await.unwrap();
    assert_eq!(moved["file"]["origin"], MOVE_NODE_KIND);
    assert!(store(&p).fs.head("inbox/a.csv").is_ok(), "a skipped move keeps its source");

    let file = store(&p).stored_ref("inbox/a.csv", "fs.file.put", "generated", "T").unwrap();
    let out = run(&p, MOVE_NODE_KIND, json!({ "from": file, "folder": "archive" }), input).await.unwrap();
    assert_eq!((out["file"]["ref"].as_str(), out["body"]["note"].as_str()), (Some("archive/a.csv"), Some("x")));
    assert!(store(&p).fs.head("inbox/a.csv").is_err());
    let same = run(&p, COPY_NODE_KIND, json!({ "from": "archive/a.csv" }), json!({})).await.unwrap_err();
    assert_eq!(same.code, "FW_NODE_FS_FILE_COPY_CONFIG");
}

#[tokio::test]
async fn folder_list_reads_from_and_answers_folder() {
    let p = platform();
    store(&p).fs.put("uploads/a.jpg", b"a").unwrap();
    store(&p).fs.put("uploads/b.jpg", b"b").unwrap();
    for from in [json!(null), json!(""), json!(1)] {
        let err = run(&p, LIST_NODE_KIND, json!({ "from": from }), json!({})).await.unwrap_err();
        assert_eq!(err.code, "FW_NODE_FS_FOLDER_LIST_SOURCE");
    }
    let out = run(&p, LIST_NODE_KIND, json!({ "from": "uploads" }), json!({ "keep": true })).await.unwrap();
    assert_eq!(keys(&out), vec!["folder", "keep"]);
    assert_eq!((out["folder"]["path"].as_str(), out["folder"]["count"].as_u64()), (Some("uploads"), Some(2)));
    assert_eq!(out["folder"]["items"][0]["path"], "uploads/a.jpg");
    let root = run(&p, LIST_NODE_KIND, json!({ "from": "/" }), json!({})).await.unwrap();
    assert_eq!(root["folder"]["path"], "");
    assert!(root["folder"]["items"].as_array().unwrap().iter().any(|item| item["path"] == "uploads"));
}

#[tokio::test]
async fn folder_create_takes_folder_and_says_whether_it_made_it() {
    let p = platform();
    let none = run(&p, MKDIR_NODE_KIND, json!({ "from": "uploads/2026" }), json!({})).await.unwrap_err();
    assert_eq!(none.code, "FW_NODE_FS_FOLDER_CREATE_CONFIG");
    let out = run(&p, MKDIR_NODE_KIND, json!({ "folder": "uploads/2026" }), json!({ "keep": true })).await.unwrap();
    assert_eq!(keys(&out), vec!["folder", "keep"]);
    assert_eq!(out["folder"], json!({ "path": "uploads/2026", "created": true }));
    let again = run(&p, MKDIR_NODE_KIND, json!({ "folder": "uploads/2026" }), json!({})).await.unwrap();
    assert_eq!(again["folder"]["created"], false);
    assert_eq!(run(&p, MKDIR_NODE_KIND, json!({ "folder": "../up" }), json!({})).await.unwrap_err().code, "FW_NODE_FS_FOLDER_CREATE_CONFIG");
}

#[test]
fn the_signatures_name_from_and_the_answer() {
    let sig = |def: NodeDefinition| crate::pipeline::nodes::node_signature(&def);
    assert_eq!(sig(get_definition()), "fs.file.get --from FILE [--encoding text|base64] [--return inline|file] [--store TEXT] → file");
    assert_eq!(sig(head_definition()), "fs.file.head --from FILE [--store TEXT] → file");
    assert_eq!(sig(delete_definition()), "fs.file.delete --from FILE [--recursive] [--store TEXT] → file");
    assert_eq!(
        sig(copy_definition()),
        "fs.file.copy --from FILE [--store TEXT] [--folder TEXT] [--filename TEXT] [--path TEXT] [--on-conflict error|skip|overwrite] → file"
    );
    assert_eq!(sig(list_definition()), "fs.folder.list --from TEXT [--store TEXT] → folder");
    assert_eq!(sig(mkdir_definition()), "fs.folder.create --folder TEXT [--store TEXT] → folder");
}