Change FileName to be relative to project root

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Features
+
+- Send project root path with events ([#1739](https://github.com/getsentry/sentry-dotnet/pull/1739))
+
 ### Fixes
 
 - Fix error with `ConcurrentHashMap` on Android <= 9 ([#1761](https://github.com/getsentry/sentry-dotnet/pull/1761))

src/Sentry/AttributeReader.cs

@@ -0,0 +1,16 @@
+using System.Linq;
+using System.Reflection;
+
+namespace Sentry
+{
+    internal static class AttributeReader
+    {
+        public static bool TryGetProjectDirectory(Assembly assembly, out string? projectDirectory)
+        {
+            projectDirectory = assembly.GetCustomAttributes<AssemblyMetadataAttribute>()
+                .FirstOrDefault(x => x.Key == "Sentry.ProjectDirectory")
+                ?.Value;
+            return projectDirectory != null;
+        }
+    }
+}

src/Sentry/Extensibility/SentryStackTraceFactory.cs

@@ -148,7 +148,7 @@ internal IEnumerable<SentryStackFrame> CreateFrames(StackTrace stackTrace, bool
         protected SentryStackFrame InternalCreateFrame(StackFrame stackFrame, bool demangle)
         {
             const string unknownRequiredField = "(unknown)";
-
+            string? projectPath = null;
             var frame = new SentryStackFrame();
             if (GetMethod(stackFrame) is { } method)
             {
@@ -178,11 +178,19 @@ protected SentryStackFrame InternalCreateFrame(StackFrame stackFrame, bool deman
                 {
                     frame.InApp = false;
                 }
+
+                AttributeReader.TryGetProjectDirectory(method.Module.Assembly, out projectPath);
             }
 
             frame.ConfigureAppFrame(_options);
 
-            frame.FileName = stackFrame.GetFileName();
+            var frameFileName = stackFrame.GetFileName();
+            if (projectPath != null && frameFileName != null)
+            {
+                frameFileName = frameFileName.Replace(projectPath, "");
+            }
+
+            frame.FileName = frameFileName;
 
             // stackFrame.HasILOffset() throws NotImplemented on Mono 5.12
             var ilOffset = stackFrame.GetILOffset();

src/Sentry/Sentry.csproj

@@ -55,4 +55,9 @@
     <PackageReference Include="System.Text.Json" Version="5.0.2" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="buildTransitive\Sentry.props" Pack="true" PackagePath="buildTransitive\Sentry.props" />
+    <None Include="buildTransitive\Sentry.props" Pack="true" PackagePath="build\Sentry.props" />
+  </ItemGroup>
+
 </Project>

src/Sentry/buildTransitive/Sentry.props

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <PropertyGroup>
+    <SentryAttributesFile>Sentry.Attributes$(MSBuildProjectExtension.Replace('proj', ''))</SentryAttributesFile>
+  </PropertyGroup>
+  <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>
+      <SentryAttributes Include="System.Reflection.AssemblyMetadata"
+                        Condition="'$(SolutionDir)' != '' And '$(SolutionDir)' != '*Undefined*'">
+        <_Parameter1>Sentry.SolutionDirectory</_Parameter1>
+        <_Parameter2>$(SolutionDir)</_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>
+</Project>

test/Sentry.Tests/AttributeReaderTests.cs

@@ -0,0 +1,12 @@
+namespace Sentry.Tests;
+
+public class AttributeReaderTests
+{
+    [Fact]
+    public void Simple()
+    {
+        var assembly = typeof(AttributeReaderTests).Assembly;
+        Assert.True(AttributeReader.TryGetProjectDirectory(assembly, out var projectDirectory));
+        Assert.NotNull(projectDirectory);
+    }
+}

test/Sentry.Tests/Internals/SentryStackTraceFactoryTests.MethodGeneric_mode=Enhanced.verified.txt

@@ -1,5 +1,5 @@
 {
-  FileName: {ProjectDirectory}Internals/SentryStackTraceFactoryTests.cs,
+  FileName: Internals/SentryStackTraceFactoryTests.cs,
   Function: void SentryStackTraceFactoryTests.GenericMethodThatThrows<T>(T value),
   InApp: true
 }

test/Sentry.Tests/Internals/SentryStackTraceFactoryTests.MethodGeneric_mode=Original.verified.txt

@@ -1,5 +1,5 @@
 {
-  FileName: {ProjectDirectory}Internals/SentryStackTraceFactoryTests.cs,
+  FileName: Internals/SentryStackTraceFactoryTests.cs,
   Function: GenericMethodThatThrows,
   Module: Other.Tests.Internals.SentryStackTraceFactoryTests,
   InApp: true

test/Sentry.Tests/Internals/SentryStackTraceFactoryTests.cs

@@ -149,6 +149,29 @@ public void Create_WithExceptionAndAttachStackTraceOptionOn_HasStackTrace()
         Assert.Equal(new StackTrace(exception, true).FrameCount, stackTrace?.Frames.Count);
     }
 
+    [SkippableFact]
+    public void FileNameShouldBeRelative()
+    {
+        Skip.If(RuntimeInfo.GetRuntime().IsMono());
+
+        _fixture.SentryOptions.AttachStacktrace = true;
+        var sut = _fixture.GetSut();
+
+        Exception exception;
+        try
+        {
+            Throw();
+            void Throw() => throw new();
+        }
+        catch (Exception e)
+        {
+            exception = e;
+        }
+
+        var expected = Path.Combine("Internals", "SentryStackTraceFactoryTests.cs");
+        Assert.Equal(expected, sut.Create(exception)!.Frames[0].FileName);
+    }
+
     [Theory]
     [InlineData(StackTraceMode.Original, "ByRefMethodThatThrows")]
     [InlineData(StackTraceMode.Enhanced, "(Fixture f, int b) SentryStackTraceFactoryTests.ByRefMethodThatThrows(int value, in int valueIn, ref int valueRef, out int valueOut)")]

test/Sentry.Tests/Sentry.Tests.csproj

@@ -34,4 +34,6 @@
     </Compile>
   </ItemGroup>
 
+  <Import Project="..\..\src\Sentry\buildTransitive\Sentry.props" />
+
 </Project>