observe and sync file attachments

Author: bitsandfoxes

sentry-android-ndk/src/main/java/io/sentry/android/ndk/NdkScopeObserver.java

@@ -1,5 +1,6 @@
 package io.sentry.android.ndk;
 
+import io.sentry.Attachment;
 import io.sentry.Breadcrumb;
 import io.sentry.DateUtils;
 import io.sentry.IScope;
@@ -145,4 +146,29 @@ public void setTrace(@Nullable SpanContext spanContext, @NotNull IScope scope) {
       options.getLogger().log(SentryLevel.ERROR, e, "Scope sync setTrace failed.");
     }
   }
+
+  @Override
+  public void addAttachment(final @NotNull Attachment attachment) {
+    final String pathname = attachment.getPathname();
+    if (pathname == null) {
+      // Only file-path attachments are getting synced to the native layer right now.
+      options.getLogger().log(SentryLevel.DEBUG, "Scope sync addAttachment skips non-file attachment.");
+      return;
+    }
+
+    try {
+      options.getExecutorService().submit(() -> nativeScope.addAttachment(pathname));
+    } catch (Throwable e) {
+      options.getLogger().log(SentryLevel.ERROR, e, "Scope sync addAttachment has an error.");
+    }
+  }
+
+  @Override
+  public void clearAttachments() {
+    try {
+      options.getExecutorService().submit(() -> nativeScope.clearAttachments());
+    } catch (Throwable e) {
+      options.getLogger().log(SentryLevel.ERROR, e, "Scope sync clearAttachments has an error.");
+    }
+  }
 }

sentry-android-ndk/src/test/java/io/sentry/android/ndk/NdkScopeObserverTest.kt

@@ -1,5 +1,6 @@
 package io.sentry.android.ndk
 
+import io.sentry.Attachment
 import io.sentry.Breadcrumb
 import io.sentry.DateUtils
 import io.sentry.JsonSerializer
@@ -153,4 +154,33 @@ class NdkScopeObserverTest {
     verify(fixture.nativeScope)
       .addBreadcrumb(anyOrNull(), anyOrNull(), anyOrNull(), anyOrNull(), anyOrNull(), anyOrNull())
   }
+
+  @Test
+  fun `add file-path attachment syncs to native scope`() {
+    val sut = fixture.getSut()
+
+    val attachment = Attachment("/data/data/com.example/files/log.txt")
+    sut.addAttachment(attachment)
+
+    verify(fixture.nativeScope).addAttachment("/data/data/com.example/files/log.txt")
+  }
+
+  @Test
+  fun `add byte attachment does not sync to native scope`() {
+    val sut = fixture.getSut()
+
+    val attachment = Attachment(byteArrayOf(1, 2, 3), "data.bin")
+    sut.addAttachment(attachment)
+
+    verify(fixture.nativeScope, never()).addAttachment(any())
+  }
+
+  @Test
+  fun `clear attachments forwards call to native scope`() {
+    val sut = fixture.getSut()
+
+    sut.clearAttachments()
+
+    verify(fixture.nativeScope).clearAttachments()
+  }
 }

sentry/src/main/java/io/sentry/IScopeObserver.java

@@ -45,4 +45,8 @@ public interface IScopeObserver {
   void setTrace(@Nullable SpanContext spanContext, @NotNull IScope scope);
 
   void setReplayId(@NotNull SentryId replayId);
+
+  void addAttachment(@NotNull Attachment attachment) {}
+
+  void clearAttachments() {}
 }

sentry/src/main/java/io/sentry/Scope.java

@@ -924,12 +924,20 @@ public List<Attachment> getAttachments() {
   @Override
   public void addAttachment(final @NotNull Attachment attachment) {
     attachments.add(attachment);
+
+    for (final IScopeObserver observer : options.getScopeObservers()) {
+      observer.addAttachment(attachment);
+    }
   }
 
   /** Clear all attachments. */
   @Override
   public void clearAttachments() {
     attachments.clear();
+
+    for (final IScopeObserver observer : options.getScopeObservers()) {
+      observer.clearAttachments();
+    }
   }
 
   /**

sentry/src/main/java/io/sentry/ScopeObserverAdapter.java

@@ -57,4 +57,10 @@ public void setTrace(@Nullable SpanContext spanContext, @NotNull IScope scope) {
 
   @Override
   public void setReplayId(@NotNull SentryId replayId) {}
+
+  @Override
+  public void addAttachment(@NotNull Attachment attachment) {}
+
+  @Override
+  public void clearAttachments() {}
 }