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
use serde_json::Value;
use flowcore::errors::Result;
use flowcore::model::input::Input;
use flowcore::model::output_connection::OutputConnection;
use flowcore::model::runtime_function::RuntimeFunction;
use crate::block::Block;
use crate::debug_command::DebugCommand;
use crate::job::Job;
use crate::run_state::RunState;
use crate::run_state::State;
/// `[DebugHandler]` trait that must be implemented by clients wishing to interface with the debugger
///
/// Programs that wish to offer a debugger user interface (such as a CLI or UI) should implement
/// this trait. The [Coordinator][crate::coordinator::Coordinator] uses it to interact with the
/// client for debugging.
pub trait DebuggerHandler {
/// Start the debugger - which swallows the first message to initialize the connection
fn start(&mut self);
/// a breakpoint has been hit on a Job being created
fn job_breakpoint(&mut self, job: &Job, function: &RuntimeFunction, states: Vec<State>);
/// A breakpoint set on creation of a `Block` matching `block` has been hit
fn block_breakpoint(&mut self, block: &Block);
/// A breakpoint set on the unblocking of a flow has been hit
fn flow_unblock_breakpoint(&mut self, flow_id: usize);
/// A breakpoint on sending a value from a specific function or to a specific function was hit
#[allow(clippy::too_many_arguments)]
fn send_breakpoint(
&mut self,
source_function_name: &str,
source_function_id: usize,
output_route: &str,
value: &Value,
destination_id: usize,
destination_name: &str,
io_name: &str,
input_number: usize,
);
/// A job error occurred during execution of the flow
fn job_error(&mut self, job: &Job);
/// A specific job completed
fn job_completed(&mut self, job: &Job);
/// returns a set of blocks
fn blocks(&mut self, blocks: Vec<Block>);
/// returns an output's connections
fn outputs(&mut self, output: Vec<OutputConnection>);
/// returns an inputs state
fn input(&mut self, input: Input);
/// lists all functions
fn function_list(&mut self, functions: &[RuntimeFunction]);
/// returns the state of a function
fn function_states(&mut self, function: RuntimeFunction, function_states: Vec<State>);
/// returns the global run state
fn run_state(&mut self, run_state: &RunState);
/// a string message from the Debugger
fn message(&mut self, message: String);
/// a panic occurred during execution
fn panic(&mut self, state: &RunState, error_message: String);
/// the debugger is exiting
fn debugger_exiting(&mut self);
/// The debugger is resetting the runtime state
fn debugger_resetting(&mut self);
/// An error occurred in the debugger
fn debugger_error(&mut self, error: String);
/// execution of the flow is starting
fn execution_starting(&mut self);
/// Execution of the flow fn `execution_ended`
fn execution_ended(&mut self);
/// Get a command for the debugger to perform
///
/// # Errors
///
/// Returns an error if the next command cannot be fetched, usually related to networking
fn get_command(&mut self, state: &RunState) -> Result<DebugCommand>;
}