Merge branch 'main' into bruno-garcia-patch-2

jamescrosswell · web-flow · commit 0945f03154a5 · 2025-03-17T17:45:37.000+13:00
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -20,7 +20,7 @@ jobs:
     steps:
       - name: Get auth token
         id: token
-        uses: actions/create-github-app-token@0d564482f06ca65fa9e77e2510873638c82206f2 # v1.11.5
+        uses: actions/create-github-app-token@21cfef2b496dd8ef5b904c159339626a10ad380e # v1.11.6
         with:
           app-id: ${{ vars.SENTRY_RELEASE_BOT_CLIENT_ID }}
           private-key: ${{ secrets.SENTRY_RELEASE_BOT_PRIVATE_KEY }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@
 
 - Target `net9.0` on Sentry.Google.Cloud.Functions to avoid conflict with Sentry.AspNetCore ([#4039](https://github.com/getsentry/sentry-dotnet/pull/4039))
 
+### Features
+
+- Exception.HResult is now included in the mechanism data for all exceptions ([#4029](https://github.com/getsentry/sentry-dotnet/pull/4029))
+
 ### Dependencies
 
 - Bump CLI from v2.42.2 to v2.42.3 ([#4036](https://github.com/getsentry/sentry-dotnet/pull/4036))
@@ -21,6 +25,7 @@
 ### Fixes
 
 - Unknown stack frames in profiles on .NET 8+ ([#3967](https://github.com/getsentry/sentry-dotnet/pull/3967))
+- Missing MAUI `Shell` navigation breadcrumbs on iOS ([#4006](https://github.com/getsentry/sentry-dotnet/pull/4006))
 
 ## 5.3.0
 
diff --git a/src/Sentry.Maui/Internal/MauiEventsBinder.cs b/src/Sentry.Maui/Internal/MauiEventsBinder.cs
@@ -34,7 +34,16 @@ public void HandleApplicationEvents(Application application, bool bind = true)
     {
         if (bind)
         {
-            // Attach element events to all descendents as they are added to the application.
+            // Attach element events to all existing descendants (skip the application itself)
+            foreach (var descendant in application.GetVisualTreeDescendants().Skip(1))
+            {
+                if (descendant is VisualElement element)
+                {
+                    OnApplicationOnDescendantAdded(application, new ElementEventArgs(element));
+                }
+            }
+
+            // Attach element events to all descendants as they are added to the application.
             application.DescendantAdded += OnApplicationOnDescendantAdded;
             application.DescendantRemoved += OnApplicationOnDescendantRemoved;
 
diff --git a/src/Sentry/Internal/MainExceptionProcessor.cs b/src/Sentry/Internal/MainExceptionProcessor.cs
@@ -199,6 +199,9 @@ private static Mechanism GetMechanism(Exception exception, int id, int? parentId
             exception.Data.Remove(Mechanism.DescriptionKey);
         }
 
+        // Add HResult to mechanism data before adding exception data, so that it can be overridden.
+        mechanism.Data["HResult"] = $"0x{exception.HResult:X8}";
+
         // Copy remaining exception data to mechanism data.
         foreach (var key in exception.Data.Keys.OfType<string>())
         {
diff --git a/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet8_0.verified.txt b/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet8_0.verified.txt
@@ -10,7 +10,15 @@
       SentryExceptions: [
         {
           Type: System.Exception,
-          Value: my exception
+          Value: my exception,
+          Mechanism: {
+            Type: generic,
+            Synthetic: false,
+            IsExceptionGroup: false,
+            Data: {
+              HResult: 0x80131500
+            }
+          }
         }
       ],
       Level: error,
diff --git a/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet9_0.verified.txt b/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.DotNet9_0.verified.txt
@@ -10,7 +10,15 @@
       SentryExceptions: [
         {
           Type: System.Exception,
-          Value: my exception
+          Value: my exception,
+          Mechanism: {
+            Type: generic,
+            Synthetic: false,
+            IsExceptionGroup: false,
+            Data: {
+              HResult: 0x80131500
+            }
+          }
         }
       ],
       Level: error,
diff --git a/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.Net4_8.verified.txt b/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsEfAsync.Net4_8.verified.txt
@@ -10,7 +10,15 @@
       SentryExceptions: [
         {
           Type: System.Exception,
-          Value: my exception
+          Value: my exception,
+          Mechanism: {
+            Type: generic,
+            Synthetic: false,
+            IsExceptionGroup: false,
+            Data: {
+              HResult: 0x80131500
+            }
+          }
         }
       ],
       Level: error,
diff --git a/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsSqlAsync.verified.txt b/test/Sentry.DiagnosticSource.IntegrationTests/SqlListenerTests.RecordsSqlAsync.verified.txt
@@ -10,7 +10,15 @@
       SentryExceptions: [
         {
           Type: System.Exception,
-          Value: my exception
+          Value: my exception,
+          Mechanism: {
+            Type: generic,
+            Synthetic: false,
+            IsExceptionGroup: false,
+            Data: {
+              HResult: 0x80131500
+            }
+          }
         }
       ],
       Level: error,
diff --git a/test/Sentry.EntityFramework.Tests/IntegrationTests.Simple.verified.txt b/test/Sentry.EntityFramework.Tests/IntegrationTests.Simple.verified.txt
@@ -10,7 +10,15 @@
       SentryExceptions: [
         {
           Type: System.Exception,
-          Value: my exception
+          Value: my exception,
+          Mechanism: {
+            Type: generic,
+            Synthetic: false,
+            IsExceptionGroup: false,
+            Data: {
+              HResult: 0x80131500
+            }
+          }
         }
       ],
       Level: error,
diff --git a/test/Sentry.EntityFramework.Tests/IntegrationTests.verify.cs b/test/Sentry.EntityFramework.Tests/IntegrationTests.verify.cs
@@ -5,7 +5,7 @@ namespace Sentry.EntityFramework.Tests;
 public class IntegrationTests
 {
     // needs to be a variable to stop EF from inlining it as a constant
-    static string shouldNotAppearInPayload = "SHOULD NOT APPEAR IN PAYLOAD";
+    private static string shouldNotAppearInPayload = "SHOULD NOT APPEAR IN PAYLOAD";
 
     [SkippableFact]
     public async Task Simple()
diff --git a/test/Sentry.Maui.Tests/MauiEventsBinderTests.Application.cs b/test/Sentry.Maui.Tests/MauiEventsBinderTests.Application.cs
@@ -145,6 +145,36 @@ public void Application_UnbindModalEvents_DoesNotAddBreadcrumb(string eventName,
         Assert.Single(_fixture.Scope.Breadcrumbs);
     }
 
+    [Fact]
+    public void Application_HandleApplicationEvents_TracksExistingDescendants()
+    {
+        // Arrange
+        var application = MockApplication.Create();
+        var element = new MockVisualElement("element");
+        var mainPage = new ContentPage
+        {
+            Content = new VerticalStackLayout
+            {
+                element
+            }
+        };
+
+        application.AddWindow(mainPage);
+
+        _fixture.Binder.HandleApplicationEvents(application);
+
+        // Act
+        element.RaiseEvent(nameof(VisualElement.Focused), new FocusEventArgs(element, true));
+
+        // Assert
+        var crumb = Assert.Single(_fixture.Scope.Breadcrumbs);
+        Assert.Equal($"{nameof(MockVisualElement)}.{nameof(VisualElement.Focused)}", crumb.Message);
+        Assert.Equal(BreadcrumbLevel.Info, crumb.Level);
+        Assert.Equal(MauiEventsBinder.SystemType, crumb.Type);
+        Assert.Equal(MauiEventsBinder.RenderingCategory, crumb.Category);
+        crumb.Data.Should().Contain($"{nameof(MockVisualElement)}.Name", "element");
+    }
+
     public static IEnumerable<object[]> ApplicationModalEventsData
     {
         get
diff --git a/test/Sentry.Maui.Tests/Mocks/MockApplication.cs b/test/Sentry.Maui.Tests/Mocks/MockApplication.cs
@@ -5,6 +5,7 @@ namespace Sentry.Maui.Tests.Mocks;
 public class MockApplication : Application
 {
     private static readonly object LockObj = new();
+    private Page _mainPage;
 
     static MockApplication()
     {
@@ -18,6 +19,23 @@ private MockApplication()
     {
     }
 
+    public void AddWindow(Page mainPage)
+    {
+        _mainPage = mainPage;
+        ((IApplication)this).CreateWindow(null);
+        _mainPage = null;
+    }
+
+    protected override Window CreateWindow(IActivationState activationState)
+    {
+        if (_mainPage != null)
+        {
+            return new Window(_mainPage);
+        }
+
+        return base.CreateWindow(activationState);
+    }
+
     public static MockApplication Create()
     {
         // The base constructor will try to set the mock as the current application, which we don't want in tests.
diff --git a/test/Sentry.MauiTrimTest/Platforms/MacCatalyst/AppDelegate.cs b/test/Sentry.MauiTrimTest/Platforms/MacCatalyst/AppDelegate.cs
@@ -1,9 +1,9 @@
-﻿using Foundation;
+using Foundation;
 
 namespace Sentry.MauiTrimTest;
 
 [Register("AppDelegate")]
 public class AppDelegate : MauiUIApplicationDelegate
 {
-	protected override MauiApp CreateMauiApp() => MauiProgram.CreateMauiApp();
+    protected override MauiApp CreateMauiApp() => MauiProgram.CreateMauiApp();
 }
diff --git a/test/Sentry.MauiTrimTest/Platforms/MacCatalyst/Program.cs b/test/Sentry.MauiTrimTest/Platforms/MacCatalyst/Program.cs
@@ -5,11 +5,11 @@ namespace Sentry.MauiTrimTest;
 
 public class Program
 {
-	// This is the main entry point of the application.
-	static void Main(string[] args)
-	{
-		// if you want to use a different Application Delegate class from "AppDelegate"
-		// you can specify it here.
-		UIApplication.Main(args, null, typeof(AppDelegate));
-	}
+    // This is the main entry point of the application.
+    private static void Main(string[] args)
+    {
+        // if you want to use a different Application Delegate class from "AppDelegate"
+        // you can specify it here.
+        UIApplication.Main(args, null, typeof(AppDelegate));
+    }
 }
diff --git a/test/Sentry.MauiTrimTest/Platforms/Tizen/Main.cs b/test/Sentry.MauiTrimTest/Platforms/Tizen/Main.cs
@@ -4,13 +4,13 @@
 
 namespace Sentry.MauiTrimTest;
 
-class Program : MauiApplication
+public class Program : MauiApplication
 {
-	protected override MauiApp CreateMauiApp() => MauiProgram.CreateMauiApp();
+    protected override MauiApp CreateMauiApp() => MauiProgram.CreateMauiApp();
 
-	static void Main(string[] args)
-	{
-		var app = new Program();
-		app.Run(args);
-	}
+    private static void Main(string[] args)
+    {
+        var app = new Program();
+        app.Run(args);
+    }
 }
diff --git a/test/Sentry.MauiTrimTest/Platforms/Windows/App.xaml.cs b/test/Sentry.MauiTrimTest/Platforms/Windows/App.xaml.cs
@@ -1,4 +1,4 @@
-﻿using Microsoft.UI.Xaml;
+using Microsoft.UI.Xaml;
 
 // To learn more about WinUI, the WinUI project structure,
 // and more about our project templates, see: http://aka.ms/winui-project-info.
@@ -10,15 +10,15 @@ namespace Sentry.MauiTrimTest.WinUI;
 /// </summary>
 public partial class App : MauiWinUIApplication
 {
-	/// <summary>
-	/// Initializes the singleton application object.  This is the first line of authored code
-	/// executed, and as such is the logical equivalent of main() or WinMain().
-	/// </summary>
-	public App()
-	{
-		this.InitializeComponent();
-	}
+    /// <summary>
+    /// Initializes the singleton application object.  This is the first line of authored code
+    /// executed, and as such is the logical equivalent of main() or WinMain().
+    /// </summary>
+    public App()
+    {
+        this.InitializeComponent();
+    }
 
-	protected override MauiApp CreateMauiApp() => MauiProgram.CreateMauiApp();
+    protected override MauiApp CreateMauiApp() => MauiProgram.CreateMauiApp();
 }
 
diff --git a/test/Sentry.NLog.Tests/IntegrationTests.Simple.DotNet8_0.verified.txt b/test/Sentry.NLog.Tests/IntegrationTests.Simple.DotNet8_0.verified.txt
@@ -59,7 +59,10 @@
                   Type: generic,
                   Handled: true,
                   Synthetic: false,
-                  IsExceptionGroup: false
+                  IsExceptionGroup: false,
+                  Data: {
+                    HResult: 0x80131500
+                  }
                 }
               }
             ],
diff --git a/test/Sentry.NLog.Tests/IntegrationTests.Simple.DotNet9_0.verified.txt b/test/Sentry.NLog.Tests/IntegrationTests.Simple.DotNet9_0.verified.txt
@@ -59,7 +59,10 @@
                   Type: generic,
                   Handled: true,
                   Synthetic: false,
-                  IsExceptionGroup: false
+                  IsExceptionGroup: false,
+                  Data: {
+                    HResult: 0x80131500
+                  }
                 }
               }
             ],
diff --git a/test/Sentry.NLog.Tests/IntegrationTests.Simple.Mono4_0.verified.txt b/test/Sentry.NLog.Tests/IntegrationTests.Simple.Mono4_0.verified.txt
@@ -59,7 +59,10 @@
                   Type: generic,
                   Handled: true,
                   Synthetic: false,
-                  IsExceptionGroup: false
+                  IsExceptionGroup: false,
+                  Data: {
+                    HResult: 0x80131500
+                  }
                 }
               }
             ],
diff --git a/test/Sentry.NLog.Tests/IntegrationTests.Simple.Net4_8.verified.txt b/test/Sentry.NLog.Tests/IntegrationTests.Simple.Net4_8.verified.txt
@@ -59,7 +59,10 @@
                   Type: generic,
                   Handled: true,
                   Synthetic: false,
-                  IsExceptionGroup: false
+                  IsExceptionGroup: false,
+                  Data: {
+                    HResult: 0x80131500
+                  }
                 }
               }
             ],
diff --git a/test/Sentry.Serilog.Tests/IntegrationTests.Simple.DotNet8_0.verified.txt b/test/Sentry.Serilog.Tests/IntegrationTests.Simple.DotNet8_0.verified.txt
@@ -224,7 +224,8 @@
                   Synthetic: false,
                   IsExceptionGroup: false,
                   Data: {
-                    details: Do work always throws.
+                    details: Do work always throws.,
+                    HResult: 0x80131500
                   }
                 }
               }
diff --git a/test/Sentry.Serilog.Tests/IntegrationTests.Simple.DotNet9_0.verified.txt b/test/Sentry.Serilog.Tests/IntegrationTests.Simple.DotNet9_0.verified.txt
@@ -224,7 +224,8 @@
                   Synthetic: false,
                   IsExceptionGroup: false,
                   Data: {
-                    details: Do work always throws.
+                    details: Do work always throws.,
+                    HResult: 0x80131500
                   }
                 }
               }
diff --git a/test/Sentry.Tests/Internals/MainExceptionProcessorTests.CreateSentryException_Aggregate.verified.txt b/test/Sentry.Tests/Internals/MainExceptionProcessorTests.CreateSentryException_Aggregate.verified.txt
diff --git a/test/Sentry.Tests/Internals/MainExceptionProcessorTests.cs b/test/Sentry.Tests/Internals/MainExceptionProcessorTests.cs

Original file line number	Diff line number	Diff line change
`@@ -199,6 +199,9 @@ private static Mechanism GetMechanism(Exception exception, int id, int? parentId`
`199`	`199`	`exception.Data.Remove(Mechanism.DescriptionKey);`
`200`	`200`	`}`
`201`	`201`
	`202`	`+ // Add HResult to mechanism data before adding exception data, so that it can be overridden.`
	`203`	`+ mechanism.Data["HResult"] = $"0x{exception.HResult:X8}";`
	`204`	`+`
`202`	`205`	`// Copy remaining exception data to mechanism data.`
`203`	`206`	`foreach (var key in exception.Data.Keys.OfType<string>())`
`204`	`207`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ namespace Sentry.EntityFramework.Tests;`
`5`	`5`	`public class IntegrationTests`
`6`	`6`	`{`
`7`	`7`	`// needs to be a variable to stop EF from inlining it as a constant`
`8`		`- static string shouldNotAppearInPayload = "SHOULD NOT APPEAR IN PAYLOAD";`
	`8`	`+ private static string shouldNotAppearInPayload = "SHOULD NOT APPEAR IN PAYLOAD";`
`9`	`9`
`10`	`10`	`[SkippableFact]`
`11`	`11`	`public async Task Simple()`