Fix #2710 - Return macOS instead of 'Darwin' and return proper version

CHANGELOG.md

@@ -9,6 +9,7 @@
 - Fixed envelopes with oversized attachments getting stuck in __processing ([#3938](https://github.com/getsentry/sentry-dotnet/pull/3938))
 - Unknown stack frames in profiles on .NET 8+ ([#3942](https://github.com/getsentry/sentry-dotnet/pull/3942))
 - Deduplicate profiling stack frames ([#3941](https://github.com/getsentry/sentry-dotnet/pull/3941))
+- OperatingSystem will now return macOS as OS name instead of 'Darwin' as well as the proper version. ([#2710](https://github.com/getsentry/sentry-dotnet/pull/3956))
 - Ignore null value on CocoaScopeObserver.SetTag ([#3948](https://github.com/getsentry/sentry-dotnet/pull/3948))
 
 ## 5.1.0

src/Sentry/Internal/Enricher.cs

@@ -45,8 +45,15 @@ public void Apply(IEventLike eventLike)
                 } catch {
                     eventLike.Contexts.OperatingSystem.RawDescription = Environment.OSVersion.VersionString;
                 }
+
 #else
                 eventLike.Contexts.OperatingSystem.RawDescription = RuntimeInformation.OSDescription;
+                if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX))
+                {
+                    // works for catalyst and net9 base
+                    eventLike.Contexts.OperatingSystem.Name = "macOS";
+                    eventLike.Contexts.OperatingSystem.Version = Environment.OSVersion.Version.ToString(); // reports macOS version (ie. 15.3.0)
+                }
 #endif
             }
         }

test/Sentry.Maui.Device.TestApp/Sentry.Maui.Device.TestApp.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFrameworks />
+    <TargetFrameworks></TargetFrameworks>
     <TargetFrameworks Condition="'$(NO_ANDROID)' == ''">$(TargetFrameworks);net8.0-android34.0</TargetFrameworks>
     <TargetFrameworks Condition="'$(NO_IOS)' == '' And $([MSBuild]::IsOSPlatform('OSX'))">$(TargetFrameworks);net8.0-ios17.0</TargetFrameworks>
     <UseMaui>true</UseMaui>
@@ -65,33 +65,33 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Maui.Controls" Version="$(MauiVersion)" />
-    <PackageReference Include="Microsoft.Maui.Core" Version="$(MauiVersion)" />
-    <PackageReference Include="Microsoft.Maui.Essentials" Version="$(MauiVersion)" />
+    <PackageReference Include="Microsoft.Maui.Controls" Version="$(MauiVersion)"/>
+    <PackageReference Include="Microsoft.Maui.Core" Version="$(MauiVersion)"/>
+    <PackageReference Include="Microsoft.Maui.Essentials" Version="$(MauiVersion)"/>
 
     <!-- https://github.com/advisories/GHSA-5f2m-466j-3848 -->
-    <PackageReference Include="System.Private.Uri" Version="4.3.2" />
+    <PackageReference Include="System.Private.Uri" Version="4.3.2"/>
   </ItemGroup>
 
   <!-- Configure XUnit -->
   <ItemGroup>
-    <AndroidAsset Include="..\xunit.runner.json" Condition="'$(TargetPlatformIdentifier)' == 'android'" />
-    <Content Include="..\xunit.runner.json" CopyToOutputDirectory="PreserveNewest" Condition="'$(TargetPlatformIdentifier)' == 'ios' Or '$(TargetPlatformIdentifier)' == 'maccatalyst'" />
+    <AndroidAsset Include="..\xunit.runner.json" Condition="'$(TargetPlatformIdentifier)' == 'android'"/>
+    <Content Include="..\xunit.runner.json" CopyToOutputDirectory="PreserveNewest" Condition="'$(TargetPlatformIdentifier)' == 'ios' Or '$(TargetPlatformIdentifier)' == 'maccatalyst'"/>
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="DeviceRunners.XHarness.Maui" Version="0.1.0-preview.1" />
-    <PackageReference Include="DeviceRunners.XHarness.Xunit" Version="0.1.0-preview.1" />
+    <PackageReference Include="DeviceRunners.XHarness.Maui" Version="0.1.0-preview.1"/>
+    <PackageReference Include="DeviceRunners.XHarness.Xunit" Version="0.1.0-preview.1"/>
     <!-- Prevent downgrade of these packages for DeviceRunners.XHarness.Xunit 0.1.0-preview.1   -->
-    <PackageReference Include="System.Net.Primitives" Version="4.3.0" />
-    <PackageReference Include="System.IO.FileSystem" Version="4.3.0" />
+    <PackageReference Include="System.Net.Primitives" Version="4.3.0"/>
+    <PackageReference Include="System.IO.FileSystem" Version="4.3.0"/>
   </ItemGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\Sentry.Android.AssemblyReader.Tests\Sentry.Android.AssemblyReader.Tests.csproj" Condition="'$(TargetPlatformIdentifier)' == 'android'" />
-    <ProjectReference Include="..\Sentry.Tests\Sentry.Tests.csproj" />
-    <ProjectReference Include="..\Sentry.Extensions.Logging.Tests\Sentry.Extensions.Logging.Tests.csproj" />
-    <ProjectReference Include="..\Sentry.Maui.Tests\Sentry.Maui.Tests.csproj" />
+    <ProjectReference Include="..\Sentry.Android.AssemblyReader.Tests\Sentry.Android.AssemblyReader.Tests.csproj" Condition="'$(TargetPlatformIdentifier)' == 'android'"/>
+    <ProjectReference Include="..\Sentry.Tests\Sentry.Tests.csproj"/>
+    <ProjectReference Include="..\Sentry.Extensions.Logging.Tests\Sentry.Extensions.Logging.Tests.csproj"/>
+    <ProjectReference Include="..\Sentry.Maui.Tests\Sentry.Maui.Tests.csproj"/>
   </ItemGroup>
 
 </Project>

test/Sentry.Tests/EnricherTests.cs

@@ -0,0 +1,24 @@
+#if NET6_0_OR_GREATER
+using Sentry.Tests;
+
+namespace Sentry.Maui.Tests;
+
+public class EnricherTests
+{
+    [PlatformFact(Platform.MacOS)]
+    public void macOS_Platform_Version()
+    {
+        var elike = Substitute.For<IEventLike>();
+        elike.Sdk.Returns(new SdkVersion());
+        elike.User = new SentryUser();
+        elike.Contexts = new SentryContexts();
+
+        var enricher = new Enricher(new SentryOptions());
+        enricher.Apply(elike);
+
+        var os = elike.Contexts.OperatingSystem;
+        os.Name.Should().Be("macOS");
+        os.Version.Should().Be(Environment.OSVersion.Version.ToString());
+    }
+}
+#endif

test/Sentry.Tests/PlatformFact.cs

@@ -0,0 +1,25 @@
+namespace Sentry.Tests;
+
+public enum Platform
+{
+    Windows,
+    Linux,
+    MacOS
+}
+
+public class PlatformFact : FactAttribute
+{
+    public PlatformFact(Platform platform)
+    {
+        var actual = platform switch
+        {
+            Platform.Windows => OSPlatform.Windows,
+            Platform.Linux => OSPlatform.Linux,
+            Platform.MacOS => OSPlatform.OSX,
+            _ => throw new NotSupportedException()
+        };
+
+        if (!RuntimeInformation.IsOSPlatform(actual))
+            Skip = "Ignored - Not Platform: " + actual;
+    }
+}