Debounce low memory breadcrumbs

Author: romtsn

sentry-android-core/src/main/java/io/sentry/android/core/AppComponentsBreadcrumbsIntegration.java

@@ -12,6 +12,8 @@
 import io.sentry.Integration;
 import io.sentry.SentryLevel;
 import io.sentry.SentryOptions;
+import io.sentry.android.core.internal.util.AndroidCurrentDateProvider;
+import io.sentry.android.core.internal.util.Debouncer;
 import io.sentry.android.core.internal.util.DeviceOrientations;
 import io.sentry.protocol.Device;
 import io.sentry.util.Objects;
@@ -24,10 +26,17 @@
 public final class AppComponentsBreadcrumbsIntegration
     implements Integration, Closeable, ComponentCallbacks2 {
 
+  private static final long DEBOUNCE_WAIT_TIME_MS = 60 * 1000;
+  // pre-allocate hint to avoid creating it every time for the low memory case
+  private static final @NotNull Hint EMPTY_HINT = new Hint();
+
   private final @NotNull Context context;
   private @Nullable IScopes scopes;
   private @Nullable SentryAndroidOptions options;
 
+  private final @NotNull Debouncer trimMemoryDebouncer =
+      new Debouncer(AndroidCurrentDateProvider.getInstance(), DEBOUNCE_WAIT_TIME_MS, 0);
+
   public AppComponentsBreadcrumbsIntegration(final @NotNull Context context) {
     this.context =
         Objects.requireNonNull(ContextUtils.getApplicationContext(context), "Context is required");
@@ -109,6 +118,11 @@ public void onTrimMemory(final int level) {
       return;
     }
 
+    if (trimMemoryDebouncer.checkForDebounce()) {
+      // if we received trim_memory within 1 minute time, ignore this call
+      return;
+    }
+
     final long now = System.currentTimeMillis();
     executeInBackground(() -> captureLowMemoryBreadcrumb(now, level));
   }
@@ -122,7 +136,7 @@ private void captureLowMemoryBreadcrumb(final long timeMs, final int level) {
       breadcrumb.setData("action", "LOW_MEMORY");
       breadcrumb.setData("level", level);
       breadcrumb.setLevel(SentryLevel.WARNING);
-      scopes.addBreadcrumb(breadcrumb);
+      scopes.addBreadcrumb(breadcrumb, EMPTY_HINT);
     }
   }
 

sentry-android-core/src/test/java/io/sentry/android/core/AppComponentsBreadcrumbsIntegrationTest.kt

@@ -15,6 +15,7 @@ import org.mockito.kotlin.check
 import org.mockito.kotlin.mock
 import org.mockito.kotlin.never
 import org.mockito.kotlin.verify
+import org.mockito.kotlin.verifyNoMoreInteractions
 import org.mockito.kotlin.whenever
 import java.lang.NullPointerException
 import kotlin.test.Test
@@ -109,7 +110,8 @@ class AppComponentsBreadcrumbsIntegrationTest {
                 assertEquals("device.event", it.category)
                 assertEquals("system", it.type)
                 assertEquals(SentryLevel.WARNING, it.level)
-            }
+            },
+            anyOrNull()
         )
     }
 
@@ -144,4 +146,26 @@ class AppComponentsBreadcrumbsIntegrationTest {
             anyOrNull()
         )
     }
+
+    @Test
+    fun `low memory changes are debounced`() {
+        val sut = fixture.getSut()
+
+        val scopes = mock<IScopes>()
+        val options = SentryAndroidOptions().apply {
+            executorService = ImmediateExecutorService()
+        }
+        sut.register(scopes, options)
+        sut.onTrimMemory(ComponentCallbacks2.TRIM_MEMORY_BACKGROUND)
+        sut.onTrimMemory(ComponentCallbacks2.TRIM_MEMORY_RUNNING_CRITICAL)
+
+        // should only add the first crumb
+        verify(scopes).addBreadcrumb(
+            check<Breadcrumb> {
+                assertEquals(it.data["level"], 40)
+            },
+            anyOrNull()
+        )
+        verifyNoMoreInteractions(scopes)
+    }
 }