fix(MAUI): Automatically captured breadcrumbs

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+### Fixes
+
+- Reduced noise created by automatically captured breadcrumbs on MAUI ([#2900](https://github.com/getsentry/sentry-dotnet/pull/2900))
+- The SDK no longer consumes third-party events on MAUI ([#2900](https://github.com/getsentry/sentry-dotnet/pull/2900))
+
 ### API breaking Changes
 
 #### Removed APIs

samples/Sentry.Samples.Maui/MainPage.xaml.cs

@@ -17,6 +17,8 @@
 
     protected override void OnAppearing()
     {
+        AddHandlerBreadcrumbs();
+
 #if !ANDROID
         JavaCrashBtn.IsVisible = false;
 #endif
@@ -27,6 +29,28 @@
         base.OnAppearing();
     }
 
+    private void AddHandlerBreadcrumbs()
+    {
+        foreach (var visualElement in GetVisualTreeDescendants())
+        {
+            if (visualElement is Element element)
+            {
+                element.HandlerChanged += (sender, _) =>
+                {
+                    // The StyleId correlates to the element's name if one is set in XAML
+                    var elementName = element.StyleId;
+                    if (elementName is not null)
+                    {
+                        var type = element.Handler?.GetType();
+                        var handlerName = type is not null ? type.Name : string.Empty;
+
+                        SentrySdk.AddBreadcrumb($"'{elementName}' handler changed to '{handlerName}'", "system", "ui.handlers");
+                    }
+                };
+            }
+        }
+    }
+
     private void OnCounterClicked(object sender, EventArgs e)
     {
         _count++;
@@ -88,4 +112,3 @@
 #endif
     }
 }
-

src/Sentry.Maui/Internal/IMauiEventsBinder.cs

@@ -4,8 +4,6 @@ internal interface IMauiEventsBinder
 {
     void BindApplicationEvents(Application application);
 
-    void BindReflectedEvents(BindableObject bindableObject, bool includeExplicitlyHandledTypes = false);
-
     void BindWindowEvents(Window window);
 
     void BindElementEvents(Element element);

src/Sentry.Maui/Internal/MauiEventsBinder.cs

@@ -1,5 +1,4 @@
 using Microsoft.Extensions.Options;
-using Sentry.Extensibility;
 
 namespace Sentry.Maui.Internal;
 
@@ -13,26 +12,11 @@ internal class MauiEventsBinder : IMauiEventsBinder
     internal const string NavigationType = "navigation";
     internal const string SystemType = "system";
     internal const string UserType = "user";
-    internal const string HandlersCategory = "ui.handlers";
     internal const string LifecycleCategory =  "ui.lifecycle";
     internal const string NavigationCategory = "navigation";
     internal const string RenderingCategory = "ui.rendering";
     internal const string UserActionCategory = "ui.useraction";
 
-    // This list should contain all types that we have explicitly added handlers for their events.
-    // Any elements that are not in this list will have their events discovered by reflection.
-    internal static readonly HashSet<Type> ExplicitlyHandledTypes = new()
-    {
-        typeof(BindableObject),
-        typeof(Element),
-        typeof(VisualElement),
-        typeof(Application),
-        typeof(Window),
-        typeof(Shell),
-        typeof(Page),
-        typeof(Button),
-    };
-
     public MauiEventsBinder(IHub hub, IOptions<SentryMauiOptions> options)
     {
         _hub = hub;
@@ -52,10 +36,6 @@ public void BindApplicationEvents(Application application)
                 BindVisualElementEvents(visualElement);
             }
 
-            // We'll use reflection to attach to other events
-            // This allows us to attach to events from custom controls
-            BindReflectedEvents(e.Element);
-
             // We can also attach to specific events on built-in controls
             // Be sure to update ExplicitlyHandledTypes when adding to this list
             switch (e.Element)
@@ -87,15 +67,9 @@ public void BindApplicationEvents(Application application)
         application.PageDisappearing += (sender, page) =>
             _hub.AddBreadcrumbForEvent(_options, sender, nameof(Application.PageDisappearing), NavigationType, NavigationCategory,
                 data => data.AddElementInfo(_options, page, nameof(Page)));
-        application.ModalPushing += (sender, e) =>
-            _hub.AddBreadcrumbForEvent(_options, sender, nameof(Application.ModalPushing), NavigationType, NavigationCategory,
-                data => data.AddElementInfo(_options, e.Modal, nameof(e.Modal)));
         application.ModalPushed += (sender, e) =>
             _hub.AddBreadcrumbForEvent(_options, sender, nameof(Application.ModalPushed), NavigationType, NavigationCategory,
                 data => data.AddElementInfo(_options, e.Modal, nameof(e.Modal)));
-        application.ModalPopping += (sender, e) =>
-            _hub.AddBreadcrumbForEvent(_options, sender, nameof(Application.ModalPopping), NavigationType, NavigationCategory,
-                data => data.AddElementInfo(_options, e.Modal, nameof(e.Modal)));
         application.ModalPopped += (sender, e) =>
             _hub.AddBreadcrumbForEvent(_options, sender, nameof(Application.ModalPopped), NavigationType, NavigationCategory,
                 data => data.AddElementInfo(_options, e.Modal, nameof(e.Modal)));
@@ -107,47 +81,6 @@ public void BindApplicationEvents(Application application)
                 data => data.Add(nameof(e.RequestedTheme), e.RequestedTheme.ToString()));
     }
 
-    public void BindReflectedEvents(BindableObject bindableObject, bool includeExplicitlyHandledTypes = false)
-    {
-        // This reflects over the object's events.
-        // By default, it attaches only to events that are *NOT* declared by types in the ExplicitlyHandledTypes list.
-        // We will only include such events when testing.
-
-        var type = bindableObject.GetType();
-
-        IEnumerable<EventInfo> events = type.GetEvents(BindingFlags.Instance | BindingFlags.Public);
-        if (!includeExplicitlyHandledTypes)
-        {
-            events = events.Where(e => !ExplicitlyHandledTypes.Contains(e.DeclaringType!));
-        }
-
-        foreach (var eventInfo in events)
-        {
-            var browsable = eventInfo.GetCustomAttribute<EditorBrowsableAttribute>();
-            if (browsable != null && browsable.State != EditorBrowsableState.Always)
-            {
-                // These events are not meant for typical consumption.
-                continue;
-            }
-
-            Action<object, object> handler = (sender, _) =>
-            {
-                _hub.AddBreadcrumbForEvent(_options, sender, eventInfo.Name);
-            };
-
-            try
-            {
-                var typedHandler = Delegate.CreateDelegate(eventInfo.EventHandlerType!, handler.Target, handler.Method);
-                eventInfo.AddEventHandler(bindableObject, typedHandler);
-            }
-            catch (Exception ex)
-            {
-                // Don't throw if we can't bind the event handler
-                _options.DiagnosticLogger?.LogError(ex, "Couldn't bind to {0}.{1}", type.Name, eventInfo.Name);
-            }
-        }
-    }
-
     public void BindWindowEvents(Window window)
     {
         // Lifecycle Events
@@ -192,15 +125,9 @@ public void BindWindowEvents(Window window)
                 });
 
         // Navigation events
-        window.ModalPushing += (sender, e) =>
-            _hub.AddBreadcrumbForEvent(_options, sender, nameof(Window.ModalPushing), NavigationType, NavigationCategory,
-                data => data.AddElementInfo(_options, e.Modal, nameof(e.Modal)));
         window.ModalPushed += (sender, e) =>
             _hub.AddBreadcrumbForEvent(_options, sender, nameof(Window.ModalPushed), NavigationType, NavigationCategory,
                 data => data.AddElementInfo(_options, e.Modal, nameof(e.Modal)));
-        window.ModalPopping += (sender, e) =>
-            _hub.AddBreadcrumbForEvent(_options, sender, nameof(Window.ModalPopping), NavigationType, NavigationCategory,
-                data => data.AddElementInfo(_options, e.Modal, nameof(e.Modal)));
         window.ModalPopped += (sender, e) =>
             _hub.AddBreadcrumbForEvent(_options, sender, nameof(Window.ModalPopped), NavigationType, NavigationCategory,
                 data => data.AddElementInfo(_options, e.Modal, nameof(e.Modal)));
@@ -210,37 +137,13 @@ public void BindWindowEvents(Window window)
 
     public void BindElementEvents(Element element)
     {
-        // Element handler events
-        // https://docs.microsoft.com/dotnet/maui/user-interface/handlers/customize#handler-lifecycle
-        element.HandlerChanging += (sender, e) =>
-            _hub.AddBreadcrumbForEvent(_options, sender, nameof(Element.HandlerChanging), SystemType, HandlersCategory,
-                data =>
-                {
-                    data.Add(nameof(e.OldHandler), e.OldHandler?.ToStringOrTypeName() ?? "");
-                    data.Add(nameof(e.NewHandler), e.NewHandler?.ToStringOrTypeName() ?? "");
-                });
-        element.HandlerChanged += (sender, _) =>
-            _hub.AddBreadcrumbForEvent(_options, sender, nameof(Element.HandlerChanged), SystemType, HandlersCategory,
-                data =>
-                {
-                    var e = sender as Element;
-                    data.Add(nameof(e.Handler), e?.Handler?.ToStringOrTypeName() ?? "");
-                });
-
         // Rendering events
         element.ChildAdded += (sender, e) =>
             _hub.AddBreadcrumbForEvent(_options, sender, nameof(Element.ChildAdded), SystemType, RenderingCategory,
                 data => data.AddElementInfo(_options, e.Element, nameof(e.Element)));
         element.ChildRemoved += (sender, e) =>
             _hub.AddBreadcrumbForEvent(_options, sender, nameof(Element.ChildRemoved), SystemType, RenderingCategory,
                 data => data.AddElementInfo(_options, e.Element, nameof(e.Element)));
-        element.ParentChanging += (sender, e) =>
-            _hub.AddBreadcrumbForEvent(_options, sender, nameof(Element.ParentChanging), SystemType, RenderingCategory,
-                data =>
-                {
-                    data.AddElementInfo(_options, e.OldParent, nameof(e.OldParent));
-                    data.AddElementInfo(_options, e.NewParent, nameof(e.NewParent));
-                });
         element.ParentChanged += (sender, _) =>
             _hub.AddBreadcrumbForEvent(_options, sender, nameof(Element.ParentChanged), SystemType, RenderingCategory,
                 data =>
@@ -271,10 +174,6 @@ public void BindElementEvents(Element element)
                 data =>
                     data.Add(nameof(BindableObject.BindingContext), bindingContext.ToStringOrTypeName()));
         };
-
-        // NotifyPropertyChanged events are too noisy to be useful
-        // element.PropertyChanging
-        // element.PropertyChanged
     }
 
     public void BindVisualElementEvents(VisualElement element)
@@ -284,21 +183,6 @@ public void BindVisualElementEvents(VisualElement element)
 
         element.Unfocused += (sender, _) =>
             _hub.AddBreadcrumbForEvent(_options, sender, nameof(VisualElement.Unfocused), SystemType, RenderingCategory);
-
-        element.Loaded += (sender, _) =>
-            _hub.AddBreadcrumbForEvent(_options, sender, nameof(VisualElement.Loaded), SystemType, RenderingCategory);
-
-        element.Unloaded += (sender, _) =>
-            _hub.AddBreadcrumbForEvent(_options, sender, nameof(VisualElement.Unloaded), SystemType, RenderingCategory);
-
-        element.ChildrenReordered += (sender, _) =>
-            _hub.AddBreadcrumbForEvent(_options, sender, nameof(VisualElement.ChildrenReordered), SystemType, RenderingCategory);
-
-        element.MeasureInvalidated += (sender, _) =>
-            _hub.AddBreadcrumbForEvent(_options, sender, nameof(VisualElement.MeasureInvalidated), SystemType, RenderingCategory);
-
-        element.SizeChanged += (sender, _) =>
-            _hub.AddBreadcrumbForEvent(_options, sender, nameof(VisualElement.SizeChanged), SystemType, RenderingCategory);
     }
 
     public void BindShellEvents(Shell shell)
@@ -337,11 +221,6 @@ public void BindPageEvents(Page page)
 
         // Navigation events
         // https://github.com/dotnet/docs-maui/issues/583
-        page.NavigatingFrom += (sender, _) =>
-            _hub.AddBreadcrumbForEvent(_options, sender, nameof(Page.NavigatingFrom), NavigationType, NavigationCategory);
-        page.NavigatedFrom += (sender, e) =>
-            _hub.AddBreadcrumbForEvent(_options, sender, nameof(Page.NavigatedFrom), NavigationType, NavigationCategory,
-                data => data.AddElementInfo(_options, e.GetDestinationPage(), "DestinationPage"));
         page.NavigatedTo += (sender, e) =>
             _hub.AddBreadcrumbForEvent(_options, sender, nameof(Page.NavigatedTo), NavigationType, NavigationCategory,
                 data => data.AddElementInfo(_options, e.GetPreviousPage(), "PreviousPage"));

test/Sentry.Maui.Tests/MauiEventsBinderTests.Application.cs

@@ -88,9 +88,7 @@ public static IEnumerable<object[]> ApplicationModalEventsData
             return new List<object[]>
             {
                 // Note, these are distinct from the Window events with the same names.
-                new object[] {nameof(Application.ModalPushing), new ModalPushingEventArgs(modelPage)},
                 new object[] {nameof(Application.ModalPushed), new ModalPushedEventArgs(modelPage)},
-                new object[] {nameof(Application.ModalPopping), new ModalPoppingEventArgs(modelPage)},
                 new object[] {nameof(Application.ModalPopped), new ModalPoppedEventArgs(modelPage)}
             };
         }