Generate AotHelper properties at compile time

[jamescrosswell]

A couple of different options

Use built in attributes

The RuntimeFeature.IsDynamicCodeSupported Property looks like it might do what we want in many cases (I think we're using AotHelper.IsNativeAot where we should probably be checking for Trimming compatibility instead in some cases). Need to do a search for uses of AotHelper.IsNativeAot and a bit of a review of these.

Generate these at compile time

For this AotHelper, instead of:

sentry-dotnet/src/Sentry/Internal/AotHelper.cs

Lines 18 to 19 in 217c11c

	var stackTrace = new StackTrace(false);
	IsNativeAot = stackTrace.GetFrame(0)?.GetMethod() is null;

Could we instead write an attribute at compile time? I imagine it's a lot cheaper (worth measuring) than trying to get a stack trace on a static constructor:

Something like this:

sentry-dotnet/src/Sentry/buildTransitive/Sentry.targets

Lines 8 to 29 in 217c11c

	<Target Name="WriteSentryAttributes"
	Condition="$(Language) == 'VB' or $(Language) == 'C#' or $(Language) == 'F#'"
	BeforeTargets="BeforeCompile;CoreCompile"
	Inputs="$(MSBuildAllProjects)"
	Outputs="$(IntermediateOutputPath)$(SentryAttributesFile)">
	<PropertyGroup>
	<SentryAttributesFilePath>$(IntermediateOutputPath)$(SentryAttributesFile)</SentryAttributesFilePath>
	</PropertyGroup>
	<ItemGroup>
	<SentryAttributes Include="System.Reflection.AssemblyMetadata">
	<_Parameter1>Sentry.ProjectDirectory</_Parameter1>
	<_Parameter2>$(ProjectDir)</_Parameter2>
	</SentryAttributes>
	<!-- Ensure not part of Compile, as a workaround for https://github.com/dotnet/sdk/issues/114 -->
	<Compile Remove="$(SentryAttributesFilePath)" />
	</ItemGroup>
	<WriteCodeFragment AssemblyAttributes="@(SentryAttributes)" Language="$(Language)" OutputFile="$(SentryAttributesFilePath)">
	<Output Condition="$(Language) != 'F#'" TaskParameter="OutputFile" ItemName="Compile" />
	<Output Condition="$(Language) == 'F#'" TaskParameter="OutputFile" ItemName="CompileBefore" />
	<Output TaskParameter="OutputFile" ItemName="FileWrites" />
	</WriteCodeFragment>
	</Target>

Here's a PR that added writing the attribute at build time as a reference: #1739

Originally posted by @bruno-garcia in #2920 (comment)

References

• More info available here: https://devblogs.microsoft.com/dotnet/creating-aot-compatible-libraries/

[vaind]

For reference: dotnet/runtime#94380

[bitsandfoxes]

I assume this would cover some previously edge cases where the SDK wrongly assumes NativeAOT on unsupported platforms (i.e. UWP)?

[jamescrosswell]

I assume this would cover some previously edge cases where the SDK wrongly assumes NativeAOT on unsupported platforms (i.e. UWP)?

I think initially when we were building AOT support, we identified and tried to avoid (at runtime) code that would throw errors when compiling AOT. It may well be trimming, rather than AOT, that prevents those code blocks from running however and we should probably change our runtime guards to check for trimming rather than AOT.

Currently if NET8_0_OR_GREATER we check to see if trimming is enabled and, if not, we assume IsNativeAot is also enabled. For previous runtimes we always set IsNativeAot to disabled but still check whether trimming is enabled:

sentry-dotnet/src/Sentry/Internal/AotHelper.cs

Lines 13 to 34 in 9f36d22

	#if NET8_0_OR_GREATER
	// TODO this probably more closely represents trimming rather than NativeAOT?
	internal static bool IsNativeAot { get; }
	[UnconditionalSuppressMessage("Trimming", "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code", Justification = AotHelper.SuppressionJustification)]
	static AotHelper()
	{
	var stackTrace = new StackTrace(false);
	IsTrimmed = stackTrace.GetFrame(0)?.GetMethod() is null;
	IsNativeAot = IsTrimmed;
	}
	#else
	// This is a compile-time const so that the irrelevant code is removed during compilation.
	internal const bool IsNativeAot = false;
	[UnconditionalSuppressMessage("Trimming", "IL2026:Members annotated with 'RequiresUnreferencedCodeAttribute' require dynamic access otherwise can break functionality when trimming application code", Justification = AotHelper.SuppressionJustification)]
	static AotHelper()
	{
	var stackTrace = new StackTrace(false);
	IsTrimmed = stackTrace.GetFrame(0)?.GetMethod() is null;
	}
	#endif

I think that's a problem though. It's entirely possible to build net8.0 apps that are trimmed but not compiled AOT.

Then we have code like this:

sentry-dotnet/src/Sentry/Internal/DebugStackTrace.cs

Lines 179 to 181 in 233e95b

	var frames = (!AotHelper.IsNativeAot && _options.StackTraceMode == StackTraceMode.Enhanced)
	? EnhancedStackTrace.GetFrames(stackTrace).Select(p => new RealStackFrame(p))
	: stackTrace.GetFrames().Select(p => new RealStackFrame(p));

So it doesn't execute some potentially problematic code if IsNativeAot is set. On net8.0 that kind of works because there is an equivalence between trimming being enabled and native aot being detected. However on UWP that code would be executed even when trimming was enabled - which I think is what causes our problems on UWP.

[bitsandfoxes]

If I get that right then we could get around this issue on UWP by updating the check instead of having to rely on a dedicated package?

[jamescrosswell]

If I get that right then we could get around this issue on UWP by updating the check instead of having to rely on a dedicated package?

Possibly. We still wouldn't be able to hook up the unhandled exception handler automatically as that relies on reflection... but that's not a huge issue (people can copy/paste 6-7 lines of code to hook that up)... and I think there is some device information we can't capture without a dedicated UWP library since gathering that relies on Windows Native libraries.

[aritchie]

Proposal - Source generator to read msbuild propertygroup values that can be read at runtime by the SentrySDK

#3313 would also benefit from this solution.

cc @jamescrosswell

[aritchie]

Initial thoughts on how we could potentially do this via source generation - https://github.com/aritchie/BuildPropertyCapture

This will give us truth values for PublishTrimmed and PublishAot values. There are several issues at the moment which are listed in the readme of the project at the moment.

[jamescrosswell]

Initial thoughts on how we could potentially do this via source generation - https://github.com/aritchie/BuildPropertyCapture

Nice! We would want to vendor that into the sentry-dotnet repo (like we've done here and here) to minimise dependencies.

When I copy stuff from my own personal repos, I don't bother with an attribution.txt file etc. I've generally just left a comment in those cases.

[aritchie]

I did it in a separate repo to prove it out. There are a few issues that still have to be figured out and are documented in the readme. Once it is finished, it would be moved to a sentry project