rura 1.6.0

Interactive TUI pipeline editor built for rapid iteration
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
use crate::rura::RuraCommand;
use crate::shell::builder::{CommandBuilder, UsrBinEnvCommandBuilder};
use crate::shell::cmd_runner::{CmdResult, CmdRunner};
use crate::shell::exec::{Exec, SystemExec};
use crate::shell::output::Output;
use itertools::Itertools;
use log::{debug, info};
use std::cell::RefCell;
use std::sync::Arc;
use std::time::SystemTime;

pub struct CachedCmdRunner {
    exec: Box<dyn Exec>,
    builder: Box<dyn CommandBuilder>,
    stdin: Arc<[u8]>,
    cache: RefCell<Vec<(String, Arc<[u8]>)>>,
}

impl CachedCmdRunner {
    pub fn new(shell: &str, stdin: Arc<[u8]>) -> Self {
        Self {
            exec: Box::new(SystemExec),
            builder: Box::new(UsrBinEnvCommandBuilder {
                shell: shell.into(),
            }),
            stdin,
            cache: RefCell::new(vec![]),
        }
    }
}

impl CmdRunner for CachedCmdRunner {
    fn run(&self, command: &RuraCommand) -> anyhow::Result<CmdResult> {
        let mut cache = self.cache.borrow_mut();

        info!("executing: '{command:?}'");

        let cached_commands = cache.iter().map(|(c, _)| c.clone()).collect_vec();
        debug!("cache: {:?}", cached_commands);

        if command.is_empty() {
            return Ok(CmdResult {
                stdin: self.stdin.clone(),
                outputs: vec![],
            });
        }

        let now = SystemTime::now();

        // check how many subcommands are equal between command and cache
        // and truncate cache to only keep those subcommands
        for (i, (cached_command_str, _)) in cache.iter().enumerate() {
            if let Some(command_str) = command.trimmed().get(i) {
                if cached_command_str != command_str {
                    cache.truncate(i);
                    break;
                }
            }
        }

        let mut outputs = vec![];

        for (i, subcommand) in command.trimmed().iter().enumerate() {
            if let Some((_, output)) = cache.get(i) {
                debug!("reuse: '{subcommand}'");
                outputs.push(Output::Ok(output.clone()));
                continue;
            }

            let current_stdin = if let Some((_, cached_bytes)) = cache.get(i.saturating_sub(1)) {
                cached_bytes
            } else {
                &self.stdin
            };

            debug!("exec: '{subcommand}'");

            let now_sub = SystemTime::now();

            let cmd = self.builder.build(subcommand);
            let output = self.exec.exec(cmd, current_stdin.clone())?;

            debug!("t: {:?}", now_sub.elapsed()?);

            outputs.push(output.clone());

            match output {
                Output::Ok(bytes) => {
                    cache.push((subcommand.clone(), bytes));
                }
                Output::Err(_bytes, _code) => {
                    debug!("  failed - aborting further execution");
                    return Ok(CmdResult {
                        stdin: self.stdin.clone(),
                        outputs,
                    });
                }
            }
        }

        // Keep all following items in cache since user might have called for instance
        // "until cursor prev" action so the full command might be still called
        // with all subcommands

        let elapsed = now.elapsed()?;
        debug!("total: {elapsed:?}");

        let cached_commands = cache.iter().map(|(c, _)| c.clone()).collect_vec();

        debug!("cache: {:?}", cached_commands);

        Ok(CmdResult {
            stdin: self.stdin.clone(),
            outputs,
        })
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::shell::builder::TestBuilder;
    use crate::shell::exec::MockExec;
    use std::cell::RefCell;
    use std::rc::Rc;

    use crate::shell::cmd_runner::CmdRunner;
    use crate::shell::exec::Exec;
    use crate::shell::output::Output;

    fn cached_runner(exec: Box<dyn Exec>, stdin: Arc<[u8]>) -> CachedCmdRunner {
        CachedCmdRunner {
            exec,
            builder: Box::new(TestBuilder {}),
            stdin,
            cache: RefCell::new(vec![]),
        }
    }
    fn cache_entry(command: &str, stdin: &str) -> (String, Arc<[u8]>) {
        (command.into(), stdin.as_bytes().into())
    }

    #[test]
    fn test_run_empty_command_cached() {
        let calls = Rc::new(RefCell::new(vec![]));
        let mock_exec = MockExec {
            calls: calls.clone(),
        };
        let runner = cached_runner(Box::new(mock_exec), "stdin".as_bytes().into());

        let result = runner.run(&vec![].into()).unwrap();

        assert_eq!(result.outputs, vec![])
    }

    #[test]
    fn test_cmd_runner_calling_three_subcommands() {
        let calls = Rc::new(RefCell::new(vec![]));
        let mock_exec = MockExec {
            calls: calls.clone(),
        };
        let runner = cached_runner(Box::new(mock_exec), "stdin".as_bytes().into());

        let result = runner
            .run(&vec!["cmd1".into(), "cmd2".into(), "cmd3".into()].into())
            .unwrap();

        assert_eq!(result.stdin, Arc::from("stdin".as_bytes()));

        assert_eq!(
            result.outputs,
            vec![
                Output::ok_str("cmd1-output"),
                Output::ok_str("cmd2-output"),
                Output::ok_str("cmd3-output")
            ]
        );

        // input for the command is the output of the previous command
        assert_eq!(
            *calls.borrow(),
            vec![
                ("cmd1".into(), "stdin".into()),
                ("cmd2".into(), "cmd1-output".into()),
                ("cmd3".into(), "cmd2-output".into()),
            ]
        );

        // all commands are cached
        assert_eq!(
            *runner.cache.borrow(),
            vec![
                cache_entry("cmd1", "cmd1-output"),
                cache_entry("cmd2", "cmd2-output"),
                cache_entry("cmd3", "cmd3-output")
            ]
        );
    }

    #[test]
    fn test_cmd_runner_shorter_command() {
        let calls = Rc::new(RefCell::new(vec![]));
        let mock_exec = MockExec {
            calls: calls.clone(),
        };
        let runner = cached_runner(Box::new(mock_exec), "stdin".as_bytes().into());

        let _init_run = runner
            .run(&vec!["cmd1".into(), "cmd2".into(), "cmd3".into()].into())
            .unwrap();

        calls.borrow_mut().clear();

        // second run
        let result = runner.run(&vec!["cmd1".into()].into()).unwrap();

        assert_eq!(result.stdin, Arc::from("stdin".as_bytes()));

        // only cmd1 is in the output
        assert_eq!(result.outputs, vec![Output::ok_str("cmd1-output"),]);

        // no calls since the command is cached
        assert_eq!(*calls.borrow(), vec![]);

        // all commands are still cached
        assert_eq!(
            *runner.cache.borrow(),
            vec![
                cache_entry("cmd1", "cmd1-output"),
                cache_entry("cmd2", "cmd2-output"),
                cache_entry("cmd3", "cmd3-output")
            ]
        );
    }

    #[test]
    fn test_cmd_runner_extended_command() {
        let calls = Rc::new(RefCell::new(vec![]));
        let mock_exec = MockExec {
            calls: calls.clone(),
        };
        let runner = cached_runner(Box::new(mock_exec), "stdin".as_bytes().into());

        let _init_run = runner
            .run(&vec!["cmd1".into(), "cmd2".into()].into())
            .unwrap();

        calls.borrow_mut().clear();

        // second run for less commands - keep whole cache
        let result = runner
            .run(&vec!["cmd1".into(), "cmd2".into(), "cmd3".into(), "cmd4".into()].into())
            .unwrap();

        assert_eq!(result.stdin, Arc::from("stdin".as_bytes()));

        assert_eq!(
            result.outputs,
            vec![
                Output::ok_str("cmd1-output"),
                Output::ok_str("cmd2-output"),
                Output::ok_str("cmd3-output"),
                Output::ok_str("cmd4-output"),
            ]
        );

        // only cmd3 is called since is's the only one not cached
        assert_eq!(
            *calls.borrow(),
            vec![
                ("cmd3".into(), "cmd2-output".into()),
                ("cmd4".into(), "cmd3-output".into()),
            ]
        );

        // all commands are still cached
        assert_eq!(
            *runner.cache.borrow(),
            vec![
                cache_entry("cmd1", "cmd1-output"),
                cache_entry("cmd2", "cmd2-output"),
                cache_entry("cmd3", "cmd3-output"),
                cache_entry("cmd4", "cmd4-output")
            ]
        );
    }

    #[test]
    fn test_cmd_runner_modified_in_the_middle() {
        let calls = Rc::new(RefCell::new(vec![]));
        let mock_exec = MockExec {
            calls: calls.clone(),
        };
        let runner = cached_runner(Box::new(mock_exec), "stdin".as_bytes().into());

        let _init_run = runner
            .run(&vec!["cmd1".into(), "cmd2".into(), "cmd3".into()].into())
            .unwrap();
        calls.borrow_mut().clear();

        // second run for shorter command - keep whole cache
        let result = runner
            .run(&vec!["cmd1".into(), "cmd2mod".into()].into())
            .unwrap();

        assert_eq!(result.stdin, Arc::from("stdin".as_bytes()));

        // all outputs of the last called command
        assert_eq!(
            result.outputs,
            vec![
                Output::ok_str("cmd1-output"),
                Output::ok_str("cmd2mod-output"),
            ]
        );

        // cmd2mod is called since it's modified
        assert_eq!(
            *calls.borrow(),
            vec![("cmd2mod".into(), "cmd1-output".into()),]
        );

        // cmd2 replaced with cmd2mod and cmd3 removed since it's invalid after modified command
        assert_eq!(
            *runner.cache.borrow(),
            vec![
                cache_entry("cmd1", "cmd1-output"),
                cache_entry("cmd2mod", "cmd2mod-output"),
            ]
        );
    }

    #[test]
    fn test_cmd_runner_modified_in_the_middle_and_extended() {
        let calls = Rc::new(RefCell::new(vec![]));
        let mock_exec = MockExec {
            calls: calls.clone(),
        };
        let runner = cached_runner(Box::new(mock_exec), "stdin".as_bytes().into());

        let _init_run = runner
            .run(&vec!["cmd1".into(), "cmd2".into(), "cmd3".into()].into())
            .unwrap();
        calls.borrow_mut().clear();

        // second run for shorter command - keep whole cache
        let result = runner
            .run(&vec!["cmd1".into(), "cmd2mod".into(), "cmd3".into()].into())
            .unwrap();

        assert_eq!(result.stdin, Arc::from("stdin".as_bytes()));

        // all outputs of the last called command
        assert_eq!(
            result.outputs,
            vec![
                Output::ok_str("cmd1-output"),
                Output::ok_str("cmd2mod-output"),
                Output::ok_str("cmd3-output")
            ]
        );

        // cmd2mod is called since it's modified
        // cmd3 is also called because it was after modified command
        assert_eq!(
            *calls.borrow(),
            vec![
                ("cmd2mod".into(), "cmd1-output".into()),
                ("cmd3".into(), "cmd2mod-output".into()),
            ]
        );

        // cmd2 replaced with cmd2mod and cmd3 replaced with updated output
        assert_eq!(
            *runner.cache.borrow(),
            vec![
                cache_entry("cmd1", "cmd1-output"),
                cache_entry("cmd2mod", "cmd2mod-output"),
                cache_entry("cmd3", "cmd3-output"),
            ]
        );
    }

    #[test]
    fn test_cmd_runner_errors() {
        let calls = Rc::new(RefCell::new(vec![]));
        let mock_exec = MockExec {
            calls: calls.clone(),
        };
        let runner = cached_runner(Box::new(mock_exec), "stdin".as_bytes().into());

        let result = runner
            .run(&vec!["cmd1".into(), "cmd2err".into(), "cmd3".into()].into())
            .unwrap();

        assert_eq!(result.stdin, Arc::from("stdin".as_bytes()));

        // all outputs of the last called command - breaks on first error
        assert_eq!(
            result.outputs,
            vec![
                Output::ok_str("cmd1-output"),
                Output::err_str("cmd2err-output"),
            ]
        );

        // cmd2mod is called since it's modified
        // cmd3 is also called because it was after modified command
        assert_eq!(
            *calls.borrow(),
            vec![
                ("cmd1".into(), "stdin".into()),
                ("cmd2err".into(), "cmd1-output".into()),
            ]
        );

        // only cmd1 is cached since it didn't fail
        assert_eq!(
            *runner.cache.borrow(),
            vec![cache_entry("cmd1", "cmd1-output"),]
        );
    }

    #[test]
    fn test_cmd_runner_errors_clear_cache() {
        let calls = Rc::new(RefCell::new(vec![]));
        let mock_exec = MockExec {
            calls: calls.clone(),
        };
        let runner = cached_runner(Box::new(mock_exec), "stdin".as_bytes().into());

        let _init_run = runner
            .run(&vec!["cmd1".into(), "cmd2".into(), "cmd3".into()].into())
            .unwrap();
        calls.borrow_mut().clear();

        let result = runner
            .run(&vec!["cmd1".into(), "cmd2err".into(), "cmd3".into()].into())
            .unwrap();

        assert_eq!(result.stdin, Arc::from("stdin".as_bytes()));

        // all outputs of the last called command - breaks on first error
        assert_eq!(
            result.outputs,
            vec![
                Output::ok_str("cmd1-output"),
                Output::err_str("cmd2err-output"),
            ]
        );

        // cmd1 not called because it's cached
        assert_eq!(
            *calls.borrow(),
            vec![("cmd2err".into(), "cmd1-output".into()),]
        );

        // only cmd1 is cached since it didn't fail
        // entry for cmd3 is cleared because cmd2err failed before
        assert_eq!(
            *runner.cache.borrow(),
            vec![cache_entry("cmd1", "cmd1-output"),]
        );
    }
}