Adding logging

soxtoby · Oct 24, 2021 · dc17fb2 · dc17fb2
1 parent 23fcedf
commit dc17fb2
Show file tree

Hide file tree

Showing 67 changed files with 3,005 additions and 167 deletions.
diff --git a/SlackNet.AspNetCore/AspNetCoreExtensions.cs b/SlackNet.AspNetCore/AspNetCoreExtensions.cs
@@ -14,7 +14,11 @@ public static IServiceCollection AddSlackNet(this IServiceCollection serviceColl
             serviceCollection.TryAddSingleton<ISlackRequestHandler, SlackRequestHandler>();
             serviceCollection.TryAddSingleton<IHttpContextAccessor, HttpContextAccessor>();
             serviceCollection.TryAddSingleton<IServiceProviderSlackRequestListener, AspNetCoreServiceProviderSlackRequestListener>();
-            return ServiceCollectionExtensions.AddSlackNet(serviceCollection, configure);
+            return ServiceCollectionExtensions.AddSlackNet(serviceCollection, c =>
+                {
+                    c.UseLogger<MicrosoftLoggerAdaptor>();
+                    configure?.Invoke(c);
+                });
         }
 
         /// <summary>

diff --git a/SlackNet.AspNetCore/MicrosoftLoggerAdaptor.cs b/SlackNet.AspNetCore/MicrosoftLoggerAdaptor.cs
@@ -0,0 +1,24 @@
+using Microsoft.Extensions.Logging;
+using SlackNetLogger = SlackNet.ILogger;
+using MicrosoftLogger = Microsoft.Extensions.Logging.ILogger;
+
+namespace SlackNet.AspNetCore
+{
+    class MicrosoftLoggerAdaptor : SlackNetLogger
+    {
+        private readonly MicrosoftLogger _logger;
+        public MicrosoftLoggerAdaptor(ILoggerFactory loggerFactory) => _logger = loggerFactory.CreateLogger("SlackNet");
+
+        public void Log(ILogEvent logEvent) =>
+            _logger.Log(logEvent.Category switch
+                    {
+                        LogCategory.Data => LogLevel.Trace,
+                        LogCategory.Internal => LogLevel.Debug,
+                        LogCategory.Request => LogLevel.Information,
+                        LogCategory.Error => LogLevel.Error,
+                        _ => LogLevel.Trace
+                    },
+                logEvent.FullMessageTemplate(),
+                logEvent.FullMessagePropertyValues());
+    }
+}
diff --git a/SlackNet.AspNetCore/SlackNet.AspNetCore.csproj b/SlackNet.AspNetCore/SlackNet.AspNetCore.csproj
@@ -32,6 +32,7 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
     <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="2.2.0" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="2.2.0" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/SlackNet.AspNetCore/SlackRequestHandler.cs b/SlackNet.AspNetCore/SlackRequestHandler.cs
diff --git a/SlackNet.Autofac/AutofacSlackServiceConfiguration.cs b/SlackNet.Autofac/AutofacSlackServiceConfiguration.cs
@@ -21,6 +21,7 @@ internal static void Configure(ContainerBuilder containerBuilder, Action<Autofac
             containerBuilder.Register(c => c.Resolve<ISlackServiceProvider>().GetJsonSettings()).As<SlackJsonSettings>().SingleInstance();
             containerBuilder.Register(c => c.Resolve<ISlackServiceProvider>().GetTypeResolver()).As<ISlackTypeResolver>().SingleInstance();
             containerBuilder.Register(c => c.Resolve<ISlackServiceProvider>().GetUrlBuilder()).As<ISlackUrlBuilder>().SingleInstance();
+            containerBuilder.Register(c => c.Resolve<ISlackServiceProvider>().GetLogger()).As<ILogger>().SingleInstance();
             containerBuilder.Register(c => c.Resolve<ISlackServiceProvider>().GetWebSocketFactory()).As<IWebSocketFactory>().SingleInstance();
             containerBuilder.Register(c => c.Resolve<ISlackServiceProvider>().GetRequestListeners()).As<IEnumerable<ISlackRequestListener>>().SingleInstance();
             containerBuilder.Register(c => c.Resolve<ISlackServiceProvider>().GetHandlerFactory()).As<ISlackHandlerFactory>().SingleInstance();

diff --git a/SlackNet.Autofac/AutofacSlackServiceProvider.cs b/SlackNet.Autofac/AutofacSlackServiceProvider.cs
@@ -32,6 +32,7 @@ public T Resolve<T>(Func<IComponentContext, T> getService)
         public SlackJsonSettings GetJsonSettings() => _baseProvider.GetJsonSettings();
         public ISlackTypeResolver GetTypeResolver() => _baseProvider.GetTypeResolver();
         public ISlackUrlBuilder GetUrlBuilder() => _baseProvider.GetUrlBuilder();
+        public ILogger GetLogger() => _baseProvider.GetLogger();
         public IWebSocketFactory GetWebSocketFactory() => _baseProvider.GetWebSocketFactory();
         public IEnumerable<ISlackRequestListener> GetRequestListeners() => _baseProvider.GetRequestListeners();
         public ISlackHandlerFactory GetHandlerFactory() => _baseProvider.GetHandlerFactory();

diff --git a/SlackNet.EventsExample/Startup.cs b/SlackNet.EventsExample/Startup.cs
@@ -49,7 +49,10 @@ public void ConfigureServices(IServiceCollection services)
                 .RegisterViewSubmissionHandler<WorkflowExample>(WorkflowExample.ConfigCallback)
                 .RegisterEventHandler<WorkflowStepExecute, WorkflowExample>()
             );
+
             services.AddMvc();
+
+            services.AddLogging();
         }
 
         // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.

diff --git a/SlackNet.EventsExample/appsettings.Development.json b/SlackNet.EventsExample/appsettings.Development.json
@@ -4,7 +4,8 @@
     "LogLevel": {
       "Default": "Debug",
       "System": "Information",
-      "Microsoft": "Information"
+      "Microsoft": "Information",
+      "SlackNet": "Information"
     }
   }
 }
diff --git a/SlackNet.Extensions.DependencyInjection/ServiceCollectionSlackServiceConfiguration.cs b/SlackNet.Extensions.DependencyInjection/ServiceCollectionSlackServiceConfiguration.cs
@@ -30,6 +30,7 @@ internal static void Configure(IServiceCollection serviceCollection, Action<Serv
             serviceCollection.TryAddSingleton<SlackJsonSettings>(sp => sp.GetRequiredService<ISlackServiceProvider>().GetJsonSettings());
             serviceCollection.TryAddSingleton<ISlackTypeResolver>(sp => sp.GetRequiredService<ISlackServiceProvider>().GetTypeResolver());
             serviceCollection.TryAddSingleton<ISlackUrlBuilder>(sp => sp.GetRequiredService<ISlackServiceProvider>().GetUrlBuilder());
+            serviceCollection.TryAddSingleton<ILogger>(sp => sp.GetRequiredService<ISlackServiceProvider>().GetLogger());
             serviceCollection.TryAddSingleton<IWebSocketFactory>(sp => sp.GetRequiredService<ISlackServiceProvider>().GetWebSocketFactory());
             serviceCollection.TryAddSingleton<IEnumerable<ISlackRequestListener>>(sp => sp.GetRequiredService<ISlackServiceProvider>().GetRequestListeners());
             serviceCollection.TryAddSingleton<ISlackHandlerFactory>(sp => sp.GetRequiredService<ISlackServiceProvider>().GetHandlerFactory());

diff --git a/SlackNet.Extensions.DependencyInjection/ServiceProviderSlackServiceProvider.cs b/SlackNet.Extensions.DependencyInjection/ServiceProviderSlackServiceProvider.cs
@@ -22,6 +22,7 @@ public ServiceProviderSlackServiceProvider(Func<ISlackServiceProvider, ISlackSer
         public SlackJsonSettings GetJsonSettings() => _baseProvider.GetJsonSettings();
         public ISlackTypeResolver GetTypeResolver() => _baseProvider.GetTypeResolver();
         public ISlackUrlBuilder GetUrlBuilder() => _baseProvider.GetUrlBuilder();
+        public ILogger GetLogger() => _baseProvider.GetLogger();
         public IWebSocketFactory GetWebSocketFactory() => _baseProvider.GetWebSocketFactory();
         public IEnumerable<ISlackRequestListener> GetRequestListeners() => _baseProvider.GetRequestListeners();
         public ISlackHandlerFactory GetHandlerFactory() => _baseProvider.GetHandlerFactory();

diff --git a/SlackNet.SimpleInjector/SimpleInjectorSlackServiceConfiguration.cs b/SlackNet.SimpleInjector/SimpleInjectorSlackServiceConfiguration.cs
@@ -23,6 +23,7 @@ internal static void Configure(Container container, Action<SimpleInjectorSlackSe
             RegisterFallback<SlackJsonSettings>(container, () => container.GetInstance<ISlackServiceProvider>().GetJsonSettings(), Lifestyle.Singleton);
             RegisterFallback<ISlackTypeResolver>(container, () => container.GetInstance<ISlackServiceProvider>().GetTypeResolver(), Lifestyle.Singleton);
             RegisterFallback<ISlackUrlBuilder>(container, () => container.GetInstance<ISlackServiceProvider>().GetUrlBuilder(), Lifestyle.Singleton);
+            RegisterFallback<ILogger>(container, () => container.GetInstance<ISlackServiceProvider>().GetLogger(), Lifestyle.Singleton);
             RegisterFallback<IWebSocketFactory>(container, () => container.GetInstance<ISlackServiceProvider>().GetWebSocketFactory(), Lifestyle.Singleton);
             RegisterFallback<IEnumerable<ISlackRequestListener>>(container, () => container.GetInstance<ISlackServiceProvider>().GetRequestListeners(), Lifestyle.Singleton);
             RegisterFallback<ISlackHandlerFactory>(container, () => container.GetInstance<ISlackServiceProvider>().GetHandlerFactory(), Lifestyle.Singleton);

diff --git a/SlackNet.SimpleInjector/SimpleInjectorSlackServiceProvider.cs b/SlackNet.SimpleInjector/SimpleInjectorSlackServiceProvider.cs
@@ -22,6 +22,7 @@ public SimpleInjectorSlackServiceProvider(Func<ISlackServiceProvider, ISlackServ
         public SlackJsonSettings GetJsonSettings() => _baseProvider.GetJsonSettings();
         public ISlackTypeResolver GetTypeResolver() => _baseProvider.GetTypeResolver();
         public ISlackUrlBuilder GetUrlBuilder() => _baseProvider.GetUrlBuilder();
+        public ILogger GetLogger() => _baseProvider.GetLogger();
         public IWebSocketFactory GetWebSocketFactory() => _baseProvider.GetWebSocketFactory();
         public IEnumerable<ISlackRequestListener> GetRequestListeners() => _baseProvider.GetRequestListeners();
         public ISlackHandlerFactory GetHandlerFactory() => _baseProvider.GetHandlerFactory();

diff --git a/SlackNet.Tests/Configuration/FactorySlackHandlerConfigurationTests.cs b/SlackNet.Tests/Configuration/FactorySlackHandlerConfigurationTests.cs
@@ -70,6 +70,14 @@ public void UseUrlBuilderType()
                 s => s.GetUrlBuilder());
         }
 
+        [Test]
+        public void UseLoggerType()
+        {
+            UseService<ILogger, TestLogger>(
+                c => c.UseLogger<TestLogger>(),
+                s => s.GetLogger());
+        }
+
         [Test]
         public void UseWebSocketFactoryType()
         {
@@ -932,6 +940,11 @@ protected class TestUrlBuilder : ISlackUrlBuilder
             public string Url(string apiMethod, Dictionary<string, object> args) => throw new NotImplementedException();
         }
 
+        protected class TestLogger : ILogger
+        {
+            public void Log(ILogEvent logEvent) => throw new NotImplementedException();
+        }
+
         protected class TestWebSocketFactory : IWebSocketFactory
         {
             public IWebSocket Create(string uri) => throw new NotImplementedException();

diff --git a/SlackNet.Tests/Configuration/FactorySlackHandlerConfigurationWithDependencyResolverTests.cs b/SlackNet.Tests/Configuration/FactorySlackHandlerConfigurationWithDependencyResolverTests.cs
@@ -45,6 +45,14 @@ public void UseUrlBuilderFactory()
                 s => s.GetUrlBuilder());
         }
 
+        [Test]
+        public void UseLoggerFactory()
+        {
+            UseService<ILogger, TestLogger>(
+                c => c.UseLogger(r => new TestLogger()),
+                s => s.GetLogger());
+        }
+
         [Test]
         public void UseWebSocketFactoryFactory()
         {

diff --git a/...ests/Configuration/FactorySlackHandlerConfigurationWithExternalDependencyResolverTests.cs b/...ests/Configuration/FactorySlackHandlerConfigurationWithExternalDependencyResolverTests.cs
@@ -42,6 +42,14 @@ public void UseUrlBuilderFactory()
                 s => s.GetUrlBuilder());
         }
 
+        [Test]
+        public void UseLoggerFactory()
+        {
+            UseService<ILogger, TestLogger>(
+                c => c.UseLogger(() => new TestLogger()),
+                s => s.GetLogger());
+        }
+
         [Test]
         public void UseWebSocketFactoryFactory()
         {

diff --git a/SlackNet.Tests/Configuration/SlackServiceConfigurationBaseTests.cs b/SlackNet.Tests/Configuration/SlackServiceConfigurationBaseTests.cs
@@ -2,7 +2,6 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
-using System.Threading.Tasks;
 using EasyAssertions;
 using Newtonsoft.Json;
 using NSubstitute;
@@ -66,6 +65,15 @@ public void UseUrlBuilder()
                 s => s.GetUrlBuilder());
         }
 
+        [Test]
+        public void UseLogger()
+        {
+            UseService(
+                Substitute.For<ILogger>(),
+                (c, sp) => c.UseLogger(sp),
+                s => s.GetLogger());
+        }
+
         [Test]
         public void UseWebSocketFactory()
         {