feat(config): Add options for secrets and environment variables on `f…

…etcharr.yaml`

BREAKING CHANGE: `config.yaml` has been renamed to `fetcharr.yaml`

.vscode/settings.json

@@ -31,5 +31,9 @@
   },
   "[markdown]": {
     "editor.wordWrap": "wordWrapColumn"
-  }
+  },
+  "yaml.customTags": [
+    "env_var",
+    "secret",
+  ]
 }

config-schema.json

@@ -1,9 +1,12 @@
 {
   "$schema": "https://json-schema.org/draft-07/schema",
-  "$id": "https://raw.githubusercontent.com/fetcharr/fetcharr/main/src/API/src/config-schema.json",
+  "$id": "https://raw.githubusercontent.com/fetcharr/fetcharr/main/config-schema.json",
   "type": "object",
   "additionalProperties": false,
   "properties": {
+    "include": {
+      "$ref": "#/$defs/include_list"
+    },
     "plex": {
       "$ref": "#/$defs/plex"
     },
@@ -25,6 +28,29 @@
     }
   },
   "$defs": {
+    "include_file": {
+      "type": "object",
+      "description": "Include a separate configuration file into the current one.",
+      "additionalProperties": false,
+      "anyOf": [
+        {"required": [ "config" ]}
+      ],
+      "properties": {
+        "config": {
+          "type": "string",
+          "description": "Include a separate configuration file, relative to the current one.\nCan also be absolute."
+        }
+      }
+    },
+    "include_list": {
+      "type": "array",
+      "minItems": 1,
+      "description": "thingy dingy",
+      "additionalItems": false,
+      "items": {
+        "$ref": "#/$defs/include_file"
+      }
+    },
     "enabled": {
       "type": "boolean",
       "default": true,

src/API/src/Fetcharr.API.csproj

@@ -17,6 +17,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\..\Models\src\Fetcharr.Models.csproj" />
+    <ProjectReference Include="..\..\Configuration\src\Fetcharr.Configuration.csproj" />
     <ProjectReference Include="..\..\Cache\Hybrid\src\Fetcharr.Cache.Hybrid.csproj" />
     <ProjectReference Include="..\..\Provider.Plex\src\Fetcharr.Provider.Plex.csproj" />
     <ProjectReference Include="..\..\Provider.Radarr\src\Fetcharr.Provider.Radarr.csproj" />

src/API/src/Program.cs

@@ -1,10 +1,10 @@
-using Fetcharr.API.Configuration;
 using Fetcharr.API.Extensions;
 using Fetcharr.API.Services;
 using Fetcharr.Cache.Core.Extensions;
 using Fetcharr.Cache.Hybrid.Extensions;
 using Fetcharr.Cache.InMemory.Extensions;
-using Fetcharr.Models.Configuration;
+using Fetcharr.Configuration.Extensions;
+using Fetcharr.Models.Extensions;
 using Fetcharr.Shared.Http.Extensions;
 
 namespace Fetcharr.API
@@ -23,21 +23,20 @@ static async Task Main(string[] args)
                     options.TimestampFormat = "HH:mm:ss ";
                 }));
 
-            builder.Services.AddSingleton<FetcharrConfiguration>(provider =>
-                ActivatorUtilities.CreateInstance<ConfigurationParser>(provider).ReadConfig());
-
             builder.Services.AddCaching(opts => opts
                 .UseHybrid("metadata", opts => opts.SQLite.DatabasePath = "metadata.sqlite")
                 .UseInMemory("watchlist"));
 
             builder.Services
-                .AddSingleton<IAppDataSetup, EnvironmentalAppDataSetup>()
-                .AddHostedService<StartupInformationService>()
+                .AddDefaultEnvironment()
+                .AddConfiguration()
+                .AddValidation()
                 .AddPlexServices()
                 .AddSonarrServices()
                 .AddRadarrServices()
                 .AddPingingServices()
-                .AddFlurlErrorHandler();
+                .AddFlurlErrorHandler()
+                .AddHostedService<StartupInformationService>();
 
             builder.Services.AddControllers();
 

src/API/src/Services/StartupInformationService.cs.cs

@@ -21,7 +21,6 @@ protected override async Task ExecuteAsync(CancellationToken cancellationToken)
             logger.LogInformation("  Base directory: {Path}", appDataSetup.BaseDirectory);
             logger.LogInformation("  Cache directory: {Path}", appDataSetup.CacheDirectory);
             logger.LogInformation("  Config directory: {Path}", appDataSetup.ConfigDirectory);
-            logger.LogInformation("  Config file: {Path}", appDataSetup.ConfigurationFilePath);
 
             await Task.CompletedTask;
         }

src/Configuration/src/EnvironmentVariables/EnvironmentVariableDeserializer.cs

@@ -0,0 +1,45 @@
+using Fetcharr.Configuration.EnvironmentVariables.Exceptions;
+using Fetcharr.Models;
+
+using YamlDotNet.Core;
+using YamlDotNet.Core.Events;
+using YamlDotNet.Serialization;
+
+namespace Fetcharr.Configuration.EnvironmentVariables
+{
+    public record EnvironmentVariableValue;
+
+    public class EnvironmentVariableDeserializer(
+        IEnvironment environment)
+        : INodeDeserializer
+    {
+        public bool Deserialize(
+            IParser reader,
+            Type expectedType,
+            Func<IParser, Type, object?> nestedObjectDeserializer,
+            out object? value,
+            ObjectDeserializer rootDeserializer)
+        {
+            if(expectedType != typeof(EnvironmentVariableValue))
+            {
+                value = null;
+                return false;
+            }
+
+            Scalar scalar = reader.Consume<Scalar>();
+            string[] segments = scalar.Value.Trim().Split(' ', count: 2);
+
+            string environmentVariableName = segments[0];
+            string? environmentVariableDefault = segments.ElementAtOrDefault(1)?.Trim();
+            string? environmentVariableValue = environment.GetEnvironmentVariable(environmentVariableName);
+
+            if(string.IsNullOrEmpty(environmentVariableValue))
+            {
+                environmentVariableValue = environmentVariableDefault;
+            }
+
+            value = environmentVariableValue ?? throw new EnvironmentVariableNotFoundException(environmentVariableName);
+            return true;
+        }
+    }
+}

src/Configuration/src/EnvironmentVariables/Exceptions/EnvironmentVariableNotFoundException.cs

@@ -0,0 +1,19 @@
+namespace Fetcharr.Configuration.EnvironmentVariables.Exceptions
+{
+    public class EnvironmentVariableNotFoundException : Exception
+    {
+        private const string ExceptionFormat = "Environment variable '{0}' was referenced, but was not defined and has no default value.";
+
+        public EnvironmentVariableNotFoundException(string variable)
+            : base(string.Format(ExceptionFormat, variable))
+        {
+
+        }
+
+        public EnvironmentVariableNotFoundException(string variable, Exception innerException)
+            : base(string.Format(ExceptionFormat, variable), innerException)
+        {
+
+        }
+    }
+}

src/Configuration/src/EnvironmentVariables/Extensions/DeserializerBuilderExtensions.cs

@@ -0,0 +1,15 @@
+using Microsoft.Extensions.DependencyInjection;
+
+using YamlDotNet.Serialization;
+
+namespace Fetcharr.Configuration.EnvironmentVariables.Extensions
+{
+    public static partial class DeserializerBuilderExtensions
+    {
+        public static DeserializerBuilder WithEnvironmentVariables(
+            this DeserializerBuilder builder,
+            IServiceProvider provider) => builder
+                .WithNodeDeserializer(ActivatorUtilities.CreateInstance<EnvironmentVariableDeserializer>(provider))
+                .WithTagMapping("!env_var", typeof(EnvironmentVariableValue));
+    }
+}

src/Configuration/src/Exceptions/DuplicateServiceKeyException.cs

@@ -0,0 +1,7 @@
+namespace Fetcharr.Configuration.Exceptions
+{
+    public class DuplicateServiceKeyException(string name, string service)
+        : Exception($"Duplicate {service} name in configuration: '{name}'")
+    {
+    }
+}

src/Configuration/src/Extensions/IServiceCollectionExtensions.cs

@@ -0,0 +1,32 @@
+using Fetcharr.Configuration.Parsing;
+using Fetcharr.Configuration.Secrets;
+using Fetcharr.Models.Configuration;
+
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Options;
+
+namespace Fetcharr.Configuration.Extensions
+{
+    public static partial class IServiceCollectionExtensions
+    {
+        /// <summary>
+        ///   Registers configuration services onto the given <see cref="IServiceCollection"/>.
+        /// </summary>
+        public static IServiceCollection AddConfiguration(this IServiceCollection services)
+        {
+            services.AddScoped<IConfigurationLocator, ConfigurationLocator>();
+            services.AddScoped<IConfigurationParser, ConfigurationParser>();
+            services.AddScoped<ISecretsProvider, SecretsProvider>();
+
+            services.AddTransient<IOptions<FetcharrConfiguration>>(provider =>
+            {
+                IConfigurationParser parser = provider.GetRequiredService<IConfigurationParser>();
+                FetcharrConfiguration configuration = parser.ReadConfig();
+
+                return Options.Create(configuration);
+            });
+
+            return services;
+        }
+    }
+}

src/Configuration/src/Fetcharr.Configuration.csproj

@@ -0,0 +1,20 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <PackageId>Fetcharr.Configuration</PackageId>
+    <AssemblyName>Fetcharr.Configuration</AssemblyName>
+    <RootNamespace>Fetcharr.Configuration</RootNamespace>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="YamlDotNet" Version="16.0.0" />
+    <PackageReference Include="Newtonsoft.Json" Version="13.0.3" />
+
+    <PackageReference Include="Microsoft.Extensions.Logging" Version="8.0.0" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="../../Models/src/Fetcharr.Models.csproj" />
+  </ItemGroup>
+
+</Project>

src/Configuration/src/Parsing/ConfigurationLocator.cs

@@ -0,0 +1,60 @@
+using Fetcharr.Models.Configuration;
+
+namespace Fetcharr.Configuration.Parsing
+{
+    /// <summary>
+    ///   Defines a mechanism for locating configuration files.
+    /// </summary>
+    public interface IConfigurationLocator
+    {
+        /// <summary>
+        ///   Locates the configuration file of name <paramref name="name"/> and returns it, if found; otherwise, <see langword="null" />
+        /// </summary>
+        /// <param name="name">Name of the configuration file. Can be with or without extension.</param>
+        FileInfo? Get(string name);
+
+        /// <summary>
+        ///   Locate and return all files within the default, or configured, configuration directory.
+        /// </summary>
+        /// <exception cref="DirectoryNotFoundException">Thrown if the configuration directory is unreachable or doesn't exist.</exception>
+        IEnumerable<FileInfo> GetAll();
+    }
+
+    /// <summary>
+    ///   Default implementation of the <see cref="IConfigurationLocator" /> interface.
+    /// </summary>
+    public class ConfigurationLocator(
+        IAppDataSetup appDataSetup)
+        : IConfigurationLocator
+    {
+        private readonly string[] _configSearchPatterns = ["*.yml", "*.yaml"];
+
+        /// <inheritdoc />
+        public FileInfo? Get(string name)
+        {
+            name = Path.GetFileNameWithoutExtension(name);
+
+            foreach(FileInfo file in this.GetAll())
+            {
+                if(Path.GetFileNameWithoutExtension(file.Name).Equals(name, StringComparison.InvariantCultureIgnoreCase))
+                {
+                    return file;
+                }
+            }
+
+            return null;
+        }
+
+        /// <inheritdoc />
+        public IEnumerable<FileInfo> GetAll()
+        {
+            DirectoryInfo directory = new(appDataSetup.ConfigDirectory);
+            if(!directory.Exists)
+            {
+                throw new DirectoryNotFoundException($"Configuration directory could not be found: '{appDataSetup.ConfigDirectory}'");
+            }
+
+            return this._configSearchPatterns.SelectMany(directory.EnumerateFiles);
+        }
+    }
+}