NLogLoggerProvider - Implement IAsyncDisposable (#825)

Author: snakefoot

appveyor.yml

@@ -5,6 +5,9 @@ skip_tags: true
 skip_branch_with_pr: true
 
 environment:
+  DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
+  DOTNET_CLI_TELEMETRY_OPTOUT: true
+  DOTNET_NOLOGO: true
   github_auth_token:
     secure: WYvd/k1xGCsDS+4iOhjzxA5/e36RjkxnuVOHpBR+eDtZNNjpYydCyNfd1COME9jI
   sonar_token:

src/NLog.Extensions.Logging/Logging/NLogLoggerFactory.cs

@@ -9,6 +9,9 @@ namespace NLog.Extensions.Logging
     /// Creating DI loggers for Microsoft.Extensions.Logging and NLog
     /// </summary>
     public class NLogLoggerFactory : ILoggerFactory
+#if NETSTANDARD2_1_OR_GREATER || NET
+        , IAsyncDisposable
+#endif
     {
         private readonly ConcurrentDictionary<string, Microsoft.Extensions.Logging.ILogger> _loggers = new ConcurrentDictionary<string, Microsoft.Extensions.Logging.ILogger>(StringComparer.Ordinal);
 
@@ -51,26 +54,6 @@ public NLogLoggerFactory(NLogLoggerProvider provider)
             _provider = provider;
         }
 
-        /// <summary>
-        /// Cleanup
-        /// </summary>
-        public void Dispose()
-        {
-            Dispose(true);
-            GC.SuppressFinalize(this);
-        }
-
-        /// <summary>
-        /// Cleanup
-        /// </summary>
-        protected virtual void Dispose(bool disposing)
-        {
-            if (disposing)
-            {
-                _provider.Dispose();
-            }
-        }
-
         /// <summary>
         /// Creates a new <see cref="Microsoft.Extensions.Logging.ILogger" /> instance.
         /// </summary>
@@ -100,5 +83,37 @@ public void AddProvider(ILoggerProvider provider)
         {
             InternalLogger.Debug("NLogLoggerFactory: AddProvider has been ignored {0}", provider?.GetType());
         }
+
+        /// <summary>
+        /// Cleanup
+        /// </summary>
+        public void Dispose()
+        {
+            Dispose(true);
+            GC.SuppressFinalize(this);
+        }
+
+        /// <summary>
+        /// Cleanup
+        /// </summary>
+        /// <param name="disposing"></param>
+        protected virtual void Dispose(bool disposing)
+        {
+            if (disposing)
+            {
+                _provider.Dispose();
+            }
+        }
+
+#if NETSTANDARD2_1_OR_GREATER || NET
+        /// <summary>
+        /// Cleanup
+        /// </summary>
+        async System.Threading.Tasks.ValueTask IAsyncDisposable.DisposeAsync()
+        {
+            await _provider.DisposeAsync();
+            GC.SuppressFinalize(this);
+        }
+#endif
     }
-}
+}

src/NLog.Extensions.Logging/Logging/NLogLoggerProvider.cs

@@ -8,6 +8,9 @@ namespace NLog.Extensions.Logging
     /// </summary>
     [ProviderAlias("NLog")]
     public class NLogLoggerProvider : ILoggerProvider
+#if NETSTANDARD2_1_OR_GREATER || NET
+        , IAsyncDisposable
+#endif
     {
         private readonly NLogBeginScopeParser _beginScopeParser;
 
@@ -87,6 +90,24 @@ protected virtual void Dispose(bool disposing)
                 }
             }
         }
+
+#if NETSTANDARD2_1_OR_GREATER || NET
+        /// <summary>
+        /// Cleanup
+        /// </summary>
+        public async System.Threading.Tasks.ValueTask DisposeAsync()
+        {
+            if (Options.ShutdownOnDispose)
+            {
+                await LogFactory.DisposeAsync().ConfigureAwait(false);
+            }
+            else
+            {
+                await LogFactory.FlushAsync(System.Threading.CancellationToken.None).ConfigureAwait(false);
+            }
+            GC.SuppressFinalize(this);
+        }
+#endif
     }
 }
 

test/NLog.Extensions.Hosting.Tests/ExtensionMethodTests.cs

@@ -68,17 +68,18 @@ public void UseNLog_withConfiguration_WorksWithNLog()
         [Fact]
         public void AddNLog_withShutdownOnDispose_worksWithNLog()
         {
+            var logFactory = new LogFactory();  // Isolated to avoid disposing global LogManager
             var someParam = new NLogProviderOptions { ShutdownOnDispose = true };
-            var actual = new HostBuilder().ConfigureLogging(l => l.AddNLog(someParam)).Build();
+            var actual = new HostBuilder().ConfigureLogging(l => l.AddNLog(someParam, svc => logFactory)).Build();
             try
             {
-                TestHostingResult(actual, false);
-                Assert.NotNull(LogManager.Configuration);
+                TestHostingResult(actual, false, logFactory);
+                Assert.NotNull(logFactory.Configuration);
             }
             finally
             {
                 actual.Dispose();
-                Assert.Null(LogManager.Configuration);
+                Assert.Null(logFactory.Configuration);
             }
         }
 
@@ -89,12 +90,14 @@ public void UseNLog_withAddNLog_worksWithNLog()
             TestHostingResult(actual, true);
         }
 
-        private static void TestHostingResult(IHost host, bool resetConfiguration)
+        private static void TestHostingResult(IHost host, bool resetConfiguration, LogFactory logFactory = null)
         {
+            logFactory ??= LogManager.LogFactory;
+
             try
             {
                 var nlogTarget = new Targets.MemoryTarget() { Name = "Output" };
-                NLog.LogManager.Setup().LoadConfiguration(c => c.ForLogger().WriteTo(nlogTarget));
+                logFactory.Setup().LoadConfiguration(c => c.ForLogger().WriteTo(nlogTarget));
 
                 var loggerFactory = host.Services.GetService<ILoggerFactory>();
                 Assert.NotNull(loggerFactory);
@@ -106,7 +109,7 @@ private static void TestHostingResult(IHost host, bool resetConfiguration)
             finally
             {
                 if (resetConfiguration)
-                    LogManager.Configuration = null;
+                    logFactory.Configuration = null;
             }
         }
 
@@ -202,21 +205,22 @@ public void IHostApplicationBuilder_UseNLog_withConfiguration_WorksWithNLog()
         [Fact]
         public void IHostApplicationBuilder_AddNLog_withShutdownOnDispose_worksWithNLog()
         {
+            var logFactory = new LogFactory();  // Isolated to avoid disposing global LogManager
             var someParam = new NLogProviderOptions { ShutdownOnDispose = true };
 
             var builder = new HostApplicationBuilder();
-            builder.Logging.AddNLog(someParam);
+            builder.Logging.AddNLog(someParam, svc => logFactory);
 
             var actual = builder.Build();
             try
             {
-                TestHostingResult(actual, false);
-                Assert.NotNull(LogManager.Configuration);
+                TestHostingResult(actual, false, logFactory);
+                Assert.NotNull(logFactory.Configuration);
             }
             finally
             {
                 actual.Dispose();
-                Assert.Null(LogManager.Configuration);
+                Assert.Null(logFactory.Configuration);
             }
         }
 
@@ -299,4 +303,4 @@ public void IHostApplicationBuilder_UseNLog_ShouldLogToNLog()
         }
 #endif
     }
-}
+}