Session Replay: Recording on Android (#3552)

bruno-garcia · jamescrosswell · web-flow · commit ad807953572d · 2024-11-05T12:13:53.000+13:00
---------

Co-authored-by: James Crosswell &lt;jamescrosswell@users.noreply.github.com&gt;
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Limited experimental support for Session Replay Recording on Android ([#3552](https://github.com/getsentry/sentry-dotnet/pull/3552))
+
 ### Fixes
 
 - When using OTel and ASP.NET Core the SDK could try to process OTel spans after the SDK had been closed ([#3726](https://github.com/getsentry/sentry-dotnet/pull/3726))
diff --git a/samples/Sentry.Samples.Maui/MauiProgram.cs b/samples/Sentry.Samples.Maui/MauiProgram.cs
@@ -25,6 +25,14 @@ public static MauiApp CreateMauiApp()
                 options.Debug = true;
                 options.SampleRate = 1.0F;
 
+#if ANDROID
+                // Currently experimental support is only available on Android
+                options.Native.ExperimentalOptions.SessionReplay.OnErrorSampleRate = 1.0;
+                options.Native.ExperimentalOptions.SessionReplay.SessionSampleRate = 1.0;
+                options.Native.ExperimentalOptions.SessionReplay.MaskAllImages = false;
+                options.Native.ExperimentalOptions.SessionReplay.MaskAllText = false;
+#endif
+
                 options.SetBeforeScreenshotCapture((@event, hint) =>
                 {
                     Console.WriteLine("screenshot about to be captured.");
@@ -33,7 +41,6 @@ public static MauiApp CreateMauiApp()
                     return true;
                 });
             })
-
             .ConfigureFonts(fonts =>
             {
                 fonts.AddFont("OpenSans-Regular.ttf", "OpenSansRegular");
diff --git a/src/Sentry.Bindings.Android/Sentry.Bindings.Android.csproj b/src/Sentry.Bindings.Android/Sentry.Bindings.Android.csproj
@@ -29,6 +29,7 @@
     <AndroidLibrary Include="$(SentryAndroidSdkDirectory)sentry-$(SentryAndroidSdkVersion).jar" />
     <AndroidLibrary Include="$(SentryAndroidSdkDirectory)sentry-android-core-$(SentryAndroidSdkVersion).aar" />
     <AndroidLibrary Include="$(SentryAndroidSdkDirectory)sentry-android-ndk-$(SentryAndroidSdkVersion).aar" />
+    <AndroidLibrary Include="$(SentryAndroidSdkDirectory)sentry-android-replay-$(SentryAndroidSdkVersion).aar" />
     <AndroidLibrary Include="..\..\lib\sentry-android-supplemental\bin\sentry-android-supplemental.jar" />
     <AndroidNativeLibrary Include="..\..\lib\sentrysupplemental\bin\arm64-v8a\libsentrysupplemental.so" Abi="arm64-v8a" />
     <AndroidNativeLibrary Include="..\..\lib\sentrysupplemental\bin\armeabi-v7a\libsentrysupplemental.so" Abi="armeabi-v7a" />
@@ -49,6 +50,12 @@
       Condition="!Exists('$(SentryAndroidSdkDirectory)sentry-android-ndk-$(SentryAndroidSdkVersion).aar')"
       Retries="3"
     />
+    <DownloadFile
+      SourceUrl="https://repo1.maven.org/maven2/io/sentry/sentry-android-replay/$(SentryAndroidSdkVersion)/sentry-android-replay-$(SentryAndroidSdkVersion).aar"
+      DestinationFolder="$(SentryAndroidSdkDirectory)"
+      Condition="!Exists('$(SentryAndroidSdkDirectory)sentry-android-replay-$(SentryAndroidSdkVersion).aar')"
+      Retries="3"
+    />
     <DownloadFile
       SourceUrl="https://repo1.maven.org/maven2/io/sentry/sentry/$(SentryAndroidSdkVersion)/sentry-$(SentryAndroidSdkVersion).jar"
       DestinationFolder="$(SentryAndroidSdkDirectory)"
diff --git a/src/Sentry.Bindings.Android/Transforms/Metadata.xml b/src/Sentry.Bindings.Android/Transforms/Metadata.xml
@@ -118,6 +118,8 @@
   <remove-node path="/api/package[@name='io.sentry.android.core']/class[@name='TempSensorBreadcrumbsIntegration']" />
   <remove-node path="/api/package[@name='io.sentry.android.core.internal.gestures']" />
   <remove-node path="/api/package[@name='io.sentry.android.core.performance']" />
+  <remove-node path="/api/package[@name='io.sentry.android.replay.viewhierarchy']" />
+  <remove-node path="/api/package[@name='io.sentry.android.replay.util']" />
 
   <remove-node path="/api/package[starts-with(@name,'io.sentry')]/*/method[@name='clone' and count(parameter)=0]" />
   <remove-node path="/api/package[starts-with(@name,'io.sentry')]/class/implements[@name='io.sentry.JsonDeserializer']" />
diff --git a/src/Sentry/Platforms/Android/BindableNativeSentryOptions.cs b/src/Sentry/Platforms/Android/BindableNativeSentryOptions.cs
@@ -1,4 +1,5 @@
 // ReSharper disable once CheckNamespace
+
 namespace Sentry;
 
 internal partial class BindableSentryOptions
@@ -34,7 +35,20 @@ public class NativeOptions
         public TimeSpan? ReadTimeout { get; set; }
         public bool? EnableTracing { get; set; }
         public bool? EnableBeforeSend { get; set; }
+        public NativeExperimentalOptions ExperimentalOptions { get; set; } = new();
+
+        internal class NativeExperimentalOptions
+        {
+            public NativeSentryReplayOptions SessionReplay { get; set; } = new();
+        }
 
+        internal class NativeSentryReplayOptions
+        {
+            public double? OnErrorSampleRate { get; set; }
+            public double? SessionSampleRate { get; set; }
+            public bool RedactAllImages { get; set; }
+            public bool RedactAllText { get; set; }
+        }
         public void ApplyTo(SentryOptions.NativeOptions options)
         {
             options.AnrEnabled = AnrEnabled ?? options.AnrEnabled;
@@ -61,6 +75,21 @@ public void ApplyTo(SentryOptions.NativeOptions options)
             options.ReadTimeout = ReadTimeout ?? options.ReadTimeout;
             options.EnableTracing = EnableTracing ?? options.EnableTracing;
             options.EnableBeforeSend = EnableBeforeSend ?? options.EnableBeforeSend;
+
+            if (ExperimentalOptions.SessionReplay.OnErrorSampleRate is { } errorSampleRate)
+            {
+#pragma warning disable CA1422
+                options.ExperimentalOptions.SessionReplay.OnErrorSampleRate = errorSampleRate;
+#pragma warning restore CA1422
+            }
+            if (ExperimentalOptions.SessionReplay.SessionSampleRate is { } sessionSampleRate)
+            {
+#pragma warning disable CA1422
+                options.ExperimentalOptions.SessionReplay.SessionSampleRate = sessionSampleRate;
+#pragma warning restore CA1422
+            }
+            ExperimentalOptions.SessionReplay.RedactAllText = options.ExperimentalOptions.SessionReplay.MaskAllText;
+            ExperimentalOptions.SessionReplay.RedactAllImages = options.ExperimentalOptions.SessionReplay.MaskAllImages;
         }
     }
 }
diff --git a/src/Sentry/Platforms/Android/NativeOptions.cs b/src/Sentry/Platforms/Android/NativeOptions.cs
@@ -1,4 +1,5 @@
 // ReSharper disable once CheckNamespace
+
 namespace Sentry;
 
 public partial class SentryOptions
@@ -260,5 +261,21 @@ public void AddInAppInclude(string prefix)
         /// be stripped away during the round-tripping between the two SDKs.  Use with caution.
         /// </remarks>
         public bool EnableBeforeSend { get; set; } = false;
+        public class NativeExperimentalOptions
+        {
+            public NativeSentryReplayOptions SessionReplay { get; set; } = new();
+        }
+
+        public class NativeSentryReplayOptions
+        {
+            public double? OnErrorSampleRate { get; set; }
+            public double? SessionSampleRate { get; set; }
+            public bool MaskAllImages { get; set; } = true;
+            public bool MaskAllText { get; set; } = true;
+        }
+        /// <summary>
+        /// ExperimentalOptions
+        /// </summary>
+        public NativeExperimentalOptions ExperimentalOptions { get; set; } = new();
     }
 }
diff --git a/src/Sentry/Platforms/Android/SentrySdk.cs b/src/Sentry/Platforms/Android/SentrySdk.cs
@@ -163,6 +163,13 @@ private static void InitSentryAndroidSdk(SentryOptions options)
             options.Native.InAppExcludes?.ForEach(o.AddInAppExclude);
             options.Native.InAppIncludes?.ForEach(o.AddInAppInclude);
 
+            o.Experimental.SessionReplay.OnErrorSampleRate =
+                (JavaDouble?)options.Native.ExperimentalOptions.SessionReplay.OnErrorSampleRate;
+            o.Experimental.SessionReplay.SessionSampleRate =
+                (JavaDouble?)options.Native.ExperimentalOptions.SessionReplay.SessionSampleRate;
+            o.Experimental.SessionReplay.SetMaskAllImages(options.Native.ExperimentalOptions.SessionReplay.MaskAllImages);
+            o.Experimental.SessionReplay.SetMaskAllText(options.Native.ExperimentalOptions.SessionReplay.MaskAllText);
+
             // These options are intentionally set and not exposed for modification
             o.EnableExternalConfiguration = false;
             o.EnableDeduplication = false;
diff --git a/test/Sentry.Tests/Platforms/Android/BindableNativeOptionsTests.cs b/test/Sentry.Tests/Platforms/Android/BindableNativeOptionsTests.cs
@@ -5,6 +5,11 @@ namespace Sentry.Tests.Platforms.Android;
 
 public class BindableNativeOptionsTests : BindableTests<SentryOptions.NativeOptions>
 {
+    public BindableNativeOptionsTests()
+        : base(nameof(BindableSentryOptions.NativeOptions.ExperimentalOptions))
+    {
+    }
+
     [Fact]
     public void BindableProperties_MatchOptionsProperties()
     {

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,11 @@ namespace Sentry.Tests.Platforms.Android;`
`5`	`5`
`6`	`6`	`public class BindableNativeOptionsTests : BindableTests<SentryOptions.NativeOptions>`
`7`	`7`	`{`
	`8`	`+ public BindableNativeOptionsTests()`
	`9`	`+ : base(nameof(BindableSentryOptions.NativeOptions.ExperimentalOptions))`
	`10`	`+ {`
	`11`	`+ }`
	`12`	`+`
`8`	`13`	`[Fact]`
`9`	`14`	`public void BindableProperties_MatchOptionsProperties()`
`10`	`15`	`{`