MAUI CommunityToolkit MVVM auto instrumentation of async commands

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- .NET MAUI integration with CommunityToolkit.Mvvm Async Relay Commands can now be auto spanned with the new package Sentry.Maui.CommunityToolkit.Mvvm ([#4125](https://github.com/getsentry/sentry-dotnet/pull/4125))
+
 ### Dependencies
 
 - Bump Native SDK from v0.8.4 to v0.8.5 ([#4189](https://github.com/getsentry/sentry-dotnet/pull/4189))

Sentry-CI-Build-Linux.slnf

@@ -44,6 +44,7 @@
       "src\\Sentry.Google.Cloud.Functions\\Sentry.Google.Cloud.Functions.csproj",
       "src\\Sentry.Hangfire\\Sentry.Hangfire.csproj",
       "src\\Sentry.Log4Net\\Sentry.Log4Net.csproj",
+      "src\\Sentry.Maui.CommunityToolkit.Mvvm\\Sentry.Maui.CommunityToolkit.Mvvm.csproj",
       "src\\Sentry.Maui\\Sentry.Maui.csproj",
       "src\\Sentry.NLog\\Sentry.NLog.csproj",
       "src\\Sentry.OpenTelemetry\\Sentry.OpenTelemetry.csproj",
@@ -65,6 +66,7 @@
       "test\\Sentry.Google.Cloud.Functions.Tests\\Sentry.Google.Cloud.Functions.Tests.csproj",
       "test\\Sentry.Hangfire.Tests\\Sentry.Hangfire.Tests.csproj",
       "test\\Sentry.Log4Net.Tests\\Sentry.Log4Net.Tests.csproj",
+      "test\\Sentry.Maui.CommunityToolkit.Mvvm.Tests\\Sentry.Maui.CommunityToolkit.Mvvm.Tests.csproj",
       "test\\Sentry.Maui.Tests\\Sentry.Maui.Tests.csproj",
       "test\\Sentry.NLog.Tests\\Sentry.NLog.Tests.csproj",
       "test\\Sentry.OpenTelemetry.Tests\\Sentry.OpenTelemetry.Tests.csproj",

Sentry-CI-Build-Windows.slnf

@@ -46,6 +46,7 @@
       "src\\Sentry.Google.Cloud.Functions\\Sentry.Google.Cloud.Functions.csproj",
       "src\\Sentry.Hangfire\\Sentry.Hangfire.csproj",
       "src\\Sentry.Log4Net\\Sentry.Log4Net.csproj",
+      "src\\Sentry.Maui.CommunityToolkit.Mvvm\\Sentry.Maui.CommunityToolkit.Mvvm.csproj",
       "src\\Sentry.Maui\\Sentry.Maui.csproj",
       "src\\Sentry.NLog\\Sentry.NLog.csproj",
       "src\\Sentry.OpenTelemetry\\Sentry.OpenTelemetry.csproj",
@@ -67,6 +68,7 @@
       "test\\Sentry.Google.Cloud.Functions.Tests\\Sentry.Google.Cloud.Functions.Tests.csproj",
       "test\\Sentry.Hangfire.Tests\\Sentry.Hangfire.Tests.csproj",
       "test\\Sentry.Log4Net.Tests\\Sentry.Log4Net.Tests.csproj",
+      "test\\Sentry.Maui.CommunityToolkit.Mvvm.Tests\\Sentry.Maui.CommunityToolkit.Mvvm.Tests.csproj",
       "test\\Sentry.Maui.Tests\\Sentry.Maui.Tests.csproj",
       "test\\Sentry.NLog.Tests\\Sentry.NLog.Tests.csproj",
       "test\\Sentry.OpenTelemetry.Tests\\Sentry.OpenTelemetry.Tests.csproj",

Sentry-CI-Build-macOS.slnf

@@ -51,6 +51,7 @@
       "src\\Sentry.Google.Cloud.Functions\\Sentry.Google.Cloud.Functions.csproj",
       "src\\Sentry.Hangfire\\Sentry.Hangfire.csproj",
       "src\\Sentry.Log4Net\\Sentry.Log4Net.csproj",
+      "src\\Sentry.Maui.CommunityToolkit.Mvvm\\Sentry.Maui.CommunityToolkit.Mvvm.csproj",
       "src\\Sentry.Maui\\Sentry.Maui.csproj",
       "src\\Sentry.NLog\\Sentry.NLog.csproj",
       "src\\Sentry.OpenTelemetry\\Sentry.OpenTelemetry.csproj",
@@ -72,6 +73,7 @@
       "test\\Sentry.Google.Cloud.Functions.Tests\\Sentry.Google.Cloud.Functions.Tests.csproj",
       "test\\Sentry.Hangfire.Tests\\Sentry.Hangfire.Tests.csproj",
       "test\\Sentry.Log4Net.Tests\\Sentry.Log4Net.Tests.csproj",
+      "test\\Sentry.Maui.CommunityToolkit.Mvvm.Tests\\Sentry.Maui.CommunityToolkit.Mvvm.Tests.csproj",
       "test\\Sentry.Maui.Device.TestApp\\Sentry.Maui.Device.TestApp.csproj",
       "test\\Sentry.Maui.Tests\\Sentry.Maui.Tests.csproj",
       "test\\Sentry.NLog.Tests\\Sentry.NLog.Tests.csproj",

Sentry-CI-CodeQL.slnf

@@ -15,6 +15,7 @@
       "src\\Sentry.Google.Cloud.Functions\\Sentry.Google.Cloud.Functions.csproj",
       "src\\Sentry.Hangfire\\Sentry.Hangfire.csproj",
       "src\\Sentry.Log4Net\\Sentry.Log4Net.csproj",
+      "src\\Sentry.Maui.CommunityToolkit.Mvvm\\Sentry.Maui.CommunityToolkit.Mvvm.csproj",
       "src\\Sentry.Maui\\Sentry.Maui.csproj",
       "src\\Sentry.NLog\\Sentry.NLog.csproj",
       "src\\Sentry.OpenTelemetry\\Sentry.OpenTelemetry.csproj",

SentryMobile.slnf

@@ -11,6 +11,7 @@
       "src\\Sentry.Bindings.Android\\Sentry.Bindings.Android.csproj",
       "src\\Sentry.Bindings.Cocoa\\Sentry.Bindings.Cocoa.csproj",
       "src\\Sentry.Extensions.Logging\\Sentry.Extensions.Logging.csproj",
+      "src\\Sentry.Maui.CommunityToolkit.Mvvm\\Sentry.Maui.CommunityToolkit.Mvvm.csproj",
       "src\\Sentry.Maui\\Sentry.Maui.csproj",
       "src\\Sentry.SourceGenerators\\Sentry.SourceGenerators.csproj",
       "src\\Sentry\\Sentry.csproj",

SentryNoSamples.slnf

@@ -16,6 +16,7 @@
       "src\\Sentry.Google.Cloud.Functions\\Sentry.Google.Cloud.Functions.csproj",
       "src\\Sentry.Hangfire\\Sentry.Hangfire.csproj",
       "src\\Sentry.Log4Net\\Sentry.Log4Net.csproj",
+      "src\\Sentry.Maui.CommunityToolkit.Mvvm\\Sentry.Maui.CommunityToolkit.Mvvm.csproj",
       "src\\Sentry.Maui\\Sentry.Maui.csproj",
       "src\\Sentry.NLog\\Sentry.NLog.csproj",
       "src\\Sentry.OpenTelemetry\\Sentry.OpenTelemetry.csproj",
@@ -37,6 +38,7 @@
       "test\\Sentry.Google.Cloud.Functions.Tests\\Sentry.Google.Cloud.Functions.Tests.csproj",
       "test\\Sentry.Hangfire.Tests\\Sentry.Hangfire.Tests.csproj",
       "test\\Sentry.Log4Net.Tests\\Sentry.Log4Net.Tests.csproj",
+      "test\\Sentry.Maui.CommunityToolkit.Mvvm.Tests\\Sentry.Maui.CommunityToolkit.Mvvm.Tests.csproj",
       "test\\Sentry.Maui.Tests\\Sentry.Maui.Tests.csproj",
       "test\\Sentry.NLog.Tests\\Sentry.NLog.Tests.csproj",
       "test\\Sentry.OpenTelemetry.Tests\\Sentry.OpenTelemetry.Tests.csproj",

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

@@ -5,5 +5,6 @@ public partial class AppShell
     public AppShell()
     {
         InitializeComponent();
+        Routing.RegisterRoute("ctmvvm", typeof(CtMvvmPage));
     }
 }

samples/Sentry.Samples.Maui/CtMvvmPage.xaml

@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="utf-8"?>
+
+<ContentPage xmlns="http://schemas.microsoft.com/dotnet/2021/maui"
+             xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"
+             xmlns:maui="clr-namespace:Sentry.Samples.Maui"
+             x:Class="Sentry.Samples.Maui.CtMvvmPage"
+             x:DataType="maui:CtMvvmViewModel"
+             Title="Community Toolkit MVVM">
+
+    <ContentPage.BindingContext>
+        <maui:CtMvvmViewModel />
+    </ContentPage.BindingContext>
+
+    <ContentPage.Content>
+        <Button Text="Auto-Instrumented Button"
+                Command="{Binding TestCommand}" />
+    </ContentPage.Content>
+</ContentPage>

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

@@ -0,0 +1,16 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Sentry.Samples.Maui;
+
+public partial class CtMvvmPage : ContentPage
+{
+    public CtMvvmPage()
+    {
+        InitializeComponent();
+    }
+}
+

samples/Sentry.Samples.Maui/CtMvvmViewModel.cs

@@ -0,0 +1,15 @@
+using CommunityToolkit.Mvvm.ComponentModel;
+using CommunityToolkit.Mvvm.Input;
+
+namespace Sentry.Samples.Maui;
+
+public partial class CtMvvmViewModel : ObservableObject
+{
+    // Sentry automatically creates spans for async relay commands
+    [RelayCommand]
+    private async Task Test()
+    {
+        var rand = new Random().Next(100, 1000);
+        await Task.Delay(TimeSpan.FromMilliseconds(rand));
+    }
+}

samples/Sentry.Samples.Maui/MainPage.xaml

@@ -83,6 +83,13 @@
                 Clicked="OnFeedbackClicked"
                 HorizontalOptions="Center" />
 
+            <Button
+                x:Name="CtMvvmBtn"
+                Text="CommunityToolkit.Mvvm Integration"
+                SemanticProperties.Hint="Shows a test that auto-instrument async relay commands from the MVVM Community Toolkit."
+                Clicked="CtMvvmBtn_OnClicked"
+                HorizontalOptions="Center" />
+
         </VerticalStackLayout>
     </ScrollView>
 

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

@@ -101,6 +101,11 @@ private async void OnFeedbackClicked(object sender, EventArgs e)
         await Navigation.PushModalAsync(new SubmitFeedback());
     }
 
+    private void CtMvvmBtn_OnClicked(object sender, EventArgs e)
+    {
+        Shell.Current.GoToAsync("ctmvvm");
+    }
+
     private void TapGestureRecognizer_OnTapped(object sender, TappedEventArgs e)
     {
     }

samples/Sentry.Samples.Maui/MauiProgram.cs

@@ -1,4 +1,5 @@
 using System.Diagnostics;
+using Sentry.Maui;
 
 namespace Sentry.Samples.Maui;
 
@@ -25,6 +26,14 @@ public static MauiApp CreateMauiApp()
                 options.Debug = true;
                 options.SampleRate = 1.0F;
 
+                // The Sentry MVVM Community Toolkit integration automatically creates traces for async relay commands,
+                // but only if tracing is enabled. Here we capture all traces (in a production app you'd probably only
+                // capture a certain percentage)
+                options.TracesSampleRate = 1.0F;
+
+                // Automatically create traces for async relay commands in the MVVM Community Toolkit
+                options.AddCommunityToolkitIntegration();
+
 #if __ANDROID__
                 // Currently experimental support is only available on Android
                 options.Native.ExperimentalOptions.SessionReplay.OnErrorSampleRate = 1.0;

samples/Sentry.Samples.Maui/Sentry.Samples.Maui.csproj

@@ -102,6 +102,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <ProjectReference Include="..\..\src\Sentry.Maui.CommunityToolkit.Mvvm\Sentry.Maui.CommunityToolkit.Mvvm.csproj" />
     <ProjectReference Include="..\..\src\Sentry.Maui\Sentry.Maui.csproj" />
     <ProjectReference Include="..\..\src\Sentry.Analyzers\Sentry.Analyzers.csproj"
                       OutputItemType="Analyzer"
@@ -110,6 +111,8 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Maui.Controls" Version="$(MauiVersion)" />
+    <!-- Check SDK users will be able to resolve the latest version of CommunityToolkit.Mvvm (our Integration targets 8.3.2 -->
+    <PackageReference Include="CommunityToolkit.Mvvm" Version="8.4.0"/>
   </ItemGroup>
 
   <!--In order to test our analyzers with this project, we manually reference our targets file.  User do not need to do this-->

scripts/device-test.ps1

@@ -24,7 +24,7 @@ try
 {
     if (!$Tfm)
     {
-        $Tfm = 'net8.0'
+        $Tfm = 'net9.0'
     }
     $arch = (!$IsWindows -and $(uname -m) -eq 'arm64') ? 'arm64' : 'x64'
     if ($Platform -eq 'android')

scripts/generate-solution-filters-config.yaml

@@ -175,10 +175,12 @@ filterConfigs:
         - "src/**/*Bindings.Cocoa.csproj"
         - "src/**/Sentry.Extensions.Logging.csproj"
         - "src/**/Sentry.Maui.csproj"
+        - "src/**/Sentry.Maui.CommunityToolkit.Mvvm.csproj"
         - "test/**/Sentry.Testing.CrashableApp.csproj"
         - "test/**/Sentry.Android.AssemblyReader.Tests.csproj"
         - "test/**/Sentry.Extensions.Logging.Tests.csproj"
         - "test/**/Sentry.Maui.Device.TestApp.csproj"
+        - "test/**/Sentry.Testing.CrashableApp.csproj"
         - "test/**/Sentry.Maui.Tests.csproj"
         - "test/**/Sentry.Testing.csproj"
         - "test/**/Sentry.Tests.csproj"

src/Sentry.Maui.CommunityToolkit.Mvvm/MauiCommunityToolkitMvvmEventsBinder.cs

@@ -0,0 +1,162 @@
+using System.Windows.Input;
+using CommunityToolkit.Mvvm.Input;
+using Sentry.Internal;
+
+namespace Sentry.Maui.CommunityToolkit.Mvvm;
+
+/// <summary>
+/// Scans all elements for known commands that are implement
+/// </summary>
+internal class MauiCommunityToolkitMvvmEventsBinder(IHub hub) : IMauiElementEventBinder
+{
+    private const string SpanName = "ctmvvm";
+    private const string SpanOp = "relay.command";
+
+    /// <summary>
+    /// Binds to the element
+    /// </summary>
+    /// <param name="element"></param>
+    /// <param name="addBreadcrumb"></param>
+    public void Bind(VisualElement element, Action<BreadcrumbEvent> addBreadcrumb) => Iterate(element, true);
+
+    /// <summary>
+    /// Unbinds from the element
+    /// </summary>
+    /// <param name="element"></param>
+    /// <exception cref="NotImplementedException"></exception>
+    public void UnBind(VisualElement element) => Iterate(element, false);
+
+
+    private void Iterate(VisualElement element, bool bind)
+    {
+        switch (element)
+        {
+            case Button button:
+                TryBindTo(button.Command, bind);
+                break;
+
+            case ImageButton imageButton:
+                TryBindTo(imageButton.Command, bind);
+                break;
+
+            case CarouselView carousel:
+                TryBindTo(carousel.CurrentItemChangedCommand, bind);
+                TryBindTo(carousel.RemainingItemsThresholdReachedCommand, bind);
+                TryBindTo(carousel.PositionChangedCommand, bind);
+                break;
+
+            case CollectionView collectionView:
+                TryBindTo(collectionView.RemainingItemsThresholdReachedCommand, bind);
+                TryBindTo(collectionView.SelectionChangedCommand, bind);
+                break;
+
+            case Entry entry:
+                TryBindTo(entry.ReturnCommand, bind);
+                break;
+
+            case RefreshView refresh:
+                TryBindTo(refresh.Command, bind);
+                break;
+
+            case SearchBar searchBar:
+                TryBindTo(searchBar.SearchCommand, bind);
+                break;
+
+            default:
+                TryGestureBinding(element, bind);
+                break;
+        }
+    }
+
+    private void TryGestureBinding(VisualElement element, bool bind)
+    {
+        if (element is IGestureRecognizers gestureRecognizers)
+        {
+            foreach (var gestureRecognizer in gestureRecognizers.GestureRecognizers)
+            {
+                TryBindTo(gestureRecognizer, bind);
+            }
+        }
+    }
+
+    private void TryBindTo(IGestureRecognizer recognizer, bool bind)
+    {
+        switch (recognizer)
+        {
+            case TapGestureRecognizer tap:
+                TryBindTo(tap.Command, bind);
+                break;
+
+            case SwipeGestureRecognizer swipe:
+                TryBindTo(swipe.Command, bind);
+                break;
+
+            case DragGestureRecognizer drag:
+                TryBindTo(drag.DragStartingCommand, bind); // unlikely to ever be async
+                TryBindTo(drag.DropCompletedCommand, bind);
+                break;
+
+            case PointerGestureRecognizer pointer:
+                TryBindTo(pointer.PointerPressedCommand, bind);
+                TryBindTo(pointer.PointerReleasedCommand, bind);
+                TryBindTo(pointer.PointerEnteredCommand, bind); // unlikely to ever be async
+                TryBindTo(pointer.PointerExitedCommand, bind);
+                break;
+
+                // no command bindings on these gestures, so they're left out
+                // PinchGestureRecognizer
+                // PanGestureRecognizer
+        }
+    }
+
+    private void TryBindTo(ICommand? command, bool bind)
+    {
+        const string isSubscribedProperty = "IsSubscribed";
+
+        if (!bind || command is not IAsyncRelayCommand relayCommand)
+        {
+            return;
+        }
+
+        // since events can retrigger binding pickups, this ensures we don't hook up event handlers more than once.
+        if (!relayCommand.GetFused<bool>(isSubscribedProperty))
+        {
+            lock (relayCommand)
+            {
+                if (!relayCommand.GetFused<bool>(isSubscribedProperty))
+                {
+                    relayCommand.PropertyChanged += RelayCommandOnPropertyChanged;
+                    relayCommand.SetFused(isSubscribedProperty, true);
+                }
+            }
+        }
+    }
+
+    private void RelayCommandOnPropertyChanged(object? sender, PropertyChangedEventArgs e)
+    {
+        if (e.PropertyName != nameof(IAsyncRelayCommand.IsRunning))
+        {
+            return;
+        }
+
+        var relay = (IAsyncRelayCommand)sender!;
+        if (relay.IsRunning)
+        {
+            // Note that we may be creating a transaction here and if so we explicitly don't store it on
+            // Scope.Transaction, because Scope.Transaction is AsyncLocal<T> and MAUI Apps have a global scope. The
+            // results would be that we would store the transaction on the scope, but it would never be cleared again,
+            // since the next call to OnPropertyChanged for this RelayCommand will (likely) be from a different thread.
+            var span = hub.StartSpan(SpanName, SpanOp);
+            if (span is ITransactionTracer transaction)
+            {
+                hub.ConfigureScope(scope => scope.Transaction = transaction);
+            }
+
+            relay.SetFused(span);
+        }
+        else if (relay.GetFused<ISpan>() is { } span)
+        {
+            span.Finish();
+        }
+    }
+}