Renamed binder to MauiSessionReplayMaskControlsOfTypeBinder

Author: jamescrosswell

samples/Sentry.Samples.Maui/MauiProgram.cs

@@ -45,15 +45,18 @@ public static MauiApp CreateMauiApp()
                 options.AddCommunityToolkitIntegration();
 
 #if __ANDROID__
-                // Currently experimental support is only available on 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 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
+                // Alternatively, the masking behaviour for entire classes of VisualElements can be configured here as
                 // an exception to the default behaviour.
+                // WARNING: In apps with complex user interfaces, consisting of hundreds of visual controls on a single
+                // page, this option may cause performance issues. In such cases, consider applying the
+                // sentry:SessionReplay.Mask="Unmask" attribute to individual controls instead.
                 options.Native.ExperimentalOptions.SessionReplay.UnmaskControlsOfType<Button>();
 #endif
 

src/Sentry.Maui/Internal/MauiCustomSessionReplayMaskBinder.cs renamed to src/Sentry.Maui/Internal/MauiSessionReplayMaskControlsOfTypeBinder.cs

@@ -74,7 +74,7 @@ public static MauiAppBuilder UseSentry(this MauiAppBuilder builder,
         configureOptions?.Invoke(options);
 #if __ANDROID__
         var replayOptions = options.Native.ExperimentalOptions.SessionReplay;
-        if (replayOptions is { IsCustomMaskingEnabled: true, IsSessionReplayEnabled: true })
+        if (replayOptions is { IsSessionReplayEnabled: true, IsTypeMaskingUsed: true })
         {
             services.AddSingleton<IMauiElementEventBinder, MauiCustomSessionReplayMaskBinder>();
         }

src/Sentry.Maui/SentryMauiAppBuilderExtensions.cs

@@ -276,40 +276,39 @@ public class NativeSentryReplayOptions
             internal HashSet<Type> MaskedControls { get; } = [];
             internal HashSet<Type> UnmaskedControls { get; } = [];
 
-            internal bool IsCustomMaskingEnabled { get; private set; }
-
             internal bool IsSessionReplayEnabled => OnErrorSampleRate > 0.0 || SessionSampleRate > 0.0;
 
+            /// <summary>
+            /// Allows you to mask all controls of a particular type for session replay recordings.
+            /// </summary>
+            /// <typeparam name="T">The Type of control that should be masked</typeparam>
+            /// <remarks>
+            /// WARNING: In apps with complex user interfaces, consisting of hundreds of visual controls on a single
+            /// page, this option may cause performance issues. In such cases, consider applying SessionReplay.Mask
+            /// attributes to individual controls instead:
+            /// <code>sentry:SessionReplay.Mask="Mask"</code>
+            /// </remarks>
             public void MaskControlsOfType<T>()
             {
                 MaskedControls.Add(typeof(T));
             }
 
-            public void UnmaskControlsOfType<T>()
-            {
-                UnmaskedControls.Add(typeof(T));
-            }
-
             /// <summary>
-            /// <para>
-            /// The <see cref="MaskAllImages"/> and <see cref="MaskAllText"/> and <see cref="MaskControlsOfType"/>
-            /// options allow you to set the default masking behaviour for all visual elements of certain types.
-            /// </para>
-            /// <para>
-            /// This option enables the use of `sentry:SessionReplay.Mask` attributes to override the masking behaviour
-            /// of specific visual elemennts (for example masking a specific image even though images more generally are
-            /// not masked).
-            /// </para>
+            /// Allows you to unmask all controls of a particular type for session replay recordings.
+            /// </summary>
+            /// <typeparam name="T">The Type of control that should be unmasked</typeparam>
             /// <remarks>
             /// WARNING: In apps with complex user interfaces, consisting of hundreds of visual controls on a single
-            /// page, enabling this option may cause performance issues.
+            /// page, this option may cause performance issues. In such cases, consider applying SessionReplay.Mask
+            /// attributes to individual controls instead:
+            /// <code>sentry:SessionReplay.Mask="Unmask"</code>
             /// </remarks>
-            /// </summary>
-            public NativeSentryReplayOptions EnableCustomSessionReplayMasks()
+            public void UnmaskControlsOfType<T>()
             {
-                IsCustomMaskingEnabled = true;
-                return this;
+                UnmaskedControls.Add(typeof(T));
             }
+
+            internal bool IsTypeMaskingUsed => MaskedControls.Count > 0 || UnmaskedControls.Count > 0;
         }
 
         /// <summary>