MAUI Gesture Recognizer Auto-Breadcrumbs

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 - Added `CaptureFeedback` overload with `configureScope` parameter ([#4073](https://github.com/getsentry/sentry-dotnet/pull/4073))
 - Custom SessionReplay masks in MAUI Android apps ([#4121](https://github.com/getsentry/sentry-dotnet/pull/4121))
+- Auto breadcrumbs now include all .NET MAUI gesture recognizer events ([#4124](https://github.com/getsentry/sentry-dotnet/pull/4124))
 
 ### Fixes
 

samples/Sentry.Samples.Maui/MainPage.xaml

@@ -15,7 +15,11 @@
                 sentry:SessionReplay.Mask="Unmask"
                 SemanticProperties.Description="Cute dot net bot waving hi to you!"
                 HeightRequest="200"
-                HorizontalOptions="Center" />
+                HorizontalOptions="Center">
+                <Image.GestureRecognizers>
+                    <TapGestureRecognizer Tapped="TapGestureRecognizer_OnTapped" />
+                </Image.GestureRecognizers>
+            </Image>
 
             <Label
                 Text="Hello, World!"

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

@@ -100,4 +100,8 @@ private async void OnFeedbackClicked(object sender, EventArgs e)
     {
         await Navigation.PushModalAsync(new SubmitFeedback());
     }
+
+    private void TapGestureRecognizer_OnTapped(object sender, TappedEventArgs e)
+    {
+    }
 }

src/Sentry.Maui/Internal/MauiGestureRecognizerEventsBinder.cs

@@ -0,0 +1,197 @@
+namespace Sentry.Maui.Internal;
+
+/// <summary>
+/// Detects and breadcrumbs any gesture recognizers attached to the visual element
+/// </summary>
+public class MauiGestureRecognizerEventsBinder : IMauiElementEventBinder
+{
+    private static Action<BreadcrumbEvent>? _addBreadcrumb = null!;
+
+    /// <summary>
+    /// Searches VisualElement for gesture recognizers to bind to
+    /// </summary>
+    public void Bind(VisualElement element, Action<BreadcrumbEvent> addBreadcrumb)
+    {
+        _addBreadcrumb ??= addBreadcrumb; // this is fine... it's the same callback for everyone and it never changes
+        TryBind(element, true);
+    }
+
+
+    /// <summary>
+    /// Searches VisualElement for gesture recognizers to unbind from
+    /// </summary>
+    /// <param name="element"></param>
+    public void UnBind(VisualElement element)
+    {
+        _addBreadcrumb = null;
+        TryBind(element, false);
+    }
+
+    private static void TryBind(VisualElement element, bool bind)
+    {
+        if (element is IGestureRecognizers recognizers)
+        {
+            foreach (var recognizer in recognizers.GestureRecognizers)
+            {
+                SetHooks(recognizer, bind);
+            }
+        }
+    }
+
+
+    private static void SetHooks(IGestureRecognizer recognizer, bool bind)
+    {
+        switch (recognizer)
+        {
+            case TapGestureRecognizer tap:
+                tap.Tapped -= OnTapGesture;
+
+                if (bind)
+                {
+                    tap.Tapped += OnTapGesture;
+                }
+                break;
+
+            case SwipeGestureRecognizer swipe:
+                swipe.Swiped -= OnSwipeGesture;
+
+                if (bind)
+                {
+                    swipe.Swiped += OnSwipeGesture;
+                }
+                break;
+
+            case PinchGestureRecognizer pinch:
+                pinch.PinchUpdated -= OnPinchGesture;
+
+                if (bind)
+                {
+                    pinch.PinchUpdated += OnPinchGesture;
+                }
+                break;
+
+            case DragGestureRecognizer drag:
+                drag.DragStarting -= OnDragStartingGesture;
+                drag.DropCompleted -= OnDropCompletedGesture;
+
+                if (bind)
+                {
+                    drag.DragStarting += OnDragStartingGesture;
+                    drag.DropCompleted += OnDropCompletedGesture;
+                }
+                break;
+
+            case PanGestureRecognizer pan:
+                pan.PanUpdated -= OnPanGesture;
+
+                if (bind)
+                {
+                    pan.PanUpdated += OnPanGesture;
+                }
+                break;
+
+            case PointerGestureRecognizer pointer:
+                pointer.PointerEntered -= OnPointerEnteredGesture;
+                pointer.PointerExited -= OnPointerExitedGesture;
+                pointer.PointerMoved -= OnPointerMovedGesture;
+                pointer.PointerPressed -= OnPointerPressedGesture;
+                pointer.PointerReleased -= OnPointerReleasedGesture;
+
+                if (bind)
+                {
+                    pointer.PointerEntered += OnPointerEnteredGesture;
+                    pointer.PointerExited += OnPointerExitedGesture;
+                    pointer.PointerMoved += OnPointerMovedGesture;
+                    pointer.PointerPressed += OnPointerPressedGesture;
+                    pointer.PointerReleased += OnPointerReleasedGesture;
+                }
+                break;
+        }
+    }
+
+    private static void OnPointerReleasedGesture(object? sender, PointerEventArgs e) => _addBreadcrumb?.Invoke(new(
+        sender,
+        nameof(PointerGestureRecognizer.PointerReleased),
+        ToPointerData(e)
+    ));
+
+    private static void OnPointerPressedGesture(object? sender, PointerEventArgs e) => _addBreadcrumb?.Invoke(new(
+        sender,
+        nameof(PointerGestureRecognizer.PointerPressed),
+        ToPointerData(e)
+    ));
+
+    private static void OnPointerMovedGesture(object? sender, PointerEventArgs e) => _addBreadcrumb?.Invoke(new(
+        sender,
+        nameof(PointerGestureRecognizer.PointerMoved),
+        ToPointerData(e)
+    ));
+
+    private static void OnPointerExitedGesture(object? sender, PointerEventArgs e) => _addBreadcrumb?.Invoke(new(
+        sender,
+        nameof(PointerGestureRecognizer.PointerExited),
+        ToPointerData(e)
+    ));
+
+    private static void OnPointerEnteredGesture(object? sender, PointerEventArgs e) => _addBreadcrumb?.Invoke(new(
+        sender,
+        nameof(PointerGestureRecognizer.PointerEntered),
+        ToPointerData(e)
+    ));
+
+    private static IEnumerable<(string Key, string Value)> ToPointerData(PointerEventArgs e) =>
+    [
+        // some of the data here may have some challenges being pulled out
+        #if ANDROID
+        ("MotionEventAction", e.PlatformArgs?.MotionEvent.Action.ToString() ?? string.Empty)
+        //("MotionEventActionButton", e.PlatformArgs?.MotionEvent.ActionButton.ToString() ?? String.Empty)
+        #elif IOS
+        ("State", e.PlatformArgs?.GestureRecognizer.State.ToString() ?? string.Empty),
+        //("ButtonMask", e.PlatformArgs?.GestureRecognizer.ButtonMask.ToString() ?? String.Empty)
+        #endif
+    ];
+
+    private static void OnPanGesture(object? sender, PanUpdatedEventArgs e) => _addBreadcrumb?.Invoke(new(
+        sender,
+        nameof(PanGestureRecognizer.PanUpdated),
+        [
+            ("GestureId", e.GestureId.ToString()),
+            ("StatusType", e.StatusType.ToString()),
+            ("TotalX", e.TotalX.ToString()),
+            ("TotalY", e.TotalY.ToString())
+        ]
+    ));
+
+    private static void OnDropCompletedGesture(object? sender, DropCompletedEventArgs e) => _addBreadcrumb?.Invoke(new(
+        sender,
+        nameof(DragGestureRecognizer.DropCompleted)
+    ));
+
+    private static void OnDragStartingGesture(object? sender, DragStartingEventArgs e) => _addBreadcrumb?.Invoke(new(
+        sender,
+        nameof(DragGestureRecognizer.DragStarting)
+    ));
+
+
+    private static void OnPinchGesture(object? sender, PinchGestureUpdatedEventArgs e) => _addBreadcrumb?.Invoke(new(
+        sender,
+        nameof(PinchGestureRecognizer.PinchUpdated),
+        [
+            ("GestureStatus", e.Status.ToString()),
+            ("Scale", e.Scale.ToString()),
+            ("ScaleOrigin", e.ScaleOrigin.ToString())
+        ]
+    ));
+
+    private static void OnSwipeGesture(object? sender, SwipedEventArgs e) => _addBreadcrumb?.Invoke(new(
+        sender,
+        nameof(SwipeGestureRecognizer.Swiped),
+        [("Direction", e.Direction.ToString())]
+    ));
+
+    private static void OnTapGesture(object? sender, TappedEventArgs e) => _addBreadcrumb?.Invoke(new(
+        sender,
+        nameof(TapGestureRecognizer.Tapped),
+        [("ButtonMask", e.Buttons.ToString())]
+    ));
+}

src/Sentry.Maui/SentryMauiAppBuilderExtensions.cs

@@ -57,6 +57,7 @@ public static MauiAppBuilder UseSentry(this MauiAppBuilder builder,
 
         services.AddSingleton<IMauiElementEventBinder, MauiButtonEventsBinder>();
         services.AddSingleton<IMauiElementEventBinder, MauiImageButtonEventsBinder>();
+        services.AddSingleton<IMauiElementEventBinder, MauiGestureRecognizerEventsBinder>();
         services.AddSingleton<IMauiElementEventBinder, MauiVisualElementEventsBinder>();
         services.TryAddSingleton<IMauiEventsBinder, MauiEventsBinder>();
 

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

@@ -0,0 +1,97 @@
+using Sentry.Maui.Internal;
+
+namespace Sentry.Maui.Tests;
+
+public partial class MauiEventsBinderTests
+{
+    [Fact]
+    public void TapGestureRecognizer_LifecycleEvents_AddsBreadcrumb()
+    {
+        var gesture = new TapGestureRecognizer();
+        TestGestureRecognizer(
+            gesture,
+            nameof(TapGestureRecognizer.Tapped),
+            new TappedEventArgs(gesture)
+        );
+    }
+
+
+    [Fact]
+    public void SwipeGestureRecognizer_LifecycleEvents_AddsBreadcrumb()
+    {
+        var gesture = new SwipeGestureRecognizer();
+        TestGestureRecognizer(
+            gesture,
+            nameof(SwipeGestureRecognizer.Swiped),
+            new SwipedEventArgs(gesture, SwipeDirection.Down)
+        );
+    }
+
+    [Fact]
+    public void PinchGestureRecognizer_LifecycleEvents_AddsBreadcrumb()
+    {
+        TestGestureRecognizer(
+            new PinchGestureRecognizer(),
+            nameof(PinchGestureRecognizer.PinchUpdated),
+            new PinchGestureUpdatedEventArgs(GestureStatus.Completed, 0, Point.Zero)
+        );
+    }
+
+    [Theory]
+    [InlineData(nameof(DragGestureRecognizer.DragStarting))]
+    [InlineData(nameof(DragGestureRecognizer.DropCompleted))]
+    public void DragGestureRecognizer_LifecycleEvents_AddsBreadcrumb(string eventName)
+    {
+        TestGestureRecognizer(
+            new DragGestureRecognizer(),
+            eventName,
+            DragStartingEventArgs.Empty
+        );
+    }
+
+    [Fact]
+    public void PanGestureRecognizer_LifecycleEvents_AddsBreadcrumb()
+    {
+        TestGestureRecognizer(
+            new PanGestureRecognizer(),
+            nameof(PanGestureRecognizer.PanUpdated),
+            new PanUpdatedEventArgs(GestureStatus.Completed, 1, 0, 0)
+        );
+    }
+
+    [Theory]
+    [InlineData(nameof(PointerGestureRecognizer.PointerEntered))]
+    [InlineData(nameof(PointerGestureRecognizer.PointerExited))]
+    [InlineData(nameof(PointerGestureRecognizer.PointerMoved))]
+    [InlineData(nameof(PointerGestureRecognizer.PointerPressed))]
+    [InlineData(nameof(PointerGestureRecognizer.PointerReleased))]
+    public void PointerGestureRecognizer_LifecycleEvents_AddsBreadcrumb(string eventName)
+    {
+        TestGestureRecognizer(
+            new PointerGestureRecognizer(),
+            eventName,
+            PointerEventArgs.Empty
+        );
+    }
+
+
+    private void TestGestureRecognizer(GestureRecognizer gesture, string eventName, object eventArgs)
+    {
+        var image = new Image();
+        image.GestureRecognizers.Add(gesture);
+
+        var args = new ElementEventArgs(image);
+        _fixture.Binder.OnApplicationOnDescendantAdded(null, args);
+
+        // Act
+        gesture.RaiseEvent(eventName, eventArgs);
+
+        // Assert
+        var crumb = Assert.Single(_fixture.Scope.Breadcrumbs);
+        Assert.Equal($"{gesture.GetType().Name}.{eventName}", crumb.Message);
+        Assert.Equal(BreadcrumbLevel.Info, crumb.Level);
+        Assert.Equal(MauiEventsBinder.SystemType, crumb.Type);
+        Assert.Equal(MauiEventsBinder.LifecycleCategory, crumb.Category);
+        // crumb.Data.Should().Contain($"{gesture.GetType().Name}.Name", "tapgesturerecognizer");
+    }
+}

test/Sentry.Maui.Tests/MauiEventsBinderTests.cs

@@ -28,7 +28,8 @@ public Fixture()
                 options,
                 [
                     new MauiButtonEventsBinder(),
-                    new MauiImageButtonEventsBinder()
+                    new MauiImageButtonEventsBinder(),
+                    new MauiGestureRecognizerEventsBinder()
                 ]
             );
         }