Framebuffer update #60
Conversation
bin/src/daemon.rs
Outdated
| @@ -43,11 +43,13 @@ async fn run_server( | |||
| config: &config::Config, | |||
| qmdl_store_lock: Arc<RwLock<RecordingStore>>, | |||
| server_shutdown_rx: oneshot::Receiver<()>, | |||
| ui_update_tx: Sender<framebuffer::Color565>, | |||
There was a problem hiding this comment.
IMO this channel should use descriptive enums of display state, rather than colors directly. something like:
enum DisplayState {
Recording,
Paused,
WarningDetected,
}and then the framebuffer code assigns those colors as an implementation detail
bin/src/diag.rs
Outdated
| @@ -47,6 +49,7 @@ impl AnalysisWriter { | |||
| writer: BufWriter::new(file), | |||
| harness: Harness::new_with_all_analyzers(), | |||
| bytes_written: 0, | |||
| has_warning: false, | |||
There was a problem hiding this comment.
hmm i'm not sure why the writer should keep this state around?
There was a problem hiding this comment.
yes good point, removed.
bin/src/diag.rs
Outdated
| qmdl_store.update_entry_has_warning(index, analysis_writer.has_warning).await | ||
| .expect("failed to update analysis file has warning"); |
There was a problem hiding this comment.
imo we shouldn't be storing whether a warning was detected in the QMDL store, but instead should return from analysis_writer.analyze() an indication of whether a warning was detected and then update the UI from here.
changing analyze()'s return type to be Result<(usize, bool), std::io::Error> would be easy enough
bin/src/stats.rs
Outdated
| if current_entry.clone().unwrap().has_warning { | ||
| info!("a heuristic triggered on this run!"); | ||
| state.ui_update_sender.send(framebuffer::Color565::Red).await | ||
| .map_err(|e| (StatusCode::INTERNAL_SERVER_ERROR, format!("couldn't send ui update message: {}", e)))?; | ||
| } |
There was a problem hiding this comment.
as per above, this should happen in the diag thread
There was a problem hiding this comment.
I moved this to analysis_writer.analyze() per your suggestion.
lib/src/analysis/example_analyzer.rs
Outdated
| pub struct ExampleAnalyzer{ | ||
| pub count: i32, | ||
| } |
There was a problem hiding this comment.
imo this kinda thing should be defined in a test file. also this is pedantic i guess but i'd describe it less as an ExampleAnalyzer and more like a DebugAnalyzer
There was a problem hiding this comment.
Good call, I renamed it test analyzer and put it behind a gate where it will only run for debug builds.
| } | ||
|
|
||
| fn get_description(&self) -> Cow<str> { | ||
| Cow::from("Always returns true, if you are seeing this you are either a developer or you are about to have problems.") |
| pub fn get_color_from_state(state: DisplayState) -> Color565 { | ||
| match state { | ||
| DisplayState::Paused => Color565::White, | ||
| DisplayState::Recording => Color565::Green, | ||
| DisplayState::WarningDetected => Color565::Red, | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
nitpick: idiomatically i think this should be an impl From<DisplayState> for Color565 {}, and then we could just say display_color = state.into() in the recv block
Fixes #57
adds quality of life improvements to framebuffer UI
white: not running
green: running
red: heuristic triggered
Also changes web ui to reflect same design language.
TODO: Write migration for qmdl metadata file, this could be in the same pull request or separate pull request.
DO NOT MERGE THIS PULL REQUEST WITHOUT COMMENTING OUT THE TEST ANALYZER IT IS VERY LOUD