Ian Letourneau
1de96027a1
The CI pipeline (`./check.sh`) was failing because of test errors, which was caused by the instrumentation framework complaining that no subscribers/listeners were registered. Instead of setting up all tests to run with a dummy subscriber, move the implementation of the instrumentation behind a feature flag so that it runs only for tests. There's a catch though: the `#[cfg(test)]` directive works only when directly testing the crate. If a crate `A` depends on another crate `B`, `B` will be compiled as usual (aka not in test mode) which will not trigger the `test` flag. So we need to introduce our own `testing` feature flag for `harmony` core and import it with that flag (only during dev/test). More info: https://github.com/rust-lang/rust/issues/59168 Co-authored-by: Ian Letourneau <letourneau.ian@gmail.com> Reviewed-on: https://git.nationtech.io/NationTech/harmony/pulls/102
63 lines
1.7 KiB
Rust
63 lines
1.7 KiB
Rust
use log::debug;
|
|
use once_cell::sync::Lazy;
|
|
use tokio::sync::broadcast;
|
|
|
|
#[derive(Debug, Clone)]
|
|
pub enum HarmonyComposerEvent {
|
|
HarmonyComposerStarted,
|
|
ProjectInitializationStarted,
|
|
ProjectInitialized,
|
|
ProjectCompilationStarted { details: String },
|
|
ProjectCompiled,
|
|
ProjectCompilationFailed { details: String },
|
|
DeploymentStarted { target: String },
|
|
DeploymentCompleted,
|
|
Shutdown,
|
|
}
|
|
|
|
static HARMONY_COMPOSER_EVENT_BUS: Lazy<broadcast::Sender<HarmonyComposerEvent>> =
|
|
Lazy::new(|| {
|
|
// TODO: Adjust channel capacity
|
|
let (tx, _rx) = broadcast::channel(16);
|
|
tx
|
|
});
|
|
|
|
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"),
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
{
|
|
let _ = event; // Suppress the "unused variable" warning for `event`
|
|
Ok(())
|
|
}
|
|
}
|
|
|
|
pub async fn subscribe<F, Fut>(name: &str, mut handler: F)
|
|
where
|
|
F: FnMut(HarmonyComposerEvent) -> Fut + Send + 'static,
|
|
Fut: Future<Output = bool> + Send,
|
|
{
|
|
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,
|
|
}
|
|
}
|
|
}
|