Add Config Validator + Bug Fixing

This commit is contained in:
Felix Glang
2024-04-28 12:59:44 +02:00
parent f73b3b5578
commit 0bb480b1d0
9 changed files with 148 additions and 65 deletions

View File

@@ -33,6 +33,7 @@ Einige Beispiele finden sich [weiter unten](https://github.com/PCJones/UmlautAda
| Anfragen-Caching für 12 Minuten zur Reduzierung der API-Zugriffe | ✓ |
| Usenet (newznab) Support |✓|
| Torrent (torznab) Support |✓|
| Support von meheren *arrs Instanzen | ✓
| Radarr Support | Geplant |
| Prowlarr Unterstützung für "DE" SceneNZBs Kategorien | Geplant |
| Unterstützung weiterer Sprachen neben Deutsch | Geplant |

View File

@@ -53,7 +53,7 @@ internal class Program
//options.SizeLimit = 20000;
});
builder.Services.AllowResolvingKeyedServicesAsDictionary();
builder.Services.AddControllers();
builder.AddTitleLookupService();
builder.Services.AddSingleton<SearchItemLookupService>();
@@ -63,7 +63,7 @@ internal class Program
builder.AddReadarrSupport();
builder.Services.AddSingleton<CacheService>();
builder.Services.AddSingleton<ProxyRequestService>();
builder.Services.AddSingleton<RrApplicationFactory>();
builder.Services.AddSingleton<ArrApplicationFactory>();
builder.Services.AddHostedService<ArrSyncBackgroundService>();
builder.Services.AddSingleton<IHostedService, HttpProxyService>();

View File

@@ -4,12 +4,12 @@ using UmlautAdaptarr.Services.Factory;
namespace UmlautAdaptarr.Services;
public class ArrSyncBackgroundService(
RrApplicationFactory rrApplicationFactory,
ArrApplicationFactory arrApplicationFactory,
CacheService cacheService,
ILogger<ArrSyncBackgroundService> logger)
: BackgroundService
{
public RrApplicationFactory RrApplicationFactory { get; } = rrApplicationFactory;
public ArrApplicationFactory ArrApplicationFactory { get; } = arrApplicationFactory;
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
@@ -56,19 +56,19 @@ public class ArrSyncBackgroundService(
var success = true;
if (RrApplicationFactory.SonarrInstances.Any())
if (ArrApplicationFactory.SonarrInstances.Any())
{
var syncSuccess = await FetchItemsFromSonarrAsync();
success = success && syncSuccess;
}
if (RrApplicationFactory.ReadarrInstances.Any())
if (ArrApplicationFactory.ReadarrInstances.Any())
{
var syncSuccess = await FetchItemsFromReadarrAsync();
success = success && syncSuccess;
}
if (RrApplicationFactory.ReadarrInstances.Any())
if (ArrApplicationFactory.ReadarrInstances.Any())
{
var syncSuccess = await FetchItemsFromLidarrAsync();
success = success && syncSuccess;
@@ -91,7 +91,7 @@ public class ArrSyncBackgroundService(
{
var items = new List<SearchItem>();
foreach (var sonarrClient in RrApplicationFactory.SonarrInstances)
foreach (var sonarrClient in ArrApplicationFactory.SonarrInstances)
{
var result = await sonarrClient.FetchAllItemsAsync();
items = items.Union(result).ToList();
@@ -115,7 +115,7 @@ public class ArrSyncBackgroundService(
{
var items = new List<SearchItem>();
foreach (var lidarrClient in RrApplicationFactory.LidarrInstances)
foreach (var lidarrClient in ArrApplicationFactory.LidarrInstances)
{
var result = await lidarrClient.FetchAllItemsAsync();
items = items.Union(result).ToList();
@@ -138,7 +138,7 @@ public class ArrSyncBackgroundService(
{
var items = new List<SearchItem>();
foreach (var readarrClient in RrApplicationFactory.ReadarrInstances)
foreach (var readarrClient in ArrApplicationFactory.ReadarrInstances)
{
var result = await readarrClient.FetchAllItemsAsync();
items = items.Union(result).ToList();

View File

@@ -6,9 +6,9 @@ namespace UmlautAdaptarr.Services.Factory
/// <summary>
/// Factory for creating RrApplication instances.
/// </summary>
public class RrApplicationFactory
public class ArrApplicationFactory
{
private readonly ILogger<RrApplicationFactory> _logger;
private readonly ILogger<ArrApplicationFactory> _logger;
/// <summary>
/// Get all IArrApplication instances.
@@ -31,10 +31,11 @@ namespace UmlautAdaptarr.Services.Factory
public IEnumerable<ReadarrClient> ReadarrInstances { get; init; }
/// <summary>
/// Constructor for the RrApplicationFactory.
/// Constructor for the ArrApplicationFactory.
/// </summary>
/// <param name="rrArrApplications">A dictionary of IArrApplication instances.</param>
public RrApplicationFactory(IDictionary<string, IArrApplication> rrArrApplications, ILogger<RrApplicationFactory> logger)
/// <param name="logger">Logger Instanz</param>
public ArrApplicationFactory(IDictionary<string, IArrApplication> rrArrApplications, ILogger<ArrApplicationFactory> logger)
{
_logger = logger;
try
@@ -51,7 +52,7 @@ namespace UmlautAdaptarr.Services.Factory
}
catch (Exception e)
{
_logger.LogError("Register RrFactory", e.Message);
_logger.LogError("Error while Register ArrFactory. This might be a Config Problem", e.Message);
throw;
}
}

View File

@@ -5,7 +5,7 @@ using UmlautAdaptarr.Services.Factory;
namespace UmlautAdaptarr.Services
{
public class SearchItemLookupService(CacheService cacheService,
RrApplicationFactory rrApplicationFactory)
ArrApplicationFactory arrApplicationFactory)
{
public async Task<SearchItem?> GetOrFetchSearchItemByExternalId(string mediaType, string externalId)
{
@@ -22,7 +22,7 @@ namespace UmlautAdaptarr.Services
{
case "tv":
var sonarrInstances = rrApplicationFactory.SonarrInstances;
var sonarrInstances = arrApplicationFactory.SonarrInstances;
if (sonarrInstances.Any())
{
@@ -34,7 +34,7 @@ namespace UmlautAdaptarr.Services
break;
case "audio":
var lidarrInstances = rrApplicationFactory.LidarrInstances;
var lidarrInstances = arrApplicationFactory.LidarrInstances;
if (lidarrInstances.Any())
{
@@ -47,7 +47,7 @@ namespace UmlautAdaptarr.Services
break;
case "book":
var readarrInstances = rrApplicationFactory.ReadarrInstances;
var readarrInstances = arrApplicationFactory.ReadarrInstances;
if (readarrInstances.Any())
{
foreach (var readarrClient in readarrInstances)
@@ -83,7 +83,7 @@ namespace UmlautAdaptarr.Services
{
case "tv":
var sonarrInstances = rrApplicationFactory.SonarrInstances;
var sonarrInstances = arrApplicationFactory.SonarrInstances;
foreach (var sonarrClient in sonarrInstances)
{
fetchedItem = await sonarrClient.FetchItemByTitleAsync(title);

View File

@@ -9,6 +9,8 @@
</PropertyGroup>
<ItemGroup>
<PackageReference Include="FluentValidation.DependencyInjectionExtensions" Version="11.9.1" />
<PackageReference Include="IL.FluentValidation.Extensions.Options" Version="11.0.2" />
<PackageReference Include="Microsoft.Extensions.Options" Version="8.0.2" />
<PackageReference Include="Microsoft.Extensions.Options.ConfigurationExtensions" Version="8.0.0" />
<PackageReference Include="Newtonsoft.Json" Version="13.0.3" />

View File

@@ -1,9 +1,11 @@
using System.Linq.Expressions;
using FluentValidation;
using System.Linq.Expressions;
using UmlautAdaptarr.Interfaces;
using UmlautAdaptarr.Options;
using UmlautAdaptarr.Options.ArrOptions.InstanceOptions;
using UmlautAdaptarr.Providers;
using UmlautAdaptarr.Services;
using UmlautAdaptarr.Validator;
namespace UmlautAdaptarr.Utilities;
@@ -12,6 +14,12 @@ namespace UmlautAdaptarr.Utilities;
/// </summary>
public static class ServicesExtensions
{
/// <summary>
/// Logger instance for logging proxy configurations.
/// </summary>
private static ILogger Logger = GlobalStaticLogger.Logger;
/// <summary>
/// Adds a service with specified options and service to the service collection.
/// </summary>
@@ -27,64 +35,87 @@ public static class ServicesExtensions
where TService : class, TInterface
where TInterface : class
{
if (builder.Services == null) throw new ArgumentNullException(nameof(builder), "Service collection is null.");
var singleInstance = builder.Configuration.GetSection(sectionName).Get<TOptions>();
var singleHost = (string?)typeof(TOptions).GetProperty("Host")?.GetValue(singleInstance, null);
// If we have no Single Instance , we try to parse for a Array
var optionsArray = singleHost == null
? builder.Configuration.GetSection(sectionName).Get<TOptions[]>()
:
[
singleInstance
];
if (optionsArray == null || !optionsArray.Any())
throw new InvalidOperationException(
$"{typeof(TService).Name} options could not be loaded from Configuration or ENV Variable.");
foreach (var option in optionsArray)
try
{
var instanceState = (bool)(typeof(TOptions).GetProperty("Enabled")?.GetValue(option, null) ?? false);
if (builder.Services == null) throw new ArgumentNullException(nameof(builder), "Service collection is null.");
// We only want to create instances that are enabled in the Configs
if (instanceState)
var singleInstance = builder.Configuration.GetSection(sectionName).Get<TOptions>();
var singleHost = (string?)typeof(TOptions).GetProperty("Host")?.GetValue(singleInstance, null);
// If we have no Single Instance , we try to parse for a Array
var optionsArray = singleHost == null
? builder.Configuration.GetSection(sectionName).Get<TOptions[]>()
:
[
singleInstance
];
if (optionsArray == null || !optionsArray.Any())
throw new InvalidOperationException(
$"{typeof(TService).Name} options could not be loaded from Configuration or ENV Variable.");
foreach (var option in optionsArray)
{
// User can give the Instance a readable Name otherwise we use the Host Property
var instanceName = (string)(typeof(TOptions).GetProperty("Name")?.GetValue(option, null) ??
(string)typeof(TOptions).GetProperty("Host")?.GetValue(option, null)!);
// Dark Magic , we don't know the Property's of TOptions , and we won't cast them for each Options
// Todo eventuell schönere Lösung finden
var paraexpression = Expression.Parameter(Type.GetType(option.GetType().FullName), "x");
GlobalInstanceOptionsValidator validator = new GlobalInstanceOptionsValidator();
foreach (var prop in option.GetType().GetProperties())
var results = validator.Validate(option as GlobalInstanceOptions);
if (!results.IsValid)
{
var val = Expression.Constant(prop.GetValue(option));
var memberexpression = Expression.PropertyOrField(paraexpression, prop.Name);
foreach (var failure in results.Errors)
{
Console.WriteLine(($"Property {failure.PropertyName } failed validation. Error was: {failure.ErrorMessage}"));
}
if (prop.PropertyType == typeof(int) || prop.PropertyType == typeof(string) || prop.PropertyType == typeof(bool))
{
var assign = Expression.Assign(memberexpression, Expression.Convert(val, prop.PropertyType));
var exp = Expression.Lambda<Action<TOptions>>(assign, paraexpression);
builder.Services.Configure(instanceName, exp.Compile());
}
else
{
Console.WriteLine(prop.PropertyType + "No Support");
}
throw new Exception("Please fix first you config and then Start UmlautAdaptarr again");
}
var instanceState = (bool)(typeof(TOptions).GetProperty("Enabled")?.GetValue(option, null) ?? false);
builder.Services.AllowResolvingKeyedServicesAsDictionary();
builder.Services.AddKeyedSingleton<TInterface, TService>(instanceName);
// We only want to create instances that are enabled in the Configs
if (instanceState)
{
// User can give the Instance a readable Name otherwise we use the Host Property
var instanceName = (string)(typeof(TOptions).GetProperty("Name")?.GetValue(option, null) ??
(string)typeof(TOptions).GetProperty("Host")?.GetValue(option, null)!);
// Dark Magic , we don't know the Property's of TOptions , and we won't cast them for each Options
// Todo eventuell schönere Lösung finden
var paraexpression = Expression.Parameter(Type.GetType(option.GetType().FullName), "x");
foreach (var prop in option.GetType().GetProperties())
{
var val = Expression.Constant(prop.GetValue(option));
var memberexpression = Expression.PropertyOrField(paraexpression, prop.Name);
if (prop.PropertyType == typeof(int) || prop.PropertyType == typeof(string) || prop.PropertyType == typeof(bool))
{
var assign = Expression.Assign(memberexpression, Expression.Convert(val, prop.PropertyType));
var exp = Expression.Lambda<Action<TOptions>>(assign, paraexpression);
builder.Services.Configure(instanceName, exp.Compile());
}
else
{
Logger.LogWarning((prop.PropertyType + "No Support"));
}
}
builder.Services.AddKeyedSingleton<TInterface, TService>(instanceName);
}
}
return builder;
}
catch (Exception e)
{
Console.WriteLine("Error while Init UmlautAdaptrr");
throw;
}
return builder;
}
/// <summary>

View File

@@ -0,0 +1,46 @@
using FluentValidation;
using System.Net;
using UmlautAdaptarr.Options.ArrOptions.InstanceOptions;
namespace UmlautAdaptarr.Validator
{
public class GlobalInstanceOptionsValidator : AbstractValidator<GlobalInstanceOptions>
{
public GlobalInstanceOptionsValidator()
{
RuleFor(x => x.Enabled).NotNull();
When(x => x.Enabled, () =>
{
RuleFor(x => x.Host)
.NotEmpty().WithMessage("Host is required when Enabled is true.")
.Must(BeAValidUrl).WithMessage("Host must start with http:// or https:// and be a valid address.")
.Must(BeReachable).WithMessage("Host is not reachable. Please check your Host or your UmlautAdaptrr Settings");
RuleFor(x => x.ApiKey)
.NotEmpty().WithMessage("ApiKey is required when Enabled is true.");
});
}
private bool BeAValidUrl(string url)
{
return Uri.TryCreate(url, UriKind.Absolute, out var uriResult)
&& (uriResult.Scheme == Uri.UriSchemeHttp || uriResult.Scheme == Uri.UriSchemeHttps);
}
private bool BeReachable(string url)
{
try
{
var request = WebRequest.Create(url);
var response = (HttpWebResponse)request.GetResponse();
return response.StatusCode == HttpStatusCode.OK;
}
catch
{
return false;
}
}
}
}

View File

@@ -26,6 +26,7 @@
{
// Docker Environment Variables:
// - Sonarr__0__Enabled: true (set to false to disable)
// - Sonarr__0__Name: Name of the Instance (Optional)
// - Sonarr__0__Host: your_sonarr_host_url
// - Sonarr__0__ApiKey: your_sonarr_api_key
"Enabled": false,
@@ -36,6 +37,7 @@
{
// Docker Environment Variables:
// - Sonarr__1__Enabled: true (set to false to disable)
// - Sonarr__0__Name: Name of the Instance (Optional)
// - Sonarr__1__Host: your_sonarr_host_url
// - Sonarr__1__ApiKey: your_sonarr_api_key
"Enabled": false,