Default `SentryOptions.Debug = true` for Debug build configurations #4330

jamescrosswell · 2025-07-09T00:18:37Z

Resolves #3212:

Support Auto Debug Mode #3212

jamescrosswell · 2025-07-09T00:21:14Z

test/Sentry.Tests/Sentry.Tests.csproj

@Flash0ver any idea how I can get the source generator working in the Sentry.Tests?

I think we need some way to test this... my thinking was basically to wire up SentryTests the same way the Samples are wired up and then set expectations based on #if DEBUG, which is implicitly set by the build configuration as well.

Actually, from what I can tell it's not just in the unit tests... the source generators don't appear to be working anywhere (even in the main branch):

Source Generators not working #4331

Indeed ... @jamescrosswell and I figured out that the [Generator] is loaded correctly, and is actually executing as well in consuming projects, but we made a mistake in the implementation so that no sources are ever emitted.

jamescrosswell · 2025-07-09T00:22:11Z

src/Sentry/Internal/AotHelper.cs

        {
            return trimmed;
        }

-        if (TryGetBoolean("publishaot", out var aot))
+        if (BuildProperties.TryGetBoolean("PublishAot", out var aot))


I think this is a major bug that was introduced by the initial PR including the source generator...

Great catch!
MSBuild is case-insensitive, and so should be the source that the [Generator] emits.
Will fix in #4331.

Fixed in #4333:

Changed the generated code to use case-insensitive lookup:

-BuildProperties.Initialize(new Dictionary<string, string>() +BuildProperties.Initialize(new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase)

Flash0ver · 2025-07-09T08:52:49Z

src/Sentry/SentryOptions.cs

@@ -1324,6 +1325,18 @@ public SentryOptions()
        );

        NetworkStatusListener = new PollingNetworkStatusListener(this);
+
+#if NET8_0_OR_GREATER


suggestion: Remove the preprocessor directive.

User code could build a .NET Framework app or a netcoreapp or older net app, while using a .NET SDK - or another Toolchain invoking the Compiler - that is compatible with Roslyn 4.3, such as the .NET SDK 6.0.400 or above.

In this case, I don't see a reason for "Auto Debug Mode" not to work.

The only thing, that we need to make very sure of, is that the source code that our Generator emits is compatible with <LangVersion>7.3</LangVersion>, which is the default C# language version used for .NET Standard 2.0 and .NET Framework TFMs.
Or alternatively let the Generator only emit code if the consuming project supports the C# language version that our generated source code requires via CSharpParseOptions.LanguageVersion.

Looks like from #4333 we need to leave the #if clause in there but we can change it to #if NET5_0_OR_GREATER

Indeed ... I was not able to remove it entirely from the generated source.
The highest dependency is ModuleInitializerAttribute, available since net5.0.

Flash0ver · 2025-07-09T11:03:33Z

src/Sentry/CompilerServices/BuildProperties.cs

+    /// <param name="key">The item key</param>
+    /// <param name="value">The value (if any)</param>
+    /// <returns>True if the key was found, false otherwise</returns>
+    public static bool TryGetBoolean(string key, out bool value)


suggestion: make internal

I don't think this needs to be accessible from the user's assembly where the Generator is emitting source to.

On the same note ... I think that the only member here, that needs to be accessible from the user's assembly, is the method Initialize(Dictionary<string, string>).

So I'm wondering if we should also make the Values property internal, since it should only be Sentry code reading it. And it's only the Initialize method that needs to be accessible for the source-generated [ModuleInitializer] to work.

Technically a breaking change, but since our source generator wasn't emitting any source code up until now, this IReadOnlyDictionary<string, string>? was always null anyways, so perhaps now may just be the time to make the Values property internal too.

Perhaps
see also https://github.com/getsentry/sentry-dotnet/pull/4330/files#r2194786902
we could make the Values property all private, so that Sentry also only access it via internal methods.

Flash0ver · 2025-07-09T11:19:10Z

src/Sentry/SentryOptions.cs

+        // See: https://develop.sentry.dev/sdk/expected-features/#auto-debug-mode
+        string? buildConfig = null;
+        BuildProperties.Values?.TryGetValue("Configuration", out buildConfig);
+        if (buildConfig == "Debug")


question: Case-sensitivity?

I wonder if this string equality check should be case insensitive 🤔

buildConfig.Equals("Debug", StringComparison.OrdinalIgnoreCase)

I think it should, but we should configure the underlying dictionary to be case insensitive... that way we don't have to worry about it in method calls like this right?

Via #4333, the generated lookup type is now case-insensitive:

-BuildProperties.Initialize(new Dictionary<string, string>() +BuildProperties.Initialize(new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase)

So we can lookup the "Configuration" Property case-insensitively.

But comparing the Value of the "Configuration"-Property here should also be done in a case-insensitive fashion. Or am I mixing something up here 🤔?

Flash0ver · 2025-07-09T11:34:42Z

src/Sentry/SentryOptions.cs

+        string? buildConfig = null;
+        BuildProperties.Values?.TryGetValue("Configuration", out buildConfig);
+        if (buildConfig == "Debug")


nitpick(style): Could we make this a one-liner?

I find this code a bit verbose.
Perhaps we could make this a one-liner:

if (BuildProperties.TryGetString("Configuration", out var buildConfig) && buildConfig == "Debug")

by adding a new internal method to BuildProperties:

// public static class BuildProperties internal static bool TryGetString(string key, [NotNullWhen(true)] out string? value) { if (Values?.TryGetValue(key, out var foundValue) == true) { value = foundValue; return true; } value = null; return false; }

and perhaps we could make the BuildProperties.Values property all private, so that we only have nicely consumable methods that work around the nullability of the IReadOnlyDictionary<string, string>.

Flash0ver · 2025-07-09T11:39:30Z

test/Sentry.Tests/Sentry.Tests.csproj

@@ -44,4 +44,12 @@
  <ItemGroup Condition="'$(TargetFramework)' != 'net48'">
    <PackageReference Include="Microsoft.Extensions.Configuration.Binder" Version="8.0.1" />
  </ItemGroup>
+
+  <!-- These are needed to test the AutoDebug functionality in SentryOptions on net8.0 targets and greater -->


note: Rephrase comment.

Depending on https://github.com/getsentry/sentry-dotnet/pull/4330/files#r2194449284
it may be independent of the target framework.

Couldn't make it TFM-agnostic, but lowered it in #4333:

-#if NET8_0_OR_GREATER +#if NET5_0_OR_GREATER

due to the generated code's dependency on ModuleInitializerAttribute, added in net5.0.

Flash0ver · 2025-07-09T11:39:55Z

test/Sentry.Tests/SentryOptionsTests.cs

@@ -675,4 +675,17 @@ public void CachesInstallationId()
        installationId2.Should().Be(installationId1);
        logger.Received(0).Log(SentryLevel.Debug, "Resolved installation ID '{0}'.", null, Arg.Any<string>());
    }
+
+#if NET8_0_OR_GREATER


note: Remove too.

Depending on https://github.com/getsentry/sentry-dotnet/pull/4330/files#r2194449284.

Couldn't make it TFM-agnostic, but lowered it in #4333:

-#if NET8_0_OR_GREATER +#if NET5_0_OR_GREATER

due to the generated code's dependency on ModuleInitializerAttribute, added in net5.0.

Flash0ver · 2025-07-10T10:46:52Z

samples/Directory.Build.targets

@@ -7,6 +7,7 @@
  <Import Project="$(MSBuildThisFileDirectory)..\src\Sentry.Bindings.Cocoa\buildTransitive\Sentry.Bindings.Cocoa.targets"
    Condition="'$(OutputType)' == 'Exe' And ('$(TargetPlatformIdentifier)' == 'ios' Or '$(TargetPlatformIdentifier)' == 'maccatalyst')" />
  <Import Project="$(MSBuildThisFileDirectory)..\src\Sentry\Platforms\Native\buildTransitive\Sentry.Native.targets" />
+  <Import Project="$(MSBuildThisFileDirectory)..\src\Sentry\buildTransitive\Sentry.SourceGenerators.targets" />


note: We deleted Sentry.SourceGenerators.targets in #4333.

It was redundant in the NuGet package, as only Sentry.props and Sentry.targets are automatically picked up in consuming projects (via PackageReference), and Sentry.SourceGenerators.targets was never Imported in any of these MSBuild files either.

jamescrosswell added 7 commits July 9, 2025 11:09

Refactor sourcegen references from Samples into Directory.* files

cbb85b2

Exclude SyntaxTree from Verify files in existing tests

88fd873

Added Configuration to tests

21a87b5

Fixed casing in AotHelper checks

9e6e173

Moved TryGetBoolean into the BuildProperties class

8967b6c

Added AutoDebug to options

67c700e

Attempting to add tests (committing for discussion)

84d9f19

jamescrosswell commented Jul 9, 2025

View reviewed changes

jamescrosswell added 2 commits July 9, 2025 12:27

Update CHANGELOG.md

1e79405

Update ApiApprovalTests.Run.DotNet8_0.verified.txt

a958fb3

Flash0ver reviewed Jul 9, 2025

View reviewed changes

Flash0ver reviewed Jul 10, 2025

View reviewed changes

Uh oh!

Default SentryOptions.Debug = true for Debug build configurations #4330

Are you sure you want to change the base?

Default SentryOptions.Debug = true for Debug build configurations #4330

Conversation

jamescrosswell commented Jul 9, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Flash0ver Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Flash0ver Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Flash0ver Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Flash0ver Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Flash0ver Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Flash0ver Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Flash0ver Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Flash0ver Jul 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Default `SentryOptions.Debug = true` for Debug build configurations #4330

Default `SentryOptions.Debug = true` for Debug build configurations #4330

Flash0ver Jul 9, 2025 •

edited

Loading

Flash0ver Jul 9, 2025 •

edited

Loading

Flash0ver Jul 10, 2025 •

edited

Loading

Flash0ver Jul 9, 2025 •

edited

Loading

Flash0ver Jul 10, 2025 •

edited

Loading

Flash0ver Jul 9, 2025 •

edited

Loading

Flash0ver Jul 10, 2025 •

edited

Loading

Flash0ver Jul 10, 2025 •

edited

Loading