fix: BuildProperty-Generator and AOT compilation detection (#4333)

---------

Co-authored-by: James Crosswell <[email protected]>

Author: Flash0ver

CHANGELOG.md

@@ -16,6 +16,7 @@
 - Sentry now decompresses Request bodies in ASP.NET Core when RequestDecompression middleware is enabled ([#4315](https://github.com/getsentry/sentry-dotnet/pull/4315))
 - Custom ISentryEventProcessors are now run for native iOS events ([#4318](https://github.com/getsentry/sentry-dotnet/pull/4318))
 - Crontab validation when capturing checkins ([#4314](https://github.com/getsentry/sentry-dotnet/pull/4314))
+- Fixed an issue with the way Sentry detects build settings. This was causing Sentry to produce code that could fail at runtime in AOT compiled applications. ([#4333](https://github.com/getsentry/sentry-dotnet/pull/4333))
 - Native AOT: link to static `lzma` on Linux/MUSL ([#4326](https://github.com/getsentry/sentry-dotnet/pull/4326))
 - AppDomain.CurrentDomain.ProcessExit hook is now removed on shutdown ([#4323](https://github.com/getsentry/sentry-dotnet/pull/4323))
 

samples/Sentry.Samples.Android/Sentry.Samples.Android.csproj

@@ -43,6 +43,4 @@
     <AndroidLinkMode>full</AndroidLinkMode>
   </PropertyGroup>
 
-  <!--In order to test our analyzers with this project, we manually reference our targets file.  User do not need to do this-->
-  <Import Project="..\..\src\Sentry\buildTransitive\Sentry.SourceGenerators.targets" />
 </Project>

samples/Sentry.Samples.Ios/Sentry.Samples.Ios.csproj

@@ -49,6 +49,4 @@
                       ReferenceOutputAssembly="false"/>
   </ItemGroup>
 
-  <!--In order to test our analyzers with this project, we manually reference our targets file.  User do not need to do this-->
-  <Import Project="..\..\src\Sentry\buildTransitive\Sentry.SourceGenerators.targets" />
 </Project>

samples/Sentry.Samples.MacCatalyst/Sentry.Samples.MacCatalyst.csproj

@@ -49,6 +49,4 @@
                       ReferenceOutputAssembly="false"/>
   </ItemGroup>
 
-  <!--In order to test our analyzers with this project, we manually reference our targets file.  User do not need to do this-->
-  <Import Project="..\..\src\Sentry\buildTransitive\Sentry.SourceGenerators.targets" />
 </Project>

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

@@ -115,6 +115,4 @@
     <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-->
-  <Import Project="..\..\src\Sentry\buildTransitive\Sentry.SourceGenerators.targets" />
 </Project>

src/Sentry.SourceGenerators/BuildPropertySourceGenerator.cs

@@ -4,12 +4,11 @@
 
 namespace Sentry.SourceGenerators;
 
-
 /// <summary>
 /// Generates the necessary msbuild variables
 /// </summary>
 [Generator(LanguageNames.CSharp)]
-public class BuildPropertySourceGenerator : ISourceGenerator
+public sealed class BuildPropertySourceGenerator : ISourceGenerator
 {
     /// <summary>
     /// Initialize the source gen
@@ -23,6 +22,8 @@ public void Initialize(GeneratorInitializationContext context)
     /// </summary>
     public void Execute(GeneratorExecutionContext context)
     {
+        const string tabString = "    ";
+
         var opts = context.AnalyzerConfigOptions.GlobalOptions;
         var properties = opts.Keys.Where(x => x.StartsWith("build_property.")).ToList();
         if (properties.Count == 0)
@@ -37,36 +38,34 @@ public void Execute(GeneratorExecutionContext context)
         }
 
         // we only want to generate code where host setup takes place
-        if (!opts.TryGetValue("build_property.outputtype", out var outputType))
-        {
-            return;
-        }
-
-        if (!outputType.Equals("exe", StringComparison.InvariantCultureIgnoreCase))
+        if (!context.Compilation.Options.OutputKind.IsExe())
         {
             return;
         }
 
         var sb = new StringBuilder();
         sb
             .Append(
-"""
+$$"""
 // <auto-generated>
-// Code generated by Sentry Source Generators
-// Changes may cause incorrect behavior and will be lost if the code is
-// regenerated.
+// This code was generated by Sentry.SourceGenerators.
+// Changes to this file may cause incorrect behavior and will be lost if the code is regenerated.
 // </auto-generated>
 
-#if NET8_0_OR_GREATER
-namespace Sentry;
+#if NET5_0_OR_GREATER
+
+#nullable enable
 
-[global::System.Runtime.CompilerServices.CompilerGenerated]
-public static class BuildVariableInitializer
+namespace Sentry.Generated
 {
-    [global::System.Runtime.CompilerServices.ModuleInitializer]
-    public static void Initialize()
+    [global::System.CodeDom.Compiler.GeneratedCodeAttribute("{{GeneratedCodeText.Tool}}", "{{GeneratedCodeText.Version}}")]
+    internal static class BuildPropertyInitializer
     {
-        global::Sentry.CompilerServices.BuildProperties.Initialize(new global::System.Collections.Generic.Dictionary<string, string> {
+        [global::System.Runtime.CompilerServices.ModuleInitializerAttribute]
+        internal static void Initialize()
+        {
+            global::Sentry.CompilerServices.BuildProperties.Initialize(new global::System.Collections.Generic.Dictionary<string, string>(global::System.StringComparer.OrdinalIgnoreCase)
+            {
 
 """
             );
@@ -78,21 +77,21 @@ public static void Initialize()
                 var pn = EscapeString(property.Replace("build_property.", ""));
                 var ev = EscapeString(value);
                 sb
-                    .Append("\t\t\t{")
+                    .Append($"{tabString}{tabString}{tabString}{tabString}{{")
                     .Append($"\"{pn}\", \"{ev}\"")
                     .AppendLine("},");
             }
         }
 
         sb
-            .AppendLine("\t\t});") // close dictionary
-            .AppendLine("\t}")
+            .AppendLine($"{tabString}{tabString}{tabString}}});") // close dictionary
+            .AppendLine($"{tabString}{tabString}}}")
+            .AppendLine($"{tabString}}}")
             .AppendLine("}")
             .AppendLine("#endif");
 
-        context.AddSource("__BuildProperties.g.cs", sb.ToString());
+        context.AddSource("Sentry.Generated.BuildPropertyInitializer.g.cs", sb.ToString());
     }
 
-
     private static string EscapeString(string value) => value.Replace("\\", "\\\\");
 }

src/Sentry.SourceGenerators/GeneratedCodeText.cs

@@ -0,0 +1,7 @@
+namespace Sentry.SourceGenerators;
+
+internal static class GeneratedCodeText
+{
+    public static string? Tool { get; } = typeof(BuildPropertySourceGenerator).Assembly.GetName().Name;
+    public static string? Version { get; } = typeof(BuildPropertySourceGenerator).Assembly.GetName().Version?.ToString();
+}

src/Sentry.SourceGenerators/OutputKindExtensions.cs

@@ -0,0 +1,20 @@
+using Microsoft.CodeAnalysis;
+
+namespace Sentry.SourceGenerators;
+
+internal static class OutputKindExtensions
+{
+    internal static bool IsExe(this OutputKind outputKind)
+    {
+        return outputKind switch
+        {
+            OutputKind.ConsoleApplication => true,
+            OutputKind.WindowsApplication => true,
+            OutputKind.DynamicallyLinkedLibrary => false,
+            OutputKind.NetModule => false,
+            OutputKind.WindowsRuntimeMetadata => false,
+            OutputKind.WindowsRuntimeApplication => true,
+            _ => false,
+        };
+    }
+}

src/Sentry/Internal/AotHelper.cs

@@ -1,4 +1,6 @@
+using System;
 using Sentry.CompilerServices;
+using Sentry.Extensibility;
 
 namespace Sentry.Internal;
 
@@ -13,31 +15,41 @@ static AotHelper()
         IsTrimmed = CheckIsTrimmed();
     }
 
-
     [UnconditionalSuppressMessage("Trimming", "IL2026: RequiresUnreferencedCode", Justification = AvoidAtRuntime)]
-    private static bool CheckIsTrimmed()
+    internal static bool CheckIsTrimmed(IDiagnosticLogger? logger = null)
     {
-        if (TryGetBoolean("publishtrimmed", out var trimmed))
+        if (TryGetBoolean("_IsPublishing", out var isPublishing) && isPublishing)
         {
-            return trimmed;
-        }
+            logger?.LogDebug("Detected _IsPublishing");
+            if (TryGetBoolean("PublishSelfContained", out var selfContained) && selfContained)
+            {
+                logger?.LogDebug("Detected PublishSelfContained");
+                if (TryGetBoolean("PublishTrimmed", out var trimmed))
+                {
+                    logger?.LogDebug("Detected PublishTrimmed");
+                    return trimmed;
+                }
+            }
 
-        if (TryGetBoolean("publishaot", out var aot))
-        {
-            return aot;
+            if (TryGetBoolean("PublishAot", out var aot))
+            {
+                logger?.LogDebug($"Detected PublishAot: {aot}");
+                return aot;
+            }
         }
 
         // fallback check
+        logger?.LogDebug("Stacktrace fallback");
         var stackTrace = new StackTrace(false);
         return stackTrace.GetFrame(0)?.GetMethod() is null;
     }
 
     private static bool TryGetBoolean(string key, out bool value)
     {
         value = false;
-        if (BuildProperties.Values?.TryGetValue(key, out var aotValue) ?? false)
+        if (BuildProperties.Values?.TryGetValue(key, out string? stringValue) ?? false)
         {
-            if (bool.TryParse(aotValue, out var result))
+            if (bool.TryParse(stringValue, out var result))
             {
                 value = result;
                 return true;

src/Sentry/Sentry.csproj

@@ -188,8 +188,6 @@
     <None Include="buildTransitive\Sentry.props" Pack="true" PackagePath="build\Sentry.props" />
     <None Include="buildTransitive\Sentry.targets" Pack="true" PackagePath="buildTransitive\Sentry.targets" />
     <None Include="buildTransitive\Sentry.targets" Pack="true" PackagePath="build\Sentry.targets" />
-    <None Include="buildTransitive\Sentry.SourceGenerators.targets" Pack="true" PackagePath="buildTransitive\Sentry.SourceGenerators.targets" />
-    <None Include="buildTransitive\Sentry.SourceGenerators.targets" Pack="true" PackagePath="build\Sentry.SourceGenerators.targets" />
   </ItemGroup>
 
   <ItemGroup>
@@ -198,4 +196,5 @@
           PackagePath="analyzers/dotnet/cs"
           Visible="false" />
   </ItemGroup>
+
 </Project>