code review

Author: tejasd

firebase-perf/src/main/java/com/google/firebase/perf/session/gauges/GaugeCounter.kt

@@ -14,6 +14,7 @@
 
 package com.google.firebase.perf.session.gauges
 
+import androidx.annotation.VisibleForTesting
 import com.google.firebase.perf.logging.AndroidLogger
 import java.util.concurrent.atomic.AtomicInteger
 
@@ -25,7 +26,9 @@ object GaugeCounter {
   private const val MAX_METRIC_COUNT = 25
   private val counter = AtomicInteger(0)
   private val logger = AndroidLogger.getInstance()
-  // TODO(b/394127311): Setting this as a var for a unit test. Refactor it.
+
+  @set:VisibleForTesting(otherwise = VisibleForTesting.NONE)
+  @set:JvmStatic
   var gaugeManager: GaugeManager = GaugeManager.getInstance()
 
   fun incrementCounter() {
@@ -43,11 +46,10 @@ object GaugeCounter {
     logger.debug("Decremented logger to $curr")
   }
 
-  // TODO: Add annotation to only call from tests
+  @VisibleForTesting(otherwise = VisibleForTesting.NONE)
   fun resetCounter() {
     counter.set(0)
   }
 
-  // TODO: Add annotation to only call from tests
-  fun count(): Int = counter.get()
+  @VisibleForTesting(otherwise = VisibleForTesting.NONE) fun count(): Int = counter.get()
 }

firebase-perf/src/test/java/com/google/firebase/perf/FirebasePerformanceTestBase.java

@@ -25,20 +25,13 @@
 import com.google.firebase.perf.config.ConfigResolver;
 import com.google.firebase.perf.session.PerfSession;
 import com.google.firebase.perf.session.SessionManager;
-import com.google.firebase.perf.session.gauges.GaugeCounter;
 import com.google.firebase.perf.util.ImmutableBundle;
 import org.junit.After;
 import org.junit.Before;
-import org.junit.BeforeClass;
 import org.robolectric.shadows.ShadowLog;
 import org.robolectric.shadows.ShadowPackageManager;
 
 public class FirebasePerformanceTestBase {
-  @BeforeClass
-  public static void setUpBeforeClass() {
-    GaugeCounter.INSTANCE.resetCounter();
-  }
-
   /**
    * The following values are needed by Firebase to identify the project and application that all
    * data stored in Firebase databases gets associated with. This is important to determine data

firebase-perf/src/test/java/com/google/firebase/perf/session/gauges/GaugeManagerTest.java

@@ -130,6 +130,7 @@ public void setUp() {
   @After
   public void tearDown() {
     shadowOf(Looper.getMainLooper()).idle();
+    GaugeCounter.INSTANCE.resetCounter();
   }
 
   @Test
@@ -331,11 +332,11 @@ 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);
-    GaugeCounter.INSTANCE.setGaugeManager(testGaugeManager);
+    GaugeCounter.setGaugeManager(testGaugeManager);
 
     // There's no job to log the gauges.
     assertThat(fakeScheduledExecutorService.isEmpty()).isTrue();
@@ -377,7 +378,7 @@ public void testUpdateAppStateHandlesMultipleAppStates() {
     fakeSession.setGaugeAndEventCollectionEnabled(true);
     testGaugeManager.setApplicationProcessState(ApplicationProcessState.FOREGROUND);
     testGaugeManager.startCollectingGauges(fakeSession);
-    GaugeCounter.INSTANCE.setGaugeManager(testGaugeManager);
+    GaugeCounter.setGaugeManager(testGaugeManager);
 
     // Generate metrics that don't exceed the GaugeCounter.MAX_COUNT.
     generateMetricsAndIncrementCounter(10);
@@ -429,7 +430,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);
@@ -519,7 +520,7 @@ public void testStopCollectingGaugesCreatesOneLastJobToConsumeAnyPendingMetrics(
             + recordedGaugeMetric.getCpuMetricReadingsCount();
     assertThat(recordedGaugeMetricsCount).isEqualTo(2);
 
-    // TODO(b/394127311): Investigate why this isn't 0 on local runs.
+    // TODO(b/394127311): Investigate why this isn't 0.
     //    assertThat(GaugeCounter.INSTANCE.count()).isEqualTo(0);
   }