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

use std::sync::{Arc, Mutex};

use error_chain::bail;
use flowcore::errors::Result;
use flowcore::model::metrics::Metrics;
use flowcore::model::submission::Submission;
use flowrlib::run_state::RunState;
use flowrlib::submission_handler::SubmissionHandler;
use log::{debug, error, info, trace};

use crate::connection_manager;
use crate::gui::client_message::ClientMessage;
use crate::gui::coordinator_connection::{DONT_WAIT, WAIT};
use crate::gui::coordinator_message::CoordinatorMessage;
use crate::CoordinatorConnection;

/// A [`SubmissionHandler`] to allow submitting flows for execution from the CLI
pub(crate) struct CLISubmissionHandler {
    coordinator_connection: Arc<Mutex<CoordinatorConnection>>,
}

impl CLISubmissionHandler {
    /// Create a new Submission handler using the connection provided
    pub fn new(connection: Arc<Mutex<CoordinatorConnection>>) -> Self {
        CLISubmissionHandler {
            coordinator_connection: connection,
        }
    }
}

impl SubmissionHandler for CLISubmissionHandler {
    fn flow_execution_starting(&mut self) -> Result<()> {
        self.coordinator_connection
            .lock()
            .map_err(|_| "Could not lock coordinator connection")?
            .send_and_receive_response::<CoordinatorMessage, ClientMessage>(
                CoordinatorMessage::FlowStart,
            )
            .map(|_| ())
    }

    // See if the runtime client has sent a message to request us to enter the debugger,
    // if so, return Ok(true).
    // A different message or Absence of a message returns Ok(false)
    fn should_enter_debugger(&mut self) -> Result<bool> {
        let msg = self
            .coordinator_connection
            .lock()
            .map_err(|_| "Could not lock coordinator connection")?
            .receive(DONT_WAIT);
        match msg {
            Ok(ClientMessage::EnterDebugger) => {
                debug!("Got EnterDebugger message");
                Ok(true)
            }
            Ok(m) => {
                debug!("Got {m:?} message");
                Ok(false)
            }
            _ => Ok(false),
        }
    }

    fn should_stop(&mut self) -> Result<bool> {
        if connection_manager::take_stop_request() {
            debug!("Stop requested by user");
            Ok(true)
        } else {
            Ok(false)
        }
    }

    fn jobs_created(&mut self, count: usize) {
        connection_manager::set_job_count(count);
    }

    fn flow_execution_ended(&mut self, state: &RunState, metrics: Metrics) -> Result<()> {
        self.coordinator_connection
            .lock()
            .map_err(|_| "Could not lock coordinator connection")?
            .send(CoordinatorMessage::FlowEnd(metrics))?;
        debug!("{state}");
        Ok(())
    }

    // Loop waiting for one of the following two messages from the client thread:
    //  - `ClientSubmission` with a submission, then return Ok(Some(submission))
    //  - `ClientExiting` then return Ok(None)
    fn wait_for_submission(&mut self) -> Result<Option<Submission>> {
        loop {
            info!("Coordinator is waiting to receive a 'Submission'");
            let guard = self.coordinator_connection.lock();
            #[allow(clippy::single_match_else)]
            match guard {
                Ok(locked) => {
                    let received = locked.receive(WAIT);
                    match received {
                        Ok(ClientMessage::ClientSubmission(submission)) => {
                            info!("Coordinator received a submission for execution");
                            trace!("\n{submission}");
                            return Ok(Some(*submission));
                        }
                        Ok(ClientMessage::ClientExiting(_)) => return Ok(None),
                        // Unexpected message — log and continue waiting for a valid submission
                        Ok(r) => error!("Coordinator did not expect message from client: '{r:?}'"),
                        Err(e) => bail!("Coordinator error while waiting for submission: '{}'", e),
                    }
                }
                _ => {
                    // Lock failure — log and exit submission loop gracefully
                    error!("Coordinator could not lock connection");
                    return Ok(None);
                }
            }
        }
    }

    fn coordinator_is_exiting(&mut self, result: Result<()>) -> Result<()> {
        debug!("Coordinator exiting");
        let mut connection = self
            .coordinator_connection
            .lock()
            .map_err(|e| format!("Could not lock Coordinator Connection: {e}"))?;
        connection.send(CoordinatorMessage::CoordinatorExiting(result))
    }
}