Add gauge counter to collector tests (#6991)

tejasd · web-flow · commit 4ed0531855f8 · 2025-05-26T15:11:46.000-04:00
diff --git a/firebase-perf/src/main/java/com/google/firebase/perf/session/gauges/CpuGaugeCollector.java b/firebase-perf/src/main/java/com/google/firebase/perf/session/gauges/CpuGaugeCollector.java
@@ -166,7 +166,7 @@ private synchronized void scheduleCpuMetricCollectionWithRate(
                 CpuMetricReading currCpuReading = syncCollectCpuMetric(referenceTime);
                 if (currCpuReading != null) {
                   cpuMetricReadings.add(currCpuReading);
-                  GaugeCounter.INSTANCE.incrementCounter();
+                  GaugeCounter.incrementCounter();
                 }
               },
               /* initialDelay */ 0,
@@ -186,7 +186,7 @@ private synchronized void scheduleCpuMetricCollectionOnce(Timer referenceTime) {
                 CpuMetricReading currCpuReading = syncCollectCpuMetric(referenceTime);
                 if (currCpuReading != null) {
                   cpuMetricReadings.add(currCpuReading);
-                  GaugeCounter.INSTANCE.incrementCounter();
+                  GaugeCounter.incrementCounter();
                 }
               },
               /* initialDelay */ 0,
diff --git a/firebase-perf/src/main/java/com/google/firebase/perf/session/gauges/GaugeCounter.kt b/firebase-perf/src/main/java/com/google/firebase/perf/session/gauges/GaugeCounter.kt
@@ -31,6 +31,7 @@ object GaugeCounter {
   @set:JvmStatic
   var gaugeManager: GaugeManager = GaugeManager.getInstance()
 
+  @JvmStatic
   fun incrementCounter() {
     val metricsCount = counter.incrementAndGet()
 
@@ -41,15 +42,17 @@ object GaugeCounter {
     logger.debug("Incremented logger to $metricsCount")
   }
 
+  @JvmStatic
   fun decrementCounter() {
     val curr = counter.decrementAndGet()
     logger.debug("Decremented logger to $curr")
   }
 
   @VisibleForTesting(otherwise = VisibleForTesting.NONE)
+  @JvmStatic
   fun resetCounter() {
     counter.set(0)
   }
 
-  @VisibleForTesting(otherwise = VisibleForTesting.NONE) fun count(): Int = counter.get()
+  @VisibleForTesting(otherwise = VisibleForTesting.NONE) @JvmStatic fun count(): Int = counter.get()
 }
diff --git a/firebase-perf/src/main/java/com/google/firebase/perf/session/gauges/GaugeManager.java b/firebase-perf/src/main/java/com/google/firebase/perf/session/gauges/GaugeManager.java
@@ -250,19 +250,18 @@ private void logExistingGaugeMetrics(
    */
   private void syncFlush(String sessionId, ApplicationProcessState appState) {
     GaugeMetric.Builder gaugeMetricBuilder = GaugeMetric.newBuilder();
-    GaugeCounter gaugeCounter = GaugeCounter.INSTANCE;
 
     // Adding CPU metric readings.
     while (!cpuGaugeCollector.get().cpuMetricReadings.isEmpty()) {
       gaugeMetricBuilder.addCpuMetricReadings(cpuGaugeCollector.get().cpuMetricReadings.poll());
-      gaugeCounter.decrementCounter();
+      GaugeCounter.decrementCounter();
     }
 
     // Adding Memory metric readings.
     while (!memoryGaugeCollector.get().memoryMetricReadings.isEmpty()) {
       gaugeMetricBuilder.addAndroidMemoryReadings(
           memoryGaugeCollector.get().memoryMetricReadings.poll());
-      gaugeCounter.decrementCounter();
+      GaugeCounter.decrementCounter();
     }
 
     // Adding Session ID info.
diff --git a/firebase-perf/src/main/java/com/google/firebase/perf/session/gauges/MemoryGaugeCollector.java b/firebase-perf/src/main/java/com/google/firebase/perf/session/gauges/MemoryGaugeCollector.java
@@ -129,7 +129,7 @@ private synchronized void scheduleMemoryMetricCollectionWithRate(
                 AndroidMemoryReading memoryReading = syncCollectMemoryMetric(referenceTime);
                 if (memoryReading != null) {
                   memoryMetricReadings.add(memoryReading);
-                  GaugeCounter.INSTANCE.incrementCounter();
+                  GaugeCounter.incrementCounter();
                 }
               },
               /* initialDelay */ 0,
@@ -149,7 +149,7 @@ private synchronized void scheduleMemoryMetricCollectionOnce(Timer referenceTime
                 AndroidMemoryReading memoryReading = syncCollectMemoryMetric(referenceTime);
                 if (memoryReading != null) {
                   memoryMetricReadings.add(memoryReading);
-                  GaugeCounter.INSTANCE.incrementCounter();
+                  GaugeCounter.incrementCounter();
                 }
               },
               /* initialDelay */ 0,
diff --git a/firebase-perf/src/test/java/com/google/firebase/perf/FirebasePerformanceTestBase.java b/firebase-perf/src/test/java/com/google/firebase/perf/FirebasePerformanceTestBase.java
@@ -59,7 +59,7 @@ public class FirebasePerformanceTestBase {
   @BeforeClass
   public static void setUpBeforeClass() {
     // TODO(b/394127311): Explore removing this.
-    GaugeCounter.INSTANCE.resetCounter();
+    GaugeCounter.resetCounter();
   }
 
   @Before
diff --git a/firebase-perf/src/test/java/com/google/firebase/perf/session/gauges/CpuGaugeCollectorTest.java b/firebase-perf/src/test/java/com/google/firebase/perf/session/gauges/CpuGaugeCollectorTest.java
@@ -60,9 +60,11 @@ public void tearDown() {
   @Test
   public void testStartCollectingAddsCpuMetricReadingsToTheConcurrentLinkedQueue()
       throws Exception {
+    int priorGaugeCount = GaugeCounter.count();
     testGaugeCollector.startCollecting(100, new Timer());
     fakeScheduledExecutorService.simulateSleepExecutingAtMostOneTask();
     assertThat(testGaugeCollector.cpuMetricReadings).hasSize(1);
+    assertThat(GaugeCounter.count()).isEqualTo(priorGaugeCount + 1);
   }
 
   @Test
@@ -246,11 +248,17 @@ public void testCollectCpuMetricDoesntStartCollectingWithInvalidCpuMetricCollect
 
   @Test
   public void testCollectOnce_addOnlyOneCpuMetricReadingToQueue() {
+    int priorGaugeCount = GaugeCounter.count();
     assertThat(testGaugeCollector.cpuMetricReadings).isEmpty();
     testGaugeCollector.collectOnce(new Timer());
 
     fakeScheduledExecutorService.simulateSleepExecutingAtMostOneTask();
+
+    // Simulate running an additional task.
+    fakeScheduledExecutorService.simulateSleepExecutingAtMostOneTask();
+
     assertThat(testGaugeCollector.cpuMetricReadings).hasSize(1);
+    assertThat(GaugeCounter.count()).isEqualTo(priorGaugeCount + 1);
   }
 
   @Test
diff --git a/firebase-perf/src/test/java/com/google/firebase/perf/session/gauges/GaugeManagerTest.java b/firebase-perf/src/test/java/com/google/firebase/perf/session/gauges/GaugeManagerTest.java
@@ -331,7 +331,7 @@ public void stopCollectingGauges_invalidGaugeCollectionFrequency_appInForeground
   }
 
   @Test
-  public void testGaugeCounterStartsAJobToConsumeTheGeneratedMetrics() throws InterruptedException {
+  public void testGaugeCounterStartsAJobToConsumeTheGeneratedMetrics() {
     PerfSession fakeSession = createTestSession(1);
     testGaugeManager.setApplicationProcessState(ApplicationProcessState.FOREGROUND);
     testGaugeManager.startCollectingGauges(fakeSession);
@@ -371,6 +371,36 @@ public void testGaugeCounterStartsAJobToConsumeTheGeneratedMetrics() throws Inte
     assertThat(recordedGaugeMetric.getSessionId()).isEqualTo(testSessionId(1));
   }
 
+  @Test
+  public void testGaugeCounterIsDecrementedWhenLogged() {
+    int priorGaugeCounter = GaugeCounter.count();
+
+    PerfSession fakeSession = createTestSession(1);
+    testGaugeManager.setApplicationProcessState(ApplicationProcessState.FOREGROUND);
+    testGaugeManager.startCollectingGauges(fakeSession);
+    GaugeCounter.setGaugeManager(testGaugeManager);
+
+    // There's no job to log the gauges.
+    assertThat(fakeScheduledExecutorService.isEmpty()).isTrue();
+
+    // Generate metrics that don't exceed the GaugeCounter.MAX_COUNT.
+    generateMetricsAndIncrementCounter(20);
+
+    // There's still no job to log the gauges.
+    assertThat(fakeScheduledExecutorService.isEmpty()).isTrue();
+
+    generateMetricsAndIncrementCounter(10);
+
+    assertThat(fakeScheduledExecutorService.isEmpty()).isFalse();
+    assertThat(fakeScheduledExecutorService.getDelayToNextTask(TimeUnit.MILLISECONDS))
+        .isEqualTo(TIME_TO_WAIT_BEFORE_FLUSHING_GAUGES_QUEUE_MS);
+
+    assertThat(GaugeCounter.count()).isEqualTo(priorGaugeCounter + 30);
+    fakeScheduledExecutorService.simulateSleepExecutingAtMostOneTask();
+
+    assertThat(GaugeCounter.count()).isEqualTo(priorGaugeCounter);
+  }
+
   @Test
   public void testUpdateAppStateHandlesMultipleAppStates() {
     PerfSession fakeSession = createTestSession(1);
@@ -429,7 +459,7 @@ public void testGaugeManagerHandlesMultipleSessionIds() {
     fakeSession.setGaugeAndEventCollectionEnabled(true);
     testGaugeManager.setApplicationProcessState(ApplicationProcessState.BACKGROUND);
     testGaugeManager.startCollectingGauges(fakeSession);
-    GaugeCounter.INSTANCE.setGaugeManager(testGaugeManager);
+    GaugeCounter.setGaugeManager(testGaugeManager);
 
     // Generate metrics that don't exceed the GaugeCounter.MAX_COUNT.
     generateMetricsAndIncrementCounter(10);
@@ -615,10 +645,10 @@ private void generateMetricsAndIncrementCounter(int count) {
     for (int i = 0; i < count; ++i) {
       if (random.nextInt(2) == 0) {
         fakeCpuGaugeCollector.cpuMetricReadings.add(createFakeCpuMetricReading(100, 200));
-        GaugeCounter.INSTANCE.incrementCounter();
+        GaugeCounter.incrementCounter();
       } else {
         fakeMemoryGaugeCollector.memoryMetricReadings.add(createFakeAndroidMetricReading(100));
-        GaugeCounter.INSTANCE.incrementCounter();
+        GaugeCounter.incrementCounter();
       }
     }
   }
diff --git a/firebase-perf/src/test/java/com/google/firebase/perf/session/gauges/MemoryGaugeCollectorTest.java b/firebase-perf/src/test/java/com/google/firebase/perf/session/gauges/MemoryGaugeCollectorTest.java
@@ -59,9 +59,11 @@ private void mockMemory() {
 
   @Test
   public void testStartCollecting_addsMemoryMetricReadingsToQueue() {
+    int priorGaugeCount = GaugeCounter.count();
     testGaugeCollector.startCollecting(/* memoryMetricCollectionRateMs= */ 100, new Timer());
     fakeScheduledExecutorService.simulateSleepExecutingAtMostOneTask();
     assertThat(testGaugeCollector.memoryMetricReadings).hasSize(1);
+    assertThat(GaugeCounter.count()).isEqualTo(priorGaugeCount + 1);
   }
 
   @Test
@@ -148,11 +150,17 @@ public void testCollectedMemoryMetric_containsApproximatelyCorrectTimestamp() {
 
   @Test
   public void testCollectOnce_addOnlyOneMemoryMetricReadingToQueue() {
+    int priorGaugeCount = GaugeCounter.count();
     assertThat(testGaugeCollector.memoryMetricReadings).isEmpty();
     testGaugeCollector.collectOnce(new Timer());
 
     fakeScheduledExecutorService.simulateSleepExecutingAtMostOneTask();
+
+    // Simulate running an additional task.
+    fakeScheduledExecutorService.simulateSleepExecutingAtMostOneTask();
+
     assertThat(testGaugeCollector.memoryMetricReadings).hasSize(1);
+    assertThat(GaugeCounter.count()).isEqualTo(priorGaugeCount + 1);
   }
 
   @Test

Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,7 @@ object GaugeCounter {`
`31`	`31`	`@set:JvmStatic`
`32`	`32`	`var gaugeManager: GaugeManager = GaugeManager.getInstance()`
`33`	`33`
	`34`	`+ @JvmStatic`
`34`	`35`	`fun incrementCounter() {`
`35`	`36`	`val metricsCount = counter.incrementAndGet()`
`36`	`37`
`@@ -41,15 +42,17 @@ object GaugeCounter {`
`41`	`42`	`logger.debug("Incremented logger to $metricsCount")`
`42`	`43`	`}`
`43`	`44`
	`45`	`+ @JvmStatic`
`44`	`46`	`fun decrementCounter() {`
`45`	`47`	`val curr = counter.decrementAndGet()`
`46`	`48`	`logger.debug("Decremented logger to $curr")`
`47`	`49`	`}`
`48`	`50`
`49`	`51`	`@VisibleForTesting(otherwise = VisibleForTesting.NONE)`
	`52`	`+ @JvmStatic`
`50`	`53`	`fun resetCounter() {`
`51`	`54`	`counter.set(0)`
`52`	`55`	`}`
`53`	`56`
`54`		`- @VisibleForTesting(otherwise = VisibleForTesting.NONE) fun count(): Int = counter.get()`
	`57`	`+ @VisibleForTesting(otherwise = VisibleForTesting.NONE) @JvmStatic fun count(): Int = counter.get()`
`55`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ public class FirebasePerformanceTestBase {`
`59`	`59`	`@BeforeClass`
`60`	`60`	`public static void setUpBeforeClass() {`
`61`	`61`	`// TODO(b/394127311): Explore removing this.`
`62`		`- GaugeCounter.INSTANCE.resetCounter();`
	`62`	`+ GaugeCounter.resetCounter();`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`@Before`