Make ISentryUserFactory public (#2719)

getsentry · Oct 12, 2023 · a8b8184 · a8b8184
1 parent d8f293e
commit a8b8184
Show file tree

Hide file tree

Showing 6 changed files with 31 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Changelog
 
+## Unreleased
+
+### Fixes
+
+- ISentryUserFactory is now public so users can register their own implementations via DI ([#2719](https://github.com/getsentry/sentry-dotnet/pull/2719))
+
 ## 3.40.0
 
 ### Obsoletion
@@ -12,6 +18,7 @@
 - Release of Azure Functions (Isolated Worker/Out-of-Process) support ([#2686](https://github.com/getsentry/sentry-dotnet/pull/2686))
 
 ### Fixes
+
 - Scope is now correctly applied to Transactions when using OpenTelemetry on ASP.NET Core ([#2690](https://github.com/getsentry/sentry-dotnet/pull/2690))
 
 ### Dependencies

diff --git a/src/Sentry/ISentryUserFactory.cs b/src/Sentry/ISentryUserFactory.cs
@@ -1,6 +1,13 @@
 namespace Sentry;
 
-internal interface ISentryUserFactory
+/// <summary>
+/// Sentry User Factory
+/// </summary>
+public interface ISentryUserFactory
 {
+    /// <summary>
+    /// Creates a Sentry <see cref="User"/> representing the current principal.
+    /// </summary>
+    /// <returns>The protocol user</returns>
     public User? Create();
 }
diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.Core3_1.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.Core3_1.verified.txt
@@ -279,6 +279,10 @@ namespace Sentry
     {
         void Apply(Sentry.Scope scope, object state);
     }
+    public interface ISentryUserFactory
+    {
+        Sentry.User? Create();
+    }
     public interface ISession
     {
         string? DistinctId { get; }

diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet6_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet6_0.verified.txt
@@ -279,6 +279,10 @@ namespace Sentry
     {
         void Apply(Sentry.Scope scope, object state);
     }
+    public interface ISentryUserFactory
+    {
+        Sentry.User? Create();
+    }
     public interface ISession
     {
         string? DistinctId { get; }

diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet7_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet7_0.verified.txt
@@ -279,6 +279,10 @@ namespace Sentry
     {
         void Apply(Sentry.Scope scope, object state);
     }
+    public interface ISentryUserFactory
+    {
+        Sentry.User? Create();
+    }
     public interface ISession
     {
         string? DistinctId { get; }

diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.Net4_8.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.Net4_8.verified.txt
@@ -278,6 +278,10 @@ namespace Sentry
     {
         void Apply(Sentry.Scope scope, object state);
     }
+    public interface ISentryUserFactory
+    {
+        Sentry.User? Create();
+    }
     public interface ISession
     {
         string? DistinctId { get; }