feat: Scope sync attachments (#5038)

Co-authored-by: sentry-warden[bot] <258096371+sentry-warden[bot]@users.noreply.github.com>

Author: bitsandfoxes

src/Sentry/ByteAttachmentContent.cs

@@ -5,13 +5,16 @@ namespace Sentry;
 /// </summary>
 public class ByteAttachmentContent : IAttachmentContent
 {
-    private readonly byte[] _bytes;
+    /// <summary>
+    /// The raw bytes of the attachment.
+    /// </summary>
+    internal byte[] Bytes { get; }
 
     /// <summary>
     /// Creates a new instance of <see cref="ByteAttachmentContent"/>.
     /// </summary>
-    public ByteAttachmentContent(byte[] bytes) => _bytes = bytes;
+    public ByteAttachmentContent(byte[] bytes) => Bytes = bytes;
 
     /// <inheritdoc />
-    public Stream GetStream() => new MemoryStream(_bytes);
+    public Stream GetStream() => new MemoryStream(Bytes);
 }

src/Sentry/FileAttachmentContent.cs

@@ -7,9 +7,13 @@ namespace Sentry;
 /// </summary>
 public class FileAttachmentContent : IAttachmentContent
 {
-    private readonly string _filePath;
     private readonly bool _readFileAsynchronously;
 
+    /// <summary>
+    /// The path to the file to attach.
+    /// </summary>
+    internal string FilePath { get; }
+
     /// <summary>
     /// Creates a new instance of <see cref="FileAttachmentContent"/>.
     /// </summary>
@@ -25,13 +29,13 @@ public FileAttachmentContent(string filePath) : this(filePath, true)
     /// <param name="readFileAsynchronously">Whether to use async file I/O to read the file.</param>
     public FileAttachmentContent(string filePath, bool readFileAsynchronously)
     {
-        _filePath = filePath;
+        FilePath = filePath;
         _readFileAsynchronously = readFileAsynchronously;
     }
 
     /// <inheritdoc />
     public Stream GetStream() => new FileStream(
-        _filePath,
+        FilePath,
         FileMode.Open,
         FileAccess.Read,
         FileShare.ReadWrite,

src/Sentry/IScopeObserver.cs

@@ -34,4 +34,14 @@ public interface IScopeObserver
     /// Sets the current trace
     /// </summary>
     public void SetTrace(SentryId traceId, SpanId parentSpanId);
+
+    /// <summary>
+    /// Adds an attachment.
+    /// </summary>
+    public void AddAttachment(SentryAttachment attachment);
+
+    /// <summary>
+    /// Clears all attachments.
+    /// </summary>
+    public void ClearAttachments();
 }

src/Sentry/Internal/ScopeObserver.cs

@@ -94,4 +94,22 @@ public void SetTrace(SentryId traceId, SpanId parentSpanId)
     }
 
     public abstract void SetTraceImpl(SentryId traceId, SpanId parentSpanId);
+
+    public void AddAttachment(SentryAttachment attachment)
+    {
+        _options.DiagnosticLogger?.Log(SentryLevel.Debug,
+            "{0} Scope Sync - Adding attachment '{1}'", null, _name, attachment.FileName);
+        AddAttachmentImpl(attachment);
+    }
+
+    public abstract void AddAttachmentImpl(SentryAttachment attachment);
+
+    public void ClearAttachments()
+    {
+        _options.DiagnosticLogger?.Log(
+            SentryLevel.Debug, "{0} Scope Sync - Clearing attachments", null, _name);
+        ClearAttachmentsImpl();
+    }
+
+    public abstract void ClearAttachmentsImpl();
 }

src/Sentry/Platforms/Android/AndroidScopeObserver.cs

@@ -104,4 +104,28 @@ public void SetTrace(SentryId traceId, SpanId parentSpanId)
     {
         // TODO: This requires sentry-java 8.4.0
     }
+
+    public void AddAttachment(SentryAttachment attachment)
+    {
+        try
+        {
+            // TODO: Missing corresponding functionality on the Android SDK
+        }
+        finally
+        {
+            _innerObserver?.AddAttachment(attachment);
+        }
+    }
+
+    public void ClearAttachments()
+    {
+        try
+        {
+            // TODO: Missing corresponding functionality on the Android SDK
+        }
+        finally
+        {
+            _innerObserver?.ClearAttachments();
+        }
+    }
 }

src/Sentry/Platforms/Cocoa/CocoaScopeObserver.cs

@@ -112,4 +112,28 @@ public void SetTrace(SentryId traceId, SpanId parentSpanId)
     {
         // TODO: Missing corresponding functionality on the Cocoa SDK
     }
+
+    public void AddAttachment(SentryAttachment attachment)
+    {
+        try
+        {
+            // TODO: Missing corresponding functionality on the Cocoa SDK
+        }
+        finally
+        {
+            _innerObserver?.AddAttachment(attachment);
+        }
+    }
+
+    public void ClearAttachments()
+    {
+        try
+        {
+            // TODO: Missing corresponding functionality on the Cocoa SDK
+        }
+        finally
+        {
+            _innerObserver?.ClearAttachments();
+        }
+    }
 }

src/Sentry/Platforms/Native/NativeScopeObserver.cs

@@ -43,6 +43,16 @@ public override void SetUserImpl(SentryUser user)
     public override void SetTraceImpl(SentryId traceId, SpanId parentSpanId) =>
         C.sentry_set_trace(traceId.ToString(), parentSpanId.ToString());
 
+    public override void AddAttachmentImpl(SentryAttachment attachment)
+    {
+        // TODO: Missing corresponding functionality on the Native SDK
+    }
+
+    public override void ClearAttachmentsImpl()
+    {
+        // TODO: Missing corresponding functionality on the Native SDK
+    }
+
     private static string GetTimestamp(DateTimeOffset timestamp) =>
         // "o": Using ISO 8601 to make sure the timestamp makes it to the bridge correctly.
         // https://docs.microsoft.com/en-gb/dotnet/standard/base-types/standard-date-and-time-format-strings#Roundtrip

src/Sentry/Scope.cs

@@ -390,7 +390,14 @@ public void UnsetTag(string key)
     /// <summary>
     /// Adds an attachment.
     /// </summary>
-    public void AddAttachment(SentryAttachment attachment) => _attachments.Add(attachment);
+    public void AddAttachment(SentryAttachment attachment)
+    {
+        _attachments.Add(attachment);
+        if (Options.EnableScopeSync)
+        {
+            Options.ScopeObserver?.AddAttachment(attachment);
+        }
+    }
 
     internal void SetPropagationContext(SentryPropagationContext propagationContext)
     {
@@ -433,6 +440,10 @@ public void ClearAttachments()
 #else
         _attachments.Clear();
 #endif
+        if (Options.EnableScopeSync)
+        {
+            Options.ScopeObserver?.ClearAttachments();
+        }
     }
 
     /// <summary>
@@ -535,7 +546,8 @@ public void Apply(Scope other)
 
         foreach (var attachment in Attachments)
         {
-            other.AddAttachment(attachment);
+            // Set the attachment directly to avoid triggering a scope sync
+            other._attachments.Add(attachment);
         }
     }
 

test/Sentry.Tests/ApiApprovalTests.Run.DotNet10_0.verified.txt

@@ -217,7 +217,9 @@ namespace Sentry
     }
     public interface IScopeObserver
     {
+        void AddAttachment(Sentry.SentryAttachment attachment);
         void AddBreadcrumb(Sentry.Breadcrumb breadcrumb);
+        void ClearAttachments();
         void SetExtra(string key, object? value);
         void SetTag(string key, string value);
         void SetTrace(Sentry.SentryId traceId, Sentry.SpanId parentSpanId);

test/Sentry.Tests/ApiApprovalTests.Run.DotNet8_0.verified.txt

@@ -217,7 +217,9 @@ namespace Sentry
     }
     public interface IScopeObserver
     {
+        void AddAttachment(Sentry.SentryAttachment attachment);
         void AddBreadcrumb(Sentry.Breadcrumb breadcrumb);
+        void ClearAttachments();
         void SetExtra(string key, object? value);
         void SetTag(string key, string value);
         void SetTrace(Sentry.SentryId traceId, Sentry.SpanId parentSpanId);