Backup_Repos/Prowlarr
1
0
Fork 0
mirror of https://github.com/Prowlarr/Prowlarr synced 2026-05-09 05:22:09 +02:00
Code Issues Projects Releases Wiki Activity

Remove redundant comments from Listenarr codebase

Browse source 
Cleaned up unnecessary and explanatory comments in Listenarr-related classes and tests to improve code readability and maintain consistency. No functional changes were made.
This commit is contained in:
Robbie Davis 2026-01-21 14:25:50 -05:00
parent 62b1e259fe
commit ebba206c1b
3 changed files with 1 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
src/NzbDrone.Core.Test/Applications/Listenarr/ListenarrFixture.cs
View file

@ -35,8 +35,6 @@ public void Setup()
Mocker.GetMock<IConfigFileProvider>().SetupGet(c => c.ApiKey).Returns("abc");
// Ensure cache calls execute factory each time during tests to avoid stale cached values
// Use ICached<List<ListenarrIndexer>> mock via dynamic mocking to avoid depending on concrete implementation
var cached = new Mock<ICached<List<ListenarrIndexer>>>();
cached.Setup(c => c.Get(It.IsAny<string>(), It.IsAny<Func<List<ListenarrIndexer>>>(), It.IsAny<TimeSpan>()))
.Returns<string, Func<List<ListenarrIndexer>>, TimeSpan>((k, f, t) => f());

20
src/NzbDrone.Core/Applications/Listenarr/Listenarr.cs
View file

@ -47,9 +47,6 @@ public override ValidationResult Test()
testIndexer.Capabilities.Categories.AddCategoryMapping(1, cat);
}
// Call the application's TestConnection directly, consistent with other application implementations.
// Some applications do not expose a reliable system status endpoint, so we rely on the indexer test itself
// to provide actionable feedback (auth, version, connectivity etc.).
try
{
failures.AddIfNotNull(_listenarrV1Proxy.TestConnection(BuildListenarrIndexer(testIndexer, testIndexer.Capabilities, DownloadProtocol.Usenet), Settings));
@ -112,7 +109,6 @@ public override List<AppIndexerMap> GetIndexerMappings()
if (match.Groups["indexer"].Success && int.TryParse(match.Groups["indexer"].Value, out var indexerId))
{
// Add parsed mapping if it's mapped to a Indexer in this Prowlarr instance
mappings.Add(new AppIndexerMap { IndexerId = indexerId, RemoteIndexerId = indexer.Id });
}
}
@ -142,7 +138,6 @@ public override void AddIndexer(IndexerDefinition indexer)
var listenarrIndexer = BuildListenarrIndexer(indexer, indexerCapabilities, indexer.Protocol);
// If an existing remote indexer already points to this app indexer (matching baseUrl or name), insert mapping and skip adding
try
{
var remoteIndexers = _listenarrV1Proxy.GetIndexers(Settings);
@ -198,7 +193,6 @@ public override void UpdateIndexer(IndexerDefinition indexer, bool forceSync = f
var appMappings = _appIndexerMapService.GetMappingsForApp(Definition.Id);
var indexerMapping = appMappings.FirstOrDefault(m => m.IndexerId == indexer.Id);
// If there is no mapping, treat this as an add instead of an update
if (indexerMapping == null)
{
if ((indexerCapabilities.MusicSearchAvailable || indexerCapabilities.SearchAvailable) &&
@ -225,7 +219,6 @@ public override void UpdateIndexer(IndexerDefinition indexer, bool forceSync = f
}
else
{
// If add returned null or failed, try to discover existing remote indexer by baseUrl or name
try
{
var remoteIndexers = _listenarrV1Proxy.GetIndexers(Settings);
@ -259,7 +252,6 @@ public override void UpdateIndexer(IndexerDefinition indexer, bool forceSync = f
return;
}
// If mapping exists but contains an invalid remote id (0), remove and re-add if possible
if (indexerMapping.RemoteIndexerId == 0)
{
_logger.Warn("Mapping for indexer {0} contains invalid remote id 0, removing mapping and re-adding if possible", indexer.Id);
@ -335,30 +327,25 @@ public override void UpdateIndexer(IndexerDefinition indexer, bool forceSync = f
if ((indexerCapabilities.MusicSearchAvailable || indexerCapabilities.SearchAvailable) &&
indexerCapabilities.Categories.SupportedCategories(Settings.SyncCategories.ToArray()).Any())
{
// Retain user fields not-affiliated with Prowlarr
if (remoteIndexer.Fields != null)
{
listenarrIndexer.Fields.AddRange(remoteIndexer.Fields.Where(f => listenarrIndexer.Fields.All(s => s.Name != f.Name)));
}
// Retain user tags not-affiliated with Prowlarr
if (remoteIndexer.Tags != null)
{
listenarrIndexer.Tags.UnionWith(remoteIndexer.Tags);
}
// Retain user settings not-affiliated with Prowlarr
listenarrIndexer.DownloadClientId = remoteIndexer.DownloadClientId;
// Ensure ID is in sync with remote before updating
listenarrIndexer.Id = remoteIndexer.Id;
// Update the indexer if it still has categories that match
_listenarrV1Proxy.UpdateIndexer(listenarrIndexer, Settings);
}
else
{
// Else remove it, it no longer should be used
_listenarrV1Proxy.RemoveIndexer(remoteIndexer.Id, Settings);
_appIndexerMapService.Delete(indexerMapping.Id);
}
@ -389,10 +376,8 @@ private ListenarrIndexer BuildListenarrIndexer(IndexerDefinition indexer, Indexe
var schemas = _schemaCache.Get(cacheKey, () => _listenarrV1Proxy.GetIndexerSchema(Settings), TimeSpan.FromDays(7));
var syncFields = new List<string> { "baseUrl", "apiPath", "apiKey", "categories", "minimumSeeders", "seedCriteria.seedRatio", "seedCriteria.seedTime", "seedCriteria.discographySeedTime", "rejectBlocklistedTorrentHashesWhileGrabbing" };
// Validate schema presence and contents. Listenarr can sometimes return no schema or an unexpected shape
if (schemas == null || !schemas.Any())
{
// Try refreshing schemas directly from proxy in case the cache is empty or stale
try
{
schemas = _listenarrV1Proxy.GetIndexerSchema(Settings);
@ -412,7 +397,6 @@ private ListenarrIndexer BuildListenarrIndexer(IndexerDefinition indexer, Indexe
if (id == 0)
{
// Ensuring backward compatibility with older versions on first sync
syncFields.AddRange(new List<string> { "additionalParameters" });
}
@ -449,7 +433,6 @@ private ListenarrIndexer BuildListenarrIndexer(IndexerDefinition indexer, Indexe
listenarrIndexer.Fields.AddRange(schema.Fields.Where(x => syncFields.Contains(x.Name)));
// Validate required fields exist to avoid NullReferenceExceptions when accessing their values
var requiredFieldNames = new List<string> { "baseUrl", "apiPath", "apiKey", "categories" };
var missing = requiredFieldNames.Where(f => listenarrIndexer.Fields.All(x => x.Name != f)).ToList();
@ -457,7 +440,6 @@ private ListenarrIndexer BuildListenarrIndexer(IndexerDefinition indexer, Indexe
{
_logger.Debug("Cached schema is missing required fields [{0}]. Attempting to refresh schema from proxy", string.Join(", ", missing));
// Try a single direct refresh from the proxy in case cache is stale
try
{
var freshSchemas = _listenarrV1Proxy.GetIndexerSchema(Settings);

2
src/NzbDrone.Core/Applications/Listenarr/ListenarrV1Proxy.cs
View file

@ -95,7 +95,6 @@ public List<ListenarrIndexer> GetIndexerSchema(ListenarrSettings settings)
}
else
{
// Primitive -> wrap into value
var item = new Newtonsoft.Json.Linq.JObject { ["name"] = prop.Name, ["value"] = prop.Value };
fieldsArray.Add(item);
}
@ -248,7 +247,6 @@ public ValidationFailure TestConnection(ListenarrIndexer indexer, ListenarrSetti
}
catch (HttpException)
{
// Bubble HttpExceptions to be handled by the caller similar to other proxies
throw;
}
}