Merge c9c0441 into 7d9c0bf

Author: tejasd

firebase-perf/firebase-perf.gradle

@@ -70,13 +70,15 @@ android {
         buildConfigField("String", "TRANSPORT_LOG_SRC", "String.valueOf(\"FIREPERF\")")
         buildConfigField("Boolean", "ENFORCE_DEFAULT_LOG_SRC", "Boolean.valueOf(false)")
         buildConfigField("String", "FIREPERF_VERSION_NAME", "String.valueOf(\"" + property("version") + "\")")
+        buildConfigField("Boolean", "ENFORCE_LEGACY_SESSIONS", "Boolean.valueOf(false)")
 
         if (project.hasProperty("fireperfBuildForAutopush")) {
             // This allows the SDK to be built for "Autopush" env when the mentioned flag
             // (-PfireperfBuildForAutopush) is passed in the gradle build command (of either the
             // SDK or the Test App).
             buildConfigField("String", "TRANSPORT_LOG_SRC", "String.valueOf(\"FIREPERF_AUTOPUSH\")")
             buildConfigField("Boolean", "ENFORCE_DEFAULT_LOG_SRC", "Boolean.valueOf(true)")
+            buildConfigField("Boolean", "ENFORCE_LEGACY_SESSIONS", "Boolean.valueOf(true)")
         }
 
         minSdkVersion project.minSdkVersion
@@ -138,4 +140,5 @@ dependencies {
     testImplementation libs.mockito.core
     testImplementation libs.mockito.mockito.inline
     testImplementation group: 'org.apache.httpcomponents', name: 'httpclient', version: '4.5.6'
+    testImplementation "androidx.arch.core:core-testing:2.1.0"
 }

firebase-perf/src/main/java/com/google/firebase/perf/FirebasePerfEarly.java

@@ -51,12 +51,10 @@ public FirebasePerfEarly(
       uiExecutor.execute(new AppStartTrace.StartFromBackgroundRunnable(appStartTrace));
     }
 
-    // TODO: Bring back Firebase Sessions dependency to watch for updates to sessions.
-
     // In the case of cold start, we create a session and start collecting gauges as early as
     // possible.
-    // There is code in SessionManager that prevents us from resetting the session twice in case
-    // of app cold start.
+    // Uploading the gauges however only starts once AQS is initialized.
+    // TODO(b/394127311): Update this to use changes in AQS initialization,
     SessionManager.getInstance().initializeGaugeCollection();
   }
 }

firebase-perf/src/main/java/com/google/firebase/perf/FirebasePerformance.java

@@ -44,8 +44,8 @@
 import com.google.firebase.perf.util.ImmutableBundle;
 import com.google.firebase.perf.util.Timer;
 import com.google.firebase.remoteconfig.RemoteConfigComponent;
-import com.google.firebase.sessions.BuildConfig;
 import com.google.firebase.sessions.api.FirebaseSessionsDependencies;
+import com.google.firebase.sessions.api.SessionSubscriber;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.net.URL;
@@ -96,6 +96,8 @@ public class FirebasePerformance implements FirebasePerformanceAttributable {
   // once during initialization and cache it.
   private final ImmutableBundle mMetadataBundle;
 
+  private final SessionSubscriber sessionSubscriber;
+
   /** Valid HttpMethods for manual network APIs */
   @StringDef({
     HttpMethod.GET,
@@ -169,9 +171,10 @@ public static FirebasePerformance getInstance() {
       this.mPerformanceCollectionForceEnabledState = false;
       this.configResolver = configResolver;
       this.mMetadataBundle = new ImmutableBundle(new Bundle());
+      this.sessionSubscriber = new FirebasePerformanceSessionSubscriber(false);
       return;
     }
-    DebugEnforcementCheck.setEnforcement(BuildConfig.DEBUG);
+    DebugEnforcementCheck.setEnforcement(BuildConfig.ENFORCE_LEGACY_SESSIONS);
 
     TransportManager.getInstance()
         .initialize(firebaseApp, firebaseInstallationsApi, transportFactoryProvider);
@@ -186,8 +189,8 @@ public static FirebasePerformance getInstance() {
     sessionManager.setApplicationContext(appContext);
 
     mPerformanceCollectionForceEnabledState = configResolver.getIsPerformanceCollectionEnabled();
-    FirebaseSessionsDependencies.register(
-        new FirebasePerformanceSessionSubscriber(isPerformanceCollectionEnabled()));
+    sessionSubscriber = new FirebasePerformanceSessionSubscriber(isPerformanceCollectionEnabled());
+    FirebaseSessionsDependencies.register(sessionSubscriber);
 
     if (logger.isLogcatEnabled() && isPerformanceCollectionEnabled()) {
       logger.info(
@@ -463,4 +466,9 @@ private static ImmutableBundle extractMetadata(Context appContext) {
   Boolean getPerformanceCollectionForceEnabledState() {
     return mPerformanceCollectionForceEnabledState;
   }
+
+  @VisibleForTesting
+  SessionSubscriber getSessionSubscriber() {
+    return sessionSubscriber;
+  }
 }

firebase-perf/src/main/java/com/google/firebase/perf/logging/DebugEnforcementCheck.kt

@@ -16,15 +16,25 @@
 
 package com.google.firebase.perf.logging
 
+import com.google.firebase.perf.session.PerfSession
+import com.google.firebase.perf.session.isLegacy
+
 class DebugEnforcementCheck {
   companion object {
     /** When enabled, failed preconditions will cause assertion errors for debugging. */
     @JvmStatic var enforcement: Boolean = false
     private var logger: AndroidLogger = AndroidLogger.getInstance()
 
-    public fun checkSession(isAqsAvailable: Boolean, failureMessage: String) {
-      if (!isAqsAvailable) {
-        Companion.logger.debug(failureMessage)
+    fun checkSession(session: PerfSession, failureMessage: String) {
+      if (session.isLegacy()) {
+        logger.debug("legacy session ${session.sessionId()}: $failureMessage")
+        assert(!enforcement) { failureMessage }
+      }
+    }
+
+    fun checkSession(sessionId: String, failureMessage: String) {
+      if (sessionId.isLegacy()) {
+        logger.debug("legacy session ${sessionId}: $failureMessage")
         assert(!enforcement) { failureMessage }
       }
     }

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

@@ -16,10 +16,10 @@
 
 package com.google.firebase.perf.session
 
+import com.google.firebase.perf.logging.DebugEnforcementCheck
 import com.google.firebase.perf.session.gauges.GaugeManager
 import com.google.firebase.perf.v1.ApplicationProcessState
 import com.google.firebase.sessions.api.SessionSubscriber
-import java.util.UUID
 
 class FirebasePerformanceSessionSubscriber(override val isDataCollectionEnabled: Boolean) :
   SessionSubscriber {
@@ -28,15 +28,22 @@ class FirebasePerformanceSessionSubscriber(override val isDataCollectionEnabled:
 
   override fun onSessionChanged(sessionDetails: SessionSubscriber.SessionDetails) {
     val currentPerfSession = SessionManager.getInstance().perfSession()
+    DebugEnforcementCheck.checkSession(currentPerfSession, "onSessionChanged")
 
     // A [PerfSession] was created before a session was started.
-    if (!currentPerfSession.isAqsReady) {
+    // Since these were verbose gauge collection at app startup, it logs them to the updated session
+    // ID.
+    if (currentPerfSession.isLegacy() && currentPerfSession.isVerbose) {
       GaugeManager.getInstance()
-        .logGaugeMetadata(currentPerfSession.sessionId(), ApplicationProcessState.FOREGROUND)
-      return
+        .logGaugeMetadata(sessionDetails.sessionId, ApplicationProcessState.FOREGROUND)
+      GaugeManager.getInstance()
+        .stopCollectingGaugesForLegacySession(
+          sessionDetails.sessionId,
+          ApplicationProcessState.FOREGROUND
+        )
     }
 
-    val updatedSession = PerfSession.createWithId(UUID.randomUUID().toString())
+    val updatedSession = PerfSession.createWithId(sessionDetails.sessionId)
     SessionManager.getInstance().updatePerfSession(updatedSession)
     GaugeManager.getInstance()
       .logGaugeMetadata(updatedSession.sessionId(), ApplicationProcessState.FOREGROUND)

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

@@ -0,0 +1,24 @@
+package com.google.firebase.perf.session
+
+import com.google.firebase.perf.util.Constants
+import java.util.UUID
+
+/** Identifies whether the [PerfSession] is legacy or not. */
+fun PerfSession.isLegacy(): Boolean {
+  return this.sessionId().isLegacy()
+}
+
+/** Identifies whether the string is from a legacy [PerfSession]. */
+fun String.isLegacy(): Boolean {
+  return this.startsWith(Constants.UNDEFINED_AQS_ID_PREFIX)
+}
+
+/** Creates a valid session ID for [PerfSession] that can be predictably identified as legacy. */
+fun createLegacySessionId(): String {
+  val uuid = UUID.randomUUID().toString().replace("-", "")
+  return uuid.replaceRange(
+    0,
+    Constants.UNDEFINED_AQS_ID_PREFIX.length,
+    Constants.UNDEFINED_AQS_ID_PREFIX
+  )
+}

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

@@ -24,51 +24,43 @@
 import com.google.firebase.perf.util.Timer;
 import com.google.firebase.perf.v1.SessionVerbosity;
 import java.util.List;
-import java.util.UUID;
 import java.util.concurrent.TimeUnit;
 
 /** Details of a session including a unique Id and related information. */
 public class PerfSession implements Parcelable {
   private final Timer creationTime;
   private final String sessionId;
   private boolean isGaugeAndEventCollectionEnabled = false;
-  public final boolean isAqsReady;
 
   /*
    * Creates a PerfSession object and decides what metrics to collect.
    */
   public static PerfSession createWithId(@Nullable String aqsSessionId) {
-    String sessionId;
-    Boolean isAqsReady;
-    if (aqsSessionId != null) {
-      sessionId = aqsSessionId;
-      isAqsReady = true;
-    } else {
-      sessionId = UUID.randomUUID().toString().replace("-", "");
-      isAqsReady = false;
+    String sessionId = aqsSessionId;
+    if (sessionId == null) {
+      sessionId = FirebaseSessionsHelperKt.createLegacySessionId();
     }
-    PerfSession session = new PerfSession(sessionId, new Clock(), isAqsReady);
-    session.setGaugeAndEventCollectionEnabled(shouldCollectGaugesAndEvents(sessionId));
+    PerfSession session = new PerfSession(sessionId, new Clock());
+    session.setGaugeAndEventCollectionEnabled(session.shouldCollectGaugesAndEvents());
     return session;
   }
 
   /** Creates a PerfSession with the provided {@code sessionId} and {@code clock}. */
   @VisibleForTesting(otherwise = VisibleForTesting.PACKAGE_PRIVATE)
-  public PerfSession(String sessionId, Clock clock, boolean isAqsReady) {
+  public PerfSession(String sessionId, Clock clock) {
     this.sessionId = sessionId;
-    this.isAqsReady = isAqsReady;
     creationTime = clock.getTime();
   }
 
   private PerfSession(@NonNull Parcel in) {
     super();
     sessionId = in.readString();
     isGaugeAndEventCollectionEnabled = in.readByte() != 0;
-    isAqsReady = in.readByte() != 0;
     creationTime = in.readParcelable(Timer.class.getClassLoader());
   }
 
   /** Returns the sessionId for the given session. */
+  @NonNull
   public String sessionId() {
     return sessionId;
   }
@@ -160,10 +152,11 @@ public static com.google.firebase.perf.v1.PerfSession[] buildAndSort(
   }
 
   /** If true, Session Gauge collection is enabled. */
-  public static boolean shouldCollectGaugesAndEvents(String sessionId) {
+  public boolean shouldCollectGaugesAndEvents() {
     ConfigResolver configResolver = ConfigResolver.getInstance();
     return configResolver.isPerformanceMonitoringEnabled()
-        && (Math.abs(sessionId.hashCode() % 100) < configResolver.getSessionsSamplingRate() * 100);
+        && (Math.abs(this.sessionId.hashCode() % 100)
+            < configResolver.getSessionsSamplingRate() * 100);
   }
 
   /**
@@ -187,7 +180,6 @@ public int describeContents() {
   public void writeToParcel(@NonNull Parcel out, int flags) {
     out.writeString(sessionId);
     out.writeByte((byte) (isGaugeAndEventCollectionEnabled ? 1 : 0));
-    out.writeByte((byte) (isAqsReady ? 1 : 0));
     out.writeParcelable(creationTime, 0);
   }
 

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

@@ -19,6 +19,7 @@
 import androidx.annotation.Keep;
 import androidx.annotation.VisibleForTesting;
 import com.google.firebase.perf.application.AppStateMonitor;
+import com.google.firebase.perf.application.AppStateUpdateHandler;
 import com.google.firebase.perf.logging.DebugEnforcementCheck;
 import com.google.firebase.perf.session.gauges.GaugeManager;
 import com.google.firebase.perf.v1.ApplicationProcessState;
@@ -32,7 +33,8 @@
 
 /** Session manager to generate sessionIDs and broadcast to the application. */
 @Keep // Needed because of b/117526359.
-public class SessionManager {
+public class SessionManager extends AppStateUpdateHandler {
+
   @SuppressLint("StaticFieldLeak")
   private static final SessionManager instance = new SessionManager();
 
@@ -49,14 +51,12 @@ public static SessionManager getInstance() {
 
   /** Returns the currently active PerfSession. */
   public final PerfSession perfSession() {
-    DebugEnforcementCheck.Companion.checkSession(
-        perfSession.isAqsReady, "Access perf session from manger without aqs ready");
-
+    DebugEnforcementCheck.Companion.checkSession(perfSession, "SessionManager.perfSession()");
     return perfSession;
   }
 
   private SessionManager() {
-    // session should quickly updated by session subscriber.
+    // Generate a new sessionID for every cold start.
     this(GaugeManager.getInstance(), PerfSession.createWithId(null), AppStateMonitor.getInstance());
   }
 
@@ -68,6 +68,20 @@ public SessionManager(
     this.appStateMonitor = appStateMonitor;
   }
 
+  @Override
+  public void onUpdateAppState(ApplicationProcessState newAppState) {
+    super.onUpdateAppState(newAppState);
+    if (appStateMonitor.isColdStart()) {
+      // Ignore the app state change if it's a cold start. [FirebasePerformanceSessionSubscriber]
+      // handles any change that's needed.
+      return;
+    }
+
+    // While the change in app state doesn't start or stop gauge collection, it updates the upload
+    // and gauge collection frequency.
+    updateGaugeCollection(newAppState);
+  }
+
   /**
    * Finalizes gauge initialization during cold start. This must be called before app start finishes
    * (currently that is before onResume finishes) to ensure gauge collection starts on time.
@@ -82,10 +96,6 @@ public void setApplicationContext(final Context appContext) {
    * @see PerfSession#isSessionRunningTooLong()
    */
   public void stopGaugeCollectionIfSessionRunningTooLong() {
-    DebugEnforcementCheck.Companion.checkSession(
-        perfSession.isAqsReady,
-        "Session is not ready while trying to stopGaugeCollectionIfSessionRunningTooLong");
-
     if (perfSession.isSessionRunningTooLong()) {
       gaugeManager.stopCollectingGauges();
     }
@@ -120,8 +130,9 @@ public void updatePerfSession(PerfSession perfSession) {
       }
     }
 
-    // Start of stop the gauge data collection.
-    startOrStopCollectingGauges(appStateMonitor.getAppState());
+    startOrStopCollectingGauges();
+    // A session is *only* updated in Foreground.
+    updateGaugeCollection(ApplicationProcessState.FOREGROUND);
   }
 
   /**
@@ -131,7 +142,7 @@ public void updatePerfSession(PerfSession perfSession) {
    * this does not reset the perfSession.
    */
   public void initializeGaugeCollection() {
-    startOrStopCollectingGauges(ApplicationProcessState.FOREGROUND);
+    startOrStopCollectingGauges();
   }
 
   /**
@@ -158,17 +169,18 @@ public void unregisterForSessionUpdates(WeakReference<SessionAwareObject> client
     }
   }
 
-  private void startOrStopCollectingGauges(ApplicationProcessState appState) {
-    DebugEnforcementCheck.Companion.checkSession(
-        perfSession.isAqsReady, "Session is not ready while trying to startOrStopCollectingGauges");
-
+  private void startOrStopCollectingGauges() {
     if (perfSession.isGaugeAndEventCollectionEnabled()) {
-      gaugeManager.startCollectingGauges(perfSession, appState);
+      gaugeManager.startCollectingGaugeMetrics(perfSession);
     } else {
       gaugeManager.stopCollectingGauges();
     }
   }
 
+  private void updateGaugeCollection(ApplicationProcessState applicationProcessState) {
+    gaugeManager.updateGaugeCollection(applicationProcessState);
+  }
+
   @VisibleForTesting
   public void setPerfSession(PerfSession perfSession) {
     this.perfSession = perfSession;