feat: Initial Lidarr support for searching for new artists

This commit is contained in:
2026-01-07 15:53:18 -07:00
parent d3947d9e15
commit 243de47cae
37 changed files with 1646 additions and 72 deletions
@@ -0,0 +1,181 @@
use crate::handlers::KeyEventHandler;
use crate::handlers::table_handler::{TableHandlingConfig, handle_table};
use crate::models::Route;
use crate::models::servarr_data::lidarr::lidarr_data::{ADD_ARTIST_BLOCKS, ActiveLidarrBlock};
use crate::{App, Key, handle_text_box_keys, handle_text_box_left_right_keys};
#[cfg(test)]
#[path = "add_artist_handler_tests.rs"]
mod add_artist_handler_tests;
pub struct AddArtistHandler<'a, 'b> {
key: Key,
app: &'a mut App<'b>,
active_lidarr_block: ActiveLidarrBlock,
_context: Option<ActiveLidarrBlock>,
}
impl<'a, 'b> KeyEventHandler<'a, 'b, ActiveLidarrBlock> for AddArtistHandler<'a, 'b> {
fn handle(&mut self) {
let add_artist_table_handling_config =
TableHandlingConfig::new(ActiveLidarrBlock::AddArtistSearchResults.into());
if !handle_table(
self,
|app| {
app
.data
.lidarr_data
.add_searched_artists
.as_mut()
.expect("add_searched_artists should be initialized")
},
add_artist_table_handling_config,
) {
self.handle_key_event();
}
}
fn accepts(active_block: ActiveLidarrBlock) -> bool {
ADD_ARTIST_BLOCKS.contains(&active_block)
}
fn ignore_special_keys(&self) -> bool {
self.app.ignore_special_keys_for_textbox_input
}
fn new(
key: Key,
app: &'a mut App<'b>,
active_block: ActiveLidarrBlock,
context: Option<ActiveLidarrBlock>,
) -> AddArtistHandler<'a, 'b> {
AddArtistHandler {
key,
app,
active_lidarr_block: active_block,
_context: context,
}
}
fn get_key(&self) -> Key {
self.key
}
fn is_ready(&self) -> bool {
!self.app.is_loading
}
fn handle_scroll_up(&mut self) {}
fn handle_scroll_down(&mut self) {}
fn handle_home(&mut self) {
if self.active_lidarr_block == ActiveLidarrBlock::AddArtistSearchInput {
self
.app
.data
.lidarr_data
.add_artist_search
.as_mut()
.unwrap()
.scroll_home();
}
}
fn handle_end(&mut self) {
if self.active_lidarr_block == ActiveLidarrBlock::AddArtistSearchInput {
self
.app
.data
.lidarr_data
.add_artist_search
.as_mut()
.unwrap()
.reset_offset();
}
}
fn handle_delete(&mut self) {}
fn handle_left_right_action(&mut self) {
if self.active_lidarr_block == ActiveLidarrBlock::AddArtistSearchInput {
handle_text_box_left_right_keys!(
self,
self.key,
self
.app
.data
.lidarr_data
.add_artist_search
.as_mut()
.unwrap()
)
}
}
fn handle_submit(&mut self) {
match self.active_lidarr_block {
ActiveLidarrBlock::AddArtistSearchInput => {
let search_text = &self
.app
.data
.lidarr_data
.add_artist_search
.as_ref()
.unwrap()
.text;
if !search_text.is_empty() {
self
.app
.push_navigation_stack(ActiveLidarrBlock::AddArtistSearchResults.into());
self.app.ignore_special_keys_for_textbox_input = false;
}
}
ActiveLidarrBlock::AddArtistSearchResults => {}
_ => (),
}
}
fn handle_esc(&mut self) {
match self.active_lidarr_block {
ActiveLidarrBlock::AddArtistSearchInput => {
self.app.pop_navigation_stack();
self.app.data.lidarr_data.add_artist_search = None;
self.app.ignore_special_keys_for_textbox_input = false;
}
ActiveLidarrBlock::AddArtistSearchResults
| ActiveLidarrBlock::AddArtistEmptySearchResults => {
self.app.pop_navigation_stack();
self.app.data.lidarr_data.add_searched_artists = None;
self.app.ignore_special_keys_for_textbox_input = true;
}
_ => (),
}
}
fn handle_char_key_event(&mut self) {
if self.active_lidarr_block == ActiveLidarrBlock::AddArtistSearchInput {
handle_text_box_keys!(
self,
self.key,
self
.app
.data
.lidarr_data
.add_artist_search
.as_mut()
.unwrap()
)
}
}
fn app_mut(&mut self) -> &mut App<'b> {
self.app
}
fn current_route(&self) -> Route {
self.app.get_current_route()
}
}
@@ -0,0 +1,356 @@
#[cfg(test)]
mod tests {
use pretty_assertions::assert_str_eq;
use rstest::rstest;
use std::sync::atomic::Ordering;
use strum::IntoEnumIterator;
use crate::app::App;
use crate::app::key_binding::DEFAULT_KEYBINDINGS;
use crate::assert_navigation_popped;
use crate::event::Key;
use crate::handlers::KeyEventHandler;
use crate::handlers::lidarr_handlers::library::add_artist_handler::AddArtistHandler;
use crate::models::HorizontallyScrollableText;
use crate::models::servarr_data::lidarr::lidarr_data::{ADD_ARTIST_BLOCKS, ActiveLidarrBlock};
use crate::models::stateful_table::StatefulTable;
use crate::network::lidarr_network::lidarr_network_test_utils::test_utils::add_artist_search_result;
mod test_handle_home_end {
use super::*;
use pretty_assertions::assert_eq;
#[test]
fn test_add_artist_search_input_home_end_keys() {
let mut app = App::test_default();
app.push_navigation_stack(ActiveLidarrBlock::AddArtistSearchInput.into());
app.data.lidarr_data.add_artist_search = Some("Test".into());
AddArtistHandler::new(
DEFAULT_KEYBINDINGS.home.key,
&mut app,
ActiveLidarrBlock::AddArtistSearchInput,
None,
)
.handle();
assert_eq!(
app
.data
.lidarr_data
.add_artist_search
.as_ref()
.unwrap()
.offset
.load(Ordering::SeqCst),
4
);
AddArtistHandler::new(
DEFAULT_KEYBINDINGS.end.key,
&mut app,
ActiveLidarrBlock::AddArtistSearchInput,
None,
)
.handle();
assert_eq!(
app
.data
.lidarr_data
.add_artist_search
.as_ref()
.unwrap()
.offset
.load(Ordering::SeqCst),
0
);
}
}
mod test_handle_left_right_action {
use super::*;
use pretty_assertions::assert_eq;
#[test]
fn test_add_artist_search_input_left_right_keys() {
let mut app = App::test_default();
app.push_navigation_stack(ActiveLidarrBlock::AddArtistSearchInput.into());
app.data.lidarr_data.add_artist_search = Some("Test".into());
AddArtistHandler::new(
DEFAULT_KEYBINDINGS.left.key,
&mut app,
ActiveLidarrBlock::AddArtistSearchInput,
None,
)
.handle();
assert_eq!(
app
.data
.lidarr_data
.add_artist_search
.as_ref()
.unwrap()
.offset
.load(Ordering::SeqCst),
1
);
AddArtistHandler::new(
DEFAULT_KEYBINDINGS.right.key,
&mut app,
ActiveLidarrBlock::AddArtistSearchInput,
None,
)
.handle();
assert_eq!(
app
.data
.lidarr_data
.add_artist_search
.as_ref()
.unwrap()
.offset
.load(Ordering::SeqCst),
0
);
}
}
mod test_handle_submit {
use super::*;
use pretty_assertions::assert_eq;
const SUBMIT_KEY: Key = DEFAULT_KEYBINDINGS.submit.key;
#[test]
fn test_add_artist_search_input_submit() {
let mut app = App::test_default();
app.push_navigation_stack(ActiveLidarrBlock::AddArtistSearchInput.into());
app.ignore_special_keys_for_textbox_input = true;
app.data.lidarr_data.add_artist_search = Some("test".into());
AddArtistHandler::new(
SUBMIT_KEY,
&mut app,
ActiveLidarrBlock::AddArtistSearchInput,
None,
)
.handle();
assert!(!app.ignore_special_keys_for_textbox_input);
assert_eq!(
app.get_current_route(),
ActiveLidarrBlock::AddArtistSearchResults.into()
);
}
#[test]
fn test_add_artist_search_input_submit_noop_on_empty_search() {
let mut app = App::test_default();
app.data.lidarr_data.add_artist_search = Some(HorizontallyScrollableText::default());
app.push_navigation_stack(ActiveLidarrBlock::Artists.into());
app.push_navigation_stack(ActiveLidarrBlock::AddArtistSearchInput.into());
app.ignore_special_keys_for_textbox_input = true;
AddArtistHandler::new(
SUBMIT_KEY,
&mut app,
ActiveLidarrBlock::AddArtistSearchInput,
None,
)
.handle();
assert!(app.ignore_special_keys_for_textbox_input);
assert_eq!(
app.get_current_route(),
ActiveLidarrBlock::AddArtistSearchInput.into()
);
}
}
mod test_handle_esc {
use super::*;
use crate::assert_modal_absent;
use rstest::rstest;
const ESC_KEY: Key = DEFAULT_KEYBINDINGS.esc.key;
#[rstest]
fn test_add_artist_search_input_esc(#[values(true, false)] is_ready: bool) {
let mut app = App::test_default();
app.is_loading = is_ready;
app.data.lidarr_data.add_artist_search = Some("test".into());
app.ignore_special_keys_for_textbox_input = true;
app.push_navigation_stack(ActiveLidarrBlock::Artists.into());
app.push_navigation_stack(ActiveLidarrBlock::AddArtistSearchInput.into());
AddArtistHandler::new(
ESC_KEY,
&mut app,
ActiveLidarrBlock::AddArtistSearchInput,
None,
)
.handle();
assert!(!app.ignore_special_keys_for_textbox_input);
assert_navigation_popped!(app, ActiveLidarrBlock::Artists.into());
assert_modal_absent!(app.data.lidarr_data.add_artist_search);
}
#[rstest]
fn test_add_artist_search_results_esc(
#[values(
ActiveLidarrBlock::AddArtistSearchResults,
ActiveLidarrBlock::AddArtistEmptySearchResults
)]
active_lidarr_block: ActiveLidarrBlock,
) {
let mut app = App::test_default();
app.push_navigation_stack(ActiveLidarrBlock::AddArtistSearchInput.into());
app.push_navigation_stack(active_lidarr_block.into());
let mut add_searched_artists = StatefulTable::default();
add_searched_artists.set_items(vec![add_artist_search_result()]);
app.data.lidarr_data.add_searched_artists = Some(add_searched_artists);
AddArtistHandler::new(ESC_KEY, &mut app, active_lidarr_block, None).handle();
assert_navigation_popped!(app, ActiveLidarrBlock::AddArtistSearchInput.into());
assert_modal_absent!(app.data.lidarr_data.add_searched_artists);
assert!(app.ignore_special_keys_for_textbox_input);
}
}
mod test_handle_key_char {
use super::*;
#[test]
fn test_add_artist_search_input_backspace() {
let mut app = App::test_default();
app.push_navigation_stack(ActiveLidarrBlock::Artists.into());
app.data.lidarr_data.add_artist_search = Some("Test".into());
AddArtistHandler::new(
DEFAULT_KEYBINDINGS.backspace.key,
&mut app,
ActiveLidarrBlock::AddArtistSearchInput,
None,
)
.handle();
assert_str_eq!(
app
.data
.lidarr_data
.add_artist_search
.as_ref()
.unwrap()
.text,
"Tes"
);
}
#[test]
fn test_add_artist_search_input_char_key() {
let mut app = App::test_default();
app.push_navigation_stack(ActiveLidarrBlock::Artists.into());
app.data.lidarr_data.add_artist_search = Some(HorizontallyScrollableText::default());
AddArtistHandler::new(
Key::Char('a'),
&mut app,
ActiveLidarrBlock::AddArtistSearchInput,
None,
)
.handle();
assert_str_eq!(
app
.data
.lidarr_data
.add_artist_search
.as_ref()
.unwrap()
.text,
"a"
);
}
}
#[test]
fn test_add_artist_handler_accepts() {
ActiveLidarrBlock::iter().for_each(|active_lidarr_block| {
if ADD_ARTIST_BLOCKS.contains(&active_lidarr_block) {
assert!(AddArtistHandler::accepts(active_lidarr_block));
} else {
assert!(!AddArtistHandler::accepts(active_lidarr_block));
}
});
}
#[rstest]
fn test_add_artist_handler_ignore_special_keys(
#[values(true, false)] ignore_special_keys_for_textbox_input: bool,
) {
let mut app = App::test_default();
app.ignore_special_keys_for_textbox_input = ignore_special_keys_for_textbox_input;
let handler = AddArtistHandler::new(
DEFAULT_KEYBINDINGS.esc.key,
&mut app,
ActiveLidarrBlock::default(),
None,
);
assert_eq!(
handler.ignore_special_keys(),
ignore_special_keys_for_textbox_input
);
}
#[test]
fn test_add_artist_search_no_panic_on_none_search_result() {
let mut app = App::test_default();
app.data.lidarr_data.add_searched_artists = None;
AddArtistHandler::new(
DEFAULT_KEYBINDINGS.esc.key,
&mut app,
ActiveLidarrBlock::AddArtistSearchResults,
None,
)
.handle();
}
#[test]
fn test_add_artist_handler_is_not_ready_when_loading() {
let mut app = App::test_default();
app.is_loading = true;
let handler = AddArtistHandler::new(
DEFAULT_KEYBINDINGS.esc.key,
&mut app,
ActiveLidarrBlock::AddArtistSearchInput,
None,
);
assert!(!handler.is_ready());
}
#[test]
fn test_add_artist_handler_is_ready_when_not_loading() {
let mut app = App::test_default();
app.is_loading = false;
let handler = AddArtistHandler::new(
DEFAULT_KEYBINDINGS.esc.key,
&mut app,
ActiveLidarrBlock::AddArtistSearchInput,
None,
);
assert!(handler.is_ready());
}
}
@@ -13,8 +13,8 @@ mod tests {
use crate::handlers::lidarr_handlers::library::{LibraryHandler, artists_sorting_options};
use crate::models::lidarr_models::{Artist, ArtistStatistics, ArtistStatus};
use crate::models::servarr_data::lidarr::lidarr_data::{
ActiveLidarrBlock, DELETE_ARTIST_BLOCKS, EDIT_ARTIST_BLOCKS, EDIT_ARTIST_SELECTION_BLOCKS,
LIBRARY_BLOCKS,
ADD_ARTIST_BLOCKS, ActiveLidarrBlock, DELETE_ARTIST_BLOCKS, EDIT_ARTIST_BLOCKS,
EDIT_ARTIST_SELECTION_BLOCKS, LIBRARY_BLOCKS,
};
use crate::models::servarr_data::lidarr::modals::EditArtistModal;
use crate::network::lidarr_network::LidarrEvent;
@@ -28,6 +28,7 @@ mod tests {
library_handler_blocks.extend(LIBRARY_BLOCKS);
library_handler_blocks.extend(DELETE_ARTIST_BLOCKS);
library_handler_blocks.extend(EDIT_ARTIST_BLOCKS);
library_handler_blocks.extend(ADD_ARTIST_BLOCKS);
ActiveLidarrBlock::iter().for_each(|lidarr_block| {
if library_handler_blocks.contains(&lidarr_block) {
@@ -502,6 +503,35 @@ mod tests {
]
}
#[rstest]
fn test_delegates_add_artist_blocks_to_add_artist_handler(
#[values(
ActiveLidarrBlock::AddArtistSearchInput,
ActiveLidarrBlock::AddArtistEmptySearchResults,
ActiveLidarrBlock::AddArtistSearchResults
)]
active_lidarr_block: ActiveLidarrBlock,
) {
let mut app = App::test_default_fully_populated();
app
.data
.lidarr_data
.artists
.set_items(vec![Artist::default()]);
app.push_navigation_stack(ActiveLidarrBlock::Artists.into());
app.push_navigation_stack(active_lidarr_block.into());
LibraryHandler::new(
DEFAULT_KEYBINDINGS.esc.key,
&mut app,
active_lidarr_block,
None,
)
.handle();
assert_eq!(app.get_current_route(), ActiveLidarrBlock::Artists.into());
}
#[test]
fn test_delegates_delete_artist_blocks_to_delete_artist_handler() {
let mut app = App::test_default();
+16 -2
View File
@@ -4,7 +4,7 @@ use crate::{
handlers::{KeyEventHandler, handle_clear_errors, handle_prompt_toggle},
matches_key,
models::{
BlockSelectionState,
BlockSelectionState, HorizontallyScrollableText,
lidarr_models::Artist,
servarr_data::lidarr::lidarr_data::{
ActiveLidarrBlock, DELETE_ARTIST_SELECTION_BLOCKS, EDIT_ARTIST_SELECTION_BLOCKS,
@@ -18,10 +18,12 @@ use crate::{
use super::handle_change_tab_left_right_keys;
use crate::handlers::table_handler::{TableHandlingConfig, handle_table};
mod add_artist_handler;
mod delete_artist_handler;
mod edit_artist_handler;
use crate::models::Route;
pub(in crate::handlers::lidarr_handlers) use add_artist_handler::AddArtistHandler;
pub(in crate::handlers::lidarr_handlers) use delete_artist_handler::DeleteArtistHandler;
pub(in crate::handlers::lidarr_handlers) use edit_artist_handler::EditArtistHandler;
@@ -60,6 +62,10 @@ impl<'a, 'b> KeyEventHandler<'a, 'b, ActiveLidarrBlock> for LibraryHandler<'a, '
artists_table_handling_config,
) {
match self.active_lidarr_block {
_ if AddArtistHandler::accepts(self.active_lidarr_block) => {
AddArtistHandler::new(self.key, self.app, self.active_lidarr_block, self.context)
.handle();
}
_ if DeleteArtistHandler::accepts(self.active_lidarr_block) => {
DeleteArtistHandler::new(self.key, self.app, self.active_lidarr_block, self.context)
.handle();
@@ -74,7 +80,8 @@ impl<'a, 'b> KeyEventHandler<'a, 'b, ActiveLidarrBlock> for LibraryHandler<'a, '
}
fn accepts(active_block: ActiveLidarrBlock) -> bool {
DeleteArtistHandler::accepts(active_block)
AddArtistHandler::accepts(active_block)
|| DeleteArtistHandler::accepts(active_block)
|| EditArtistHandler::accepts(active_block)
|| LIBRARY_BLOCKS.contains(&active_block)
}
@@ -157,6 +164,13 @@ impl<'a, 'b> KeyEventHandler<'a, 'b, ActiveLidarrBlock> for LibraryHandler<'a, '
let key = self.key;
match self.active_lidarr_block {
ActiveLidarrBlock::Artists => match key {
_ if matches_key!(add, key) => {
self
.app
.push_navigation_stack(ActiveLidarrBlock::AddArtistSearchInput.into());
self.app.data.lidarr_data.add_artist_search = Some(HorizontallyScrollableText::default());
self.app.ignore_special_keys_for_textbox_input = true;
}
_ if matches_key!(toggle_monitoring, key) => {
self.app.data.lidarr_data.prompt_confirm = true;
self.app.data.lidarr_data.prompt_confirm_action = Some(