Merge pull request #12 from Stravaig-Projects/#2/create-config-provider

Create basic provider

Author: colinangusmackay

release-notes/wip-release-notes.md

@@ -11,6 +11,7 @@ Date: ???
 ### Miscellaneous
 
 - #1: Initial set up
+- #2: Create the initial provider
 
 ### Dependabot
 

src/Example/Example.csproj

@@ -0,0 +1,28 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFramework>net6.0</TargetFramework>
+        <Nullable>enable</Nullable>
+        <UserSecretsId>7f191ac2-a110-4f9d-989f-0c4afa1d9e45</UserSecretsId>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\Stravaig.Configuration.SqlServer\Stravaig.Configuration.SqlServer.csproj" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <PackageReference Include="Microsoft.Extensions.Configuration.UserSecrets" Version="6.0.0" />
+      <PackageReference Include="Microsoft.Extensions.Hosting" Version="6.0.0" />
+      <PackageReference Include="Microsoft.FeatureManagement" Version="2.4.0" />
+      <PackageReference Include="Stravaig.Configuration.Diagnostics.Logging" Version="1.0.4" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <None Remove="appsettings.json" />
+      <Content Include="appsettings.json">
+        <CopyToOutputDirectory>Always</CopyToOutputDirectory>
+      </Content>
+    </ItemGroup>
+
+</Project>

src/Example/MyFeatureConfiguration.cs

@@ -0,0 +1,12 @@
+namespace Example;
+
+public class MyFeatureConfiguration
+{
+    public int? SomeNumber { get; set; }
+    
+    public string? SomeString { get; set; }
+    
+    public double? SomeFloatingPointNumber { get; set; }
+    
+    public bool? SomeBoolean { get; set; }
+}

src/Example/Program.cs

@@ -0,0 +1,31 @@
+using Example;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
+using Microsoft.FeatureManagement;
+using Stravaig.Configuration.SqlServer;
+
+await Host.CreateDefaultBuilder(args)
+    .ConfigureAppConfiguration(builder =>
+    {
+        builder.AddUserSecrets<Program>();
+        builder.AddSqlServer(opts =>
+        {
+            opts.FromExistingConfiguration();
+        });
+    })
+    .ConfigureLogging(builder =>
+    {
+        builder.AddConsole();
+        builder.AddDebug();
+    })
+    .ConfigureServices((ctx, services) =>
+    {
+        IConfigurationRoot configRoot = (IConfigurationRoot) ctx.Configuration;
+        services.AddTransient<IHostedService, TheHostedService>();
+        services.AddSingleton(configRoot);
+        services.Configure<MyFeatureConfiguration>(configRoot.GetSection("MyConfiguration"));
+        services.AddFeatureManagement(configRoot.GetSection("FeatureManager"));
+    })
+    .RunConsoleAsync();

src/Example/TheHostedService.cs

@@ -0,0 +1,82 @@
+using System;
+using System.Text.Json;
+using System.Threading;
+using System.Threading.Tasks;
+using System.Timers;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+using Microsoft.FeatureManagement;
+using Stravaig.Configuration.Diagnostics.Logging;
+using Timer = System.Timers.Timer;
+
+
+namespace Example;
+
+public class TheHostedService : IHostedService, IDisposable
+{
+    private readonly ILogger<TheHostedService> _logger;
+    private readonly IConfigurationRoot _configRoot;
+    private readonly IFeatureManager _featureManager;
+    private readonly IOptionsMonitor<MyFeatureConfiguration> _featureValues;
+    private readonly Timer _timer;
+    
+    public TheHostedService(
+        ILogger<TheHostedService> logger,
+        IConfigurationRoot configRoot,
+        IFeatureManager featureManager,
+        IOptionsMonitor<MyFeatureConfiguration> featureValues)
+    {
+        _logger = logger;
+        _configRoot = configRoot;
+        _featureManager = featureManager;
+        _featureValues = featureValues;
+        _timer = new Timer(10000);
+        _timer.Elapsed += TimerOnElapsed;
+        featureValues.OnChange((_, s) =>
+        {
+            Console.WriteLine($"[{DateTime.Now:HH:mm:ss}] Change Detected. {s}");
+        });
+    }
+
+    private async void TimerOnElapsed(object? sender, ElapsedEventArgs e)
+    {
+        var jsonOptions = new JsonSerializerOptions()
+        {
+            WriteIndented = true,
+        };
+        string json = JsonSerializer.Serialize(_featureValues.CurrentValue, jsonOptions);
+        Console.Clear();
+        _logger.LogInformation(
+            "At {Time} the object looks like:\n{Json}",
+            e.SignalTime,
+            json);
+        await foreach (string feature in _featureManager.GetFeatureNamesAsync())
+        {
+            var state = await _featureManager.IsEnabledAsync(feature);
+            _logger.LogInformation("{Feature} : {State}", feature, state);
+        }
+        _logger.LogConfigurationValuesAsInformation(_configRoot.GetSection("MyConfiguration"));
+    }
+
+    public Task StartAsync(CancellationToken cancellationToken)
+    {
+        _logger.LogInformation("The hosted service is starting.");
+        _logger.LogProvidersAsInformation(_configRoot);
+        _timer.Enabled = true;
+        return Task.CompletedTask;
+    }
+
+    public Task StopAsync(CancellationToken cancellationToken)
+    {
+        _timer.Enabled = false;
+        _logger.LogInformation("The hosted service is ending.");
+        return Task.CompletedTask;
+    }
+
+    public void Dispose()
+    {
+        _timer.Dispose();
+    }
+}

src/Example/appsettings.json

@@ -0,0 +1,20 @@
+{
+    "Stravaig": {
+        "AppConfiguration": {
+            "SchemaName": "Stravaig",
+            "TableName": "AppConfiguration",
+            "RefreshSeconds": 15,
+            "ConnectionString": "*** Found in User Secrets ***"
+        }
+    },
+    "FeatureManager": {
+        "FeatureA": true,
+        "FeatureB": {}
+    },
+    "MyConfiguration": {
+        "SomeNumber": 123,
+        "SomeString": "A value from appsettings",
+        "SomeBoolean": "true",
+        "SomeFloatingPointNumber": 123.456
+    }
+}

src/SQL Scripts/CreateAppConfigurationTable.sql

@@ -0,0 +1,10 @@
+-- Run this in to your database. You can change the schema to suit if you need to.
+
+CREATE SCHEMA Stravaig;
+GO
+CREATE TABLE Stravaig.AppConfiguration
+(
+    ConfigKey NVARCHAR(1024) PRIMARY KEY CLUSTERED,
+    ConfigValue NVARCHAR(MAX)
+);
+GO

src/SQL Scripts/CreateNewConfigurationValue.sql

@@ -0,0 +1,12 @@
+BEGIN TRANSACTION
+
+UPDATE Stravaig.AppConfiguration
+SET ConfigValue = 'A different value from the database.'
+WHERE ConfigKey = 'MyConfiguration:SomeString'
+
+
+UPDATE Stravaig.AppConfiguration
+SET ConfigValue = 'true'
+WHERE ConfigKey = 'FeatureManager:FeatureC'
+
+COMMIT TRANSACTION

src/SQL Scripts/UpdateConfigurationValues.sql

@@ -0,0 +1,13 @@
+using System;
+using System.Collections.Generic;
+
+namespace Stravaig.Configuration.SqlServer.Tests;
+
+public class FakeDataLoader : IDataLoader
+{
+    public KeyValuePair<string, string>[] FakeData { get; set; } = Array.Empty<KeyValuePair<string, string>>();
+    public IEnumerable<KeyValuePair<string, string>> RetrieveData(SqlServerConfigurationSource source)
+    {
+        return FakeData;
+    }
+}