Associate replays with errors and traces on Android

Part of #2136

Associate Errors and Traces with the active Session Replay (if one exists) on Android.

Author: jamescrosswell

src/Sentry/Platforms/Android/AndroidEventProcessor.cs

@@ -1,3 +1,5 @@
+using Java.Lang;
+using Kotlin;
 using Sentry.Android.Extensions;
 using Sentry.Extensibility;
 using Sentry.JavaSdk.Android.Core;
@@ -33,6 +35,14 @@ 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.

src/Sentry/Protocol/Replay.cs

@@ -0,0 +1,88 @@
+using Sentry.Extensibility;
+using Sentry.Internal;
+using Sentry.Internal.Extensions;
+
+namespace Sentry.Protocol;
+
+/// <summary>
+/// Sentry Replay context interface.
+/// </summary>
+/// <example>
+/// {
+///     "contexts": {
+///         "replay": {
+///             "replay_id": "12312012123120121231201212312012"
+///         }
+///     }
+/// }
+/// </example>
+/// <see href="https://develop.sentry.dev/sdk/data-model/event-payloads/contexts/#replay-context"/>
+public sealed class Replay : ISentryJsonSerializable, ICloneable<Replay>, IUpdatable<Replay>
+{
+    /// <summary>
+    /// Tells Sentry which type of context this is.
+    /// </summary>
+    public const string Type = "replay";
+
+    /// <summary>
+    /// The name of the runtime.
+    /// </summary>
+    public SentryId? ReplayId { get; set; }
+
+    /// <summary>
+    /// Clones this instance.
+    /// </summary>
+    public Replay Clone()
+    {
+        var response = new Replay();
+
+        response.UpdateFrom(this);
+
+        return response;
+    }
+
+    /// <summary>
+    /// Updates this instance with data from the properties in the <paramref name="source"/>,
+    /// unless there is already a value in the existing property.
+    /// </summary>
+    public void UpdateFrom(Replay source)
+    {
+        ReplayId ??= source.ReplayId;
+    }
+
+    /// <summary>
+    /// Updates this instance with data from the properties in the <paramref name="source"/>,
+    /// unless there is already a value in the existing property.
+    /// </summary>
+    public void UpdateFrom(object source)
+    {
+        if (source is Replay response)
+        {
+            UpdateFrom(response);
+        }
+    }
+
+    /// <inheritdoc />
+    public void WriteTo(Utf8JsonWriter writer, IDiagnosticLogger? logger)
+    {
+        writer.WriteStartObject();
+
+        writer.WriteString("type", Type);
+        writer.WriteSerializableIfNotNull("replay_id", ReplayId, logger);
+
+        writer.WriteEndObject();
+    }
+
+    /// <summary>
+    /// Parses from JSON.
+    /// </summary>
+    public static Replay FromJson(JsonElement json)
+    {
+        var replayId = json.GetPropertyOrNull("replay_id")?.Pipe(SentryId.FromJson);
+
+        return new Replay
+        {
+            ReplayId = replayId
+        };
+    }
+}

src/Sentry/SentryContexts.cs

@@ -55,6 +55,11 @@ public SentryFeedback? Feedback
     /// </remarks>
     public OperatingSystem OperatingSystem => _innerDictionary.GetOrCreate<OperatingSystem>(OperatingSystem.Type);
 
+    /// <summary>
+    /// Replay interface that contains information about the Session Replay (if any) related to the event.
+    /// </summary>
+    public Replay Replay => _innerDictionary.GetOrCreate<Replay>(Replay.Type);
+
     /// <summary>
     /// Response interface that contains information on any HTTP response related to the event.
     /// </summary>
@@ -172,6 +177,10 @@ public static SentryContexts FromJson(JsonElement json)
             {
                 result[name] = OperatingSystem.FromJson(value);
             }
+            else if (string.Equals(type, Replay.Type, StringComparison.OrdinalIgnoreCase))
+            {
+                result[name] = Replay.FromJson(value);
+            }
             else if (string.Equals(type, Response.Type, StringComparison.OrdinalIgnoreCase))
             {
                 result[name] = Response.FromJson(value);