Added the ability to Mask/Unmask controls by Type

Author: jamescrosswell

samples/Sentry.Samples.Maui/MainPage.xaml

@@ -12,6 +12,7 @@
 
             <Image
                 Source="dotnet_bot.png"
+                sentry:SessionReplay.Mask="Unmask"
                 SemanticProperties.Description="Cute dot net bot waving hi to you!"
                 HeightRequest="200"
                 HorizontalOptions="Center" />
@@ -32,55 +33,48 @@
             <Button
                 x:Name="CounterBtn"
                 Text="Click me"
-                sentry:SessionReplay.Mask="Unmask"
                 SemanticProperties.Hint="Counts the number of times you click."
                 Clicked="OnCounterClicked"
                 HorizontalOptions="Center" />
 
             <Button
                 x:Name="ThrowAndCaptureBtn"
                 Text="Throw and Capture Exception"
-                sentry:SessionReplay.Mask="Unmask"
                 SemanticProperties.Hint="Throws an exception and captures it."
                 Clicked="OnCapturedExceptionClicked"
                 HorizontalOptions="Center" />
 
             <Button
                 x:Name="ThrowUnhandledBtn"
                 Text="Throw Unhandled .NET Exception (Crash)"
-                sentry:SessionReplay.Mask="Unmask"
                 SemanticProperties.Hint="Throws an unhandled .NET exception, crashing the app."
                 Clicked="OnUnhandledExceptionClicked"
                 HorizontalOptions="Center" />
 
             <Button
                 x:Name="ThrowBackgroundUnhandledBtn"
                 Text="Throw Unhandled .NET Exception on Background Thread (Crash)"
-                sentry:SessionReplay.Mask="Unmask"
                 SemanticProperties.Hint="Throws an unhandled .NET exception on a background thread, crashing the app."
                 Clicked="OnBackgroundThreadUnhandledExceptionClicked"
                 HorizontalOptions="Center" />
 
             <Button
                 x:Name="JavaCrashBtn"
                 Text="Throw Java Exception (Crash)"
-                sentry:SessionReplay.Mask="Unmask"
                 SemanticProperties.Hint="Throws an unhandled Java exception, crashing the app."
                 Clicked="OnJavaCrashClicked"
                 HorizontalOptions="Center" />
 
             <Button
                 x:Name="NativeCrashBtn"
                 Text="Cause Native Crash"
-                sentry:SessionReplay.Mask="Unmask"
                 SemanticProperties.Hint="Performs an invalid native operation, crashing the app."
                 Clicked="OnNativeCrashClicked"
                 HorizontalOptions="Center" />
 
             <Button
                 x:Name="FeedbackBtn"
                 Text="Submit Feedback"
-                sentry:SessionReplay.Mask="Unmask"
                 SemanticProperties.Hint="Provides a form that can be used to capture open feedback from the user."
                 Clicked="OnFeedbackClicked"
                 HorizontalOptions="Center" />

samples/Sentry.Samples.Maui/MauiProgram.cs

@@ -25,14 +25,17 @@ public static MauiApp CreateMauiApp()
                 options.Debug = true;
                 options.SampleRate = 1.0F;
 
-#if ANDROID
+#if __ANDROID__
                 // Currently experimental support is only available on Android
                 options.Native.ExperimentalOptions.SessionReplay.OnErrorSampleRate = 1.0;
                 options.Native.ExperimentalOptions.SessionReplay.SessionSampleRate = 1.0;
-                // Mask all images and text by default.
-                // This can be overridden for individual view elements (see MainPage.xaml for an example)
+                // Mask all images and text by default. This can be overridden for individual view elements via the
+                // sentry:SessionReplay.Mask XML attribute (see MainPage.xaml for an example)
                 options.Native.ExperimentalOptions.SessionReplay.MaskAllImages = true;
                 options.Native.ExperimentalOptions.SessionReplay.MaskAllText = true;
+                // Alternatively the masking behaviour for entire classes of VisualElements can be configured here as
+                // an exception to the default behaviour.
+                options.Native.ExperimentalOptions.SessionReplay.UnmaskControlsOfType<Button>();
 #endif
 
                 options.SetBeforeScreenshotCapture((@event, hint) =>

samples/Sentry.Samples.Maui/Platforms/Android/MainActivity.cs

@@ -1,5 +1,8 @@
+#if __ANDROID__
 using Android.App;
 using Android.Content.PM;
+using Android.OS;
+#endif
 
 namespace Sentry.Samples.Maui;
 

src/Sentry.Maui/Internal/MauiEventsBinder.cs

@@ -1,4 +1,9 @@
 using Microsoft.Extensions.Options;
+using Microsoft.Maui.Platform;
+using Sentry.Extensibility;
+#if __ANDROID__
+using View = Android.Views.View;
+#endif
 
 namespace Sentry.Maui.Internal;
 
@@ -245,11 +250,13 @@ internal void HandleVisualElementEvents(VisualElement element, bool bind = true)
         {
             element.Focused += OnElementOnFocused;
             element.Unfocused += OnElementOnUnfocused;
+            element.Loaded += OnElementLoaded;
         }
         else
         {
             element.Focused -= OnElementOnFocused;
             element.Unfocused -= OnElementOnUnfocused;
+            element.Loaded -= OnElementLoaded;
         }
     }
 
@@ -409,6 +416,40 @@ private void OnElementOnFocused(object? sender, FocusEventArgs _) =>
     private void OnElementOnUnfocused(object? sender, FocusEventArgs _) =>
         _hub.AddBreadcrumbForEvent(_options, sender, nameof(VisualElement.Unfocused), SystemType, RenderingCategory);
 
+    private void OnElementLoaded(object? sender, EventArgs _)
+    {
+        if (sender is not VisualElement element)
+        {
+            _options.LogDebug("OnElementLoaded: sender is not a VisualElement");
+            return;
+        }
+
+        var handler = element.Handler;
+        if (handler is null)
+        {
+            _options.LogDebug("OnElementLoaded: element.Handler is null");
+            return;
+        }
+
+#if __ANDROID__
+        if (element.Handler?.PlatformView is not View nativeView)
+        {
+            return;
+        }
+
+        if (_options.Native.ExperimentalOptions.SessionReplay.MaskedControls.Contains(sender.GetType()))
+        {
+            nativeView.Tag = "sentry-mask";
+            _options.LogDebug("OnElementLoaded: Successfully set sentry-mask tag on native view");
+        }
+        else if (_options.Native.ExperimentalOptions.SessionReplay.UnmaskedControls.Contains(element.GetType()))
+        {
+            nativeView.Tag = "sentry-unmask";
+            _options.LogDebug("OnElementLoaded: Successfully set sentry-unmask tag on native view");
+        }
+#endif
+    }
+
     // Shell Events
 
     private void OnShellOnNavigating(object? sender, ShellNavigatingEventArgs e) =>

src/Sentry.Maui/SentryMauiOptions.cs

@@ -81,7 +81,7 @@ public SentryMauiOptions()
     /// if this callback return false the capture will not take place
     /// </remarks>
     /// <code>
-    /// 
+    ///
     ///options.SetBeforeCapture((@event, hint) =>
     ///{
     ///    // Return true to capture or false to prevent the capture

src/Sentry.Maui/SessionReplay.cs

@@ -1,5 +1,9 @@
 #if __ANDROID__
 using View = Android.Views.View;
+using Android.Views;
+using Java.Lang;
+using Microsoft.Maui.Handlers;
+using Microsoft.Maui.Platform;
 #endif
 
 namespace Sentry.Maui;

src/Sentry/Platforms/Android/NativeOptions.cs

@@ -272,6 +272,18 @@ public class NativeSentryReplayOptions
             public double? SessionSampleRate { get; set; }
             public bool MaskAllImages { get; set; } = true;
             public bool MaskAllText { get; set; } = true;
+            internal HashSet<Type> MaskedControls { get; } = [];
+            internal HashSet<Type> UnmaskedControls { get; } = [];
+
+            public void MaskControlsOfType<T>()
+            {
+                MaskedControls.Add(typeof(T));
+            }
+
+            public void UnmaskControlsOfType<T>()
+            {
+                UnmaskedControls.Add(typeof(T));
+            }
         }
 
         /// <summary>