Trimming for .NET 7+

Directory.Build.props

@@ -17,7 +17,7 @@
     <NoWarn>$(NoWarn);CS8002</NoWarn>
   </PropertyGroup>
 
-  <PropertyGroup Condition="'$(SolutionName)' == 'Sentry.NoMobile'">
+  <PropertyGroup Condition="'$(SolutionName)' == 'Sentry.NoMobile' or '$(SolutionName)' == 'Sentry.Aot'">
     <NO_MOBILE>true</NO_MOBILE>
   </PropertyGroup>
 

Sentry.Aot.sln.DotSettings

@@ -0,0 +1,2 @@
+<wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=UI/@EntryIndexedValue">UI</s:String></wpf:ResourceDictionary>

Sentry.sln.DotSettings

@@ -1,5 +1,7 @@
 <wpf:ResourceDictionary xml:space="preserve" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:s="clr-namespace:System;assembly=mscorlib" xmlns:ss="urn:shemas-jetbrains-com:settings-storage-xaml" xmlns:wpf="http://schemas.microsoft.com/winfx/2006/xaml/presentation">
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=QL/@EntryIndexedValue">QL</s:String>
+	<s:String x:Key="/Default/CodeStyle/Naming/CSharpNaming/Abbreviations/=UI/@EntryIndexedValue">UI</s:String>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=Enricher/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=enrichers/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/UserDictionary/Words/=instrumenter/@EntryIndexedValue">True</s:Boolean>
-	<s:Boolean x:Key="/Default/UserDictionary/Words/=otel/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>
+	<s:Boolean x:Key="/Default/UserDictionary/Words/=otel/@EntryIndexedValue">True</s:Boolean></wpf:ResourceDictionary>

SentryAot.slnf

@@ -0,0 +1,12 @@
+{
+  "solution": {
+    "path": "Sentry.Aot.sln",
+    "projects": [
+      "samples\\Sentry.Samples.Console.Basic\\Sentry.Samples.Console.Basic.csproj",
+      "src\\Sentry\\Sentry.csproj",
+      "test\\Sentry.Testing.CrashableApp\\Sentry.Testing.CrashableApp.csproj",
+      "test\\Sentry.Testing\\Sentry.Testing.csproj",
+      "test\\Sentry.Tests\\Sentry.Tests.csproj"
+    ]
+  }
+}

samples/Directory.Build.props

@@ -33,4 +33,8 @@
     <MtouchUseLlvm>false</MtouchUseLlvm>
   </PropertyGroup>
 
+  <!-- AOT not supported for osx-arm64 on .NET 7 -->
+  <PropertyGroup Condition="'$(SolutionName)' == 'Sentry.Aot' and (!$([MSBuild]::IsOSPlatform('OSX')) or '$(TargetFramework)' == 'net8.0')">
+    <PublishAot>true</PublishAot>
+  </PropertyGroup>
 </Project>

samples/Sentry.Samples.Console.Basic/Sentry.Samples.Console.Basic.csproj

@@ -5,10 +5,11 @@
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
     <TargetFrameworks>net7.0;net8.0</TargetFrameworks>
+  </PropertyGroup>
 
+  <PropertyGroup Condition="!$([MSBuild]::IsOSPlatform('OSX')) or '$(TargetFramework)' == 'net8.0'">
     <!-- AOT not supported for osx-arm64 on .NET 7 -->
-	<!-- TODO, consider updating after changes from #2732 come into effect -->
-    <PublishAot Condition="!$([MSBuild]::IsOSPlatform('OSX')) or '$(TargetFramework)' == 'net8.0'">true</PublishAot>
+    <PublishAot>true</PublishAot>
   </PropertyGroup>
 
   <PropertyGroup>

scripts/generate-solution-filters-config.yaml

@@ -3,7 +3,13 @@
 # the *.slnf solution filters for the Sentry solution.
 ################################################################
 
-defaultSolution: Sentry.sln
+coreSolution: Sentry.sln
+# We don't maintain the buildSolutions manually... these are just
+# copies of Sentry.sln that are used to set certain build 
+# properties when using solution filters that are based on these
+buildSolutions:
+  - Sentry.NoMobile.sln
+  - Sentry.Aot.sln
 
 groupConfigs:
   allProjects:
@@ -170,3 +176,13 @@ filterConfigs:
         - "**/*Bindings*"
         - "**/*DeviceTests*"
         - "**/*TestApp*"
+
+  - outputPath: SentryAot.slnf
+    solution: Sentry.Aot.sln
+    include:
+      patterns:
+        - "**/Sentry.Samples.Console.Basic.csproj"
+        - "**/Sentry.csproj"
+        - "**/Sentry.Testing.csproj"
+        - "**/Sentry.Testing.CrashableApp.csproj"
+        - "**/Sentry.Tests.csproj"

scripts/generate-solution-filters.ps1

@@ -104,7 +104,7 @@ foreach($filter in $config.filterConfigs){
     $solution = if ($filter.ContainsKey('solution')) {
       $filter.solution
     } else {
-      $config.defaultSolution
+      $config.coreSolution
     }
     $content = "{
   `"solution`": {
@@ -138,7 +138,9 @@ foreach($filter in $config.filterConfigs){
   Write-Debug "Created $outputPath"
 }
 
-# Update solution files from Sentry.sln
-$source = Join-Path $repoRoot "Sentry.sln"
-$destination = Join-Path $repoRoot "Sentry.NoMobile.sln"
-Copy-Item -Path $source -Destination $destination -Force
+# Copy the Core solution to each of the required build solutions
+$source = Join-Path $repoRoot $config.coreSolution
+foreach ($buildSolution in $config.buildSolutions) {
+  $destination = Join-Path $repoRoot $buildSolution
+  Copy-Item -Path $source -Destination $destination -Force
+}

src/Directory.Build.props

@@ -35,6 +35,10 @@
     <CodeAnalysisRuleSet>$(MSBuildThisFileDirectory)CodeAnalysis.ruleset</CodeAnalysisRuleSet>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(SolutionName)' == 'Sentry.Aot' and ($(TargetFramework.StartsWith('net6')) or $(TargetFramework.StartsWith('net7')) or $(TargetFramework.StartsWith('net8')))">
+    <IsAotCompatible>true</IsAotCompatible>
+  </PropertyGroup>
+
   <PropertyGroup>
     <!-- Used by SIL.ReleaseTasks below -->
     <ChangelogFile>$(MSBuildThisFileDirectory)..\CHANGELOG.md</ChangelogFile>

src/Sentry.AspNetCore.Grpc/Sentry.AspNetCore.Grpc.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net6.0;net5.0;netcoreapp3.0</TargetFrameworks>
+    <TargetFrameworks>net6.0;net5.0;netcoreapp3.1</TargetFrameworks>
     <PackageTags>$(PackageTags);AspNetCore;gRPC</PackageTags>
     <Description>Official ASP.NET Core gRPC integration for Sentry - Open-source error tracking that helps developers monitor and fix crashes in real time.</Description>
   </PropertyGroup>

src/Sentry.AspNetCore/Sentry.AspNetCore.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net6.0;net5.0;netcoreapp3.0;netstandard2.0</TargetFrameworks>
+    <TargetFrameworks>net6.0;net5.0;netcoreapp3.1;netstandard2.0</TargetFrameworks>
     <PackageTags>$(PackageTags);AspNetCore;MVC</PackageTags>
     <Description>Official ASP.NET Core integration for Sentry - Open-source error tracking that helps developers monitor and fix crashes in real time.</Description>
   </PropertyGroup>

src/Sentry.Extensions.Logging/Sentry.Extensions.Logging.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks>net6.0;net5.0;netcoreapp3.0;netstandard2.0</TargetFrameworks>
+    <TargetFrameworks>net6.0;net5.0;netcoreapp3.1;netstandard2.0</TargetFrameworks>
     <PackageTags>$(PackageTags);Logging;Microsoft.Extensions.Logging</PackageTags>
     <Description>Official Microsoft.Extensions.Logging integration for Sentry - Open-source error tracking that helps developers monitor and fix crashes in real time.</Description>
   </PropertyGroup>
@@ -15,9 +15,9 @@
     <PackageReference Include="Microsoft.Extensions.Http" Version="2.1.0" />
   </ItemGroup>
 
-  <ItemGroup Condition="'$(TargetFramework)' == 'netcoreapp3.0'">
-    <PackageReference Include="Microsoft.Extensions.Logging.Configuration" Version="3.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Http" Version="3.0.0" />
+  <ItemGroup Condition="'$(TargetFramework)' == 'netcoreapp3.1'">
+    <PackageReference Include="Microsoft.Extensions.Logging.Configuration" Version="3.1.0" />
+    <PackageReference Include="Microsoft.Extensions.Http" Version="3.1.0" />
   </ItemGroup>
 
   <ItemGroup Condition="'$(TargetFramework)' == 'net5.0'">

src/Sentry.OpenTelemetry/SentrySpanProcessor.cs

@@ -56,7 +56,7 @@ internal SentrySpanProcessor(IHub hub, IEnumerable<IOpenTelemetryEnricher>? enri
         // Resource attributes are consistent between spans, but not available during construction.
         // Thus, get a single instance lazily.
         _resourceAttributes = new Lazy<IDictionary<string, object>>(() =>
-            ParentProvider?.GetResource().Attributes.ToDictionary() ?? new Dictionary<string, object>(0));
+            ParentProvider?.GetResource().Attributes.ToDict() ?? new Dictionary<string, object>(0));
     }
 
     /// <inheritdoc />
@@ -111,7 +111,7 @@ public override void OnStart(Activity data)
     public override void OnEnd(Activity data)
     {
         // Make a dictionary of the attributes (aka "tags") for faster lookup when used throughout the processor.
-        var attributes = data.TagObjects.ToDictionary();
+        var attributes = data.TagObjects.ToDict();
 
         if (attributes.TryGetTypedValue("http.url", out string? url) && (_options?.IsSentryRequest(url) ?? false))
         {
@@ -325,7 +325,7 @@ private void GenerateSentryErrorsFromOtelSpan(Activity activity, IDictionary<str
         // https://opentelemetry.io/docs/specs/otel/trace/semantic_conventions/exceptions/
         foreach (var @event in activity.Events.Where(e => e.Name == OtelSemanticConventions.AttributeExceptionEventName))
         {
-            var eventAttributes = @event.Tags.ToDictionary();
+            var eventAttributes = @event.Tags.ToDict();
             // This would be where we would ideally implement full exception capture. That's not possible at the
             // moment since the full exception isn't yet available via the OpenTelemetry API.
             // See https://github.com/open-telemetry/opentelemetry-dotnet/issues/2439#issuecomment-1577314568

src/Sentry/GraphQLRequestContent.cs

@@ -1,5 +1,6 @@
 using Sentry.Extensibility;
 using Sentry.Internal.Extensions;
+using Sentry.Internal.GraphQL;
 
 namespace Sentry;
 
@@ -25,8 +26,7 @@ public GraphQLRequestContent(string? requestContent, SentryOptions? options = nu
 
         try
         {
-            var deserialized = JsonSerializer.Deserialize<Dictionary<string, object>>(requestContent, SerializerOptions);
-            Items = (deserialized ?? new Dictionary<string, object>()).AsReadOnly();
+            Items = GraphQLRequestContentReader.Read(requestContent);
         }
         catch (Exception e)
         {

src/Sentry/Integrations/WinUIUnhandledExceptionIntegration.cs

@@ -1,5 +1,6 @@
 #if NET5_0_OR_GREATER
 using Sentry.Extensibility;
+using Sentry.Internal;
 
 namespace Sentry.Integrations;
 
@@ -35,7 +36,7 @@ internal class WinUIUnhandledExceptionIntegration : ISdkIntegration
     private IHub _hub = null!;
     private SentryOptions _options = null!;
 
-    public static bool IsApplicable => WinUIAssembly != null;
+    internal static bool IsApplicable => WinUIAssembly != null;
 
     public void Register(IHub hub, SentryOptions options)
     {
@@ -73,6 +74,12 @@ public void Register(IHub hub, SentryOptions options)
         });
     }
 
+    /// <summary>
+    /// This method uses reflection to hook up an UnhandledExceptionHandler. When IsTrimmed is true, users will have
+    /// follow our guidance to perform this initialization manually.
+    /// </summary>
+    [UnconditionalSuppressMessage("Trimming", "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code", Justification = AotHelper.SuppressionJustification)]
+    [UnconditionalSuppressMessage("Trimming", "IL2075:\'this\' argument does not satisfy \'DynamicallyAccessedMembersAttribute\' in call to target method. The return value of the source method does not have matching annotations.", Justification = AotHelper.SuppressionJustification)]
     private void AttachEventHandler()
     {
         try
@@ -89,6 +96,8 @@ private void AttachEventHandler()
         }
         catch (Exception ex)
         {
+            // If we get an exception we should let the user know how they can manually wire up the event handler.
+            // TODO: We need to create a mechanism for users to wire this up manually and document this in a separate PR
             _options.LogError(ex, "Could not attach WinUIUnhandledExceptionHandler.");
         }
     }

src/Sentry/Internal/AotHelper.cs

@@ -0,0 +1,28 @@
+namespace Sentry.Internal;
+
+internal static class AotHelper
+{
+    internal const string SuppressionJustification = "Non-trimmable code is avoided at runtime";
+
+    private class AotTester
+    {
+        public void Test() { }
+    }
+
+    internal static bool IsAot { get; }
+
+    static AotHelper()
+    {
+        try
+        {
+            // GetMethod should throw an exception if Trimming is enabled
+            var type = typeof(AotTester);
+            _ = type.GetMethod(nameof(AotTester.Test));
+        }
+        catch
+        {
+            IsAot = true;
+        }
+        IsAot = false;
+    }
+}

src/Sentry/Internal/DebugStackTrace.cs

@@ -1,7 +1,7 @@
 using Sentry.Internal.Extensions;
 using Sentry.Extensibility;
-using Sentry.Internal.ILSpy;
 using Sentry.Native;
+using Sentry.Internal.ILSpy;
 
 namespace Sentry.Internal;
 
@@ -155,20 +155,19 @@ internal void MergeDebugImagesInto(SentryEvent @event)
     /// <summary>
     /// Creates an enumerator of <see cref="SentryStackFrame"/> from a <see cref="StackTrace"/>.
     /// </summary>
+    [UnconditionalSuppressMessage("Trimming", "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code", Justification = AotHelper.SuppressionJustification)]
     private IEnumerable<SentryStackFrame> CreateFrames(StackTrace stackTrace, bool isCurrentStackTrace)
     {
-        var frames = _options.StackTraceMode switch
-        {
-            StackTraceMode.Enhanced => EnhancedStackTrace.GetFrames(stackTrace).Select(p => new RealStackFrame(p)),
-            _ => stackTrace.GetFrames()
-            // error CS8619: Nullability of reference types in value of type 'StackFrame?[]' doesn't match target type 'IEnumerable<StackFrame>'.
-#if NETCOREAPP3_0
+        var frames = (!AotHelper.IsAot && _options.StackTraceMode == StackTraceMode.Enhanced)
+            ? EnhancedStackTrace.GetFrames(stackTrace).Select(p => new RealStackFrame(p))
+            : stackTrace.GetFrames()
+                // error CS8619: Nullability of reference types in value of type 'StackFrame?[]' doesn't match target type 'IEnumerable<StackFrame>'.
+#if NETCOREAPP3_1
                 .Where(f => f is not null)
-                .Select(p => new RealStackFrame(p!))
+                .Select(p => new RealStackFrame(p!));
 #else
-                .Select(p => new RealStackFrame(p))
+                .Select(p => new RealStackFrame(p));
 #endif
-        };
 
         // Not to throw on code that ignores nullability warnings.
         if (frames.IsNull())
@@ -229,7 +228,7 @@ private IEnumerable<SentryStackFrame> CreateFrames(StackTrace stackTrace, bool i
 
     /// <summary>
     /// Native AOT implementation of CreateFrame.
-    /// Native frames have only limited method information at runtime (and even that can be disabled). 
+    /// Native frames have only limited method information at runtime (and even that can be disabled).
     ///  We try to parse that and also add addresses for server-side symbolication.
     /// </summary>
     private SentryStackFrame? TryCreateNativeAOTFrame(IStackFrame stackFrame)
@@ -255,7 +254,7 @@ private IEnumerable<SentryStackFrame> CreateFrames(StackTrace stackTrace, bool i
     }
 
     // Method info is currently only exposed by ToString(), see https://github.com/dotnet/runtime/issues/92869
-    // We only care about the case where the method is available (`StackTraceSupport` property is the default `true`): 
+    // We only care about the case where the method is available (`StackTraceSupport` property is the default `true`):
     // https://github.com/dotnet/runtime/blob/254230253da143a082f47cfaf8711627c0bf2faf/src/coreclr/nativeaot/System.Private.CoreLib/src/Internal/DeveloperExperience/DeveloperExperience.cs#L42
     internal static SentryStackFrame ParseNativeAOTToString(string info)
     {
@@ -272,6 +271,7 @@ internal static SentryStackFrame ParseNativeAOTToString(string info)
     /// <summary>
     /// Default the implementation of CreateFrame.
     /// </summary>
+    [UnconditionalSuppressMessage("Trimming", "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code", Justification = AotHelper.SuppressionJustification)]
     private SentryStackFrame? TryCreateManagedFrame(IStackFrame stackFrame)
     {
         if (stackFrame.GetMethod() is not { } method)
@@ -286,6 +286,8 @@ internal static SentryStackFrame ParseNativeAOTToString(string info)
             Package = method.DeclaringType?.Assembly.FullName
         };
 
+        frame.Function = method.Name;
+
         if (stackFrame.Frame is EnhancedStackFrame enhancedStackFrame)
         {
             var stringBuilder = new StringBuilder();
@@ -305,10 +307,6 @@ internal static SentryStackFrame ParseNativeAOTToString(string info)
                     : module;
             }
         }
-        else
-        {
-            frame.Function = method.Name;
-        }
 
         // Originally we didn't skip methods from dynamic assemblies, so not to break compatibility:
         if (_options.StackTraceMode != StackTraceMode.Original && method.Module.Assembly.IsDynamic)
@@ -336,7 +334,7 @@ internal static SentryStackFrame ParseNativeAOTToString(string info)
             {
                 // method.MetadataToken may throw
                 // see https://learn.microsoft.com/en-us/dotnet/api/system.reflection.memberinfo.metadatatoken?view=net-6.0
-                _options.LogDebug("Could not get MetadataToken for stack frame {0} from {1}", frame.Function, method.Module.Name);
+                _options.LogDebug("Could not get MetadataToken for stack frame {0} from {1}", frame.Function, method.Module.GetNameOrScopeName());
             }
         }
 
@@ -393,8 +391,7 @@ internal static SentryStackFrame ParseNativeAOTToString(string info)
             DemangleAnonymousFunction(frame);
             DemangleLambdaReturnType(frame);
         }
-
-        if (stackFrame.Frame is EnhancedStackFrame)
+        else
         {
             // In Enhanced mode, Module (which in this case is the Namespace)
             // is already prepended to the function, after return type.
@@ -489,8 +486,15 @@ private static void DemangleLambdaReturnType(SentryStackFrame frame)
         }
     }
 
+    [UnconditionalSuppressMessage("SingleFile", "IL3002:Avoid calling members marked with 'RequiresAssemblyFilesAttribute' when publishing as a single-file", Justification = AotHelper.SuppressionJustification)]
     private static PEReader? TryReadAssemblyFromDisk(Module module, SentryOptions options, out string? assemblyName)
     {
+        if (AotHelper.IsAot)
+        {
+            assemblyName = null;
+            return null;
+        }
+
         assemblyName = module.FullyQualifiedName;
         if (options.AssemblyReader is { } reader)
         {