Fix EF Core garbage collected messages and ordering. (#1368)

Co-authored-by: Sentry Github Bot <[email protected]>
Co-authored-by: Bruno Garcia <[email protected]>

Author: 3 people

CHANGELOG.md

@@ -10,6 +10,7 @@
 
 ### Fixes
 
+- Fix EF Core garbage collected messages and ordering ([#1368](https://github.com/getsentry/sentry-dotnet/pull/1368))
 - Update X-Sentry-Auth header to include correct sdk name and version ([#1333](https://github.com/getsentry/sentry-dotnet/pull/1333))
 
 ## 3.12.0

src/Sentry.DiagnosticSource/Internals/DiagnosticSource/SentryEFCoreListener.cs

@@ -1,6 +1,8 @@
+#if NETCOREAPP3_0_OR_GREATER
 using System;
 using System.Collections.Generic;
 using System.Threading;
+#endif
 using Sentry.Extensibility;
 
 namespace Sentry.Internals.DiagnosticSource
@@ -55,6 +57,9 @@ public SentryEFCoreListener(IHub hub, SentryOptions options)
 
         internal bool DisableQuerySpan() => _logQueryEnabled = false;
 
+        private ISpan? GetParent(SentryEFSpanType type, Scope scope)
+            => type == SentryEFSpanType.QueryExecution ? scope.GetSpan() : scope.Transaction;
+
         private ISpan? AddSpan(SentryEFSpanType type, string operation, string? description)
         {
             ISpan? span = null;
@@ -65,7 +70,7 @@ public SentryEFCoreListener(IHub hub, SentryOptions options)
                     return;
                 }
 
-                if (scope.GetSpan()?.StartChild(operation, description) is not { } startedChild)
+                if (GetParent(type, scope)?.StartChild(operation, description) is not { } startedChild)
                 {
                     return;
                 }
@@ -93,7 +98,10 @@ public SentryEFCoreListener(IHub hub, SentryOptions options)
                     {
                         span = startedSpan;
                     }
-                    _options.LogWarning("Trying to close a span that was already garbage collected. {0}", type);
+                    else
+                    {
+                        _options.LogWarning("Trying to close a span that was already garbage collected. {0}", type);
+                    }
                 }
             });
             return span;

test/Sentry.DiagnosticSource.Tests/SentryEFCoreListenerTests.cs

@@ -229,6 +229,7 @@ public void OnNext_HappyPath_IsValid()
         Assert.Equal(_fixture.Tracer.SpanId, compilerSpan.ParentSpanId);
         Assert.Equal(_fixture.Tracer.SpanId, connectionSpan.ParentSpanId);
         Assert.Equal(connectionSpan.SpanId, commandSpan.ParentSpanId);
+        _fixture.Options.DiagnosticLogger.Received(0).Log(Arg.Is(SentryLevel.Warning), Arg.Is("Trying to close a span that was already garbage collected. {0}"), null, Arg.Any<object[]>());
     }
 
     [Fact]
@@ -319,6 +320,24 @@ public void OnNext_ThrowsException_ExceptionIsolated()
         Assert.False(exceptionReceived);
     }
 
+
+    [Theory]
+    [InlineData(EFCommandExecuted)]
+    [InlineData(EFConnectionClosed)]
+    [InlineData(EFQueryCompiled)]
+    public void OnNext_TakeSpanWithoutSpan_ShowsGarbageCollectorError(string operation)
+    {
+        // Arrange
+        var hub = _fixture.Hub;
+        var interceptor = new SentryEFCoreListener(hub, _fixture.Options);
+
+        // Act
+        interceptor.OnNext(new(operation, "ef Junk\r\nSELECT * FROM ..."));
+
+        // Assert
+        _fixture.Options.DiagnosticLogger.Received(1).Log(Arg.Is(SentryLevel.Warning), Arg.Is("Trying to close a span that was already garbage collected. {0}"), null, Arg.Any<object[]>());
+    }
+
     [Fact]
     public void FilterNewLineValue_StringWithNewLine_SubStringAfterNewLine()
     {