Re-introduce gauge metadata collection

Author: tejasd

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

@@ -2,6 +2,7 @@ package com.google.firebase.perf.session
 
 import com.google.firebase.perf.config.ConfigResolver
 import com.google.firebase.perf.logging.AndroidLogger
+import com.google.firebase.perf.session.gauges.GaugeManager
 import com.google.firebase.sessions.api.SessionSubscriber
 
 class FirebasePerformanceSessionSubscriber(private val dataCollectionEnabled: Boolean) :
@@ -29,6 +30,9 @@ class FirebasePerformanceSessionSubscriber(private val dataCollectionEnabled: Bo
       SessionManager.getInstance().updatePerfSession(newSession)
       perfSessionToAqs[newSession.sessionId()] = sessionDetails
     }
+
+    // Always log GaugeMetadata when a session changes.
+    GaugeManager.getInstance().logGaugeMetadata(sessionDetails.sessionId)
   }
 
   fun reportPerfSession(perfSessionId: String) {

firebase-perf/src/main/java/com/google/firebase/perf/session/SessionManager.java

@@ -29,8 +29,6 @@
 import java.util.Iterator;
 import java.util.Objects;
 import java.util.Set;
-import java.util.concurrent.ExecutorService;
-import java.util.concurrent.Executors;
 import java.util.concurrent.Future;
 
 /** Session manager to generate sessionIDs and broadcast to the application. */
@@ -76,14 +74,7 @@ public SessionManager(
    * (currently that is before onResume finishes) to ensure gauge collection starts on time.
    */
   public void setApplicationContext(final Context appContext) {
-    // TODO(b/258263016): Migrate to go/firebase-android-executors
-    @SuppressLint("ThreadPoolCreation")
-    ExecutorService executorService = Executors.newSingleThreadExecutor();
-    syncInitFuture =
-        executorService.submit(
-            () -> {
-              gaugeManager.initializeGaugeMetadataManager(appContext);
-            });
+    gaugeManager.initializeGaugeMetadataManager(appContext, ApplicationProcessState.FOREGROUND);
   }
 
   /**

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

@@ -95,8 +95,10 @@ private GaugeManager() {
   }
 
   /** Initializes GaugeMetadataManager which requires application context. */
-  public void initializeGaugeMetadataManager(Context appContext) {
+  public void initializeGaugeMetadataManager(
+      Context appContext, ApplicationProcessState applicationProcessState) {
     this.gaugeMetadataManager = new GaugeMetadataManager(appContext);
+    this.applicationProcessState = applicationProcessState;
   }
 
   /** Returns the singleton instance of this class. */
@@ -255,28 +257,20 @@ private void syncFlush(String sessionId, ApplicationProcessState appState) {
   /**
    * Log the Gauge Metadata information to the transport.
    *
-   * @param sessionId The {@link PerfSession#sessionId()} to which the collected Gauge Metrics
+   * @param aqsSessionId The {@link FirebasePerformanceSessionSubscriber#getAqsMappedToPerfSession(String)} to which the collected Gauge Metrics
    *     should be associated with.
-   * @param appState The {@link ApplicationProcessState} for which these gauges are collected.
    * @return true if GaugeMetadata was logged, false otherwise.
    */
-  public boolean logGaugeMetadata(String sessionId, ApplicationProcessState appState) {
-    // TODO(b/394127311): Re-introduce logging of metadata for AQS.
-    String aqsSessionId =
-        FirebasePerformanceSessionSubscriber.Companion.getInstance()
-            .getAqsMappedToPerfSession(sessionId);
-    AndroidLogger.getInstance()
-        .debug("CFPR logGaugeMetadata: " + sessionId + " AQS: " + aqsSessionId);
-    if (gaugeMetadataManager != null) {
-      GaugeMetric gaugeMetric =
-          GaugeMetric.newBuilder()
-              .setSessionId(aqsSessionId)
-              .setGaugeMetadata(getGaugeMetadata())
-              .build();
-      transportManager.log(gaugeMetric, appState);
-      return true;
-    }
-    return false;
+  public void logGaugeMetadata(String aqsSessionId) {
+    // TODO(b/394127311): This can now throw an NPE. Explore if there's anything that should be
+    // verified.
+    AndroidLogger.getInstance().debug("CFPR logGaugeMetadata: " + aqsSessionId);
+    GaugeMetric gaugeMetric =
+        GaugeMetric.newBuilder()
+            .setSessionId(aqsSessionId)
+            .setGaugeMetadata(getGaugeMetadata())
+            .build();
+    transportManager.log(gaugeMetric, this.applicationProcessState);
   }
 
   private GaugeMetadata getGaugeMetadata() {

firebase-perf/src/test/java/com/google/firebase/perf/session/SessionManagerTest.java

@@ -75,8 +75,8 @@ public void setApplicationContext_logGaugeMetadata_afterGaugeMetadataManagerIsIn
     testSessionManager.setApplicationContext(mockApplicationContext);
 
     testSessionManager.getSyncInitFuture().get();
-    inOrder.verify(mockGaugeManager).initializeGaugeMetadataManager(any());
-    inOrder.verify(mockGaugeManager).logGaugeMetadata(any(), any());
+    inOrder.verify(mockGaugeManager).initializeGaugeMetadataManager(any(), any());
+    inOrder.verify(mockGaugeManager).logGaugeMetadata(any());
   }
 
   @Test

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

@@ -641,7 +641,7 @@ public void testLogGaugeMetadataSendDataToTransport() {
     when(fakeGaugeMetadataManager.getMaxAppJavaHeapMemoryKb()).thenReturn(1000);
     when(fakeGaugeMetadataManager.getMaxEncouragedAppJavaHeapMemoryKb()).thenReturn(800);
 
-    testGaugeManager.logGaugeMetadata("sessionId", ApplicationProcessState.FOREGROUND);
+    testGaugeManager.logGaugeMetadata("sessionId");
 
     GaugeMetric recordedGaugeMetric =
         getLastRecordedGaugeMetric(ApplicationProcessState.FOREGROUND, 1);
@@ -668,35 +668,6 @@ public void testLogGaugeMetadataDoesntLogWhenGaugeMetadataManagerNotAvailable()
             /* gaugeMetadataManager= */ null,
             new Lazy<>(() -> fakeCpuGaugeCollector),
             new Lazy<>(() -> fakeMemoryGaugeCollector));
-
-    assertThat(testGaugeManager.logGaugeMetadata("sessionId", ApplicationProcessState.FOREGROUND))
-        .isFalse();
-  }
-
-  @Test
-  public void testLogGaugeMetadataLogsAfterApplicationContextIsSet() {
-
-    testGaugeManager =
-        new GaugeManager(
-            new Lazy<>(() -> fakeScheduledExecutorService),
-            mockTransportManager,
-            mockConfigResolver,
-            /* gaugeMetadataManager= */ null,
-            new Lazy<>(() -> fakeCpuGaugeCollector),
-            new Lazy<>(() -> fakeMemoryGaugeCollector));
-
-    assertThat(testGaugeManager.logGaugeMetadata("sessionId", ApplicationProcessState.FOREGROUND))
-        .isFalse();
-
-    testGaugeManager.initializeGaugeMetadataManager(ApplicationProvider.getApplicationContext());
-    assertThat(testGaugeManager.logGaugeMetadata("sessionId", ApplicationProcessState.FOREGROUND))
-        .isTrue();
-
-    GaugeMetric recordedGaugeMetric =
-        getLastRecordedGaugeMetric(ApplicationProcessState.FOREGROUND, 1);
-    GaugeMetadata recordedGaugeMetadata = recordedGaugeMetric.getGaugeMetadata();
-
-    assertThat(recordedGaugeMetric.getSessionId()).isEqualTo("sessionId");
   }
 
   @Test