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.

2024-07-17 19:55:10 -06:00
parent 9104b7c356
commit d84e7dfcab
49 changed files with 5143 additions and 265 deletions
@@ -8,6 +8,7 @@ mod tests {
  use crate::event::Key;
  use crate::handlers::radarr_handlers::downloads::DownloadsHandler;
  use crate::handlers::KeyEventHandler;
+  use crate::models::radarr_models::DownloadRecord;
  use crate::models::servarr_data::radarr::radarr_data::{ActiveRadarrBlock, DOWNLOADS_BLOCKS};

  mod test_handle_scroll_up_and_down {
@@ -27,6 +28,36 @@ mod tests {
      None,
      title
    );
+
+    #[rstest]
+    fn test_downloads_scroll_no_op_when_not_ready(
+      #[values(
+			DEFAULT_KEYBINDINGS.up.key, DEFAULT_KEYBINDINGS.down.key
+		)]
+      key: Key,
+    ) {
+      let mut app = App::default();
+      app.is_loading = true;
+      app
+        .data
+        .radarr_data
+        .downloads
+        .set_items(simple_stateful_iterable_vec!(DownloadRecord));
+
+      DownloadsHandler::with(&key, &mut app, &ActiveRadarrBlock::Downloads, &None).handle();
+
+      assert_str_eq!(
+        app.data.radarr_data.downloads.current_selection().title,
+        "Test 1"
+      );
+
+      DownloadsHandler::with(&key, &mut app, &ActiveRadarrBlock::Downloads, &None).handle();
+
+      assert_str_eq!(
+        app.data.radarr_data.downloads.current_selection().title,
+        "Test 1"
+      );
+    }
  }

  mod test_handle_home_end {
@@ -44,23 +75,85 @@ mod tests {
      None,
      title
    );
+
+    #[test]
+    fn test_downloads_home_end_no_op_when_not_ready() {
+      let mut app = App::default();
+      app.is_loading = true;
+      app
+        .data
+        .radarr_data
+        .downloads
+        .set_items(extended_stateful_iterable_vec!(DownloadRecord));
+
+      DownloadsHandler::with(
+        &DEFAULT_KEYBINDINGS.end.key,
+        &mut app,
+        &ActiveRadarrBlock::Downloads,
+        &None,
+      )
+      .handle();
+
+      assert_str_eq!(
+        app.data.radarr_data.downloads.current_selection().title,
+        "Test 1"
+      );
+
+      DownloadsHandler::with(
+        &DEFAULT_KEYBINDINGS.home.key,
+        &mut app,
+        &ActiveRadarrBlock::Downloads,
+        &None,
+      )
+      .handle();
+
+      assert_str_eq!(
+        app.data.radarr_data.downloads.current_selection().title,
+        "Test 1"
+      );
+    }
  }

  mod test_handle_delete {
    use pretty_assertions::assert_eq;

-    use crate::assert_delete_prompt;
-
    use super::*;

    const DELETE_KEY: Key = DEFAULT_KEYBINDINGS.delete.key;

    #[test]
    fn test_delete_download_prompt() {
-      assert_delete_prompt!(
-        DownloadsHandler,
-        ActiveRadarrBlock::Downloads,
-        ActiveRadarrBlock::DeleteDownloadPrompt
+      let mut app = App::default();
+      app
+        .data
+        .radarr_data
+        .downloads
+        .set_items(vec![DownloadRecord::default()]);
+
+      DownloadsHandler::with(&DELETE_KEY, &mut app, &ActiveRadarrBlock::Downloads, &None).handle();
+
+      assert_eq!(
+        app.get_current_route(),
+        &ActiveRadarrBlock::DeleteDownloadPrompt.into()
+      );
+    }
+
+    #[test]
+    fn test_delete_download_prompt_no_op_when_not_ready() {
+      let mut app = App::default();
+      app.is_loading = true;
+      app.push_navigation_stack(ActiveRadarrBlock::Downloads.into());
+      app
+        .data
+        .radarr_data
+        .downloads
+        .set_items(vec![DownloadRecord::default()]);
+
+      DownloadsHandler::with(&DELETE_KEY, &mut app, &ActiveRadarrBlock::Downloads, &None).handle();
+
+      assert_eq!(
+        app.get_current_route(),
+        &ActiveRadarrBlock::Downloads.into()
      );
    }
  }
@@ -71,9 +164,10 @@ mod tests {

    use super::*;

-    #[test]
-    fn test_downloads_tab_left() {
+    #[rstest]
+    fn test_downloads_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(2);

      DownloadsHandler::with(
@@ -94,9 +188,10 @@ mod tests {
      );
    }

-    #[test]
-    fn test_downloads_tab_right() {
+    #[rstest]
+    fn test_downloads_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(2);

      DownloadsHandler::with(
@@ -165,6 +260,11 @@ mod tests {
      #[case] expected_action: RadarrEvent,
    ) {
      let mut app = App::default();
+      app
+        .data
+        .radarr_data
+        .downloads
+        .set_items(vec![DownloadRecord::default()]);
      app.data.radarr_data.prompt_confirm = true;
      app.push_navigation_stack(base_route.into());
      app.push_navigation_stack(prompt_block.into());
@@ -187,6 +287,11 @@ mod tests {
      #[case] prompt_block: ActiveRadarrBlock,
    ) {
      let mut app = App::default();
+      app
+        .data
+        .radarr_data
+        .downloads
+        .set_items(vec![DownloadRecord::default()]);
      app.push_navigation_stack(base_route.into());
      app.push_navigation_stack(prompt_block.into());

@@ -224,9 +329,10 @@ mod tests {
      assert!(!app.data.radarr_data.prompt_confirm);
    }

-    #[test]
-    fn test_default_esc() {
+    #[rstest]
+    fn test_default_esc(#[values(true, false)] is_ready: bool) {
      let mut app = App::default();
+      app.is_loading = is_ready;
      app.error = "test error".to_owned().into();
      app.push_navigation_stack(ActiveRadarrBlock::Downloads.into());
      app.push_navigation_stack(ActiveRadarrBlock::Downloads.into());
@@ -244,13 +350,16 @@ mod tests {
  mod test_handle_key_char {
    use pretty_assertions::assert_eq;

-    use crate::assert_refresh_key;
-
    use super::*;

    #[test]
    fn test_update_downloads_key() {
      let mut app = App::default();
+      app
+        .data
+        .radarr_data
+        .downloads
+        .set_items(vec![DownloadRecord::default()]);

      DownloadsHandler::with(
        &DEFAULT_KEYBINDINGS.update.key,
@@ -266,9 +375,80 @@ mod tests {
      );
    }

+    #[test]
+    fn test_update_downloads_key_no_op_when_not_ready() {
+      let mut app = App::default();
+      app.is_loading = true;
+      app.push_navigation_stack(ActiveRadarrBlock::Downloads.into());
+      app
+        .data
+        .radarr_data
+        .downloads
+        .set_items(vec![DownloadRecord::default()]);
+
+      DownloadsHandler::with(
+        &DEFAULT_KEYBINDINGS.update.key,
+        &mut app,
+        &ActiveRadarrBlock::Downloads,
+        &None,
+      )
+      .handle();
+
+      assert_eq!(
+        app.get_current_route(),
+        &ActiveRadarrBlock::Downloads.into()
+      );
+    }
+
    #[test]
    fn test_refresh_downloads_key() {
-      assert_refresh_key!(DownloadsHandler, ActiveRadarrBlock::Downloads);
+      let mut app = App::default();
+      app
+        .data
+        .radarr_data
+        .downloads
+        .set_items(vec![DownloadRecord::default()]);
+      app.push_navigation_stack(ActiveRadarrBlock::Downloads.into());
+
+      DownloadsHandler::with(
+        &DEFAULT_KEYBINDINGS.refresh.key,
+        &mut app,
+        &ActiveRadarrBlock::Downloads,
+        &None,
+      )
+      .handle();
+
+      assert_eq!(
+        app.get_current_route(),
+        &ActiveRadarrBlock::Downloads.into()
+      );
+      assert!(app.should_refresh);
+    }
+
+    #[test]
+    fn test_refresh_downloads_key_no_op_when_not_ready() {
+      let mut app = App::default();
+      app.is_loading = true;
+      app.push_navigation_stack(ActiveRadarrBlock::Downloads.into());
+      app
+        .data
+        .radarr_data
+        .downloads
+        .set_items(vec![DownloadRecord::default()]);
+
+      DownloadsHandler::with(
+        &DEFAULT_KEYBINDINGS.refresh.key,
+        &mut app,
+        &ActiveRadarrBlock::Downloads,
+        &None,
+      )
+      .handle();
+
+      assert_eq!(
+        app.get_current_route(),
+        &ActiveRadarrBlock::Downloads.into()
+      );
+      assert!(!app.should_refresh);
    }
  }

@@ -282,4 +462,54 @@ mod tests {
      }
    })
  }
+
+  #[test]
+  fn test_downloads_handler_not_ready_when_loading() {
+    let mut app = App::default();
+    app.is_loading = true;
+
+    let handler = DownloadsHandler::with(
+      &DEFAULT_KEYBINDINGS.esc.key,
+      &mut app,
+      &ActiveRadarrBlock::Downloads,
+      &None,
+    );
+
+    assert!(!handler.is_ready());
+  }
+
+  #[test]
+  fn test_downloads_handler_not_ready_when_downloads_is_empty() {
+    let mut app = App::default();
+    app.is_loading = false;
+
+    let handler = DownloadsHandler::with(
+      &DEFAULT_KEYBINDINGS.esc.key,
+      &mut app,
+      &ActiveRadarrBlock::Downloads,
+      &None,
+    );
+
+    assert!(!handler.is_ready());
+  }
+
+  #[test]
+  fn test_downloads_handler_ready_when_not_loading_and_downloads_is_not_empty() {
+    let mut app = App::default();
+    app.is_loading = false;
+
+    app
+      .data
+      .radarr_data
+      .downloads
+      .set_items(vec![DownloadRecord::default()]);
+    let handler = DownloadsHandler::with(
+      &DEFAULT_KEYBINDINGS.esc.key,
+      &mut app,
+      &ActiveRadarrBlock::Downloads,
+      &None,
+    );
+
+    assert!(handler.is_ready());
+  }
 }