Set replay_id on DSC rather than directly on the event Context

jamescrosswell · jamescrosswell · commit b8d945242cc7 · 2025-04-23T17:59:34.000+12:00
diff --git a/src/Sentry/DynamicSamplingContext.cs b/src/Sentry/DynamicSamplingContext.cs
@@ -28,7 +28,9 @@ private DynamicSamplingContext(
         double? sampleRand = null,
         string? release = null,
         string? environment = null,
-        string? transactionName = null)
+        string? transactionName = null,
+        SentryId? replayId = null
+        )
     {
         // Validate and set required values
         if (traceId == SentryId.Empty)
@@ -88,6 +90,11 @@ private DynamicSamplingContext(
             items.Add("transaction", transactionName);
         }
 
+        if (replayId is not null && replayId.Value != SentryId.Empty)
+        {
+            items.Add("replay_id", replayId.Value.ToString());
+        }
+
         Items = items;
     }
 
@@ -156,6 +163,7 @@ public static DynamicSamplingContext CreateFromTransaction(TransactionTracer tra
         var sampleRate = transaction.SampleRate!.Value;
         var sampleRand = transaction.SampleRand;
         var transactionName = transaction.NameSource.IsHighQuality() ? transaction.Name : null;
+        var replayId = transaction.Contexts.Replay.ReplayId;
 
         // These two may not have been set yet on the transaction, but we can get them directly.
         var release = options.SettingLocator.GetRelease();
@@ -169,7 +177,8 @@ public static DynamicSamplingContext CreateFromTransaction(TransactionTracer tra
             sampleRand,
             release,
             environment,
-            transactionName);
+            transactionName,
+            replayId);
     }
 
     public static DynamicSamplingContext CreateFromPropagationContext(SentryPropagationContext propagationContext, SentryOptions options)
@@ -178,13 +187,15 @@ public static DynamicSamplingContext CreateFromPropagationContext(SentryPropagat
         var publicKey = options.ParsedDsn.PublicKey;
         var release = options.SettingLocator.GetRelease();
         var environment = options.SettingLocator.GetEnvironment();
+        var replayId = ReplayHelper.GetReplayId();
 
         return new DynamicSamplingContext(
             traceId,
             publicKey,
             null,
             release: release,
-            environment: environment);
+            environment: environment,
+            replayId: replayId);
     }
 }
 
diff --git a/src/Sentry/Internal/Hub.cs b/src/Sentry/Internal/Hub.cs
@@ -134,6 +134,8 @@ internal ITransactionTracer StartTransaction(
                 : SampleRandHelper.GenerateSampleRand(context.TraceId.ToString())
         };
 
+        transaction.Contexts.Replay.ReplayId = ReplayHelper.GetReplayId();
+
         // If the hub is disabled, we will always sample out.  In other words, starting a transaction
         // after disposing the hub will result in that transaction not being sent to Sentry.
         // Additionally, we will always sample out if tracing is explicitly disabled.
diff --git a/src/Sentry/Internal/ReplayHelper.cs b/src/Sentry/Internal/ReplayHelper.cs
@@ -0,0 +1,19 @@
+#if __ANDROID__
+using Sentry.Android.Extensions;
+#endif
+
+namespace Sentry.Internal;
+
+internal static class ReplayHelper
+{
+    internal static SentryId? GetReplayId()
+    {
+#if __ANDROID__
+        // Check to see if a Replay ID is available
+        var replayId = JavaSdk.ScopesAdapter.Instance?.Options?.ReplayController?.ReplayId?.ToSentryId();
+        return (replayId is { } id && id != SentryId.Empty) ? id : null;
+#else
+        return null;
+#endif
+    }
+}
diff --git a/src/Sentry/Platforms/Android/AndroidEventProcessor.cs b/src/Sentry/Platforms/Android/AndroidEventProcessor.cs
@@ -35,14 +35,6 @@ public SentryEvent Process(SentryEvent @event)
         // Copy more information from the Android SDK
         if (_androidProcessor is { } androidProcessor)
         {
-            // TODO: We should really do this when creating the DSC, so that it gets propagated correctly
-            // Check to see if a Replay ID is available
-            var activeReplayId = Sentry.JavaSdk.ScopesAdapter.Instance?.Options?.ReplayController?.ReplayId?.ToSentryId();
-            if (activeReplayId is { } replayId && replayId != SentryId.Empty)
-            {
-                @event.Contexts.Replay.ReplayId = replayId;
-            }
-
             // TODO: Can we gather more data directly and remove this?
 
             // Run a fake event through the Android processor, so we can get context info from the Android SDK.
diff --git a/test/Sentry.AspNetCore.Tests/WebIntegrationTests.Versioning.DotNet8_0.verified.txt b/test/Sentry.AspNetCore.Tests/WebIntegrationTests.Versioning.DotNet8_0.verified.txt
@@ -17,6 +17,7 @@
           QueryString: 
         },
         Contexts: {
+          replay: {},
           trace: {
             Operation: http.server,
             Origin: auto.http.aspnetcore,
diff --git a/test/Sentry.AspNetCore.Tests/WebIntegrationTests.Versioning.DotNet9_0.verified.txt b/test/Sentry.AspNetCore.Tests/WebIntegrationTests.Versioning.DotNet9_0.verified.txt
@@ -17,6 +17,7 @@
           QueryString: 
         },
         Contexts: {
+          replay: {},
           trace: {
             Operation: http.server,
             Origin: auto.http.aspnetcore,
diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt
@@ -504,6 +504,7 @@ namespace Sentry
         public object this[string key] { get; set; }
         public System.Collections.Generic.ICollection<string> Keys { get; }
         public Sentry.Protocol.OperatingSystem OperatingSystem { get; }
+        public Sentry.Protocol.Replay Replay { get; }
         public Sentry.Protocol.Response Response { get; }
         public Sentry.Protocol.Runtime Runtime { get; }
         public Sentry.Protocol.Trace Trace { get; }
@@ -1754,6 +1755,17 @@ namespace Sentry.Protocol
         public void WriteTo(System.Text.Json.Utf8JsonWriter writer, Sentry.Extensibility.IDiagnosticLogger? _) { }
         public static Sentry.Protocol.OperatingSystem FromJson(System.Text.Json.JsonElement json) { }
     }
+    public sealed class Replay : Sentry.ISentryJsonSerializable
+    {
+        public const string Type = "replay";
+        public Replay() { }
+        public Sentry.SentryId? ReplayId { get; set; }
+        public Sentry.Protocol.Replay Clone() { }
+        public void UpdateFrom(Sentry.Protocol.Replay source) { }
+        public void UpdateFrom(object source) { }
+        public void WriteTo(System.Text.Json.Utf8JsonWriter writer, Sentry.Extensibility.IDiagnosticLogger? logger) { }
+        public static Sentry.Protocol.Replay FromJson(System.Text.Json.JsonElement json) { }
+    }
     public sealed class Response : Sentry.ISentryJsonSerializable
     {
         public const string Type = "response";
diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.DotNet9_0.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.DotNet9_0.verified.txt
@@ -504,6 +504,7 @@ namespace Sentry
         public object this[string key] { get; set; }
         public System.Collections.Generic.ICollection<string> Keys { get; }
         public Sentry.Protocol.OperatingSystem OperatingSystem { get; }
+        public Sentry.Protocol.Replay Replay { get; }
         public Sentry.Protocol.Response Response { get; }
         public Sentry.Protocol.Runtime Runtime { get; }
         public Sentry.Protocol.Trace Trace { get; }
@@ -1754,6 +1755,17 @@ namespace Sentry.Protocol
         public void WriteTo(System.Text.Json.Utf8JsonWriter writer, Sentry.Extensibility.IDiagnosticLogger? _) { }
         public static Sentry.Protocol.OperatingSystem FromJson(System.Text.Json.JsonElement json) { }
     }
+    public sealed class Replay : Sentry.ISentryJsonSerializable
+    {
+        public const string Type = "replay";
+        public Replay() { }
+        public Sentry.SentryId? ReplayId { get; set; }
+        public Sentry.Protocol.Replay Clone() { }
+        public void UpdateFrom(Sentry.Protocol.Replay source) { }
+        public void UpdateFrom(object source) { }
+        public void WriteTo(System.Text.Json.Utf8JsonWriter writer, Sentry.Extensibility.IDiagnosticLogger? logger) { }
+        public static Sentry.Protocol.Replay FromJson(System.Text.Json.JsonElement json) { }
+    }
     public sealed class Response : Sentry.ISentryJsonSerializable
     {
         public const string Type = "response";
diff --git a/test/Sentry.Tests/ApiApprovalTests.Run.Net4_8.verified.txt b/test/Sentry.Tests/ApiApprovalTests.Run.Net4_8.verified.txt
@@ -492,6 +492,7 @@ namespace Sentry
         public object this[string key] { get; set; }
         public System.Collections.Generic.ICollection<string> Keys { get; }
         public Sentry.Protocol.OperatingSystem OperatingSystem { get; }
+        public Sentry.Protocol.Replay Replay { get; }
         public Sentry.Protocol.Response Response { get; }
         public Sentry.Protocol.Runtime Runtime { get; }
         public Sentry.Protocol.Trace Trace { get; }
@@ -1736,6 +1737,17 @@ namespace Sentry.Protocol
         public void WriteTo(System.Text.Json.Utf8JsonWriter writer, Sentry.Extensibility.IDiagnosticLogger? _) { }
         public static Sentry.Protocol.OperatingSystem FromJson(System.Text.Json.JsonElement json) { }
     }
+    public sealed class Replay : Sentry.ISentryJsonSerializable
+    {
+        public const string Type = "replay";
+        public Replay() { }
+        public Sentry.SentryId? ReplayId { get; set; }
+        public Sentry.Protocol.Replay Clone() { }
+        public void UpdateFrom(Sentry.Protocol.Replay source) { }
+        public void UpdateFrom(object source) { }
+        public void WriteTo(System.Text.Json.Utf8JsonWriter writer, Sentry.Extensibility.IDiagnosticLogger? logger) { }
+        public static Sentry.Protocol.Replay FromJson(System.Text.Json.JsonElement json) { }
+    }
     public sealed class Response : Sentry.ISentryJsonSerializable
     {
         public const string Type = "response";
diff --git a/test/Sentry.Tests/HubTests.CaptureEvent_ActiveTransaction_UnhandledExceptionTransactionEndedAsCrashed.DotNet8_0.verified.txt b/test/Sentry.Tests/HubTests.CaptureEvent_ActiveTransaction_UnhandledExceptionTransactionEndedAsCrashed.DotNet8_0.verified.txt
@@ -170,6 +170,7 @@
             SampleRate: 1.0,
             Request: {},
             Contexts: {
+              replay: {},
               trace: {
                 Operation: my operation,
                 Description: ,
diff --git a/test/Sentry.Tests/HubTests.CaptureEvent_ActiveTransaction_UnhandledExceptionTransactionEndedAsCrashed.DotNet9_0.verified.txt b/test/Sentry.Tests/HubTests.CaptureEvent_ActiveTransaction_UnhandledExceptionTransactionEndedAsCrashed.DotNet9_0.verified.txt
@@ -170,6 +170,7 @@
             SampleRate: 1.0,
             Request: {},
             Contexts: {
+              replay: {},
               trace: {
                 Operation: my operation,
                 Description: ,
diff --git a/test/Sentry.Tests/TransactionProcessorTests.Simple.verified.txt b/test/Sentry.Tests/TransactionProcessorTests.Simple.verified.txt
@@ -78,6 +78,7 @@
             Request: {},
             Contexts: {
               key: value,
+              replay: {},
               trace: {
                 Operation: my operation,
                 Description: ,
