Simplified a method name

JonPSmith · JonPSmith · commit 782feda9e2c8 · 2023-08-15T09:02:31.000+01:00
diff --git a/AuthPermissions.AspNetCore.sln b/AuthPermissions.AspNetCore.sln
@@ -54,6 +54,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Example7.MvcWebApp.Sharding
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Example7.SingleLevelShardingOnly", "Example7.SingleLevelShardingOnly\Example7.SingleLevelShardingOnly.csproj", "{9ABE93FC-DE35-47E1-B5B3-27867E350933}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ConsoleApp.AuthP6Upgrade", "ConsoleApp.AuthP6Upgrade\ConsoleApp.AuthP6Upgrade.csproj", "{65A69729-B8E3-4F11-B88F-2AF1AFAB50F2}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -304,6 +306,18 @@ Global
 		{9ABE93FC-DE35-47E1-B5B3-27867E350933}.Release|x64.Build.0 = Release|Any CPU
 		{9ABE93FC-DE35-47E1-B5B3-27867E350933}.Release|x86.ActiveCfg = Release|Any CPU
 		{9ABE93FC-DE35-47E1-B5B3-27867E350933}.Release|x86.Build.0 = Release|Any CPU
+		{65A69729-B8E3-4F11-B88F-2AF1AFAB50F2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{65A69729-B8E3-4F11-B88F-2AF1AFAB50F2}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{65A69729-B8E3-4F11-B88F-2AF1AFAB50F2}.Debug|x64.ActiveCfg = Debug|Any CPU
+		{65A69729-B8E3-4F11-B88F-2AF1AFAB50F2}.Debug|x64.Build.0 = Debug|Any CPU
+		{65A69729-B8E3-4F11-B88F-2AF1AFAB50F2}.Debug|x86.ActiveCfg = Debug|Any CPU
+		{65A69729-B8E3-4F11-B88F-2AF1AFAB50F2}.Debug|x86.Build.0 = Debug|Any CPU
+		{65A69729-B8E3-4F11-B88F-2AF1AFAB50F2}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{65A69729-B8E3-4F11-B88F-2AF1AFAB50F2}.Release|Any CPU.Build.0 = Release|Any CPU
+		{65A69729-B8E3-4F11-B88F-2AF1AFAB50F2}.Release|x64.ActiveCfg = Release|Any CPU
+		{65A69729-B8E3-4F11-B88F-2AF1AFAB50F2}.Release|x64.Build.0 = Release|Any CPU
+		{65A69729-B8E3-4F11-B88F-2AF1AFAB50F2}.Release|x86.ActiveCfg = Release|Any CPU
+		{65A69729-B8E3-4F11-B88F-2AF1AFAB50F2}.Release|x86.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
diff --git a/AuthPermissions.AspNetCore/ShardingServices/GetSetShardingEntriesFileStoreCache.cs b/AuthPermissions.AspNetCore/ShardingServices/GetSetShardingEntriesFileStoreCache.cs
@@ -185,7 +185,7 @@ public List<string> GetConnectionStringNames()
     /// </summary>
     /// <returns>List of all the sharding entries names with the tenants using that database data name
     /// NOTE: The hasOwnDb is true for a database containing a single database, false for multiple tenant database and null if empty</returns>
-    public async Task<List<(string shardingName, bool? hasOwnDb, List<string> tenantNames)>> GetDatabaseInfoNamesWithTenantNamesAsync()
+    public async Task<List<(string shardingName, bool? hasOwnDb, List<string> tenantNames)>> GetShardingsWithTenantNamesAsync()
     {
         var nameAndConnectionName = await _authDbContext.Tenants
             .Select(x => new { ConnectionName = x.DatabaseInfoName, x })
diff --git a/AuthPermissions.AspNetCore/ShardingServices/IGetSetShardingEntries.cs b/AuthPermissions.AspNetCore/ShardingServices/IGetSetShardingEntries.cs
@@ -69,7 +69,7 @@ public interface IGetSetShardingEntries
     /// </summary>
     /// <returns>List of all the database info names with the tenants (and whether its sharding) within that database data name
     /// NOTE: The hasOwnDb is true for a database containing a single database, false for multiple tenant database and null if empty</returns>
-    Task<List<(string shardingName, bool? hasOwnDb, List<string> tenantNames)>> GetDatabaseInfoNamesWithTenantNamesAsync();
+    Task<List<(string shardingName, bool? hasOwnDb, List<string> tenantNames)>> GetShardingsWithTenantNamesAsync();
 
     /// <summary>
     /// This will provide the connection string for the entry with the given database info name
diff --git a/AuthPermissions.SupportCode/DemoGetDatabaseForNewTenant.cs b/AuthPermissions.SupportCode/DemoGetDatabaseForNewTenant.cs
@@ -51,7 +51,7 @@ public async Task<IStatusGeneric<Tenant>> FindOrCreateDatabaseAsync(Tenant tenan
         var status = new StatusGenericLocalizer<Tenant>(_localizeDefault);
 
         //This gets the databases with the info on whether the database is available
-        var dbsWithUsers = await _shardingService.GetDatabaseInfoNamesWithTenantNamesAsync();
+        var dbsWithUsers = await _shardingService.GetShardingsWithTenantNamesAsync();
 
         var foundDatabaseInfoName = hasOwnDb
             ? // this will find the first empty database
diff --git a/Example6.MvcWebApp.Sharding/Controllers/TenantController.cs b/Example6.MvcWebApp.Sharding/Controllers/TenantController.cs
@@ -40,7 +40,7 @@ public async Task<IActionResult> Index(string message)
         [HasPermission(Example6Permissions.ListDbsWithTenants)]
         public async Task<IActionResult> ListDatabases([FromServices] IGetSetShardingEntries shardingService)
         {
-            var connections = await shardingService.GetDatabaseInfoNamesWithTenantNamesAsync();
+            var connections = await shardingService.GetShardingsWithTenantNamesAsync();
 
             return View(connections);
         }
diff --git a/Example7.MvcWebApp.ShardingOnly/Controllers/TenantController.cs b/Example7.MvcWebApp.ShardingOnly/Controllers/TenantController.cs
@@ -38,7 +38,7 @@ public async Task<IActionResult> Index(string message)
         [HasPermission(Example7Permissions.ListDbsWithTenants)]
         public async Task<IActionResult> ListDatabases([FromServices] IGetSetShardingEntries shardingService)
         {
-            var connections = await shardingService.GetDatabaseInfoNamesWithTenantNamesAsync();
+            var connections = await shardingService.GetShardingsWithTenantNamesAsync();
 
             return View(connections);
         }
diff --git a/Test/StubClasses/StubGetSetShardingEntries.cs b/Test/StubClasses/StubGetSetShardingEntries.cs
@@ -126,7 +126,7 @@ public string FormConnectionString(string databaseInfoName)
         };
     }
 
-    public Task<List<(string shardingName, bool? hasOwnDb, List<string> tenantNames)>> GetDatabaseInfoNamesWithTenantNamesAsync()
+    public Task<List<(string shardingName, bool? hasOwnDb, List<string> tenantNames)>> GetShardingsWithTenantNamesAsync()
     {
         return Task.FromResult(new List<(string key, bool? hasOwnDb, List<string> tenantNames)>
         {
diff --git a/Test/UnitTests/TestSharding/TestGetSetShardingEntriesFileStoreCache.cs b/Test/UnitTests/TestSharding/TestGetSetShardingEntriesFileStoreCache.cs
@@ -477,7 +477,7 @@ public async Task TestQueryTenantsSingle()
         setup.AuthDbContext.ChangeTracker.Clear();
 
         //ATTEMPT
-        var list = await setup.Service.GetDatabaseInfoNamesWithTenantNamesAsync();
+        var list = await setup.Service.GetShardingsWithTenantNamesAsync();
 
         //VERIFY
         list.ShouldEqual(new List<(string databaseName, bool? hasOwnDb, List<string> tenantNames)>
diff --git a/UpdateToVersion6.md b/UpdateToVersion6.md
@@ -1,11 +1,62 @@
 # Updating your code from AuthPermissions.AspNetCore 5.* to 6.0
 
-Version 6.0.0 of the AuthPermissions.AspNetCore library (shortened to **AuthP** from now on) contains improved sharding features, but they contain **BREAKING CHANGES**. There are lot of small and obvious changes, but only in AuthP's sharding features.
+Version 6.0.0 of the AuthPermissions.AspNetCore library (shortened to **AuthP** from now on) contains improved sharding features, but they contain **BREAKING CHANGES**. These breaking changes came about because of a limitation found in the ASP.NET Core `IOptions` feature (see this section ????). These changes ONLY EFFECT multi-tenant applications that use sharding, i.e. you have the `SetupMultiTenantSharding` extension method in your AuthP registration code.
+
+However, when I was working on the data that links tenants to databases (now called _sharding entries_) I found my previous code didn't use _nice names_. For instance:
+
+- The name of a class, method, etc didn't match what it was used for. For instance the class that links a tenant to a database was called `DatabaseInformation`, but its name is now its called `ShardingEntry`. 
+- Some method names were too long. For instance the method that updated a `ShardingEntry` was called `UpdateDatabaseInfoToShardingInformation` and now called `UpdateShardingEntry`.
+
+Of course this creates more breaking changes, but the code will be easier to understand. Also on upgrading to AuthP 6 it will be very obvious, as each change will become an error.  
 
 ## TABLE OF CONTENT
 
-1. 
+1. Changing to the new IGetSetShardingEntries service.
+2. Updating the IGetSetShardingEntries method names
+3. Make sure that distributed FileStore Cache is registered
+4. Once it complies and **before you run your application**
+    - Move your sharding entries from the json file to the distributed FileStore Cache
 
 The subsections below the items listed in the table of content.
 
+## 1. Changing to the new [IGetSetShardingEntries](https://github.com/JonPSmith/AuthPermissions.AspNetCore/blob/main/AuthPermissions.AspNetCore/ShardingServices/IGetSetShardingEntries.cs) service
+
+Before AuthP version 6 you had two services called `IAccessDatabaseInformationVer5` and `IShardingConnections`. Now you have one service called `IGetSetShardingEntries` that contains all the methods, properties, etc. that the two services it replaces.
+
+| Old name          | new name      | Notes |
+| ----------------- | ------------- | ----- |
+| `IAccessDatabaseInformationVer5`    | `IGetSetShardingEntries` | I use `shardingService` |
+| `IShardingConnections`    | `IGetSetShardingEntries` | I use `shardingService` |
+
+The other big change is `IGetSetShardingEntries` changes the name of a class
+
+| Old name          | new name      | Notes |
+| ----------------- | ------------- | ----- |
+| `DatabaseInformation`    | `ShardingEntry` |  |
+
+## 2. Updating the IGetSetShardingEntries method names
+
+The table below gives the old and new.
+| Old name          | new name      | Notes |
+| ----------------- | ------------- | ----- |
+| `ReadAllShardingInformation`    | `GetAllShardingEntries` |  |
+| `GetDatabaseInformationByName`    | `GetSingleShardingEntry` |  |
+| `AddDatabaseInfoToShardingInformation`    | `AddNewShardingEntry` |  |
+| `UpdateDatabaseInfoToShardingInformation`    | `UpdateShardingEntry` |  |
+| `RemoveDatabaseInfoFromShardingInformationAsync`    | `RemoveShardingEntry` |  |
+| `GetAllPossibleShardingData` | `GetAllShardingEntries` |  |
+| `GetDatabaseInfoNamesWithTenantNamesAsync` | `GetShardingsWithTenantNamesAsync` |  |
+
+A properly that has been simplified
+| Old name          | new name      | Notes |
+| ----------------- | ------------- | ----- |
+| `ShardingDatabaseProviders.Keys.ToArray()`    | `PossibleDatabaseProviders()` |  |
+
+Other methods that haven't changed are listed below
+| Old name          | new name      | Notes |
+| ----------------- | ------------- | ----- |
+| `GetConnectionStringNames` | `GetConnectionStringNames` | see note1  |
+
+Note1
+
 END

Original file line number	Diff line number	Diff line change
`@@ -185,7 +185,7 @@ public List<string> GetConnectionStringNames()`
`185`	`185`	`/// </summary>`
`186`	`186`	`/// <returns>List of all the sharding entries names with the tenants using that database data name`
`187`	`187`	`/// NOTE: The hasOwnDb is true for a database containing a single database, false for multiple tenant database and null if empty</returns>`
`188`		`- public async Task<List<(string shardingName, bool? hasOwnDb, List<string> tenantNames)>> GetDatabaseInfoNamesWithTenantNamesAsync()`
	`188`	`+ public async Task<List<(string shardingName, bool? hasOwnDb, List<string> tenantNames)>> GetShardingsWithTenantNamesAsync()`
`189`	`189`	`{`
`190`	`190`	`var nameAndConnectionName = await _authDbContext.Tenants`
`191`	`191`	`.Select(x => new { ConnectionName = x.DatabaseInfoName, x })`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public async Task<IActionResult> Index(string message)`
`40`	`40`	`[HasPermission(Example6Permissions.ListDbsWithTenants)]`
`41`	`41`	`public async Task<IActionResult> ListDatabases([FromServices] IGetSetShardingEntries shardingService)`
`42`	`42`	`{`
`43`		`- var connections = await shardingService.GetDatabaseInfoNamesWithTenantNamesAsync();`
	`43`	`+ var connections = await shardingService.GetShardingsWithTenantNamesAsync();`
`44`	`44`
`45`	`45`	`return View(connections);`
`46`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ public async Task<IActionResult> Index(string message)`
`38`	`38`	`[HasPermission(Example7Permissions.ListDbsWithTenants)]`
`39`	`39`	`public async Task<IActionResult> ListDatabases([FromServices] IGetSetShardingEntries shardingService)`
`40`	`40`	`{`
`41`		`- var connections = await shardingService.GetDatabaseInfoNamesWithTenantNamesAsync();`
	`41`	`+ var connections = await shardingService.GetShardingsWithTenantNamesAsync();`
`42`	`42`
`43`	`43`	`return View(connections);`
`44`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -126,7 +126,7 @@ public string FormConnectionString(string databaseInfoName)`
`126`	`126`	`};`
`127`	`127`	`}`
`128`	`128`
`129`		`- public Task<List<(string shardingName, bool? hasOwnDb, List<string> tenantNames)>> GetDatabaseInfoNamesWithTenantNamesAsync()`
	`129`	`+ public Task<List<(string shardingName, bool? hasOwnDb, List<string> tenantNames)>> GetShardingsWithTenantNamesAsync()`
`130`	`130`	`{`
`131`	`131`	`return Task.FromResult(new List<(string key, bool? hasOwnDb, List<string> tenantNames)>`
`132`	`132`	`{`