fix: Source context for class libraries when running on Android in Release mode

[jamescrosswell]

Resolves: #4278, #4342

• Partial source context in Release with multi-project MAUI apps #4278
• No line numbers or source code on Android #4342

Note

Introducing this change caused the Android Device Tests to start failing on CI only. After a lot of trial and error, I eventually narrowed it down to this test (which has therefore been disabled in CI on Android):

sentry-dotnet/test/Sentry.Maui.Tests/SentryMauiScreenshotTests.cs

Lines 184 to 189 in 9346258

	[SkippableFact]
	public async Task CaptureException_AttachScreenshot_Threadsafe()
	{
	#if ANDROID
	Skip.If(TestEnvironment.IsGitHubActions, "Flaky in CI on Android");
	#endif

[bruno-garcia]

looks like we have one logger but shouldn't this be a level Error log?

[jamescrosswell]

We'd have to refactor the AssemblyReader classes that we vendored in fomr MS in order to be able to do that (they use a different pattern for logging).

Probably the easiest would be to replace DebugLogger with our own IDiagnosticLogger... would involve quite a few changes, but then we've made so many changes to these already that the only way to merge in changes from new code is by hand. So a few more changes wouldn't hurt.

[jamescrosswell]

@bruno-garcia one remaining question on this PR is whether we want to refactor all the vendored in code to use our IDiagnosticLogger instead of the DebugLogger delegate that is used currently:

sentry-dotnet/src/Sentry.Android.AssemblyReader/DebugLogger.cs

Line 8 in 4ee96ee

public delegate void DebugLogger(string message, params object?[] args);

The existing delegate doesn't have any notion of "log levels" (so doesn't support what you suggested above).

[bruno-garcia]

I wouldn't add that as a requirement to unblock this. But it's not unreasonable to add if it'll help us debug this better going forward

[jamescrosswell]

k, I'll track that in a separate issue as I think we should get this fix out ASAP:

• Refactor AssemblyReaders to use our IDiagnosticLogger #4382

[jamescrosswell]

Note

This behaviour only manifests in CI (with the headless runners). Device tests work fine when run locally on a simulator.

Something very unusual happening with the device tests. Running against API levels 27 and 33, 27 always fails. 33 fails frequently (but not always).

Since Google require folks target 34 and higher to be able to release anything on the play store now, I figured I'd bump the API levels we test against to 34 (oldest supported) and 36 (latest). The also both seem to fail.

Looking at the logs, there don't appear to be any failed tests.

In one run, I noticed the last line that gets logged from .NET SDK is:

07-14 05:34:09.084  4252  4294 I DOTNET  : 	[IGNORED] Sentry.Maui.Tests.SentryMauiScreenshotTests.CaptureException_BeforeCaptureScreenshot_DefaultAsync

Shortly after that I see some logs from sentry-native:

07-14 05:34:10.213  4252  5450 I sentry-native: entering signal handler
07-14 05:34:10.225  4252  4280 I sentry-native: entering signal handler
07-14 05:34:10.229  4252  5450 D sentry-native: captured backtrace from ucontext with 1 frames
07-14 05:34:10.232  4252  5450 D sentry-native: captured backtrace with 1 frames
07-14 05:34:10.232  4252  5450 D sentry-native: merging scope into event
07-14 05:34:10.232  4252  5450 D sentry-native: trying to read modules from /proc/self/maps
...
07-14 05:34:11.726  4252  5439 I sentry-native: entering signal handler
...
07-14 05:34:11.828  4252  5450 D sentry-native: read 475 modules from /proc/self/maps
07-14 05:34:11.828  4252  5450 D sentry-native: adding attachments to envelope
07-14 05:34:11.828  4252  5450 D sentry-native: sending envelope
07-14 05:34:11.829  4252  5450 I sentry-native: crash has been captured

So it looks like potentially there is a low level crash that sentry-native is picking up and sending as an envelope. To where though and from which test?

Even then, this was only on the Run against API level 34... level 36 doesn't show any native errors.

[jamescrosswell]

The issues running android device tests in CI seem to manifest when running the SentryMauiOptionsTests, which is quite surprising since those tests are blindingly simple.

About my only hypothesis is that, by default, SentryOptions creates a new PollingNetworkStatusListener:

sentry-dotnet/src/Sentry/SentryOptions.cs

Line 1326 in 723c84e

NetworkStatusListener = new PollingNetworkStatusListener(this);

How this is in any way related to the changes this PR makes to the Android Assembly Readers in .NET 9 escapes me... but I'll try substituting in a Fake reliable network status listener. In a MAUI app, a MauiNetworkStatusListener would actually be used instead of either of these... but these particular tests have nothing to do with network status listeners so a fake should be fine (and it's easier to wire up).

[jamescrosswell]

OK after days of fluffing about disabling and enabling different tests in a protracted divide and conquer algorithm, it looks like this is the culprit (assuming there are no other flaky tests)... so I've disabled this in CI on Android:

sentry-dotnet/test/Sentry.Maui.Tests/SentryMauiScreenshotTests.cs

Lines 184 to 189 in 9346258

	[SkippableFact]
	public async Task CaptureException_AttachScreenshot_Threadsafe()
	{
	#if ANDROID
	Skip.If(TestEnvironment.IsGitHubActions, "Flaky in CI on Android");
	#endif

[bruno-garcia]

lgtm