refactor connection logic [CPP-322][CPP-329]

.github/workflows/main.yml

@@ -90,8 +90,11 @@ jobs:
             ${{ runner.os }}-
 
       - name: Set up python builder
+        shell: bash
         run: |
           cargo make setup-builder
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Run Backend Benchmarks (Windows)
         env:
@@ -156,8 +159,11 @@ jobs:
             ${{ runner.os }}-
 
       - name: Set up python builder
+        shell: bash
         run: |
           cargo make setup-builder
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Run Checks
         run: |
@@ -262,8 +268,11 @@ jobs:
             ${{ runner.os }}-
 
       - name: Set up python builder
+        shell: bash
         run: |
           cargo make setup-builder
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Build ${{ runner.os }} Binaries.
         env:

Makefile.toml

@@ -147,6 +147,18 @@ Get-ChildItem .\console_backend -Recurse -Include @("*.egg-info", "*.dist-info")
 command = "${PYTHON}"
 args = ["-m", "swiftnav_console.main", "${@}"]
 
+[tasks.start-console-gdb]
+command = "rust-gdb"
+args = [
+  "-ex",
+  "run",
+  "--args",
+  "${PYTHON}",
+  "-m",
+  "swiftnav_console.main",
+  "${@}",
+]
+
 [tasks.qml-run]
 dependencies = ["generate-resources"]
 run_task = "start-console"
@@ -161,6 +173,16 @@ dependencies = [
 ]
 run_task = "start-console"
 
+[tasks.gdb-run]
+dependencies = [
+  "copy-capnp",
+  "generate-resources",
+  "remove-egg-dist",
+  "store-version",
+  "install-backend",
+]
+run_task = "start-console-gdb"
+
 [tasks.prod-run]
 dependencies = [
   "copy-capnp",
@@ -214,7 +236,6 @@ command = "${PYTHON}"
 args = ["setup.py", "bdist_wheel"]
 
 [tasks.get-get-pip]
-condition = { files_not_exist = ["${WORKSPACE}/get-pip.py"] }
 script_runner = "@duckscript"
 script = '''
 wget -O ./get-pip.py https://bootstrap.pypa.io/get-pip.py
@@ -248,7 +269,6 @@ cm_run_task generate-resources
 '''
 
 [tasks.prep-dist]
-dependencies = ["get-standalone-py"]
 script_runner = "@duckscript"
 script = '''
 cm_run_task copy-capnp
@@ -502,7 +522,7 @@ args = ["clippy", "--all-targets", "--", "--deny", "warnings"]
 dependencies = ["store-version", "copy-capnp"]
 command = "cargo"
 cwd = "console_backend"
-args = ["test", "--features", "tests", "--", "--nocapture"]
+args = ["test", "--features", "tests", "${@}", "--", "--nocapture"]
 
 [tasks.rust-type-check]
 dependencies = ["store-version", "copy-capnp"]

console_backend/Cargo.toml

@@ -40,8 +40,8 @@ minreq = { version = "2.4.2", features = ["https"] }
 regex = { version = "1.5.4" }
 semver = { version = "1" }
 rust-ini = "0.17.0"
-sbp = { version = "4.0", features = ["json", "link", "swiftnav"] }
-sbp-settings = "0.1"
+sbp = { version = "4.0.2", features = ["json", "link", "swiftnav"] }
+sbp-settings = "0.2"
 env_logger = { version = "0.9", optional = true }
 mimalloc = { version = "0.1", default-features = false }
 

console_backend/benches/cpu_benches.rs

@@ -12,7 +12,8 @@ use std::{
 
 extern crate console_backend;
 use console_backend::{
-    connection::Connection,
+    common_constants::ConnectionState,
+    connection::{Connection, ConnectionManager},
     process_messages,
     shared_state::SharedState,
     types::{ClientSender, RealtimeDelay},
@@ -51,23 +52,22 @@ fn run_process_messages(file_in_name: &str, failure: bool) {
         assert!(iter_count > 0);
     });
     {
-        let (client_send_, client_recv) = channel::unbounded::<Vec<u8>>();
+        let (client_send, client_recv) = channel::unbounded::<Vec<u8>>();
+        let client_send = ClientSender::new(client_send);
         client_recv_tx
             .send(client_recv)
             .expect("sending client recv handle should succeed");
         if failure {
             thread::sleep(time::Duration::from_millis(FAILURE_CASE_SLEEP_MILLIS));
         }
         let shared_state = SharedState::new();
-        let client_send = ClientSender::new(client_send_);
-        shared_state.set_running(true, client_send.clone());
         shared_state.set_debug(true);
-        let conn = Connection::file(
+        let conn_manager = ConnectionManager::new(client_send, shared_state);
+        conn_manager.connect_to_file(
             file_in_name.into(),
             RealtimeDelay::Off,
             /*close_when_done=*/ true,
         );
-        process_messages::process_messages(conn, shared_state, client_send).unwrap();
     }
     recv_thread.join().expect("join should succeed");
 }

console_backend/src/bin/headless-console.rs

@@ -2,7 +2,7 @@ use anyhow::Result;
 use chrono::prelude::*;
 use console_backend::{
     cli_options::{handle_cli, CliOptions},
-    connection::ConnectionState,
+    connection::ConnectionManager,
     log_panel::setup_logging,
     server_recv_thread::server_recv_thread,
     shared_state::SharedState,
@@ -30,11 +30,11 @@ Usage:
     let client_send = ClientSender::new(client_send_);
     setup_logging(client_send.clone(), true);
     let shared_state = SharedState::new();
-    let connection_state = ConnectionState::new(client_send.clone(), shared_state.clone());
-    handle_cli(opt, &connection_state, shared_state.clone());
+    let conn_manager = ConnectionManager::new(client_send.clone(), shared_state.clone());
+    handle_cli(opt, &conn_manager, shared_state.clone());
     refresh_navbar(&mut client_send.clone(), shared_state.clone());
     refresh_loggingbar(&mut client_send.clone(), shared_state.clone());
-    server_recv_thread(connection_state, client_send, server_recv, shared_state);
+    server_recv_thread(conn_manager, client_send, server_recv, shared_state);
 
     let mut msg_count: usize = 0;
     while client_recv.recv().is_ok() {

console_backend/src/cli_options.rs

@@ -16,7 +16,7 @@ use crate::shared_state::SharedState;
 use crate::types::{FlowControl, RealtimeDelay};
 use crate::{
     common_constants::{SbpLogging, Tabs},
-    connection::{Connection, ConnectionState},
+    connection::{Connection, ConnectionManager},
 };
 
 #[derive(Debug)]
@@ -262,26 +262,26 @@ fn is_baudrate(br: &str) -> Result<(), String> {
 ///
 /// # Parameters
 /// - `opt`: CLI Options to start specific connection type.
-/// - `connection_state`: The Server state to start a specific connection.
+/// - `conn_manager`: The Server state to start a specific connection.
 /// - `client_send`: Client Sender channel for communication from backend to frontend.
 /// - `shared_state`: The shared state for validating another connection is not already running.
-pub fn handle_cli(opt: CliOptions, connection_state: &ConnectionState, shared_state: SharedState) {
+pub fn handle_cli(opt: CliOptions, conn_manager: &ConnectionManager, shared_state: SharedState) {
     if let Some(opt_input) = opt.input {
         match opt_input {
             Input::Tcp { host, port } => {
-                connection_state.connect_to_host(host, port);
+                conn_manager.connect_to_host(host, port);
             }
             Input::File { file_in } => {
                 let filename = file_in.display().to_string();
-                connection_state.connect_to_file(filename, RealtimeDelay::On, opt.exit_after);
+                conn_manager.connect_to_file(filename, RealtimeDelay::On, opt.exit_after);
             }
             Input::Serial {
                 serialport,
                 baudrate,
                 flow_control,
             } => {
                 let serialport = serialport.display().to_string();
-                connection_state.connect_to_serial(serialport, baudrate, flow_control);
+                conn_manager.connect_to_serial(serialport, baudrate, flow_control);
             }
         }
     }

console_backend/src/common_constants.rs

@@ -157,8 +157,8 @@ pub enum Keys {
     PREVIOUS_PORTS,
     #[strum(serialize = "PREVIOUS_FILES")]
     PREVIOUS_FILES,
-    #[strum(serialize = "CONNECTED")]
-    CONNECTED,
+    #[strum(serialize = "CONNECTION_STATE")]
+    CONNECTION_STATE,
     #[strum(serialize = "PORT")]
     PORT,
     #[strum(serialize = "POS")]
@@ -282,9 +282,9 @@ pub enum Keys {
 }
 
 #[derive(Clone, Debug, Display, EnumString, EnumVariantNames, Eq, Hash, PartialEq)]
-pub enum ApplicationStates {
-    #[strum(serialize = "CLOSE")]
-    CLOSE,
+pub enum ConnectionState {
+    #[strum(serialize = "CLOSED")]
+    CLOSED,
     #[strum(serialize = "CONNECTED")]
     CONNECTED,
     #[strum(serialize = "DISCONNECTED")]