Caching (#576)

Author: Tyrrrz

.github/workflows/build.yaml

@@ -26,20 +26,20 @@ jobs:
 
     steps:
         - name: Checkout
-          uses: actions/checkout@v2
+          uses: actions/checkout@v2.3.3
 
         - name: Setup .NET SDK (v2.1)
-          uses: actions/[email protected].0
+          uses: actions/[email protected].2
           with:
             dotnet-version: '2.1.809'
 
         - name: Setup .NET SDK (v3.1)
-          uses: actions/[email protected].0
+          uses: actions/[email protected].2
           with:
             dotnet-version: '3.1.401'
 
         - name: Setup .NET SDK (v5.0)
-          uses: actions/[email protected].0
+          uses: actions/[email protected].2
           with:
             dotnet-version: '5.0.100'
 

CHANGELOG.md

@@ -1,7 +1,8 @@
 # Changelog
 
-## unreleased
+## vNext
 
+* Implement envelope caching. (#576) @Tyrrrz
 * Add a list of .NET Frameworks installed when available. (#531) @lucas-zimerman
 * Parse Mono and IL2CPP stacktraces for Unity and Xamarin (#578) @bruno-garcia
 * Update TFMs and dependency min version (#580) @bruno-garcia

src/Sentry/Internal/BackgroundWorker.cs

@@ -123,15 +123,15 @@ private async ValueTask WorkerAsync()
                             // Dispose inside try/catch
                             using var _ = envelope;
 
-                            var ValueTask = _transport.SendEnvelopeAsync(envelope, shutdownTimeout.Token);
+                            var task = _transport.SendEnvelopeAsync(envelope, shutdownTimeout.Token);
 
                             _options.DiagnosticLogger?.LogDebug(
-                                "Envelope {0} in-flight to Sentry. #{1} in queue.",
+                                "Envelope {0} handed off to transport. #{1} in queue.",
                                 envelope.TryGetEventId(),
                                 _queue.Count
                             );
 
-                            await ValueTask.ConfigureAwait(false);
+                            await task.ConfigureAwait(false);
                         }
                         catch (OperationCanceledException)
                         {
@@ -201,7 +201,8 @@ public async ValueTask FlushAsync(TimeSpan timeout)
             var timeoutWithShutdown = CancellationTokenSource.CreateLinkedTokenSource(
                 timeoutSource.Token,
                 _shutdownSource.Token,
-                flushSuccessSource.Token);
+                flushSuccessSource.Token
+            );
 
             var counter = 0;
             var depth = int.MaxValue;
@@ -249,7 +250,8 @@ void EventFlushedCallback(object objProcessed, EventArgs _)
             {
                 _options.DiagnosticLogger?.LogDebug(flushSuccessSource.IsCancellationRequested
                     ? "Successfully flushed all events up to call to FlushAsync."
-                    : "Timeout when trying to flush queue.");
+                    : "Timeout when trying to flush queue."
+                );
             }
             finally
             {
@@ -281,6 +283,9 @@ public void Dispose()
                 // If there's anything in the queue, it'll keep running until 'shutdownTimeout' is reached
                 // If the queue is empty it will quit immediately
                 _ = WorkerTask.Wait(_options.ShutdownTimeout);
+
+                // Dispose the transport if needed
+                (_transport as IDisposable)?.Dispose();
             }
             catch (OperationCanceledException)
             {
@@ -293,8 +298,10 @@ public void Dispose()
 
             if (_queue.Count > 0)
             {
-                _options.DiagnosticLogger?.LogWarning("Worker stopped while {0} were still in the queue.",
-                    _queue.Count);
+                _options.DiagnosticLogger?.LogWarning(
+                    "Worker stopped while {0} were still in the queue.",
+                    _queue.Count
+                );
             }
         }
     }

src/Sentry/Internal/Disposable.cs

@@ -0,0 +1,16 @@
+using System;
+
+namespace Sentry.Internal
+{
+    internal class Disposable : IDisposable
+    {
+        private readonly Action _dispose;
+
+        public Disposable(Action dispose) => _dispose = dispose;
+
+        public void Dispose() => _dispose();
+
+        public static IDisposable Create(Action dispose) =>
+            new Disposable(dispose);
+    }
+}

src/Sentry/Internal/Extensions/HashExtensions.cs

@@ -0,0 +1,32 @@
+using System.Security.Cryptography;
+using System.Text;
+
+namespace Sentry.Internal.Extensions
+{
+    internal static class HashExtensions
+    {
+        private static string GetHexString(this byte[] data)
+        {
+            var buffer = new StringBuilder();
+
+            foreach (var t in data)
+            {
+                buffer.Append(t.ToString("X2"));
+            }
+
+            return buffer.ToString();
+        }
+
+        public static string GetHashString(this string str, HashAlgorithm algo)
+        {
+            using (algo)
+            {
+                var hashData = algo.ComputeHash(Encoding.UTF8.GetBytes(str));
+                return hashData.GetHexString();
+            }
+        }
+
+        public static string GetHashString(this string str) =>
+            str.GetHashString(SHA1.Create());
+    }
+}