Fix Deluge service crashing when download is not found (#97)

README.md

@@ -214,15 +214,18 @@ services:
       # OR
       # - DOWNLOAD_CLIENT=qBittorrent
       # - QBITTORRENT__URL=http://localhost:8080
+      # - QBITTORRENT__URL_BASE=myCustomPath
       # - QBITTORRENT__USERNAME=user
       # - QBITTORRENT__PASSWORD=pass
       # OR
       # - DOWNLOAD_CLIENT=deluge
+      # - DELUGE__URL_BASE=myCustomPath
       # - DELUGE__URL=http://localhost:8112
       # - DELUGE__PASSWORD=testing
       # OR
       # - DOWNLOAD_CLIENT=transmission
       # - TRANSMISSION__URL=http://localhost:9091
+      # - TRANSMISSION__URL_BASE=myCustomPath
       # - TRANSMISSION__USERNAME=test
       # - TRANSMISSION__PASSWORD=testing
 

code/Common/Configuration/DownloadClient/DelugeConfig.cs

@@ -1,4 +1,5 @@
-using Common.Exceptions;
+using Common.Exceptions;
+using Microsoft.Extensions.Configuration;
 
 namespace Common.Configuration.DownloadClient;
 
@@ -8,6 +9,9 @@ public sealed record DelugeConfig : IConfig
     
     public Uri? Url { get; init; }
     
+    [ConfigurationKeyName("URL_BASE")]
+    public string UrlBase { get; init; } = string.Empty;
+    
     public string? Password { get; init; }
     
     public void Validate()

code/Common/Configuration/DownloadClient/QBitConfig.cs

@@ -1,4 +1,5 @@
-using Common.Exceptions;
+using Common.Exceptions;
+using Microsoft.Extensions.Configuration;
 
 namespace Common.Configuration.DownloadClient;
 
@@ -8,6 +9,9 @@ public sealed class QBitConfig : IConfig
     
     public Uri? Url { get; init; }
     
+    [ConfigurationKeyName("URL_BASE")]
+    public string UrlBase { get; init; } = string.Empty;
+    
     public string? Username { get; init; }
     
     public string? Password { get; init; }

code/Common/Configuration/DownloadClient/TransmissionConfig.cs

@@ -1,4 +1,5 @@
-using Common.Exceptions;
+using Common.Exceptions;
+using Microsoft.Extensions.Configuration;
 
 namespace Common.Configuration.DownloadClient;
 
@@ -8,6 +9,9 @@ public record TransmissionConfig : IConfig
     
     public Uri? Url { get; init; }
     
+    [ConfigurationKeyName("URL_BASE")]
+    public string UrlBase { get; init; } = "transmission";
+    
     public string? Username { get; init; }
     
     public string? Password { get; init; }

code/Executable/appsettings.Development.json

@@ -52,15 +52,18 @@
   "DOWNLOAD_CLIENT": "qbittorrent",
   "qBittorrent": {
     "Url": "http://localhost:8080",
+    "URL_BASE": "",
     "Username": "test",
     "Password": "testing"
   },
   "Deluge": {
     "Url": "http://localhost:8112",
+    "URL_BASE": "",
     "Password": "testing"
   },
   "Transmission": {
     "Url": "http://localhost:9091",
+    "URL_BASE": "transmission",
     "Username": "test",
     "Password": "testing"
   },

code/Executable/appsettings.json

@@ -42,15 +42,18 @@
   "DOWNLOAD_CLIENT": "none",
   "qBittorrent": {
     "Url": "http://localhost:8080",
+    "URL_BASE": "",
     "Username": "",
     "Password": ""
   },
   "Deluge": {
     "Url": "http://localhost:8112",
+    "URL_BASE": "",
     "Password": "testing"
   },
   "Transmission": {
     "Url": "http://localhost:9091",
+    "URL_BASE": "transmission",
     "Username": "test",
     "Password": "testing"
   },

code/Infrastructure/Verticals/Arr/ArrClient.cs

@@ -43,9 +43,11 @@ public abstract class ArrClient : IArrClient
 
     public virtual async Task<QueueListResponse> GetQueueItemsAsync(ArrInstance arrInstance, int page)
     {
-        Uri uri = new(arrInstance.Url, GetQueueUrlPath(page));
+        UriBuilder uriBuilder = new(arrInstance.Url);
+        uriBuilder.Path = $"{uriBuilder.Path.TrimEnd('/')}/{GetQueueUrlPath().TrimStart('/')}";
+        uriBuilder.Query = GetQueueUrlQuery(page);
 
-        using HttpRequestMessage request = new(HttpMethod.Get, uri);
+        using HttpRequestMessage request = new(HttpMethod.Get, uriBuilder.Uri);
         SetApiKey(request, arrInstance.ApiKey);
         
         using HttpResponseMessage response = await _httpClient.SendAsync(request);
@@ -56,7 +58,7 @@ public abstract class ArrClient : IArrClient
         }
         catch
         {
-            _logger.LogError("queue list failed | {uri}", uri);
+            _logger.LogError("queue list failed | {uri}", uriBuilder.Uri);
             throw;
         }
         
@@ -65,7 +67,7 @@ public abstract class ArrClient : IArrClient
 
         if (queueResponse is null)
         {
-            throw new Exception($"unrecognized queue list response | {uri} | {responseBody}");
+            throw new Exception($"unrecognized queue list response | {uriBuilder.Uri} | {responseBody}");
         }
 
         return queueResponse;
@@ -114,11 +116,13 @@ public abstract class ArrClient : IArrClient
     
     public virtual async Task DeleteQueueItemAsync(ArrInstance arrInstance, QueueRecord record, bool removeFromClient)
     {
-        Uri uri = new(arrInstance.Url, GetQueueDeleteUrlPath(record.Id, removeFromClient));
+        UriBuilder uriBuilder = new(arrInstance.Url);
+        uriBuilder.Path = $"{uriBuilder.Path.TrimEnd('/')}/{GetQueueDeleteUrlPath(record.Id).TrimStart('/')}";
+        uriBuilder.Query = GetQueueDeleteUrlQuery(removeFromClient);
 
         try
         {
-            using HttpRequestMessage request = new(HttpMethod.Delete, uri);
+            using HttpRequestMessage request = new(HttpMethod.Delete, uriBuilder.Uri);
             SetApiKey(request, arrInstance.ApiKey);
 
             HttpResponseMessage? response = await _dryRunInterceptor.InterceptAsync<HttpResponseMessage>(SendRequestAsync, request);
@@ -134,7 +138,7 @@ public abstract class ArrClient : IArrClient
         }
         catch
         {
-            _logger.LogError("queue delete failed | {uri} | {title}", uri, record.Title);
+            _logger.LogError("queue delete failed | {uri} | {title}", uriBuilder.Uri, record.Title);
             throw;
         }
     }
@@ -152,9 +156,13 @@ public abstract class ArrClient : IArrClient
         return true;
     }
     
-    protected abstract string GetQueueUrlPath(int page);
+    protected abstract string GetQueueUrlPath();
 
-    protected abstract string GetQueueDeleteUrlPath(long recordId, bool removeFromClient);
+    protected abstract string GetQueueUrlQuery(int page);
+
+    protected abstract string GetQueueDeleteUrlPath(long recordId);
+    
+    protected abstract string GetQueueDeleteUrlQuery(bool removeFromClient);
     
     protected virtual void SetApiKey(HttpRequestMessage request, string apiKey)
     {

code/Infrastructure/Verticals/Arr/LidarrClient.cs

@@ -27,29 +27,42 @@ public class LidarrClient : ArrClient, ILidarrClient
     {
     }
 
-    protected override string GetQueueUrlPath(int page)
+    protected override string GetQueueUrlPath()
     {
-        return $"/api/v1/queue?page={page}&pageSize=200&includeUnknownArtistItems=true&includeArtist=true&includeAlbum=true";
+        return "/api/v1/queue";
     }
 
-    protected override string GetQueueDeleteUrlPath(long recordId, bool removeFromClient)
+    protected override string GetQueueUrlQuery(int page)
     {
-        string path = $"/api/v1/queue/{recordId}?blocklist=true&skipRedownload=true&changeCategory=false";
+        return $"page={page}&pageSize=200&includeUnknownArtistItems=true&includeArtist=true&includeAlbum=true";
+    }
 
-        path += removeFromClient ? "&removeFromClient=true" : "&removeFromClient=false";
+    protected override string GetQueueDeleteUrlPath(long recordId)
+    {
+        return $"/api/v1/queue/{recordId}";
+    }
 
-        return path;
+    protected override string GetQueueDeleteUrlQuery(bool removeFromClient)
+    {
+        string query = "blocklist=true&skipRedownload=true&changeCategory=false";
+        query += removeFromClient ? "&removeFromClient=true" : "&removeFromClient=false";
+
+        return query;
     }
 
     public override async Task RefreshItemsAsync(ArrInstance arrInstance, HashSet<SearchItem>? items)
     {
-        if (items?.Count is null or 0) return;
+        if (items?.Count is null or 0)
+        {
+            return;
+        }
 
-        Uri uri = new(arrInstance.Url, "/api/v1/command");
+        UriBuilder uriBuilder = new(arrInstance.Url);
+        uriBuilder.Path = $"{uriBuilder.Path.TrimEnd('/')}/api/v1/command";
 
         foreach (var command in GetSearchCommands(items))
         {
-            using HttpRequestMessage request = new(HttpMethod.Post, uri);
+            using HttpRequestMessage request = new(HttpMethod.Post, uriBuilder.Uri);
             request.Content = new StringContent(
                 JsonConvert.SerializeObject(command, new JsonSerializerSettings { NullValueHandling = NullValueHandling.Ignore }),
                 Encoding.UTF8,
@@ -132,8 +145,11 @@ public class LidarrClient : ArrClient, ILidarrClient
 
     private async Task<List<Album>?> GetAlbumsAsync(ArrInstance arrInstance, List<long> albumIds)
     {
-        Uri uri = new(arrInstance.Url, $"api/v1/album?{string.Join('&', albumIds.Select(x => $"albumIds={x}"))}");
+        UriBuilder uriBuilder = new(arrInstance.Url);
-        using HttpRequestMessage request = new(HttpMethod.Get, uri);
+        uriBuilder.Path = $"{uriBuilder.Path.TrimEnd('/')}/api/v1/album";
+        uriBuilder.Query = string.Join('&', albumIds.Select(x => $"albumIds={x}"));
+        
+        using HttpRequestMessage request = new(HttpMethod.Get, uriBuilder.Uri);
         SetApiKey(request, arrInstance.ApiKey);
 
         using var response = await _httpClient.SendAsync(request);

code/Infrastructure/Verticals/Arr/RadarrClient.cs

@@ -27,18 +27,27 @@ public class RadarrClient : ArrClient, IRadarrClient
     {
     }
 
-    protected override string GetQueueUrlPath(int page)
+    protected override string GetQueueUrlPath()
     {
-        return $"/api/v3/queue?page={page}&pageSize=200&includeUnknownMovieItems=true&includeMovie=true";
+        return "/api/v3/queue";
     }
 
-    protected override string GetQueueDeleteUrlPath(long recordId, bool removeFromClient)
+    protected override string GetQueueUrlQuery(int page)
     {
-        string path = $"/api/v3/queue/{recordId}?blocklist=true&skipRedownload=true&changeCategory=false";
+        return $"page={page}&pageSize=200&includeUnknownMovieItems=true&includeMovie=true";
+    }
 
-        path += removeFromClient ? "&removeFromClient=true" : "&removeFromClient=false";
+    protected override string GetQueueDeleteUrlPath(long recordId)
+    {
+        return $"/api/v3/queue/{recordId}";
+    }
 
-        return path;
+    protected override string GetQueueDeleteUrlQuery(bool removeFromClient)
+    {
+        string query = "blocklist=true&skipRedownload=true&changeCategory=false";
+        query += removeFromClient ? "&removeFromClient=true" : "&removeFromClient=false";
+
+        return query;
     }
 
     public override async Task RefreshItemsAsync(ArrInstance arrInstance, HashSet<SearchItem>? items)
@@ -50,14 +59,16 @@ public class RadarrClient : ArrClient, IRadarrClient
 
         List<long> ids = items.Select(item => item.Id).ToList();
         
-        Uri uri = new(arrInstance.Url, "/api/v3/command");
+        UriBuilder uriBuilder = new(arrInstance.Url);
+        uriBuilder.Path = $"{uriBuilder.Path.TrimEnd('/')}/api/v3/command";
+        
         RadarrCommand command = new()
         {
             Name = "MoviesSearch",
             MovieIds = ids,
         };
         
-        using HttpRequestMessage request = new(HttpMethod.Post, uri);
+        using HttpRequestMessage request = new(HttpMethod.Post, uriBuilder.Uri);
         request.Content = new StringContent(
             JsonConvert.SerializeObject(command),
             Encoding.UTF8,
@@ -135,8 +146,10 @@ public class RadarrClient : ArrClient, IRadarrClient
 
     private async Task<Movie?> GetMovie(ArrInstance arrInstance, long movieId)
     {
-        Uri uri = new(arrInstance.Url, $"api/v3/movie/{movieId}");
+        UriBuilder uriBuilder = new(arrInstance.Url);
-        using HttpRequestMessage request = new(HttpMethod.Get, uri);
+        uriBuilder.Path = $"{uriBuilder.Path.TrimEnd('/')}/api/v3/movie/{movieId}";
+        
+        using HttpRequestMessage request = new(HttpMethod.Get, uriBuilder.Uri);
         SetApiKey(request, arrInstance.ApiKey);
 
         using HttpResponseMessage response = await _httpClient.SendAsync(request);

code/Infrastructure/Verticals/Arr/SonarrClient.cs

@@ -28,18 +28,27 @@ public class SonarrClient : ArrClient, ISonarrClient
     {
     }
     
-    protected override string GetQueueUrlPath(int page)
+    protected override string GetQueueUrlPath()
     {
-        return $"/api/v3/queue?page={page}&pageSize=200&includeUnknownSeriesItems=true&includeSeries=true&includeEpisode=true";
+        return "/api/v3/queue";
     }
 
-    protected override string GetQueueDeleteUrlPath(long recordId, bool removeFromClient)
+    protected override string GetQueueUrlQuery(int page)
     {
-        string path = $"/api/v3/queue/{recordId}?blocklist=true&skipRedownload=true&changeCategory=false";
+        return $"page={page}&pageSize=200&includeUnknownSeriesItems=true&includeSeries=true&includeEpisode=true";
+    }
 
-        path += removeFromClient ? "&removeFromClient=true" : "&removeFromClient=false";
+    protected override string GetQueueDeleteUrlPath(long recordId)
+    {
+        return $"/api/v3/queue/{recordId}";
+    }
 
-        return path;
+    protected override string GetQueueDeleteUrlQuery(bool removeFromClient)
+    {
+        string query = "blocklist=true&skipRedownload=true&changeCategory=false";
+        query += removeFromClient ? "&removeFromClient=true" : "&removeFromClient=false";
+        
+        return query;
     }
 
     public override async Task RefreshItemsAsync(ArrInstance arrInstance, HashSet<SearchItem>? items)
@@ -49,11 +58,12 @@ public class SonarrClient : ArrClient, ISonarrClient
             return;
         }
 
-        Uri uri = new(arrInstance.Url, "/api/v3/command");
+        UriBuilder uriBuilder = new(arrInstance.Url);
+        uriBuilder.Path = $"{uriBuilder.Path.TrimEnd('/')}/api/v3/command";
         
         foreach (SonarrCommand command in GetSearchCommands(items.Cast<SonarrSearchItem>().ToHashSet()))
         {
-            using HttpRequestMessage request = new(HttpMethod.Post, uri);
+            using HttpRequestMessage request = new(HttpMethod.Post, uriBuilder.Uri);
             request.Content = new StringContent(
                 JsonConvert.SerializeObject(command, new JsonSerializerSettings { NullValueHandling = NullValueHandling.Ignore }),
                 Encoding.UTF8,
@@ -199,8 +209,11 @@ public class SonarrClient : ArrClient, ISonarrClient
 
     private async Task<List<Episode>?> GetEpisodesAsync(ArrInstance arrInstance, List<long> episodeIds)
     {
-        Uri uri = new(arrInstance.Url, $"api/v3/episode?{string.Join('&', episodeIds.Select(x => $"episodeIds={x}"))}");
+        UriBuilder uriBuilder = new(arrInstance.Url);
-        using HttpRequestMessage request = new(HttpMethod.Get, uri);
+        uriBuilder.Path = $"{uriBuilder.Path.TrimEnd('/')}/api/v3/episode";
+        uriBuilder.Query = string.Join('&', episodeIds.Select(x => $"episodeIds={x}"));
+        
+        using HttpRequestMessage request = new(HttpMethod.Get, uriBuilder.Uri);
         SetApiKey(request, arrInstance.ApiKey);
 
         using HttpResponseMessage response = await _httpClient.SendAsync(request);
@@ -212,8 +225,10 @@ public class SonarrClient : ArrClient, ISonarrClient
 
     private async Task<Series?> GetSeriesAsync(ArrInstance arrInstance, long seriesId)
     {
-        Uri uri = new(arrInstance.Url, $"api/v3/series/{seriesId}");
+        UriBuilder uriBuilder = new(arrInstance.Url);
-        using HttpRequestMessage request = new(HttpMethod.Get, uri);
+        uriBuilder.Path = $"{uriBuilder.Path.TrimEnd('/')}/api/v3/series/{seriesId}";
+        
+        using HttpRequestMessage request = new(HttpMethod.Get, uriBuilder.Uri);
         SetApiKey(request, arrInstance.ApiKey);
 
         using HttpResponseMessage response = await _httpClient.SendAsync(request);

code/Infrastructure/Verticals/DownloadClient/Deluge/DelugeClient.cs

@@ -33,6 +33,7 @@ public sealed class DelugeClient
     public DelugeClient(IOptions<DelugeConfig> config, IHttpClientFactory httpClientFactory)
     {
         _config = config.Value;
+        _config.Validate();
         _httpClient = httpClientFactory.CreateClient(nameof(DelugeService));
     }
     
@@ -79,11 +80,24 @@ public sealed class DelugeClient
     
     public async Task<TorrentStatus?> GetTorrentStatus(string hash)
     {
-        return await SendRequest<TorrentStatus?>(
+        try
-            "web.get_torrent_status",
+        {
-            hash,
+            return await SendRequest<TorrentStatus?>(
-            Fields
+                "web.get_torrent_status",
-        );
+                hash,
+                Fields
+            );
+        }
+        catch (DelugeClientException e)
+        {
+            // Deluge returns an error when the torrent is not found
+            if (e.Message == "AttributeError: 'NoneType' object has no attribute 'call'")
+            {
+                return null;
+            }
+
+            throw;
+        }
     }
     
     public async Task<List<TorrentStatus>?> GetStatusForAllTorrents()
@@ -122,7 +136,11 @@ public sealed class DelugeClient
         StringContent content = new StringContent(json);
         content.Headers.ContentType = new MediaTypeWithQualityHeaderValue("application/json");
         
-        var responseMessage = await _httpClient.PostAsync(new Uri(_config.Url, "/json"), content);
+        UriBuilder uriBuilder = new(_config.Url);
+        uriBuilder.Path = string.IsNullOrEmpty(_config.UrlBase)
+            ? $"{uriBuilder.Path.TrimEnd('/')}/json"
+            : $"{uriBuilder.Path.TrimEnd('/')}/{_config.UrlBase.TrimStart('/').TrimEnd('/')}/json";
+        var responseMessage = await _httpClient.PostAsync(uriBuilder.Uri, content);
         responseMessage.EnsureSuccessStatusCode();
 
         var responseJson = await responseMessage.Content.ReadAsStringAsync();

code/Infrastructure/Verticals/DownloadClient/QBittorrent/QBitService.cs

@@ -45,7 +45,11 @@ public class QBitService : DownloadService, IQBitService
     {
         _config = config.Value;
         _config.Validate();
-        _client = new(httpClientFactory.CreateClient(Constants.HttpClientWithRetryName), _config.Url);
+        UriBuilder uriBuilder = new(_config.Url);
+        uriBuilder.Path = string.IsNullOrEmpty(_config.UrlBase)
+            ? uriBuilder.Path
+            : $"{uriBuilder.Path.TrimEnd('/')}/{_config.UrlBase.TrimStart('/')}";
+        _client = new(httpClientFactory.CreateClient(Constants.HttpClientWithRetryName), uriBuilder.Uri);
     }
 
     public override async Task LoginAsync()

code/Infrastructure/Verticals/DownloadClient/Transmission/TransmissionService.cs

@@ -64,9 +64,13 @@ public class TransmissionService : DownloadService, ITransmissionService
     {
         _config = config.Value;
         _config.Validate();
+        UriBuilder uriBuilder = new(_config.Url);
+        uriBuilder.Path = string.IsNullOrEmpty(_config.UrlBase)
+            ? $"{uriBuilder.Path.TrimEnd('/')}/rpc"
+            : $"{uriBuilder.Path.TrimEnd('/')}/{_config.UrlBase.TrimStart('/').TrimEnd('/')}/rpc";
         _client = new(
             httpClientFactory.CreateClient(Constants.HttpClientWithRetryName),
-            new Uri(_config.Url, "/transmission/rpc").ToString(),
+            uriBuilder.Uri.ToString(),
             login: _config.Username,
             password: _config.Password
         );

code/Infrastructure/Verticals/QueueCleaner/QueueCleaner.cs

@@ -88,8 +88,6 @@ public sealed class QueueCleaner : GenericHandler
                     continue;
                 }
                 
-                _logger.LogTrace("processing | {title} | {id}", record.Title, record.DownloadId);
-                
                 // push record to context
                 ContextProvider.Set(nameof(QueueRecord), record);
 

variables.md

@@ -378,6 +378,12 @@
 - Default: `http://localhost:8080`.
 - Required: No.
 
+#### **`QBITTORRENT__URL_BASE`**
+- Adds a prefix to the qBittorrent url, such as `[QBITTORRENT__URL]/[QBITTORRENT__URL_BASE]/api`.
+- Type: String.
+- Default: Empty.
+- Required: No.
+
 #### **`QBITTORRENT__USERNAME`**
 - Username for qBittorrent authentication.
 - Type: String.
@@ -396,6 +402,12 @@
 - Default: `http://localhost:8112`.
 - Required: No.
 
+#### **`DELUGE__URL_BASE`**
+- Adds a prefix to the deluge json url, such as `[DELUGE__URL]/[DELUGE__URL_BASE]/json`.
+- Type: String.
+- Default: Empty.
+- Required: No.
+
 #### **`DELUGE__PASSWORD`**
 - Password for Deluge authentication.
 - Type: String.
@@ -408,6 +420,12 @@
 - Default: `http://localhost:9091`.
 - Required: No.
 
+#### **`TRANSMISSION__URL_BASE`**
+- Adds a prefix to the Transmission rpc url, such as `[TRANSMISSION__URL]/[TRANSMISSION__URL_BASE]/rpc`.
+- Type: String.
+- Default: `transmission`.
+- Required: No.
+
 #### **`TRANSMISSION__USERNAME`**
 - Username for Transmission authentication.
 - Type: String.