feat(readarr): edit an indexer and expose the command on the CLI

This commit is contained in:
Dark-Alex-17 committed 2026-09-01 17:11:32 -06:00
1 parent be5826f2c4
commit daf991d1eb
7 files changed
+1037 -10

No files matched your search

+219 -3
View File
@@ -1,14 +1,230 @@
use crate::models::servarr_models::Indexer;
use crate::models::servarr_models::{EditIndexerParams, Indexer};
use crate::network::readarr_network::ReadarrEvent;
use crate::network::{Network, RequestMethod};
use anyhow::Result;
use log::info;
use anyhow::{Context, Result};
use log::{debug, info};
use serde_json::{Value, json};
#[cfg(test)]
#[path = "readarr_indexers_network_tests.rs"]
mod readarr_indexers_network_tests;
impl Network<'_, '_> {
pub(in crate::network::readarr_network) async fn edit_readarr_indexer(
&mut self,
mut edit_indexer_params: EditIndexerParams,
) -> Result<()> {
if let Some(tag_input_str) = edit_indexer_params.tag_input_string.as_ref() {
let tag_ids_vec = self
.extract_and_add_readarr_tag_ids_vec(tag_input_str)
.await;
edit_indexer_params.tags = Some(tag_ids_vec);
}
let detail_event = ReadarrEvent::GetIndexers;
let event = ReadarrEvent::EditIndexer(EditIndexerParams::default());
let id = edit_indexer_params.indexer_id;
info!("Updating Readarr indexer with ID: {id}");
info!("Fetching indexer details for indexer with ID: {id}");
let request_props = self
.request_props_from(
detail_event,
RequestMethod::Get,
None::<()>,
Some(format!("/{id}")),
None,
)
.await;
let mut response = String::new();
self
.handle_request::<(), Value>(request_props, |detailed_indexer_body, _| {
response = detailed_indexer_body.to_string()
})
.await?;
info!("Constructing edit indexer body");
let mut detailed_indexer_body: Value = serde_json::from_str(&response)?;
let (
name,
enable_rss,
enable_automatic_search,
enable_interactive_search,
url,
api_key,
seed_ratio,
tags,
priority,
) = {
let priority = detailed_indexer_body["priority"]
.as_i64()
.context("Failed to deserialize indexer 'priority' field")?;
let seed_ratio_field_option = detailed_indexer_body["fields"]
.as_array()
.context("Failed to get indexer 'fields' array")?
.iter()
.find(|field| field["name"] == "seedCriteria.seedRatio");
let name = edit_indexer_params.name.unwrap_or(
detailed_indexer_body["name"]
.as_str()
.context("Failed to deserialize indexer 'name' field")?
.to_owned(),
);
let enable_rss = edit_indexer_params.enable_rss.unwrap_or(
detailed_indexer_body["enableRss"]
.as_bool()
.context("Failed to deserialize indexer 'enableRss' field")?,
);
let enable_automatic_search = edit_indexer_params.enable_automatic_search.unwrap_or(
detailed_indexer_body["enableAutomaticSearch"]
.as_bool()
.context("Failed to deserialize indexer 'enableAutomaticSearch' field")?,
);
let enable_interactive_search = edit_indexer_params.enable_interactive_search.unwrap_or(
detailed_indexer_body["enableInteractiveSearch"]
.as_bool()
.context("Failed to deserialize indexer 'enableInteractiveSearch' field")?,
);
let url = edit_indexer_params.url.unwrap_or(
detailed_indexer_body["fields"]
.as_array()
.context("Failed to get indexer 'fields' array for baseUrl")?
.iter()
.find(|field| field["name"] == "baseUrl")
.context("Field 'baseUrl' was not found in the indexer fields array")?
.get("value")
.unwrap_or(&json!(""))
.as_str()
.context("Failed to deserialize indexer 'baseUrl' value")?
.to_owned(),
);
let api_key = edit_indexer_params.api_key.unwrap_or(
detailed_indexer_body["fields"]
.as_array()
.context("Failed to get indexer 'fields' array for apiKey")?
.iter()
.find(|field| field["name"] == "apiKey")
.context("Field 'apiKey' was not found in the indexer fields array")?
.get("value")
.unwrap_or(&json!(""))
.as_str()
.context("Failed to deserialize indexer 'apiKey' value")?
.to_owned(),
);
let seed_ratio = edit_indexer_params.seed_ratio.unwrap_or_else(|| {
if let Some(seed_ratio_field) = seed_ratio_field_option {
return seed_ratio_field
.get("value")
.unwrap_or(&json!(""))
.as_str()
.unwrap_or("")
.to_owned();
}
String::new()
});
let tags = if edit_indexer_params.clear_tags {
vec![]
} else {
edit_indexer_params.tags.unwrap_or(
detailed_indexer_body["tags"]
.as_array()
.context("Failed to get indexer 'tags' array")?
.iter()
.map(|item| {
item
.as_i64()
.context("Failed to deserialize indexer tag ID")
})
.collect::<Result<Vec<_>>>()?,
)
};
let priority = edit_indexer_params.priority.unwrap_or(priority);
(
name,
enable_rss,
enable_automatic_search,
enable_interactive_search,
url,
api_key,
seed_ratio,
tags,
priority,
)
};
*detailed_indexer_body
.get_mut("name")
.context("Failed to get mutable reference to indexer 'name' field")? = json!(name);
*detailed_indexer_body
.get_mut("priority")
.context("Failed to get mutable reference to indexer 'priority' field")? = json!(priority);
*detailed_indexer_body
.get_mut("enableRss")
.context("Failed to get mutable reference to indexer 'enableRss' field")? = json!(enable_rss);
*detailed_indexer_body
.get_mut("enableAutomaticSearch")
.context("Failed to get mutable reference to indexer 'enableAutomaticSearch' field")? =
json!(enable_automatic_search);
*detailed_indexer_body
.get_mut("enableInteractiveSearch")
.context("Failed to get mutable reference to indexer 'enableInteractiveSearch' field")? =
json!(enable_interactive_search);
*detailed_indexer_body
.get_mut("fields")
.and_then(|f| f.as_array_mut())
.context("Failed to get mutable reference to indexer 'fields' array")?
.iter_mut()
.find(|field| field["name"] == "baseUrl")
.context("Failed to find 'baseUrl' field in indexer fields array")?
.get_mut("value")
.context("Failed to get mutable reference to 'baseUrl' value")? = json!(url);
*detailed_indexer_body
.get_mut("fields")
.and_then(|f| f.as_array_mut())
.context("Failed to get mutable reference to indexer 'fields' array for apiKey")?
.iter_mut()
.find(|field| field["name"] == "apiKey")
.context("Failed to find 'apiKey' field in indexer fields array")?
.get_mut("value")
.context("Failed to get mutable reference to 'apiKey' value")? = json!(api_key);
*detailed_indexer_body
.get_mut("tags")
.context("Failed to get mutable reference to indexer 'tags' field")? = json!(tags);
let seed_ratio_field_option = detailed_indexer_body
.get_mut("fields")
.and_then(|f| f.as_array_mut())
.context("Failed to get mutable reference to indexer 'fields' array for seed ratio")?
.iter_mut()
.find(|field| field["name"] == "seedCriteria.seedRatio");
if let Some(seed_ratio_field) = seed_ratio_field_option {
seed_ratio_field
.as_object_mut()
.context("Failed to get mutable reference to 'seedCriteria.seedRatio' object")?
.insert("value".to_string(), json!(seed_ratio));
}
debug!("Edit indexer body: {detailed_indexer_body:?}");
let request_props = self
.request_props_from(
event,
RequestMethod::Put,
Some(detailed_indexer_body),
Some(format!("/{id}")),
Some("forceSave=true".to_owned()),
)
.await;
self
.handle_request::<Value, ()>(request_props, |_, _| ())
.await
}
pub(in crate::network::readarr_network) async fn get_readarr_indexers(
&mut self,
) -> Result<Vec<Indexer>> {
@@ -1,12 +1,15 @@
#[cfg(test)]
mod tests {
use crate::models::readarr_models::ReadarrSerdeable;
use crate::models::servarr_models::Indexer;
use crate::models::servarr_models::{EditIndexerParams, Indexer};
use crate::network::NetworkResource;
use crate::network::network_tests::test_utils::{MockServarrApi, test_network};
use crate::network::readarr_network::ReadarrEvent;
use crate::network::readarr_network::readarr_network_test_utils::test_utils::{
INDEXER_JSON, indexer, stale_indexer,
};
use bimap::BiMap;
use mockito::Matcher;
use pretty_assertions::assert_eq;
use serde_json::{Value, json};
@@ -78,4 +81,313 @@ mod tests {
stale_indexers
);
}
#[tokio::test]
async fn test_handle_edit_readarr_indexer_event() {
let mut expected_body: Value = serde_json::from_str(INDEXER_JSON).unwrap();
*expected_body.get_mut("name").unwrap() = json!("Test Update");
*expected_body.get_mut("priority").unwrap() = json!(3);
*expected_body.get_mut("enableRss").unwrap() = json!(false);
*expected_body.get_mut("enableAutomaticSearch").unwrap() = json!(false);
*expected_body.get_mut("enableInteractiveSearch").unwrap() = json!(false);
*expected_body["fields"][0].get_mut("value").unwrap() = json!("https://localhost:9696/8/");
*expected_body["fields"][1].get_mut("value").unwrap() = json!("test1234");
*expected_body["fields"][2].get_mut("value").unwrap() = json!("1.3");
*expected_body.get_mut("tags").unwrap() = json!([1, 2]);
let edit_indexer_params = EditIndexerParams {
indexer_id: 8,
name: Some("Test Update".to_owned()),
enable_rss: Some(false),
enable_automatic_search: Some(false),
enable_interactive_search: Some(false),
url: Some("https://localhost:9696/8/".to_owned()),
api_key: Some("test1234".to_owned()),
seed_ratio: Some("1.3".to_owned()),
tag_input_string: Some("usenet, testing".to_owned()),
priority: Some(3),
..EditIndexerParams::default()
};
let (async_details_server, app, mut server) = MockServarrApi::get()
.returns(serde_json::from_str(INDEXER_JSON).unwrap())
.path("/8")
.build_for(ReadarrEvent::GetIndexers)
.await;
let async_edit_server = server
.mock(
"PUT",
format!(
"/api/v1{}/8?forceSave=true",
ReadarrEvent::EditIndexer(edit_indexer_params.clone()).resource()
)
.as_str(),
)
.with_status(202)
.match_header("X-Api-Key", "test1234")
.match_body(Matcher::Json(expected_body))
.create_async()
.await;
{
let mut app = app.lock().await;
app.server_tabs.set_index(3);
app.data.readarr_data.tags_map =
BiMap::from_iter([(1, "usenet".to_owned()), (2, "testing".to_owned())]);
}
let mut network = test_network(&app);
let result = network
.handle_readarr_event(ReadarrEvent::EditIndexer(edit_indexer_params))
.await;
async_details_server.assert_async().await;
async_edit_server.assert_async().await;
assert_ok!(result);
}
#[tokio::test]
async fn test_handle_edit_readarr_indexer_event_defaults_to_previous_values() {
let expected_body: Value = serde_json::from_str(INDEXER_JSON).unwrap();
let edit_indexer_params = EditIndexerParams {
indexer_id: 8,
..EditIndexerParams::default()
};
let (async_details_server, app, mut server) = MockServarrApi::get()
.returns(serde_json::from_str(INDEXER_JSON).unwrap())
.path("/8")
.build_for(ReadarrEvent::GetIndexers)
.await;
let async_edit_server = server
.mock(
"PUT",
format!(
"/api/v1{}/8?forceSave=true",
ReadarrEvent::EditIndexer(edit_indexer_params.clone()).resource()
)
.as_str(),
)
.with_status(202)
.match_header("X-Api-Key", "test1234")
.match_body(Matcher::Json(expected_body))
.create_async()
.await;
app.lock().await.server_tabs.set_index(3);
let mut network = test_network(&app);
let result = network
.handle_readarr_event(ReadarrEvent::EditIndexer(edit_indexer_params))
.await;
async_details_server.assert_async().await;
async_edit_server.assert_async().await;
assert_ok!(result);
}
#[tokio::test]
async fn test_handle_edit_readarr_indexer_event_does_not_overwrite_tags_vec_if_tag_input_string_is_none()
{
let mut expected_body: Value = serde_json::from_str(INDEXER_JSON).unwrap();
*expected_body.get_mut("tags").unwrap() = json!([2, 3]);
let edit_indexer_params = EditIndexerParams {
indexer_id: 8,
tags: Some(vec![2, 3]),
..EditIndexerParams::default()
};
let (async_details_server, app, mut server) = MockServarrApi::get()
.returns(serde_json::from_str(INDEXER_JSON).unwrap())
.path("/8")
.build_for(ReadarrEvent::GetIndexers)
.await;
let async_edit_server = server
.mock(
"PUT",
format!(
"/api/v1{}/8?forceSave=true",
ReadarrEvent::EditIndexer(edit_indexer_params.clone()).resource()
)
.as_str(),
)
.with_status(202)
.match_header("X-Api-Key", "test1234")
.match_body(Matcher::Json(expected_body))
.create_async()
.await;
app.lock().await.server_tabs.set_index(3);
let mut network = test_network(&app);
let result = network
.handle_readarr_event(ReadarrEvent::EditIndexer(edit_indexer_params))
.await;
async_details_server.assert_async().await;
async_edit_server.assert_async().await;
assert_ok!(result);
}
#[tokio::test]
async fn test_handle_edit_readarr_indexer_event_clears_tags_when_clear_tags_is_true() {
let mut expected_body: Value = serde_json::from_str(INDEXER_JSON).unwrap();
*expected_body.get_mut("tags").unwrap() = json!([]);
let edit_indexer_params = EditIndexerParams {
indexer_id: 8,
clear_tags: true,
..EditIndexerParams::default()
};
let (async_details_server, app, mut server) = MockServarrApi::get()
.returns(serde_json::from_str(INDEXER_JSON).unwrap())
.path("/8")
.build_for(ReadarrEvent::GetIndexers)
.await;
let async_edit_server = server
.mock(
"PUT",
format!(
"/api/v1{}/8?forceSave=true",
ReadarrEvent::EditIndexer(edit_indexer_params.clone()).resource()
)
.as_str(),
)
.with_status(202)
.match_header("X-Api-Key", "test1234")
.match_body(Matcher::Json(expected_body))
.create_async()
.await;
app.lock().await.server_tabs.set_index(3);
let mut network = test_network(&app);
let result = network
.handle_readarr_event(ReadarrEvent::EditIndexer(edit_indexer_params))
.await;
async_details_server.assert_async().await;
async_edit_server.assert_async().await;
assert_ok!(result);
}
#[tokio::test]
async fn test_handle_edit_readarr_indexer_event_does_not_add_seed_ratio_when_seed_ratio_field_is_absent_in_details()
{
let mut details_body: Value = serde_json::from_str(INDEXER_JSON).unwrap();
details_body["fields"].as_array_mut().unwrap().pop();
let expected_body = details_body.clone();
let edit_indexer_params = EditIndexerParams {
indexer_id: 8,
seed_ratio: Some("1.3".to_owned()),
..EditIndexerParams::default()
};
let (async_details_server, app, mut server) = MockServarrApi::get()
.returns(details_body)
.path("/8")
.build_for(ReadarrEvent::GetIndexers)
.await;
let async_edit_server = server
.mock(
"PUT",
format!(
"/api/v1{}/8?forceSave=true",
ReadarrEvent::EditIndexer(edit_indexer_params.clone()).resource()
)
.as_str(),
)
.with_status(202)
.match_header("X-Api-Key", "test1234")
.match_body(Matcher::Json(expected_body))
.create_async()
.await;
app.lock().await.server_tabs.set_index(3);
let mut network = test_network(&app);
let result = network
.handle_readarr_event(ReadarrEvent::EditIndexer(edit_indexer_params))
.await;
async_details_server.assert_async().await;
async_edit_server.assert_async().await;
assert_ok!(result);
}
#[tokio::test]
async fn test_handle_edit_readarr_indexer_event_populates_the_seed_ratio_value_when_it_is_missing_in_details()
{
let mut details_body: Value = serde_json::from_str(INDEXER_JSON).unwrap();
details_body["fields"][2]
.as_object_mut()
.unwrap()
.remove("value");
let mut expected_body = details_body.clone();
expected_body["fields"][2]
.as_object_mut()
.unwrap()
.insert("value".to_owned(), json!("1.3"));
let edit_indexer_params = EditIndexerParams {
indexer_id: 8,
seed_ratio: Some("1.3".to_owned()),
..EditIndexerParams::default()
};
let (async_details_server, app, mut server) = MockServarrApi::get()
.returns(details_body)
.path("/8")
.build_for(ReadarrEvent::GetIndexers)
.await;
let async_edit_server = server
.mock(
"PUT",
format!(
"/api/v1{}/8?forceSave=true",
ReadarrEvent::EditIndexer(edit_indexer_params.clone()).resource()
)
.as_str(),
)
.with_status(202)
.match_header("X-Api-Key", "test1234")
.match_body(Matcher::Json(expected_body))
.create_async()
.await;
app.lock().await.server_tabs.set_index(3);
let mut network = test_network(&app);
let result = network
.handle_readarr_event(ReadarrEvent::EditIndexer(edit_indexer_params))
.await;
async_details_server.assert_async().await;
async_edit_server.assert_async().await;
assert_ok!(result);
}
#[tokio::test]
async fn test_handle_edit_readarr_indexer_event_failure() {
let edit_indexer_params = EditIndexerParams {
indexer_id: 8,
name: Some("Test Update".to_owned()),
..EditIndexerParams::default()
};
let (async_details_server, app, mut server) = MockServarrApi::get()
.returns(serde_json::from_str(INDEXER_JSON).unwrap())
.path("/8")
.build_for(ReadarrEvent::GetIndexers)
.await;
let async_edit_server = server
.mock(
"PUT",
format!(
"/api/v1{}/8?forceSave=true",
ReadarrEvent::EditIndexer(edit_indexer_params.clone()).resource()
)
.as_str(),
)
.with_status(500)
.match_header("X-Api-Key", "test1234")
.with_body(INDEXER_JSON)
.create_async()
.await;
app.lock().await.server_tabs.set_index(3);
let mut network = test_network(&app);
let result = network
.handle_readarr_event(ReadarrEvent::EditIndexer(edit_indexer_params))
.await;
async_details_server.assert_async().await;
async_edit_server.assert_async().await;
assert_err!(result);
}
}
+9 -2
View File
@@ -7,7 +7,9 @@ use crate::models::readarr_models::{
AddAuthorBody, AddReadarrRootFolderBody, DeleteParams, EditAuthorParams, ReadarrSerdeable,
ReadarrTaskName,
};
use crate::models::servarr_models::{MetadataProfile, QualityProfile, ReleaseDownloadBody, Tag};
use crate::models::servarr_models::{
EditIndexerParams, MetadataProfile, QualityProfile, ReleaseDownloadBody, Tag,
};
use crate::network::{Network, RequestMethod};
mod blocklist;
@@ -41,6 +43,7 @@ pub enum ReadarrEvent {
DeleteTag(i64),
DownloadRelease(ReleaseDownloadBody),
EditAuthor(EditAuthorParams),
EditIndexer(EditIndexerParams),
GetAuthorDetails(i64),
GetAuthorHistory(i64),
GetAuthorReleases(i64),
@@ -112,7 +115,7 @@ impl NetworkResource for ReadarrEvent {
ReadarrEvent::GetHistory(_) => "/history",
ReadarrEvent::GetAuthorHistory(_) | ReadarrEvent::GetBookHistory(_, _) => "/history/author",
ReadarrEvent::MarkHistoryItemAsFailed(_) => "/history/failed",
ReadarrEvent::GetIndexers => "/indexer",
ReadarrEvent::EditIndexer(_) | ReadarrEvent::GetIndexers => "/indexer",
ReadarrEvent::GetLogs(_) => "/log",
ReadarrEvent::GetMetadataProfiles => "/metadataprofile",
ReadarrEvent::GetQualityProfiles => "/qualityprofile",
@@ -189,6 +192,10 @@ impl Network<'_, '_> {
.edit_author(edit_author_params)
.await
.map(ReadarrSerdeable::from),
ReadarrEvent::EditIndexer(edit_indexer_params) => self
.edit_readarr_indexer(edit_indexer_params)
.await
.map(ReadarrSerdeable::from),
ReadarrEvent::GetAuthorDetails(author_id) => self
.get_author_details(author_id)
.await
@@ -159,9 +159,33 @@ pub mod test_utils {
"configContract": "TorznabSettings",
"infoLink": "https://wiki.servarr.com/readarr/supported#torznab",
"fields": [
{ "name": "baseUrl", "value": "https://test.com" },
{ "name": "apiKey", "value": "" },
{ "name": "seedCriteria.seedRatio", "value": "1.2" }
{
"order": 0,
"name": "baseUrl",
"label": "URL",
"value": "https://test.com",
"type": "textbox",
"advanced": false,
"isFloat": false
},
{
"order": 2,
"name": "apiKey",
"label": "API Key",
"value": "",
"type": "textbox",
"advanced": false,
"isFloat": false
},
{
"order": 7,
"name": "seedCriteria.seedRatio",
"label": "Seed Ratio",
"value": "1.2",
"type": "number",
"advanced": false,
"isFloat": true
}
],
"tags": [1],
"id": 8
@@ -4,7 +4,9 @@ mod tests {
use crate::models::readarr_models::{
AddAuthorBody, AddReadarrRootFolderBody, DeleteParams, EditAuthorParams, ReadarrSerdeable,
};
use crate::models::servarr_models::{MetadataProfile, QualityProfile, ReleaseDownloadBody, Tag};
use crate::models::servarr_models::{
EditIndexerParams, MetadataProfile, QualityProfile, ReleaseDownloadBody, Tag,
};
use crate::network::network_tests::test_utils::{MockServarrApi, test_network};
use crate::network::{NetworkEvent, NetworkResource, readarr_network::ReadarrEvent};
use bimap::BiMap;
@@ -47,6 +49,7 @@ mod tests {
#[case(ReadarrEvent::GetAuthorHistory(1), "/history/author")]
#[case(ReadarrEvent::GetBookHistory(1, 2), "/history/author")]
#[case(ReadarrEvent::MarkHistoryItemAsFailed(1), "/history/failed")]
#[case(ReadarrEvent::EditIndexer(EditIndexerParams::default()), "/indexer")]
#[case(ReadarrEvent::GetIndexers, "/indexer")]
#[case(ReadarrEvent::GetLogs(500), "/log")]
#[case(ReadarrEvent::GetMetadataProfiles, "/metadataprofile")]