refactor(indexers): extract test logic into search providers #490
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| /* | ||
| * Listenarr - Audiobook Management System | ||
| * Copyright (C) 2024-2025 Listenarr Contributors | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as published | ||
| * by the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| using System.Text.Json; | ||
| using Listenarr.Api.Services; | ||
| using Listenarr.Domain.Models; | ||
|
|
||
| namespace Listenarr.Api.Services.Search.Providers | ||
| { | ||
| /// <summary> | ||
| /// Base class for indexer providers, providing shared constants, helpers, | ||
| /// and exception handling for connection tests. | ||
| /// </summary> | ||
| public abstract class IndexerProviderBase : IIndexerSearchProvider | ||
| { | ||
| protected readonly ILogger _logger; | ||
|
|
||
| protected IndexerProviderBase(ILogger logger) | ||
| { | ||
| _logger = logger ?? throw new ArgumentNullException(nameof(logger)); | ||
| } | ||
|
|
||
| public abstract string IndexerType { get; } | ||
|
|
||
| /// <summary>Listenarr user-agent for standard indexer requests.</summary> | ||
| protected static string ListenarrUserAgent { get; } = | ||
| $"Listenarr/{typeof(IndexerProviderBase).Assembly.GetName().Version?.ToString() ?? "0.0.0"} (+https://github.com/listenarrs/listenarr)"; | ||
|
|
||
| /// <summary>Browser-like user-agent for indexers that require it (e.g. MyAnonamouse).</summary> | ||
| protected const string BrowserUserAgent = | ||
| "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36"; | ||
|
|
||
| /// <inheritdoc /> | ||
| public abstract Task<List<IndexerSearchResult>> SearchAsync( | ||
| Indexer indexer, | ||
| string query, | ||
| string? category = null, | ||
| Listenarr.Api.Models.SearchRequest? request = null); | ||
|
|
||
| /// <summary> | ||
| /// Implement the actual test logic. Exceptions are caught by <see cref="TestAsync"/>. | ||
| /// </summary> | ||
| protected abstract Task<IndexerTestResult> ExecuteTestAsync(Indexer indexer); | ||
|
|
||
| /// <summary> | ||
| /// Wraps <see cref="ExecuteTestAsync"/> in shared exception handling | ||
| /// so individual providers only implement the happy path. | ||
| /// </summary> | ||
| public async Task<IndexerTestResult> TestAsync(Indexer indexer) | ||
| { | ||
| try | ||
| { | ||
| return await ExecuteTestAsync(indexer); | ||
| } | ||
| catch (Exception ex) when (ex is HttpRequestException | ||
| or TaskCanceledException | ||
| or JsonException | ||
| or UriFormatException | ||
| or System.Net.CookieException | ||
| or InvalidOperationException) | ||
| { | ||
| return LogAndFail(indexer, ex); | ||
| } | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Parse a string value from the indexer's AdditionalSettings JSON. | ||
| /// </summary> | ||
| protected string? GetAdditionalSetting(Indexer indexer, string key) | ||
|
lzinga marked this conversation as resolved.
Outdated
|
||
| { | ||
| if (string.IsNullOrEmpty(indexer.AdditionalSettings)) | ||
| return null; | ||
|
|
||
| try | ||
| { | ||
| using var doc = JsonDocument.Parse(indexer.AdditionalSettings); | ||
| if (doc.RootElement.TryGetProperty(key, out var prop)) | ||
| return prop.GetString(); | ||
| } | ||
| catch (JsonException ex) | ||
| { | ||
| _logger.LogWarning(ex, "Failed to parse AdditionalSettings for indexer '{Name}'", | ||
| LogRedaction.SanitizeText(indexer.Name)); | ||
| } | ||
|
|
||
| return null; | ||
| } | ||
|
|
||
| private IndexerTestResult LogAndFail(Indexer indexer, Exception ex) | ||
| { | ||
| _logger.LogWarning(ex, "{IndexerType} indexer '{Name}' test failed", | ||
| IndexerType, LogRedaction.SanitizeText(indexer.Name)); | ||
| return IndexerTestResult.Failed($"{IndexerType} test failed", ex.Message); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| /* | ||
| * Listenarr - Audiobook Management System | ||
| * Copyright (C) 2024-2025 Listenarr Contributors | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License as published | ||
| * by the Free Software Foundation, either version 3 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * GNU Affero General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Affero General Public License | ||
| * along with this program. If not, see <https://www.gnu.org/licenses/>. | ||
| */ | ||
|
|
||
| namespace Listenarr.Api.Services.Search.Providers | ||
| { | ||
| /// <summary> | ||
| /// Represents the outcome of an indexer connection test, including | ||
| /// whether the test succeeded and any diagnostic messages. | ||
| /// </summary> | ||
| public record IndexerTestResult | ||
| { | ||
| /// <summary>Whether the connection test passed.</summary> | ||
| public bool Success { get; init; } | ||
|
|
||
| /// <summary>Human-readable summary shown to the user (e.g. "Indexer authentication successful").</summary> | ||
| public string? Message { get; init; } | ||
|
|
||
| /// <summary>Error detail when <see cref="Success"/> is <c>false</c>; <c>null</c> on success.</summary> | ||
| public string? Error { get; init; } | ||
|
|
||
| /// <summary>Create a successful test result.</summary> | ||
| public static IndexerTestResult Succeeded(string message) => | ||
| new() { Success = true, Message = message }; | ||
|
|
||
| /// <summary>Create a failed test result.</summary> | ||
| public static IndexerTestResult Failed(string message, string error) => | ||
| new() { Success = false, Message = message, Error = error }; | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is so broad and could throw errors for unrelated bugs. What about propagate those to other handlers and use a dedicated exception type for provider validation failures?