make instrumentation sync instead of async to avoid concurrency issues

harmony_composer/src/harmony_composer_logger.rs

@@ -1,82 +1,66 @@
 use harmony_cli::progress::{IndicatifProgressTracker, ProgressTracker};
 use indicatif::MultiProgress;
-use std::sync::Arc;
 
 use crate::instrumentation::{self, HarmonyComposerEvent};
 
-pub fn init() -> tokio::task::JoinHandle<()> {
+pub fn init() {
     configure_logger();
-    let handle = tokio::spawn(handle_events());
-
-    loop {
-        if instrumentation::instrument(HarmonyComposerEvent::HarmonyComposerStarted).is_ok() {
-            break;
-        }
-    }
-
-    handle
+    handle_events();
 }
 
 fn configure_logger() {
     env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).build();
 }
 
-pub async fn handle_events() {
-    let progress_tracker = Arc::new(IndicatifProgressTracker::new(MultiProgress::new()));
+pub fn handle_events() {
+    let progress_tracker = IndicatifProgressTracker::new(MultiProgress::new());
 
     const SETUP_SECTION: &str = "project-initialization";
     const COMPILTATION_TASK: &str = "compilation";
     const PROGRESS_DEPLOYMENT: &str = "deployment";
 
     instrumentation::subscribe("Harmony Composer Logger", {
-        move |event| {
-            let progress_tracker = Arc::clone(&progress_tracker);
-
-            async move {
-                match event {
-                    HarmonyComposerEvent::HarmonyComposerStarted => {}
-                    HarmonyComposerEvent::ProjectInitializationStarted => {
-                        progress_tracker.add_section(
-                            SETUP_SECTION,
-                            &format!(
-                                "{} Initializing Harmony project...",
-                                harmony_cli::theme::EMOJI_HARMONY,
-                            ),
-                        );
-                    }
-                    HarmonyComposerEvent::ProjectInitialized => {}
-                    HarmonyComposerEvent::ProjectCompilationStarted { details } => {
-                        progress_tracker.add_task(SETUP_SECTION, COMPILTATION_TASK, &details);
-                    }
-                    HarmonyComposerEvent::ProjectCompiled => {
-                        progress_tracker.finish_task(COMPILTATION_TASK, "project compiled");
-                    }
-                    HarmonyComposerEvent::ProjectCompilationFailed { details } => {
-                        progress_tracker.fail_task(COMPILTATION_TASK, &format!("failed to compile project:\n{details}"));
-                    }
-                    HarmonyComposerEvent::DeploymentStarted { target, profile } => {
-                        progress_tracker.add_section(
-                            PROGRESS_DEPLOYMENT,
-                            &format!(
-                                "\n{} Deploying project on target '{target}' with profile '{profile}'...\n",
-                                harmony_cli::theme::EMOJI_DEPLOY,
-                            ),
-                        );
-                    }
-                    HarmonyComposerEvent::DeploymentCompleted => {
-                        progress_tracker.clear();
-                    }
-                    HarmonyComposerEvent::DeploymentFailed { details } => {
-                        progress_tracker.add_task(PROGRESS_DEPLOYMENT, "deployment-failed", "");
-                        progress_tracker.fail_task("deployment-failed", &details);
-                    },
-                    HarmonyComposerEvent::Shutdown => {
-                        return false;
-                    }
-                }
-                true
+        move |event| match event {
+            HarmonyComposerEvent::HarmonyComposerStarted => {}
+            HarmonyComposerEvent::ProjectInitializationStarted => {
+                progress_tracker.add_section(
+                    SETUP_SECTION,
+                    &format!(
+                        "{} Initializing Harmony project...",
+                        harmony_cli::theme::EMOJI_HARMONY,
+                    ),
+                );
             }
+            HarmonyComposerEvent::ProjectInitialized => {}
+            HarmonyComposerEvent::ProjectCompilationStarted { details } => {
+                progress_tracker.add_task(SETUP_SECTION, COMPILTATION_TASK, details);
+            }
+            HarmonyComposerEvent::ProjectCompiled => {
+                progress_tracker.finish_task(COMPILTATION_TASK, "project compiled");
+            }
+            HarmonyComposerEvent::ProjectCompilationFailed { details } => {
+                progress_tracker.fail_task(
+                    COMPILTATION_TASK,
+                    &format!("failed to compile project:\n{details}"),
+                );
+            }
+            HarmonyComposerEvent::DeploymentStarted { target, profile } => {
+                progress_tracker.add_section(
+                    PROGRESS_DEPLOYMENT,
+                    &format!(
+                        "\n{} Deploying project on target '{target}' with profile '{profile}'...\n",
+                        harmony_cli::theme::EMOJI_DEPLOY,
+                    ),
+                );
+            }
+            HarmonyComposerEvent::DeploymentCompleted => {
+                progress_tracker.clear();
+            }
+            HarmonyComposerEvent::DeploymentFailed { details } => {
+                progress_tracker.add_task(PROGRESS_DEPLOYMENT, "deployment-failed", "");
+                progress_tracker.fail_task("deployment-failed", details);
+            }
+            HarmonyComposerEvent::Shutdown => {}
         }
     })
-    .await
 }

harmony_composer/src/instrumentation.rs

@@ -1,6 +1,5 @@
-use log::debug;
 use once_cell::sync::Lazy;
-use tokio::sync::broadcast;
+use std::{collections::HashMap, sync::Mutex};
 
 use crate::{HarmonyProfile, HarmonyTarget};
 
@@ -27,48 +26,43 @@ pub enum HarmonyComposerEvent {
     Shutdown,
 }
 
-static HARMONY_COMPOSER_EVENT_BUS: Lazy<broadcast::Sender<HarmonyComposerEvent>> =
-    Lazy::new(|| {
-        // TODO: Adjust channel capacity
-        let (tx, _rx) = broadcast::channel(16);
-        tx
-    });
+type Subscriber = Box<dyn Fn(&HarmonyComposerEvent) + Send + Sync>;
 
-pub fn instrument(event: HarmonyComposerEvent) -> Result<(), &'static str> {
-    #[cfg(not(test))]
-    {
-        match HARMONY_COMPOSER_EVENT_BUS.send(event) {
-            Ok(_) => Ok(()),
-            Err(_) => Err("send error: no subscribers"),
-        }
-    }
+static SUBSCRIBERS: Lazy<Mutex<HashMap<String, Subscriber>>> =
+    Lazy::new(|| Mutex::new(HashMap::new()));
 
-    #[cfg(test)]
-    {
-        let _ = event; // Suppress the "unused variable" warning for `event`
-        Ok(())
-    }
-}
-
-pub async fn subscribe<F, Fut>(name: &str, mut handler: F)
+/// Subscribes a listener to all instrumentation events.
+///
+/// Simply provide a unique name and a closure to run when an event happens.
+///
+/// # Example
+/// ```
+/// instrumentation::subscribe("my_logger", |event| {
+///   println!("Event occurred: {:?}", event);
+/// });
+/// ```
+pub fn subscribe<F>(name: &str, callback: F)
 where
-    F: FnMut(HarmonyComposerEvent) -> Fut + Send + 'static,
-    Fut: Future<Output = bool> + Send,
+    F: Fn(&HarmonyComposerEvent) + Send + Sync + 'static,
 {
-    let mut rx = HARMONY_COMPOSER_EVENT_BUS.subscribe();
-    debug!("[{name}] Service started. Listening for events...");
-    loop {
-        match rx.recv().await {
-            Ok(event) => {
-                if !handler(event).await {
-                    debug!("[{name}] Handler requested exit.");
-                    break;
-                }
-            }
-            Err(broadcast::error::RecvError::Lagged(n)) => {
-                debug!("[{name}] Lagged behind by {n} messages.");
-            }
-            Err(_) => break,
-        }
-    }
+    let mut subs = SUBSCRIBERS.lock().unwrap();
+    subs.insert(name.to_string(), Box::new(callback));
+}
+
+/// Instruments an event, notifying all subscribers.
+///
+/// This will call every closure that was registered with `subscribe`.
+///
+/// # Example
+/// ```
+/// instrumentation::instrument(HarmonyEvent::HarmonyStarted);
+/// ```
+pub fn instrument(event: HarmonyComposerEvent) -> Result<(), &'static str> {
+    let subs = SUBSCRIBERS.lock().unwrap();
+
+    for callback in subs.values() {
+        callback(&event);
+    }
+
+    Ok(())
 }

harmony_composer/src/main.rs

@@ -99,7 +99,7 @@ impl std::fmt::Display for HarmonyProfile {
 
 #[tokio::main]
 async fn main() {
-    let hc_logger_handle = harmony_composer_logger::init();
+    harmony_composer_logger::init();
     let cli_args = GlobalArgs::parse();
 
     let harmony_path = Path::new(&cli_args.harmony_path)
@@ -199,8 +199,6 @@ async fn main() {
     }
 
     instrumentation::instrument(HarmonyComposerEvent::Shutdown).unwrap();
-
-    let _ = tokio::try_join!(hc_logger_handle);
 }
 
 #[derive(Clone, Debug, clap::ValueEnum)]