5.0.0-preview020 - modified TenantChange interface

JonPSmith · JonPSmith · commit f53aa5cec533 · 2023-05-28T19:27:08.000+01:00
diff --git a/AuthPermissions.AspNetCore/CreateNuGetDebug.nuspec b/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-preview019debug</version>
+    <version>5.0.0-preview020debug</version>
     <authors>Jon P Smith</authors>
     <product>AuthPermissions.AspNetCore</product>
     <copyright>Copyright (c) 2021 Jon P Smith</copyright>
diff --git a/AuthPermissions.AspNetCore/MultiProjPack.xml b/AuthPermissions.AspNetCore/MultiProjPack.xml
@@ -4,7 +4,7 @@
   <!-- See documentation for all the possible values -->
   <metadata>
     <id>AuthPermissions.AspNetCore</id>
-    <version>5.0.0-preview019debug</version>
+    <version>5.0.0-preview020debug</version>
     <authors>Jon P Smith</authors>
     <product>AuthPermissions.AspNetCore</product>
     <copyright>Copyright (c) 2021 Jon P Smith</copyright>
diff --git a/AuthPermissions.AspNetCore/ShardingServices/IAccessDatabaseInformationVer5.cs b/AuthPermissions.AspNetCore/ShardingServices/IAccessDatabaseInformationVer5.cs
@@ -1,6 +1,7 @@
 ﻿// Copyright (c) 2023 Jon P Smith, GitHub: JonPSmith, web: http://www.thereformedprogrammer.net/
 // Licensed under MIT license. See License.txt in the project root for license information.
 
+using AuthPermissions.BaseCode;
 using StatusGeneric;
 
 namespace AuthPermissions.AspNetCore.ShardingServices;
diff --git a/AuthPermissions.AspNetCore/ShardingServices/IDatabaseSpecificMethods.cs b/AuthPermissions.AspNetCore/ShardingServices/IDatabaseSpecificMethods.cs
@@ -2,6 +2,7 @@
 // Licensed under MIT license. See License.txt in the project root for license information.
 
 using System.ComponentModel;
+using AuthPermissions.BaseCode;
 using AuthPermissions.BaseCode.SetupCode;
 using StatusGeneric;
 
diff --git a/AuthPermissions.AspNetCore/ShardingServices/IShardingConnections.cs b/AuthPermissions.AspNetCore/ShardingServices/IShardingConnections.cs
@@ -1,6 +1,7 @@
 ﻿// Copyright (c) 2023 Jon P Smith, GitHub: JonPSmith, web: http://www.thereformedprogrammer.net/
 // Licensed under MIT license. See License.txt in the project root for license information.
 
+using AuthPermissions.BaseCode;
 using AuthPermissions.BaseCode.SetupCode;
 using StatusGeneric;
 
diff --git a/AuthPermissions.AspNetCore/ShardingServices/PostgresDatabaseSpecificMethods.cs b/AuthPermissions.AspNetCore/ShardingServices/PostgresDatabaseSpecificMethods.cs
@@ -2,6 +2,7 @@
 // Licensed under MIT license. See License.txt in the project root for license information.
 
 using System.ComponentModel;
+using AuthPermissions.BaseCode;
 using AuthPermissions.BaseCode.CommonCode;
 using AuthPermissions.BaseCode.SetupCode;
 using Medallion.Threading.Postgres;
diff --git a/AuthPermissions.AspNetCore/ShardingServices/ShardingSettingsOption.cs b/AuthPermissions.AspNetCore/ShardingServices/ShardingSettingsOption.cs
@@ -1,6 +1,8 @@
 ﻿// Copyright (c) 2023 Jon P Smith, GitHub: JonPSmith, web: http://www.thereformedprogrammer.net/
 // Licensed under MIT license. See License.txt in the project root for license information.
 
+using AuthPermissions.BaseCode;
+
 namespace AuthPermissions.AspNetCore.ShardingServices;
 
 /// <summary>
diff --git a/AuthPermissions.AspNetCore/ShardingServices/SqlServerDatabaseSpecificMethods.cs b/AuthPermissions.AspNetCore/ShardingServices/SqlServerDatabaseSpecificMethods.cs
@@ -2,6 +2,7 @@
 // Licensed under MIT license. See License.txt in the project root for license information.
 
 using System.ComponentModel;
+using AuthPermissions.BaseCode;
 using AuthPermissions.BaseCode.CommonCode;
 using AuthPermissions.BaseCode.SetupCode;
 using Medallion.Threading.SqlServer;
diff --git a/AuthPermissions.BaseCode/DatabaseInformation.cs b/AuthPermissions.BaseCode/DatabaseInformation.cs
@@ -2,12 +2,12 @@
 // Licensed under MIT license. See License.txt in the project root for license information.
 
 using System.ComponentModel.DataAnnotations;
-using AuthPermissions.BaseCode;
 using AuthPermissions.BaseCode.CommonCode;
 using AuthPermissions.BaseCode.DataLayer.EfCode;
 using AuthPermissions.BaseCode.SetupCode;
+using Microsoft.EntityFrameworkCore;
 
-namespace AuthPermissions.AspNetCore.ShardingServices;
+namespace AuthPermissions.BaseCode;
 
 /// <summary>
 /// This class holds the information about each database used by the AuthP sharding feature
@@ -64,9 +64,6 @@ string GetShortDatabaseProviderName()
                 case AuthPDatabaseTypes.PostgreSQL:
                     return "PostgreSQL";
                 case AuthPDatabaseTypes.CustomDatabase:
-                    if(authPContext == null)
-                        throw new AuthPermissionsException(
-                            "When using a custom database provide, then you must provide an instance of the AuthPermissionsDbContext context.");
                     return authPContext.GetProviderShortName();
                 default:
                     throw new ArgumentOutOfRangeException();
diff --git a/AuthPermissions.BaseCode/ProviderNameExtension.cs b/AuthPermissions.BaseCode/ProviderNameExtension.cs
@@ -1,12 +1,13 @@
 ﻿// Copyright (c) 2023 Jon P Smith, GitHub: JonPSmith, web: http://www.thereformedprogrammer.net/
 // Licensed under MIT license. See License.txt in the project root for license information.
 
+using AuthPermissions.BaseCode.CommonCode;
 using Microsoft.EntityFrameworkCore;
 
-namespace AuthPermissions.AspNetCore.ShardingServices;
+namespace AuthPermissions.BaseCode;
 
 /// <summary>
-/// method to get the Database Provider short name
+/// Simple method to get the short name of a EF Core database provider
 /// </summary>
 public static class ProviderNameExtension
 {
@@ -18,6 +19,10 @@ public static class ProviderNameExtension
     /// <returns></returns>
     public static string GetProviderShortName(this DbContext context)
     {
+        if (context == null)
+            throw new AuthPermissionsException(
+                "When using a custom database provide, then you must provide an instance of the AuthPermissionsDbContext context.");
+
         var lastPart = context.Database.ProviderName!.Split('.').Last();
         if (lastPart == "EntityFrameworkCore")
         {
diff --git a/AuthPermissions/AdminCode/ITenantChangeService.cs b/AuthPermissions/AdminCode/ITenantChangeService.cs
@@ -4,6 +4,7 @@
 using System.Collections.Generic;
 using System.Threading.Tasks;
 using AuthPermissions.AdminCode.Services;
+using AuthPermissions.BaseCode;
 using AuthPermissions.BaseCode.DataLayer.Classes;
 
 namespace AuthPermissions.AdminCode
@@ -22,9 +23,11 @@ public interface ITenantChangeService
         /// You should apply multiple changes within a transaction so that if any fails then any previous changes will be rolled back.
         /// NOTE: With hierarchical tenants you cannot be sure that the tenant has, or will have, children
         /// </summary>
-        /// <param name="tenant"></param>
+        /// <param name="tenant">The tenant data used to create a new tenant</param>
+        /// <param name="databaseInformation">Optional: If sharding and "sign up" feature  you need to provide the DatabaseInformation.
+        /// This overcomes a problem that the ShardingConnectionsJsonFile doesn't update quickly enough.</param>
         /// <returns>Returns null if all OK, otherwise the create is rolled back and the return string is shown to the user</returns>
-        Task<string> CreateNewTenantAsync(Tenant tenant);
+        Task<string> CreateNewTenantAsync(Tenant tenant, DatabaseInformation databaseInformation = null);
 
         //----------------------------------------------------
         // Single-level only methods
diff --git a/Example3.InvoiceCode/EfCoreCode/InvoiceTenantChangeService.cs b/Example3.InvoiceCode/EfCoreCode/InvoiceTenantChangeService.cs
@@ -7,6 +7,7 @@
 using System.Threading.Tasks;
 using AuthPermissions.AdminCode;
 using AuthPermissions.AdminCode.Services;
+using AuthPermissions.BaseCode;
 using AuthPermissions.BaseCode.CommonCode;
 using AuthPermissions.BaseCode.DataLayer.Classes;
 using Example3.InvoiceCode.EfCoreClasses;
@@ -38,9 +39,11 @@ public InvoiceTenantChangeService(InvoicesDbContext context, ILogger<InvoiceTena
         /// You should apply multiple changes within a transaction so that if any fails then any previous changes will be rolled back.
         /// NOTE: With hierarchical tenants you cannot be sure that the tenant has, or will have, children
         /// </summary>
-        /// <param name="tenant"></param>
+        /// <param name="tenant">The tenant data used to create a new tenant</param>
+        /// <param name="databaseInformation">Optional: If sharding and "sign up" feature  you need to provide the DatabaseInformation.
+        /// This overcomes a problem that the ShardingConnectionsJsonFile doesn't update quickly enough.</param>
         /// <returns>Returns null if all OK, otherwise the create is rolled back and the return string is shown to the user</returns>
-        public async Task<string> CreateNewTenantAsync(Tenant tenant)
+        public async Task<string> CreateNewTenantAsync(Tenant tenant, DatabaseInformation databaseInformation = null)
         {
             var newCompanyTenant = new CompanyTenant
             {
diff --git a/Example4.ShopCode/EfCoreCode/RetailTenantChangeService.cs b/Example4.ShopCode/EfCoreCode/RetailTenantChangeService.cs
@@ -8,6 +8,7 @@
 using System.Threading.Tasks;
 using AuthPermissions.AdminCode;
 using AuthPermissions.AdminCode.Services;
+using AuthPermissions.BaseCode;
 using AuthPermissions.BaseCode.CommonCode;
 using AuthPermissions.BaseCode.DataLayer.Classes;
 using Example4.ShopCode.EfCoreClasses;
@@ -35,9 +36,11 @@ public RetailTenantChangeService(RetailDbContext context, ILogger<RetailTenantCh
         /// You should apply multiple changes within a transaction so that if any fails then any previous changes will be rolled back.
         /// NOTE: With hierarchical tenants you cannot be sure that the tenant has, or will have, children so we always add a retail
         /// </summary>
-        /// <param name="tenant"></param>
+        /// <param name="tenant">The tenant data used to create a new tenant</param>
+        /// <param name="databaseInformation">Optional: If sharding and "sign up" feature  you need to provide the DatabaseInformation.
+        /// This overcomes a problem that the ShardingConnectionsJsonFile doesn't update quickly enough.</param>
         /// <returns>Returns null if all OK, otherwise the create is rolled back and the return string is shown to the user</returns>
-        public async Task<string> CreateNewTenantAsync(Tenant tenant)
+        public async Task<string> CreateNewTenantAsync(Tenant tenant, DatabaseInformation databaseInformation = null)
         {
             _context.Add(new RetailOutlet(tenant.TenantId, tenant.TenantFullName, tenant.GetTenantDataKey()));
             await _context.SaveChangesAsync();
diff --git a/Example6.MvcWebApp.Sharding/Controllers/TenantAdminController.cs b/Example6.MvcWebApp.Sharding/Controllers/TenantAdminController.cs
@@ -24,7 +24,7 @@ public TenantAdminController(IAuthUsersAdminService authUsersAdmin)
         public async Task<IActionResult> Index(string message)
         {
             var dataKey = User.GetAuthDataKeyFromUser();
-            var userQuery = _authUsersAdmin.QueryAuthUsers(dataKey);
+            var userQuery = _authUsersAdmin.QueryAuthUsers(dataKey, User.GetDatabaseInfoNameFromUser());
             var usersToShow = await AuthUserDisplay.TurnIntoDisplayFormat(userQuery.OrderBy(x => x.Email)).ToListAsync();
 
             ViewBag.Message = message;
diff --git a/Example6.MvcWebApp.Sharding/Models/DatabaseInformationEdit.cs b/Example6.MvcWebApp.Sharding/Models/DatabaseInformationEdit.cs
@@ -2,6 +2,7 @@
 // Licensed under MIT license. See License.txt in the project root for license information.
 
 using AuthPermissions.AspNetCore.ShardingServices;
+using AuthPermissions.BaseCode;
 
 namespace Example6.MvcWebApp.Sharding.Models;
 
diff --git a/Example6.MvcWebApp.Sharding/Views/Sharding/Index.cshtml b/Example6.MvcWebApp.Sharding/Views/Sharding/Index.cshtml
@@ -1,7 +1,7 @@
 ﻿@using AuthPermissions.BaseCode.PermissionsCode
 @using Example6.MvcWebApp.Sharding.PermissionsCode
 @using Microsoft.AspNetCore.Mvc.TagHelpers
-@model IEnumerable<AuthPermissions.AspNetCore.ShardingServices.DatabaseInformation>
+@model IEnumerable<AuthPermissions.BaseCode.DatabaseInformation>
 
 @{
     ViewData["Title"] = "Database Info";
diff --git a/Example6.SingleLevelSharding/EfCoreCode/ShardingTenantChangeService.cs b/Example6.SingleLevelSharding/EfCoreCode/ShardingTenantChangeService.cs
@@ -5,6 +5,7 @@
 using AuthPermissions.AdminCode;
 using AuthPermissions.AspNetCore.GetDataKeyCode;
 using AuthPermissions.AspNetCore.ShardingServices;
+using AuthPermissions.BaseCode;
 using AuthPermissions.BaseCode.CommonCode;
 using AuthPermissions.BaseCode.DataLayer.Classes;
 using Example6.SingleLevelSharding.EfCoreClasses;
@@ -46,9 +47,11 @@ public ShardingTenantChangeService(DbContextOptions<ShardingSingleDbContext> opt
     /// <summary>
     /// This creates a <see cref="CompanyTenant"/> in the given database
     /// </summary>
-    /// <param name="tenant"></param>
-    /// <returns>Null if no errors, otherwise string is shown as an error to the user</returns>
-    public async Task<string> CreateNewTenantAsync(Tenant tenant)
+    /// <param name="tenant">The tenant data used to create a new tenant</param>
+    /// <param name="databaseInformation">Optional: If sharding and "sign up" feature  you need to provide the DatabaseInformation.
+    /// This overcomes a problem that the ShardingConnectionsJsonFile doesn't update quickly enough.</param>
+    /// <returns>Returns null if all OK, otherwise the create is rolled back and the return string is shown to the user</returns>
+    public async Task<string> CreateNewTenantAsync(Tenant tenant, DatabaseInformation databaseInformation = null)
     {
         using var context = GetShardingSingleDbContext(tenant.DatabaseInfoName, tenant.GetTenantDataKey());
         if (context == null)
diff --git a/Test/StubClasses/StubConnectionsService.cs b/Test/StubClasses/StubConnectionsService.cs
@@ -2,6 +2,7 @@
 // Licensed under MIT license. See License.txt in the project root for license information.
 
 using AuthPermissions.AspNetCore.ShardingServices;
+using AuthPermissions.BaseCode;
 using AuthPermissions.BaseCode.SetupCode;
 using StatusGeneric;
 using TestSupport.Helpers;
diff --git a/Test/StubClasses/StubITenantChangeService.cs b/Test/StubClasses/StubITenantChangeService.cs
@@ -5,6 +5,7 @@
 using System.Linq;
 using System.Threading.Tasks;
 using AuthPermissions.AdminCode;
+using AuthPermissions.BaseCode;
 using AuthPermissions.BaseCode.CommonCode;
 using AuthPermissions.BaseCode.DataLayer.Classes;
 using AuthPermissions.SetupCode.Factories;
@@ -45,7 +46,7 @@ public StubITenantChangeService(StubITenantChangeServiceFactory factory, string
                 _errorMessage = errorMessage;
             }
 
-            public Task<string> CreateNewTenantAsync(Tenant tenant)
+            public Task<string> CreateNewTenantAsync(Tenant tenant, DatabaseInformation databaseInformation = null)
             {
                 _factory.NewTenantName = tenant.TenantFullName;
 
diff --git a/Test/StubClasses/StubSqliteDatabaseSpecificMethods.cs b/Test/StubClasses/StubSqliteDatabaseSpecificMethods.cs
@@ -3,6 +3,7 @@
 
 using System.ComponentModel;
 using AuthPermissions.AspNetCore.ShardingServices;
+using AuthPermissions.BaseCode;
 using AuthPermissions.BaseCode.SetupCode;
 using StatusGeneric;
 
diff --git a/Test/TestData/shardingsettings.Test.json b/Test/TestData/shardingsettings.Test.json
@@ -3,8 +3,8 @@
     {
       "Name": "Default Database",
       "DatabaseName": null,
-      "ConnectionName": "PostgreSqlConnection",
-      "DatabaseType": "SqliteInMemory"
+      "ConnectionName": "UnitTestConnection",
+      "DatabaseType": "SqlServer"
     },
     {
       "Name": "Other Database",
@@ -17,6 +17,24 @@
       "DatabaseName": "StubTest",
       "ConnectionName": "PostgreSqlConnection",
       "DatabaseType": "PostgreSQL"
+    },
+    {
+      "Name": "Name1",
+      "DatabaseName": "DatabaseName1",
+      "ConnectionName": "UnitTestConnection",
+      "DatabaseType": "PostgreSQL"
+    },
+    {
+      "Name": "Name2",
+      "DatabaseName": "DatabaseName2",
+      "ConnectionName": "UnitTestConnection",
+      "DatabaseType": "PostgreSQL"
+    },
+    {
+      "Name": "Name3",
+      "DatabaseName": "DatabaseName3",
+      "ConnectionName": "UnitTestConnection",
+      "DatabaseType": "PostgreSQL"
     }
   ]
 }
diff --git a/Test/UnitTests/TestSharding/TestPostgresDatabaseSpecificMethods.cs b/Test/UnitTests/TestSharding/TestPostgresDatabaseSpecificMethods.cs
@@ -6,6 +6,7 @@
 using AuthPermissions.BaseCode.SetupCode;
 using Microsoft.EntityFrameworkCore;
 using System.Collections.Concurrent;
+using AuthPermissions.BaseCode;
 using AuthPermissions.BaseCode.CommonCode;
 using StatusGeneric;
 using Test.Helpers;
diff --git a/Test/UnitTests/TestSharding/TestSqlServerDatabaseSpecificMethods.cs b/Test/UnitTests/TestSharding/TestSqlServerDatabaseSpecificMethods.cs
@@ -6,6 +6,7 @@
 using AuthPermissions.BaseCode.SetupCode;
 using Microsoft.EntityFrameworkCore;
 using System.Collections.Concurrent;
+using AuthPermissions.BaseCode;
 using AuthPermissions.BaseCode.CommonCode;
 using StatusGeneric;
 using Test.TestHelpers;
