Remove Library Signing from Sentry.Hangfire (#4099)

---------

Co-authored-by: James Crosswell <[email protected]>

Author: aritchie

CHANGELOG.md

@@ -5,6 +5,7 @@
 ### Fixes
 
 - Redact Authorization headers before sending events to Sentry ([#4164](https://github.com/getsentry/sentry-dotnet/pull/4164))
+- Remove Strong Naming from Sentry.Hangfire ([#4099](https://github.com/getsentry/sentry-dotnet/pull/4099))
 
 ### Features
 

src/Sentry.Hangfire/Sentry.Hangfire.csproj

@@ -5,6 +5,7 @@
     <PackageTags>$(PackageTags);Hangfire</PackageTags>
     <TargetFrameworks>net9.0;net8.0;net462</TargetFrameworks>
     <ImplicitUsings>enable</ImplicitUsings>
+    <SignAssembly>false</SignAssembly>
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(EnableAot)' == 'true'">

src/Sentry.Hangfire/SentryServerFilter.cs

@@ -17,7 +17,9 @@ public SentryServerFilter() : this(null, null)
     internal SentryServerFilter(IHub? hub, IDiagnosticLogger? logger)
     {
         _hub = hub ?? HubAdapter.Instance;
-        _logger = logger ?? _hub.GetSentryOptions()?.DiagnosticLogger;
+#pragma warning disable CS0618 // Type or member is obsolete
+        _logger = logger ?? _hub.GetInternalSentryOptions()?.DiagnosticLogger;
+#pragma warning restore CS0618 // Type or member is obsolete
     }
 
     public void OnPerforming(PerformingContext context)

src/Sentry/Sentry.csproj

@@ -173,7 +173,6 @@
     <InternalsVisibleTo Include="Sentry.GraphQL.Client.Tests" PublicKey="$(SentryPublicKey)" />
     <InternalsVisibleTo Include="Sentry.Google.Cloud.Functions" PublicKey="$(SentryPublicKey)" />
     <InternalsVisibleTo Include="Sentry.Google.Cloud.Functions.Tests" PublicKey="$(SentryPublicKey)" />
-    <InternalsVisibleTo Include="Sentry.Hangfire" PublicKey="$(SentryPublicKey)" />
     <InternalsVisibleTo Include="Sentry.Hangfire.Tests" PublicKey="$(SentryPublicKey)" />
     <InternalsVisibleTo Include="Sentry.Log4Net" PublicKey="$(SentryPublicKey)" />
     <InternalsVisibleTo Include="Sentry.Log4Net.Tests" PublicKey="$(SentryPublicKey)" />

src/Sentry/SentryClientExtensions.cs

@@ -114,4 +114,18 @@ public static Task FlushAsync(this ISentryClient client)
             HubAdapter => SentrySdk.CurrentOptions,
             _ => SentryOptionsForTestingOnly
         };
+
+    /// <summary>
+    /// <para>
+    /// Gets internal SentryOptions for integrations like Hangfire that don't support strong assembly names.
+    /// </para>
+    ///<remarks>
+    /// *** This is not meant for external use !!! ***
+    /// </remarks>>
+    /// </summary>
+    /// <param name="clientOrHub"></param>
+    /// <returns></returns>
+    [Obsolete("This method is meant for external usage only")]
+    public static SentryOptions? GetInternalSentryOptions(this ISentryClient clientOrHub) =>
+        clientOrHub.GetSentryOptions();
 }

test/Sentry.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt

@@ -484,6 +484,8 @@ namespace Sentry
         public static void Flush(this Sentry.ISentryClient client) { }
         public static void Flush(this Sentry.ISentryClient client, System.TimeSpan timeout) { }
         public static System.Threading.Tasks.Task FlushAsync(this Sentry.ISentryClient client) { }
+        [System.Obsolete("This method is meant for external usage only")]
+        public static Sentry.SentryOptions? GetInternalSentryOptions(this Sentry.ISentryClient clientOrHub) { }
     }
     public static class SentryConstants
     {

test/Sentry.Tests/ApiApprovalTests.Run.DotNet9_0.verified.txt

@@ -484,6 +484,8 @@ namespace Sentry
         public static void Flush(this Sentry.ISentryClient client) { }
         public static void Flush(this Sentry.ISentryClient client, System.TimeSpan timeout) { }
         public static System.Threading.Tasks.Task FlushAsync(this Sentry.ISentryClient client) { }
+        [System.Obsolete("This method is meant for external usage only")]
+        public static Sentry.SentryOptions? GetInternalSentryOptions(this Sentry.ISentryClient clientOrHub) { }
     }
     public static class SentryConstants
     {

test/Sentry.Tests/ApiApprovalTests.Run.Net4_8.verified.txt

@@ -472,6 +472,8 @@ namespace Sentry
         public static void Flush(this Sentry.ISentryClient client) { }
         public static void Flush(this Sentry.ISentryClient client, System.TimeSpan timeout) { }
         public static System.Threading.Tasks.Task FlushAsync(this Sentry.ISentryClient client) { }
+        [System.Obsolete("This method is meant for external usage only")]
+        public static Sentry.SentryOptions? GetInternalSentryOptions(this Sentry.ISentryClient clientOrHub) { }
     }
     public static class SentryConstants
     {

test/Sentry.Tests/SentrySdkTests.cs

@@ -676,14 +676,18 @@ public void Implements_Client()
     [Fact]
     public void Implements_ClientExtensions()
     {
-        var clientExtensions = typeof(SentryClientExtensions).GetMembers(BindingFlags.Public | BindingFlags.Static)
+        string[] excludedMembers = [nameof(SentryClientExtensions.GetSentryOptions), nameof(SentryClientExtensions.GetInternalSentryOptions)];
+        var clientExtensions = typeof(SentryClientExtensions)
+            .GetMembers(BindingFlags.Public | BindingFlags.Static)
+            .Where(x => !excludedMembers.Contains(x.Name))
             // Remove the extension argument: Method(this ISentryClient client, ...
             .Select(m => m.ToString()!
                 .Replace($"({typeof(ISentryClient).FullName}", "(")
                 .Replace("(, ", "("));
-        var sentrySdk = typeof(SentrySdk).GetMembers(BindingFlags.Public | BindingFlags.Static);
 
-        Assert.Empty(clientExtensions.Except(sentrySdk.Select(m => m.ToString())));
+        var sentrySdk = typeof(SentrySdk).GetMembers(BindingFlags.Public | BindingFlags.Static);
+        var values = clientExtensions.Except(sentrySdk.Select(m => m.ToString()));
+        Assert.Empty(values);
     }
 
     [Fact]