Refactored to require handlers to specify the components they rely on and to specify when they are ready. This fixes a lot of bugs with the UI when users try to press buttons while the application is still loading.

This commit is contained in:
2024-07-17 19:55:10 -06:00
parent 9104b7c356
commit d84e7dfcab
49 changed files with 5143 additions and 265 deletions
@@ -9,6 +9,7 @@ mod tests {
use crate::event::Key;
use crate::handlers::radarr_handlers::system::SystemHandler;
use crate::handlers::KeyEventHandler;
use crate::models::radarr_models::{QueueEvent, Task};
use crate::models::servarr_data::radarr::radarr_data::{
ActiveRadarrBlock, SYSTEM_DETAILS_BLOCKS,
};
@@ -19,9 +20,10 @@ mod tests {
use super::*;
#[test]
fn test_system_tab_left() {
#[rstest]
fn test_system_tab_left(#[values(true, false)] is_ready: bool) {
let mut app = App::default();
app.is_loading = is_ready;
app.data.radarr_data.main_tabs.set_index(6);
SystemHandler::with(
@@ -39,9 +41,10 @@ mod tests {
assert_eq!(app.get_current_route(), &ActiveRadarrBlock::Indexers.into());
}
#[test]
fn test_system_tab_right() {
#[rstest]
fn test_system_tab_right(#[values(true, false)] is_ready: bool) {
let mut app = App::default();
app.is_loading = is_ready;
app.data.radarr_data.main_tabs.set_index(6);
SystemHandler::with(
@@ -67,9 +70,10 @@ mod tests {
const ESC_KEY: Key = DEFAULT_KEYBINDINGS.esc.key;
#[test]
fn test_default_esc() {
#[rstest]
fn test_default_esc(#[values(true, false)] is_loading: bool) {
let mut app = App::default();
app.is_loading = is_loading;
app.error = "test error".to_owned().into();
app.push_navigation_stack(ActiveRadarrBlock::System.into());
app.push_navigation_stack(ActiveRadarrBlock::System.into());
@@ -84,7 +88,6 @@ mod tests {
mod test_handle_key_char {
use pretty_assertions::{assert_eq, assert_str_eq};
use crate::assert_refresh_key;
use crate::models::HorizontallyScrollableText;
use super::*;
@@ -92,6 +95,16 @@ mod tests {
#[test]
fn test_update_system_key() {
let mut app = App::default();
app.data.radarr_data.logs.set_items(vec![
HorizontallyScrollableText::from("test 1"),
HorizontallyScrollableText::from("test 2"),
]);
app
.data
.radarr_data
.queued_events
.set_items(vec![QueueEvent::default()]);
app.data.radarr_data.tasks.set_items(vec![Task::default()]);
SystemHandler::with(
&DEFAULT_KEYBINDINGS.update.key,
@@ -107,9 +120,46 @@ mod tests {
);
}
#[test]
fn test_update_system_key_no_op_if_not_ready() {
let mut app = App::default();
app.is_loading = true;
app.push_navigation_stack(ActiveRadarrBlock::System.into());
app.data.radarr_data.logs.set_items(vec![
HorizontallyScrollableText::from("test 1"),
HorizontallyScrollableText::from("test 2"),
]);
app
.data
.radarr_data
.queued_events
.set_items(vec![QueueEvent::default()]);
app.data.radarr_data.tasks.set_items(vec![Task::default()]);
SystemHandler::with(
&DEFAULT_KEYBINDINGS.update.key,
&mut app,
&ActiveRadarrBlock::System,
&None,
)
.handle();
assert_eq!(app.get_current_route(), &ActiveRadarrBlock::System.into());
}
#[test]
fn test_queued_events_key() {
let mut app = App::default();
app.data.radarr_data.logs.set_items(vec![
HorizontallyScrollableText::from("test 1"),
HorizontallyScrollableText::from("test 2"),
]);
app
.data
.radarr_data
.queued_events
.set_items(vec![QueueEvent::default()]);
app.data.radarr_data.tasks.set_items(vec![Task::default()]);
SystemHandler::with(
&DEFAULT_KEYBINDINGS.events.key,
@@ -125,9 +175,87 @@ mod tests {
);
}
#[test]
fn test_queued_events_key_no_op_if_not_ready() {
let mut app = App::default();
app.is_loading = true;
app.push_navigation_stack(ActiveRadarrBlock::System.into());
app.data.radarr_data.logs.set_items(vec![
HorizontallyScrollableText::from("test 1"),
HorizontallyScrollableText::from("test 2"),
]);
app
.data
.radarr_data
.queued_events
.set_items(vec![QueueEvent::default()]);
app.data.radarr_data.tasks.set_items(vec![Task::default()]);
SystemHandler::with(
&DEFAULT_KEYBINDINGS.events.key,
&mut app,
&ActiveRadarrBlock::System,
&None,
)
.handle();
assert_eq!(app.get_current_route(), &ActiveRadarrBlock::System.into());
}
#[test]
fn test_refresh_system_key() {
assert_refresh_key!(SystemHandler, ActiveRadarrBlock::System);
let mut app = App::default();
app.data.radarr_data.logs.set_items(vec![
HorizontallyScrollableText::from("test 1"),
HorizontallyScrollableText::from("test 2"),
]);
app
.data
.radarr_data
.queued_events
.set_items(vec![QueueEvent::default()]);
app.data.radarr_data.tasks.set_items(vec![Task::default()]);
app.push_navigation_stack(ActiveRadarrBlock::System.into());
SystemHandler::with(
&DEFAULT_KEYBINDINGS.refresh.key,
&mut app,
&ActiveRadarrBlock::System,
&None,
)
.handle();
assert_eq!(app.get_current_route(), &ActiveRadarrBlock::System.into());
assert!(app.should_refresh);
}
#[test]
fn test_refresh_system_key_no_op_if_not_ready() {
let mut app = App::default();
app.is_loading = true;
app.push_navigation_stack(ActiveRadarrBlock::System.into());
app.data.radarr_data.logs.set_items(vec![
HorizontallyScrollableText::from("test 1"),
HorizontallyScrollableText::from("test 2"),
]);
app
.data
.radarr_data
.queued_events
.set_items(vec![QueueEvent::default()]);
app.data.radarr_data.tasks.set_items(vec![Task::default()]);
app.push_navigation_stack(ActiveRadarrBlock::System.into());
SystemHandler::with(
&DEFAULT_KEYBINDINGS.refresh.key,
&mut app,
&ActiveRadarrBlock::System,
&None,
)
.handle();
assert_eq!(app.get_current_route(), &ActiveRadarrBlock::System.into());
assert!(!app.should_refresh);
}
#[test]
@@ -137,6 +265,12 @@ mod tests {
HorizontallyScrollableText::from("test 1"),
HorizontallyScrollableText::from("test 2"),
]);
app
.data
.radarr_data
.queued_events
.set_items(vec![QueueEvent::default()]);
app.data.radarr_data.tasks.set_items(vec![Task::default()]);
SystemHandler::with(
&DEFAULT_KEYBINDINGS.logs.key,
@@ -160,9 +294,47 @@ mod tests {
);
}
#[test]
fn test_logs_key_no_op_when_not_ready() {
let mut app = App::default();
app.is_loading = true;
app.push_navigation_stack(ActiveRadarrBlock::System.into());
app.data.radarr_data.logs.set_items(vec![
HorizontallyScrollableText::from("test 1"),
HorizontallyScrollableText::from("test 2"),
]);
app
.data
.radarr_data
.queued_events
.set_items(vec![QueueEvent::default()]);
app.data.radarr_data.tasks.set_items(vec![Task::default()]);
SystemHandler::with(
&DEFAULT_KEYBINDINGS.logs.key,
&mut app,
&ActiveRadarrBlock::System,
&None,
)
.handle();
assert_eq!(app.get_current_route(), &ActiveRadarrBlock::System.into());
assert!(app.data.radarr_data.log_details.is_empty());
}
#[test]
fn test_tasks_key() {
let mut app = App::default();
app.data.radarr_data.logs.set_items(vec![
HorizontallyScrollableText::from("test 1"),
HorizontallyScrollableText::from("test 2"),
]);
app
.data
.radarr_data
.queued_events
.set_items(vec![QueueEvent::default()]);
app.data.radarr_data.tasks.set_items(vec![Task::default()]);
SystemHandler::with(
&DEFAULT_KEYBINDINGS.tasks.key,
@@ -177,6 +349,33 @@ mod tests {
&ActiveRadarrBlock::SystemTasks.into()
);
}
#[test]
fn test_tasks_key_no_op_when_not_ready() {
let mut app = App::default();
app.is_loading = true;
app.push_navigation_stack(ActiveRadarrBlock::System.into());
app.data.radarr_data.logs.set_items(vec![
HorizontallyScrollableText::from("test 1"),
HorizontallyScrollableText::from("test 2"),
]);
app
.data
.radarr_data
.queued_events
.set_items(vec![QueueEvent::default()]);
app.data.radarr_data.tasks.set_items(vec![Task::default()]);
SystemHandler::with(
&DEFAULT_KEYBINDINGS.tasks.key,
&mut app,
&ActiveRadarrBlock::System,
&None,
)
.handle();
assert_eq!(app.get_current_route(), &ActiveRadarrBlock::System.into());
}
}
#[rstest]
@@ -210,4 +409,100 @@ mod tests {
}
})
}
#[test]
fn test_system_handler_is_not_ready_when_loading() {
let mut app = App::default();
app.is_loading = true;
let system_handler = SystemHandler::with(
&DEFAULT_KEYBINDINGS.update.key,
&mut app,
&ActiveRadarrBlock::System,
&None,
);
assert!(!system_handler.is_ready());
}
#[test]
fn test_system_handler_is_not_ready_when_logs_is_empty() {
let mut app = App::default();
app.is_loading = false;
app.data.radarr_data.tasks.set_items(vec![Task::default()]);
app
.data
.radarr_data
.queued_events
.set_items(vec![QueueEvent::default()]);
let system_handler = SystemHandler::with(
&DEFAULT_KEYBINDINGS.update.key,
&mut app,
&ActiveRadarrBlock::System,
&None,
);
assert!(!system_handler.is_ready());
}
#[test]
fn test_system_handler_is_not_ready_when_tasks_is_empty() {
let mut app = App::default();
app.is_loading = false;
app.data.radarr_data.logs.set_items(vec!["test".into()]);
app
.data
.radarr_data
.queued_events
.set_items(vec![QueueEvent::default()]);
let system_handler = SystemHandler::with(
&DEFAULT_KEYBINDINGS.update.key,
&mut app,
&ActiveRadarrBlock::System,
&None,
);
assert!(!system_handler.is_ready());
}
#[test]
fn test_system_handler_is_not_ready_when_queued_events_is_empty() {
let mut app = App::default();
app.is_loading = false;
app.data.radarr_data.logs.set_items(vec!["test".into()]);
app.data.radarr_data.tasks.set_items(vec![Task::default()]);
let system_handler = SystemHandler::with(
&DEFAULT_KEYBINDINGS.update.key,
&mut app,
&ActiveRadarrBlock::System,
&None,
);
assert!(!system_handler.is_ready());
}
#[test]
fn test_system_handler_is_ready_when_all_required_tables_are_not_empty() {
let mut app = App::default();
app.is_loading = false;
app.data.radarr_data.logs.set_items(vec!["test".into()]);
app.data.radarr_data.tasks.set_items(vec![Task::default()]);
app
.data
.radarr_data
.queued_events
.set_items(vec![QueueEvent::default()]);
let system_handler = SystemHandler::with(
&DEFAULT_KEYBINDINGS.update.key,
&mut app,
&ActiveRadarrBlock::System,
&None,
);
assert!(system_handler.is_ready());
}
}