Remove OptionalHub (replace with a static method) (#534)

Author: Tyrrrz

src/Sentry.Extensions.Logging/Extensions/DependencyInjection/ServiceCollectionExtensions.cs

@@ -25,8 +25,6 @@ public static IServiceCollection AddSentry<TOptions>(this IServiceCollection ser
             services.TryAddSingleton<SentryOptions>(
                 c => c.GetRequiredService<IOptions<TOptions>>().Value);
 
-            services.TryAddSingleton<OptionalHub>();
-
             services.TryAddTransient<ISentryClient>(c => c.GetRequiredService<IHub>());
             services.TryAddTransient(c => c.GetRequiredService<Func<IHub>>()());
 
@@ -36,7 +34,7 @@ public static IServiceCollection AddSentry<TOptions>(this IServiceCollection ser
 
                 if (options.InitializeSdk)
                 {
-                    var hub = c.GetRequiredService<OptionalHub>();
+                    var hub = OptionalHub.FromOptions(options);
                     _ = SentrySdk.UseHub(hub);
                 }
 

src/Sentry.Extensions.Logging/SentryLoggerFactoryExtensions.cs

@@ -51,7 +51,7 @@ public static ILoggerFactory AddSentry(
                 else
                 {
                     options.DiagnosticLogger?.LogDebug("Initializing from {0} and swapping current Hub.", nameof(SentryLoggerFactoryExtensions));
-                    hub = new OptionalHub(options);
+                    hub = OptionalHub.FromOptions(options);
                     _ = SentrySdk.UseHub(hub);
                 }
             }

src/Sentry/Internal/OptionalHub.cs

@@ -1,49 +1,17 @@
-using System;
-using System.Threading.Tasks;
 using Sentry.Extensibility;
-using Sentry.Protocol;
 
 namespace Sentry.Internal
 {
     // Depending on Options:
     // - A proxy to a new Hub instance
     // or
     // - A proxy to SentrySdk which could hold a Hub if SentrySdk.Init was called, or a disabled Hub
-    internal class OptionalHub : IHub, IDisposable
+    internal static class OptionalHub
     {
-        private readonly IHub _hub;
-
-        public bool IsEnabled => _hub.IsEnabled;
-
-        public OptionalHub(SentryOptions options)
+        public static IHub FromOptions(SentryOptions options)
         {
             options.SetupLogging();
-            _hub = GetHub(options);
-        }
-
-        public SentryId CaptureEvent(SentryEvent evt, Scope? scope = null) => _hub.CaptureEvent(evt, scope);
-
-        public Task FlushAsync(TimeSpan timeout) => _hub.FlushAsync(timeout);
-
-        public void ConfigureScope(Action<Scope> configureScope) => _hub.ConfigureScope(configureScope);
-
-        public Task ConfigureScopeAsync(Func<Scope, Task> configureScope) => _hub.ConfigureScopeAsync(configureScope);
 
-        public void BindClient(ISentryClient client) => _hub.BindClient(client);
-
-        public IDisposable PushScope() => _hub.PushScope();
-
-        public IDisposable PushScope<TState>(TState state)
-            => _hub.PushScope(state);
-
-        public void WithScope(Action<Scope> scopeCallback) => _hub.WithScope(scopeCallback);
-
-        public SentryId LastEventId => _hub.LastEventId;
-
-        public void Dispose() => (_hub as IDisposable)?.Dispose();
-
-        private static IHub GetHub(SentryOptions options)
-        {
             var dsn = options.Dsn ?? DsnLocator.FindDsnStringOrDisable();
 
             if (Dsn.IsDisabled(dsn))

test/Sentry.Extensions.Logging.Tests/SentryLoggerFactoryExtensionsTests.cs

@@ -63,17 +63,6 @@ public void AddSentry_InitializeSdkFalse_HubAdapter()
                 .AddProvider(Arg.Is<SentryLoggerProvider>(p => p.Hub == HubAdapter.Instance));
         }
 
-        [Fact]
-        public void AddSentry_DefaultOptions_InstantiateOptionalHub()
-        {
-            var sut = Substitute.For<ILoggerFactory>();
-
-            _ = sut.AddSentry();
-
-            sut.Received(1)
-                .AddProvider(Arg.Is<SentryLoggerProvider>(p => p.Hub is OptionalHub));
-        }
-
         [Fact]
         public void AddSentry_NoDiagnosticSet_MelSet()
         {

test/Sentry.Tests/Internals/OptionalHubTests.cs

@@ -9,16 +9,16 @@ public class OptionalHubTests
     {
         // Issue: https://github.com/getsentry/sentry-dotnet/issues/123
         [Fact]
-        public void Ctor_NoDsn_DisposeDoesNotThrow()
+        public void FromOptions_NoDsn_DisposeDoesNotThrow()
         {
-            var sut = new OptionalHub(new SentryOptions());
-            sut.Dispose();
+            var sut = OptionalHub.FromOptions(new SentryOptions()) as IDisposable;
+            sut?.Dispose();
         }
 
         [Fact]
-        public Task Ctor_NoDsn_FlushAsyncDoesNotThrow()
+        public Task FromOptions_NoDsn_FlushAsyncDoesNotThrow()
         {
-            var sut = new OptionalHub(new SentryOptions());
+            var sut = OptionalHub.FromOptions(new SentryOptions());
             return sut.FlushAsync(TimeSpan.FromDays(1));
         }
     }