Hotfix/7.0.4 (#110)

* db conn aclaration

* exception logging & builder

* docs

* wait for data generation

* currentHolder with initial ctor

* xmldocs

* wait for default tenant

* xmldocs

* formatting

* logging improved

* xmldocs

* xmldocs

* method detection standardized

* xmldocs

* method detections

* xmldocs

* description and min version

* fix logging of errors array

* cherrypick-errors fixed

* dependency fix

* test fix

* correlation holder is injected, must not contain more public ctors

* build triggers adapted

* master -> main

Author: marcwittke

README.md

@@ -15,7 +15,7 @@ Backend.Fx.AspNetCore.Mvc | 2.0 | [![NuGet](https://img.shields.io/nuget/v/Backe
 Backend.Fx.NetCore | 1.3 | [![NuGet](https://img.shields.io/nuget/v/Backend.Fx.NetCore.svg)](https://www.nuget.org/packages/Backend.Fx.NetCore)
 
 ## What does "opinionated" mean?
-You get vendor locked to a set of abstractions, like my DDD building blocks and some architecture [patterns](https://github.com/marcwittke/Backend.Fx/tree/master/src/abstractions/Backend.Fx/Patterns) defined as interfaces
+You get vendor locked to a set of abstractions, like my DDD building blocks and some architecture [patterns](https://github.com/marcwittke/Backend.Fx/tree/main/src/abstractions/Backend.Fx/Patterns) defined as interfaces
 
 ## Less opinonated, but already provided as pluggable implementations of patterns
 

build/Build.cs

@@ -92,7 +92,7 @@ class Build : NukeBuild
                            .DependsOn(Pack)
                            .Executes(() =>
                            {
-                               bool pushToNuget = GitRepository.Branch == "master";
+                               bool pushToNuget = GitRepository.Branch == "main";
 
                                foreach (var nupkg in ArtifactsDirectory.GlobFiles("*.nupkg"))
                                {

src/abstractions/Backend.Fx/Environment/Authentication/CurrentIdentityHolder.cs

@@ -5,6 +5,12 @@ namespace Backend.Fx.Environment.Authentication
 {
     public class CurrentIdentityHolder : CurrentTHolder<IIdentity>
     {
+        public CurrentIdentityHolder()
+        { }
+
+        private CurrentIdentityHolder(IIdentity initial) : base(initial)
+        { }
+        
         public override IIdentity ProvideInstance()
         {
             return new AnonymousIdentity();
@@ -28,9 +34,7 @@ public static ICurrentTHolder<IIdentity> CreateSystem()
 
         public static ICurrentTHolder<IIdentity> Create(IIdentity identity)
         {
-            var currentIdentityHolder = new CurrentIdentityHolder();
-            currentIdentityHolder.ReplaceCurrent(identity);
-            return currentIdentityHolder;
+            return new CurrentIdentityHolder(identity);
         }
     }
 }

src/abstractions/Backend.Fx/Environment/MultiTenancy/CurrentTenantIdHolder.cs

@@ -4,17 +4,21 @@ namespace Backend.Fx.Environment.MultiTenancy
 {
     public class CurrentTenantIdHolder : CurrentTHolder<TenantId>
     {
+        public CurrentTenantIdHolder()
+        { }
+
+        private CurrentTenantIdHolder(TenantId initial) : base(initial)
+        { }
+        
         public static CurrentTenantIdHolder Create(int tenantId)
         {
-            var instance = new CurrentTenantIdHolder();
-            instance.ReplaceCurrent(new TenantId(tenantId));
+            var instance = new CurrentTenantIdHolder((TenantId)tenantId);
             return instance;
         }
 
         public static CurrentTenantIdHolder Create(TenantId tenantId)
         {
-            var instance = new CurrentTenantIdHolder();
-            instance.ReplaceCurrent(tenantId);
+            var instance = new CurrentTenantIdHolder(tenantId);
             return instance;
         }
 

src/abstractions/Backend.Fx/Environment/MultiTenancy/ITenantIdProvider.cs

@@ -1,8 +1,10 @@
 namespace Backend.Fx.Environment.MultiTenancy
 {
     /// <summary>
-    /// By means of this instance, other services gain insight about all active tenants. This is useful, when for example a job
+    /// By means of this instance, the IBackendFxApplication gains insight about all active tenants. This is required, when for example a job
     /// should be executed for all tenants or data should be generated for all tenants during startup.
+    /// The <see cref="ITenantService"/> can provide such implementation, but this can only be done in process. When the tenant service is
+    /// running in another process, the implementation must be done using a suitable remoting technology.
     /// </summary>
     public interface ITenantIdProvider
     {

src/abstractions/Backend.Fx/Environment/MultiTenancy/SingleTenantApplication.cs

@@ -13,6 +13,7 @@ public class SingleTenantApplication : TenantApplication, IBackendFxApplication
         private readonly bool _isDemoTenant;
         private readonly ITenantService _tenantService;
         private readonly IBackendFxApplication _application;
+        private readonly ManualResetEventSlim _defaultTenantEnsured = new ManualResetEventSlim(false);
 
         public SingleTenantApplication(bool isDemoTenant, ITenantService tenantService, IBackendFxApplication application) : base(application)
         {
@@ -38,7 +39,7 @@ public void Dispose()
 
         public bool WaitForBoot(int timeoutMilliSeconds = int.MaxValue, CancellationToken cancellationToken = default)
         {
-            return _application.WaitForBoot(timeoutMilliSeconds, cancellationToken);
+            return _defaultTenantEnsured.Wait(timeoutMilliSeconds, cancellationToken);
         }
 
         public async Task Boot(CancellationToken cancellationToken = default)
@@ -50,6 +51,8 @@ public async Task Boot(CancellationToken cancellationToken = default)
             Logger.Info($"Ensuring existence of single tenant");
             TenantId = _tenantService.GetActiveTenants().SingleOrDefault()?.GetTenantId()
                        ?? _tenantService.CreateTenant("Single Tenant", "This application runs in single tenant mode", _isDemoTenant);
+
+            _defaultTenantEnsured.Set();
         }
     }
 }

src/abstractions/Backend.Fx/Environment/Persistence/DbConnectionOperationDecorator.cs

@@ -38,6 +38,12 @@ public void Complete()
         public void Cancel()
         {
             Operation.Cancel();
+            Logger.Debug("Closing database connection");
+            DbConnection.Close();
+            _connectionLifetimeLogger?.Dispose();
+            
+            // note: we do not dispose the DbConnection here, because we did not instantiate it. Disposing is always up to the creator of
+            // the instance, that is in this case the injection container.
         }
     }
 }

src/abstractions/Backend.Fx/Exceptions/ClientException.cs

@@ -12,11 +12,19 @@ public ClientException()
         {
         }
 
+        /// <param name="message">When using one of the middlewares in Backend.Fx.AspNetCore.ErrorHandling, the message is not sent
+        /// to the client to not provide internal details to an attacker. Write the exception message with a developer in mind, since
+        /// the application log will contain the message. To provide the user with functional feedback to correct their input, use
+        /// the AddError(s) overloads.</param>
         public ClientException(string message)
             : base(message)
         {
         }
 
+        /// <param name="message">When using one of the middlewares in Backend.Fx.AspNetCore.ErrorHandling, the message is not sent
+        /// to the client to not provide internal details to an attacker. Write the exception message with a developer in mind, since
+        /// the application log will contain the message. To provide the user with functional feedback to correct their input, use
+        /// the AddError(s) overloads.</param>
         public ClientException(string message, Exception innerException)
             : base(message, innerException)
         {
@@ -48,6 +56,16 @@ public override string ToString()
             return string.Join(System.Environment.NewLine,
                                new[] {message, Errors.ToString(), innerException, StackTrace}.Where(s => s != null));
         }
+        
+        /// <summary>
+        /// Used to build an <see cref="ClientException"/> with multiple possible error messages. The builder will throw on disposal
+        /// when at least one error was added. Using the AddIf methods is quite comfortable when there are several criteria to be validated
+        /// before executing a business case. 
+        /// </summary>
+        public static IExceptionBuilder UseBuilder()
+        {
+            return new ExceptionBuilder<ClientException>();
+        }
     }
 
     public static class ClientExceptionEx

src/abstractions/Backend.Fx/Exceptions/ConflictedException.cs

@@ -9,19 +9,16 @@ public ConflictedException()
         {
         }
 
+        /// <inheritdoc />
         public ConflictedException(string message)
             : base(message)
         {
         }
 
+        /// <inheritdoc />
         public ConflictedException(string message, Exception innerException)
             : base(message, innerException)
         {
         }
-
-        public static IExceptionBuilder UseBuilder()
-        {
-            return new ExceptionBuilder<ConflictedException>();
-        }
     }
 }

src/abstractions/Backend.Fx/Exceptions/ForbiddenException.cs

@@ -9,19 +9,16 @@ public ForbiddenException()
         {
         }
 
+        /// <inheritdoc />
         public ForbiddenException(string message)
             : base(message)
         {
         }
 
+        /// <inheritdoc />
         public ForbiddenException(string message, Exception innerException)
             : base(message, innerException)
         {
         }
-
-        public static IExceptionBuilder UseBuilder()
-        {
-            return new ExceptionBuilder<ForbiddenException>();
-        }
     }
 }