Make ITransport and SentryOptions.Transport public (#1602)

getsentry · Apr 26, 2022 · 6a2f44c · 6a2f44c
1 parent 02d7560
commit 6a2f44c
Show file tree

Hide file tree

Showing 14 changed files with 59 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Expose `ITransport` and `SentryOptions.Transport` public, to support using custom transports ([#1602](https://github.com/getsentry/sentry-dotnet/pull/1602))
+
 ### Fixes
 
 - Workaround `System.Text.Json` issue with Unity IL2CPP. ([#1583](https://github.com/getsentry/sentry-dotnet/pull/1583))

diff --git a/src/Sentry/Extensibility/ITransport.cs b/src/Sentry/Extensibility/ITransport.cs
@@ -7,7 +7,7 @@ namespace Sentry.Extensibility
     /// <summary>
     /// An abstraction to the transport of the event.
     /// </summary>
-    internal interface ITransport
+    public interface ITransport
     {
         /// <summary>
         /// Sends the <see cref="Envelope" /> to Sentry asynchronously.
@@ -16,9 +16,4 @@ internal interface ITransport
         /// <param name="cancellationToken">The cancellation token.</param>
         Task SendEnvelopeAsync(Envelope envelope, CancellationToken cancellationToken = default);
     }
-
-    internal interface IFlushableTransport : ITransport
-    {
-        Task FlushAsync(CancellationToken cancellationToken = default);
-    }
 }
diff --git a/src/Sentry/Internal/Http/CachingTransport.cs b/src/Sentry/Internal/Http/CachingTransport.cs
@@ -11,7 +11,7 @@
 
 namespace Sentry.Internal.Http
 {
-    internal class CachingTransport : IFlushableTransport, IAsyncDisposable, IDisposable
+    internal class CachingTransport : ITransport, IAsyncDisposable, IDisposable
     {
         private const string EnvelopeFileExt = "envelope";
 

diff --git a/src/Sentry/Internal/SdkComposer.cs b/src/Sentry/Internal/SdkComposer.cs
@@ -52,7 +52,7 @@ private HttpTransport CreateHttpTransport()
             return new HttpTransport(_options, httpClient);
         }
 
-        internal void BlockCacheFlush(IFlushableTransport transport)
+        internal void BlockCacheFlush(CachingTransport transport)
         {
             // If configured, flush existing cache
             if (_options.InitCacheFlushTimeout > TimeSpan.Zero)

diff --git a/src/Sentry/SentryOptions.cs b/src/Sentry/SentryOptions.cs
@@ -8,6 +8,7 @@
 using Sentry.Http;
 using Sentry.Integrations;
 using Sentry.Internal;
+using Sentry.Internal.Http;
 using Sentry.Internal.ScopeStack;
 using static Sentry.Constants;
 using static Sentry.Internal.Constants;
@@ -49,9 +50,13 @@ public bool IsGlobalModeEnabled
 
         /// <summary>
         /// This holds a reference to the current transport, when one is active.
-        /// If set manually (for tests), it will be used instead of the default transport.
+        /// If set manually before initialization, the provided transport will be used instead of the default transport.
         /// </summary>
-        internal ITransport? Transport { get; set; }
+        /// <remarks>
+        /// If <seealso cref="CacheDirectoryPath"/> is set, any transport set here will be wrapped in a
+        /// <seealso cref="CachingTransport"/> and used as its inner transport.
+        /// </remarks>
+        public ITransport? Transport { get; set; }
 
         internal ISentryStackTraceFactory? SentryStackTraceFactory { get; set; }
 

diff --git a/test/Sentry.DiagnosticSource.Tests/ApiApprovalTests.Run.Core3_1.verified.txt b/test/Sentry.DiagnosticSource.Tests/ApiApprovalTests.Run.Core3_1.verified.txt
@@ -498,6 +498,7 @@ namespace Sentry
         public Sentry.StackTraceMode StackTraceMode { get; set; }
         public double TracesSampleRate { get; set; }
         public System.Func<Sentry.TransactionSamplingContext, double?>? TracesSampler { get; set; }
+        public Sentry.Extensibility.ITransport? Transport { get; set; }
         public bool UseAsyncFileIO { get; set; }
     }
     public static class SentryOptionsExtensions
@@ -1038,6 +1039,10 @@ namespace Sentry.Extensibility
     {
         Sentry.SentryStackTrace? Create(System.Exception? exception = null);
     }
+    public interface ITransport
+    {
+        System.Threading.Tasks.Task SendEnvelopeAsync(Sentry.Protocol.Envelopes.Envelope envelope, System.Threading.CancellationToken cancellationToken = default);
+    }
     public class RequestBodyExtractionDispatcher : Sentry.Extensibility.IRequestPayloadExtractor
     {
         public RequestBodyExtractionDispatcher(System.Collections.Generic.IEnumerable<Sentry.Extensibility.IRequestPayloadExtractor> extractors, Sentry.SentryOptions options, System.Func<Sentry.Extensibility.RequestSize> sizeSwitch) { }

diff --git a/test/Sentry.DiagnosticSource.Tests/ApiApprovalTests.Run.DotNet5_0.verified.txt b/test/Sentry.DiagnosticSource.Tests/ApiApprovalTests.Run.DotNet5_0.verified.txt
@@ -498,6 +498,7 @@ namespace Sentry
         public Sentry.StackTraceMode StackTraceMode { get; set; }
         public double TracesSampleRate { get; set; }
         public System.Func<Sentry.TransactionSamplingContext, double?>? TracesSampler { get; set; }
+        public Sentry.Extensibility.ITransport? Transport { get; set; }
         public bool UseAsyncFileIO { get; set; }
     }
     public static class SentryOptionsExtensions
@@ -1038,6 +1039,10 @@ namespace Sentry.Extensibility
     {
         Sentry.SentryStackTrace? Create(System.Exception? exception = null);
     }
+    public interface ITransport
+    {
+        System.Threading.Tasks.Task SendEnvelopeAsync(Sentry.Protocol.Envelopes.Envelope envelope, System.Threading.CancellationToken cancellationToken = default);
+    }
     public class RequestBodyExtractionDispatcher : Sentry.Extensibility.IRequestPayloadExtractor
     {
         public RequestBodyExtractionDispatcher(System.Collections.Generic.IEnumerable<Sentry.Extensibility.IRequestPayloadExtractor> extractors, Sentry.SentryOptions options, System.Func<Sentry.Extensibility.RequestSize> sizeSwitch) { }

diff --git a/test/Sentry.DiagnosticSource.Tests/ApiApprovalTests.Run.DotNet6_0.verified.txt b/test/Sentry.DiagnosticSource.Tests/ApiApprovalTests.Run.DotNet6_0.verified.txt
@@ -498,6 +498,7 @@ namespace Sentry
         public Sentry.StackTraceMode StackTraceMode { get; set; }
         public double TracesSampleRate { get; set; }
         public System.Func<Sentry.TransactionSamplingContext, double?>? TracesSampler { get; set; }
+        public Sentry.Extensibility.ITransport? Transport { get; set; }
         public bool UseAsyncFileIO { get; set; }
     }
     public static class SentryOptionsExtensions
@@ -1038,6 +1039,10 @@ namespace Sentry.Extensibility
     {
         Sentry.SentryStackTrace? Create(System.Exception? exception = null);
     }
+    public interface ITransport
+    {
+        System.Threading.Tasks.Task SendEnvelopeAsync(Sentry.Protocol.Envelopes.Envelope envelope, System.Threading.CancellationToken cancellationToken = default);
+    }
     public class RequestBodyExtractionDispatcher : Sentry.Extensibility.IRequestPayloadExtractor
     {
         public RequestBodyExtractionDispatcher(System.Collections.Generic.IEnumerable<Sentry.Extensibility.IRequestPayloadExtractor> extractors, Sentry.SentryOptions options, System.Func<Sentry.Extensibility.RequestSize> sizeSwitch) { }

diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.Core2_1.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.Core2_1.verified.txt
@@ -498,6 +498,7 @@ namespace Sentry
         public Sentry.StackTraceMode StackTraceMode { get; set; }
         public double TracesSampleRate { get; set; }
         public System.Func<Sentry.TransactionSamplingContext, double?>? TracesSampler { get; set; }
+        public Sentry.Extensibility.ITransport? Transport { get; set; }
         public bool UseAsyncFileIO { get; set; }
     }
     public static class SentryOptionsExtensions
@@ -1037,6 +1038,10 @@ namespace Sentry.Extensibility
     {
         Sentry.SentryStackTrace? Create(System.Exception? exception = null);
     }
+    public interface ITransport
+    {
+        System.Threading.Tasks.Task SendEnvelopeAsync(Sentry.Protocol.Envelopes.Envelope envelope, System.Threading.CancellationToken cancellationToken = default);
+    }
     public class RequestBodyExtractionDispatcher : Sentry.Extensibility.IRequestPayloadExtractor
     {
         public RequestBodyExtractionDispatcher(System.Collections.Generic.IEnumerable<Sentry.Extensibility.IRequestPayloadExtractor> extractors, Sentry.SentryOptions options, System.Func<Sentry.Extensibility.RequestSize> sizeSwitch) { }

diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.Core3_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.Core3_0.verified.txt
@@ -498,6 +498,7 @@ namespace Sentry
         public Sentry.StackTraceMode StackTraceMode { get; set; }
         public double TracesSampleRate { get; set; }
         public System.Func<Sentry.TransactionSamplingContext, double?>? TracesSampler { get; set; }
+        public Sentry.Extensibility.ITransport? Transport { get; set; }
         public bool UseAsyncFileIO { get; set; }
     }
     public static class SentryOptionsExtensions
@@ -1037,6 +1038,10 @@ namespace Sentry.Extensibility
     {
         Sentry.SentryStackTrace? Create(System.Exception? exception = null);
     }
+    public interface ITransport
+    {
+        System.Threading.Tasks.Task SendEnvelopeAsync(Sentry.Protocol.Envelopes.Envelope envelope, System.Threading.CancellationToken cancellationToken = default);
+    }
     public class RequestBodyExtractionDispatcher : Sentry.Extensibility.IRequestPayloadExtractor
     {
         public RequestBodyExtractionDispatcher(System.Collections.Generic.IEnumerable<Sentry.Extensibility.IRequestPayloadExtractor> extractors, Sentry.SentryOptions options, System.Func<Sentry.Extensibility.RequestSize> sizeSwitch) { }

diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.Core3_1.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.Core3_1.verified.txt
@@ -498,6 +498,7 @@ namespace Sentry
         public Sentry.StackTraceMode StackTraceMode { get; set; }
         public double TracesSampleRate { get; set; }
         public System.Func<Sentry.TransactionSamplingContext, double?>? TracesSampler { get; set; }
+        public Sentry.Extensibility.ITransport? Transport { get; set; }
         public bool UseAsyncFileIO { get; set; }
     }
     public static class SentryOptionsExtensions
@@ -1038,6 +1039,10 @@ namespace Sentry.Extensibility
     {
         Sentry.SentryStackTrace? Create(System.Exception? exception = null);
     }
+    public interface ITransport
+    {
+        System.Threading.Tasks.Task SendEnvelopeAsync(Sentry.Protocol.Envelopes.Envelope envelope, System.Threading.CancellationToken cancellationToken = default);
+    }
     public class RequestBodyExtractionDispatcher : Sentry.Extensibility.IRequestPayloadExtractor
     {
         public RequestBodyExtractionDispatcher(System.Collections.Generic.IEnumerable<Sentry.Extensibility.IRequestPayloadExtractor> extractors, Sentry.SentryOptions options, System.Func<Sentry.Extensibility.RequestSize> sizeSwitch) { }

diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet4_6.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet4_6.verified.txt
@@ -497,6 +497,7 @@ namespace Sentry
         public Sentry.StackTraceMode StackTraceMode { get; set; }
         public double TracesSampleRate { get; set; }
         public System.Func<Sentry.TransactionSamplingContext, double?>? TracesSampler { get; set; }
+        public Sentry.Extensibility.ITransport? Transport { get; set; }
         public bool UseAsyncFileIO { get; set; }
     }
     public static class SentryOptionsExtensions
@@ -1037,6 +1038,10 @@ namespace Sentry.Extensibility
     {
         Sentry.SentryStackTrace? Create(System.Exception? exception = null);
     }
+    public interface ITransport
+    {
+        System.Threading.Tasks.Task SendEnvelopeAsync(Sentry.Protocol.Envelopes.Envelope envelope, System.Threading.CancellationToken cancellationToken = default);
+    }
     public class RequestBodyExtractionDispatcher : Sentry.Extensibility.IRequestPayloadExtractor
     {
         public RequestBodyExtractionDispatcher(System.Collections.Generic.IEnumerable<Sentry.Extensibility.IRequestPayloadExtractor> extractors, Sentry.SentryOptions options, System.Func<Sentry.Extensibility.RequestSize> sizeSwitch) { }

diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet5_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet5_0.verified.txt
@@ -498,6 +498,7 @@ namespace Sentry
         public Sentry.StackTraceMode StackTraceMode { get; set; }
         public double TracesSampleRate { get; set; }
         public System.Func<Sentry.TransactionSamplingContext, double?>? TracesSampler { get; set; }
+        public Sentry.Extensibility.ITransport? Transport { get; set; }
         public bool UseAsyncFileIO { get; set; }
     }
     public static class SentryOptionsExtensions
@@ -1038,6 +1039,10 @@ namespace Sentry.Extensibility
     {
         Sentry.SentryStackTrace? Create(System.Exception? exception = null);
     }
+    public interface ITransport
+    {
+        System.Threading.Tasks.Task SendEnvelopeAsync(Sentry.Protocol.Envelopes.Envelope envelope, System.Threading.CancellationToken cancellationToken = default);
+    }
     public class RequestBodyExtractionDispatcher : Sentry.Extensibility.IRequestPayloadExtractor
     {
         public RequestBodyExtractionDispatcher(System.Collections.Generic.IEnumerable<Sentry.Extensibility.IRequestPayloadExtractor> extractors, Sentry.SentryOptions options, System.Func<Sentry.Extensibility.RequestSize> sizeSwitch) { }

diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet6_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet6_0.verified.txt
@@ -498,6 +498,7 @@ namespace Sentry
         public Sentry.StackTraceMode StackTraceMode { get; set; }
         public double TracesSampleRate { get; set; }
         public System.Func<Sentry.TransactionSamplingContext, double?>? TracesSampler { get; set; }
+        public Sentry.Extensibility.ITransport? Transport { get; set; }
         public bool UseAsyncFileIO { get; set; }
     }
     public static class SentryOptionsExtensions
@@ -1038,6 +1039,10 @@ namespace Sentry.Extensibility
     {
         Sentry.SentryStackTrace? Create(System.Exception? exception = null);
     }
+    public interface ITransport
+    {
+        System.Threading.Tasks.Task SendEnvelopeAsync(Sentry.Protocol.Envelopes.Envelope envelope, System.Threading.CancellationToken cancellationToken = default);
+    }
     public class RequestBodyExtractionDispatcher : Sentry.Extensibility.IRequestPayloadExtractor
     {
         public RequestBodyExtractionDispatcher(System.Collections.Generic.IEnumerable<Sentry.Extensibility.IRequestPayloadExtractor> extractors, Sentry.SentryOptions options, System.Func<Sentry.Extensibility.RequestSize> sizeSwitch) { }