5.0.0-preview019 - Fixed bug in ShardingConnection

Author: JonPSmith

AuthPermissions.AspNetCore/CreateNuGetDebug.nuspec

@@ -2,7 +2,7 @@
 <package xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
   <metadata>
     <id>AuthPermissions.AspNetCore</id>
-    <version>5.0.0-preview017debug</version>
+    <version>5.0.0-preview019debug</version>
     <authors>Jon P Smith</authors>
     <product>AuthPermissions.AspNetCore</product>
     <copyright>Copyright (c) 2021 Jon P Smith</copyright>

AuthPermissions.AspNetCore/MultiProjPack.xml

@@ -4,7 +4,7 @@
   <!-- See documentation for all the possible values -->
   <metadata>
     <id>AuthPermissions.AspNetCore</id>
-    <version>5.0.0-preview017debug</version>
+    <version>5.0.0-preview019debug</version>
     <authors>Jon P Smith</authors>
     <product>AuthPermissions.AspNetCore</product>
     <copyright>Copyright (c) 2021 Jon P Smith</copyright>

AuthPermissions.AspNetCore/ShardingServices/ShardingConnectionsJsonFile.cs

@@ -26,7 +26,11 @@ public class ShardingConnectionsJsonFile : IShardingConnections
     private readonly AuthPermissionsDbContext _context;
     private readonly IDefaultLocalizer _localizeDefault;
     private readonly AuthPermissionsOptions _options;
-    private readonly ShardingSettingsOption _shardingSettings;
+
+    /// <summary>
+    /// This contains the most up to date data in the shardingsettings json file
+    /// </summary>
+    private List<DatabaseInformation> _databaseInformation;
 
     /// <summary>
     /// This contains the methods with are specific to a database provider
@@ -48,26 +52,21 @@ public class ShardingConnectionsJsonFile : IShardingConnections
     /// <param name="databaseProviderMethods"></param>
     /// <param name="localizeProvider">Provides the used to localize any errors or messages</param>
     public ShardingConnectionsJsonFile(IOptionsSnapshot<ConnectionStringsOption> connectionsAccessor,
-        IOptionsSnapshot<ShardingSettingsOption> shardingSettingsAccessor,
+        IOptionsMonitor<ShardingSettingsOption> shardingSettingsAccessor,
         AuthPermissionsDbContext context, AuthPermissionsOptions options, 
         IEnumerable<IDatabaseSpecificMethods> databaseProviderMethods,
         IAuthPDefaultLocalizer localizeProvider)
     {
         //thanks to https://stackoverflow.com/questions/37287427/get-multiple-connection-strings-in-appsettings-json-without-ef
         _connectionDict = connectionsAccessor.Value;
-        _shardingSettings = shardingSettingsAccessor.Value;
         _context = context;
         _options = options;
+        SetDatabaseInformation(shardingSettingsAccessor.CurrentValue);
+        shardingSettingsAccessor.OnChange(SetDatabaseInformation);
+
         DatabaseProviderMethods = databaseProviderMethods.ToDictionary(x => x.AuthPDatabaseType);
         ShardingDatabaseProviders = DatabaseProviderMethods.Values.ToDictionary(x => x.DatabaseProviderShortName);
         _localizeDefault = localizeProvider.DefaultLocalizer;
-
-        //If no sharding settings file, then we provide one default sharding settings data
-        //NOTE that the DatabaseInformation class has default values linked to a 
-        _shardingSettings.ShardingDatabases ??= new List<DatabaseInformation>
-        {
-            DatabaseInformation.FormDefaultDatabaseInfo(options, _context)
-        };
     }
 
     /// <summary>
@@ -79,7 +78,7 @@ public ShardingConnectionsJsonFile(IOptionsSnapshot<ConnectionStringsOption> con
     /// <returns>A list of <see cref="DatabaseInformation"/> from the sharding settings file</returns>
     public List<DatabaseInformation> GetAllPossibleShardingData()
     {
-        return _shardingSettings.ShardingDatabases;
+        return _databaseInformation;
     }
 
     /// <summary>
@@ -110,7 +109,7 @@ public IEnumerable<string> GetConnectionStringNames()
 
         var result = new List<(string databaseInfoName, bool? hasOwnDb, List<string>)>();
         //Add sharding database names that have no tenants in them so that you can see all the connection string  names
-        foreach (var databaseInfoName in _shardingSettings.ShardingDatabases.Select(x => x.Name))
+        foreach (var databaseInfoName in _databaseInformation.Select(x => x.Name))
         {
             result.Add(grouped.ContainsKey(databaseInfoName)
                 ? (databaseInfoName,
@@ -130,15 +129,16 @@ public IEnumerable<string> GetConnectionStringNames()
     /// This will provide the connection string for the entry with the given database info name
     /// </summary>
     /// <param name="databaseInfoName">The name of sharding database info we want to access</param>
-    /// <returns>The connection string, or null if not found</returns>
+    /// <returns>The connection string, or throw exception</returns>
     public string FormConnectionString(string databaseInfoName)
     {
         if (databaseInfoName == null)
             throw new AuthPermissionsException("The name of the database date can't be null");
 
-        var databaseData = _shardingSettings.ShardingDatabases.SingleOrDefault(x => x.Name == databaseInfoName);
+        var databaseData = _databaseInformation.SingleOrDefault(x => x.Name == databaseInfoName);
         if (databaseData == null)
-            return null;
+            throw new AuthPermissionsException(
+                $"The database information with the name of '{databaseInfoName}' wasn't founds.");
 
         if (!_connectionDict.TryGetValue(databaseData.ConnectionName, out var connectionString))
             throw new AuthPermissionsException(
@@ -186,4 +186,18 @@ public IStatusGeneric TestFormingConnectionString(DatabaseInformation databaseIn
 
         return status;
     }
+
+    //--------------------------------------------
+    //private methods
+
+    /// <summary>
+    /// This takes to information from the OptionsMonitor and sets the _databaseInformation parameter
+    /// </summary>
+    /// <returns></returns>
+    private void SetDatabaseInformation(ShardingSettingsOption fromMonitor )
+    {
+        _databaseInformation = (fromMonitor.ShardingDatabases == null || !fromMonitor.ShardingDatabases.Any())
+            ? new List<DatabaseInformation> { DatabaseInformation.FormDefaultDatabaseInfo(_options, _context) }
+            : fromMonitor.ShardingDatabases;
+    }
 }

Test/TestData/shardingsettings.Test.json

@@ -16,7 +16,7 @@
       "Name": "PostgreSql1",
       "DatabaseName": "StubTest",
       "ConnectionName": "PostgreSqlConnection",
-      "DatabaseType": "Postgres"
+      "DatabaseType": "PostgreSQL"
     }
   ]
 }

Test/UnitTests/TestSharding/TestAccessDatabaseInformation.cs

@@ -92,7 +92,7 @@ public void TestReadShardingSettingsFile()
         databaseInfo.Count.ShouldEqual(3);
         databaseInfo[0].ToString().ShouldEqual("Name: Default Database, DatabaseName:  < null > , ConnectionName: UnitTestConnection, DatabaseType: SqlServer");
         databaseInfo[1].ToString().ShouldEqual("Name: Other Database, DatabaseName: MyDatabase1, ConnectionName: UnitTestConnection, DatabaseType: SqlServer");
-        databaseInfo[2].ToString().ShouldEqual("Name: PostgreSql1, DatabaseName: StubTest, ConnectionName: PostgreSqlConnection, DatabaseType: Postgres");
+        databaseInfo[2].ToString().ShouldEqual("Name: PostgreSql1, DatabaseName: StubTest, ConnectionName: PostgreSqlConnection, DatabaseType: PostgreSQL");
     }
 
     [Fact]

Test/UnitTests/TestSharding/TestShardingConnectionString.cs

@@ -21,7 +21,7 @@ public class TestShardingConnectionString
 {
     private readonly ITestOutputHelper _output;
     private readonly IOptionsSnapshot<ConnectionStringsOption> _connectSnapshot;
-    private readonly IOptionsSnapshot<ShardingSettingsOption> _shardingSnapshot;
+    private readonly IOptionsMonitor<ShardingSettingsOption> _shardingMonitor;
 
     public TestShardingConnectionString(ITestOutputHelper output)
     {
@@ -34,7 +34,7 @@ public TestShardingConnectionString(ITestOutputHelper output)
         var serviceProvider = services.BuildServiceProvider();
 
         _connectSnapshot = serviceProvider.GetRequiredService<IOptionsSnapshot<ConnectionStringsOption>>();
-        _shardingSnapshot = serviceProvider.GetRequiredService<IOptionsSnapshot<ShardingSettingsOption>>();
+        _shardingMonitor = serviceProvider.GetRequiredService<IOptionsMonitor<ShardingSettingsOption>>();
     }
 
     private static AuthPermissionsOptions FormAuthOptionsForSharding(
@@ -110,7 +110,7 @@ public void TestDefaultShardingDatabaseData_CustomDatabase_NoContext()
     public void TestGetAllConnectionStrings()
     {
         //SETUP
-        var service = new ShardingConnectionsJsonFile(_connectSnapshot, _shardingSnapshot,
+        var service = new ShardingConnectionsJsonFile(_connectSnapshot, _shardingMonitor,
             null, FormAuthOptionsForSharding(), ShardingHelpers.GetDatabaseSpecificMethods(),
             "en".SetupAuthPLoggingLocalizer());
 
@@ -135,7 +135,7 @@ public void TestGetAllConnectionStrings()
     public void TestFormingConnectionString(string connectionName, bool isValid)
     {
         //SETUP
-        var service = new ShardingConnectionsJsonFile(_connectSnapshot, _shardingSnapshot,
+        var service = new ShardingConnectionsJsonFile(_connectSnapshot, _shardingMonitor,
             null, FormAuthOptionsForSharding(), ShardingHelpers.GetDatabaseSpecificMethods(),
             "en".SetupAuthPLoggingLocalizer());
 
@@ -158,7 +158,7 @@ public void TestFormingConnectionString(string connectionName, bool isValid)
     public void TestGetNamedConnectionStringSqlServer()
     {
         //SETUP
-        var service = new ShardingConnectionsJsonFile(_connectSnapshot, _shardingSnapshot,
+        var service = new ShardingConnectionsJsonFile(_connectSnapshot, _shardingMonitor,
             null, FormAuthOptionsForSharding(), ShardingHelpers.GetDatabaseSpecificMethods(),
             "en".SetupAuthPLoggingLocalizer());
 
@@ -173,7 +173,7 @@ public void TestGetNamedConnectionStringSqlServer()
     public void TestGetNamedConnectionStringSqlServer_NoDatabaseName()
     {
         //SETUP
-        var service = new ShardingConnectionsJsonFile(_connectSnapshot, _shardingSnapshot,
+        var service = new ShardingConnectionsJsonFile(_connectSnapshot, _shardingMonitor,
             null, FormAuthOptionsForSharding(), ShardingHelpers.GetDatabaseSpecificMethods(),
             "en".SetupAuthPLoggingLocalizer());
 
@@ -188,7 +188,7 @@ public void TestGetNamedConnectionStringSqlServer_NoDatabaseName()
     public void TestGetNamedConnectionStringDefaultDatabase()
     {
         //SETUP
-        var service = new ShardingConnectionsJsonFile(_connectSnapshot, _shardingSnapshot,
+        var service = new ShardingConnectionsJsonFile(_connectSnapshot, _shardingMonitor,
             null, FormAuthOptionsForSharding(), ShardingHelpers.GetDatabaseSpecificMethods(),
             "en".SetupAuthPLoggingLocalizer());
 
@@ -203,7 +203,7 @@ public void TestGetNamedConnectionStringDefaultDatabase()
     public void TestGetNamedConnectionStringPostgres()
     {
         //SETUP
-        var service = new ShardingConnectionsJsonFile(_connectSnapshot, _shardingSnapshot,
+        var service = new ShardingConnectionsJsonFile(_connectSnapshot, _shardingMonitor,
             null, FormAuthOptionsForSharding(AuthPDatabaseTypes.PostgreSQL), 
             ShardingHelpers.GetDatabaseSpecificMethods(),
             "en".SetupAuthPLoggingLocalizer());
@@ -238,7 +238,7 @@ public async Task TestQueryTenantsSingle()
         var services = new ServiceCollection();
         services.Configure<ConnectionStringsOption>(config.GetSection("ConnectionStrings"));
 
-        var service = new ShardingConnectionsJsonFile(_connectSnapshot, _shardingSnapshot,
+        var service = new ShardingConnectionsJsonFile(_connectSnapshot, _shardingMonitor,
             context, FormAuthOptionsForSharding(), ShardingHelpers.GetDatabaseSpecificMethods(),
             "en".SetupAuthPLoggingLocalizer());
 
@@ -286,7 +286,7 @@ public async Task TestQueryTenantsSingleDefaultConnectionName(bool addTenantDefa
         var services = new ServiceCollection();
         services.Configure<ConnectionStringsOption>(config.GetSection("ConnectionStrings"));
 
-        var service = new ShardingConnectionsJsonFile(_connectSnapshot, _shardingSnapshot,
+        var service = new ShardingConnectionsJsonFile(_connectSnapshot, _shardingMonitor,
             context, FormAuthOptionsForSharding(), ShardingHelpers.GetDatabaseSpecificMethods(),
             "en".SetupAuthPLoggingLocalizer());