convert perf session to use aqs support session id

Author: themiswang

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

@@ -34,6 +34,7 @@
 import com.google.firebase.perf.config.RemoteConfigManager;
 import com.google.firebase.perf.logging.AndroidLogger;
 import com.google.firebase.perf.logging.ConsoleUrlGenerator;
+import com.google.firebase.perf.logging.DebugEnforcementCheck;
 import com.google.firebase.perf.metrics.HttpMetric;
 import com.google.firebase.perf.metrics.Trace;
 import com.google.firebase.perf.session.FirebasePerformanceSessionSubscriber;
@@ -43,6 +44,7 @@
 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 java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
@@ -169,6 +171,7 @@ public static FirebasePerformance getInstance() {
       this.mMetadataBundle = new ImmutableBundle(new Bundle());
       return;
     }
+    DebugEnforcementCheck.setEnforcement(BuildConfig.DEBUG);
 
     TransportManager.getInstance()
         .initialize(firebaseApp, firebaseInstallationsApi, transportFactoryProvider);

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

@@ -0,0 +1,16 @@
+package com.google.firebase.perf.logging
+
+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)
+        assert(!enforcement) { failureMessage }
+      }
+    }
+  }
+}

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

@@ -19,28 +19,16 @@ package com.google.firebase.perf.session
 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 {
 
   override val sessionSubscriberName: SessionSubscriber.Name = SessionSubscriber.Name.PERFORMANCE
 
   override fun onSessionChanged(sessionDetails: SessionSubscriber.SessionDetails) {
-    val currentPerfSession = SessionManager.getInstance().perfSession()
-
-    // A [PerfSession] was created before a session was started.
-    if (currentPerfSession.aqsSessionId() == null) {
-      currentPerfSession.setAQSId(sessionDetails)
-      GaugeManager.getInstance()
-        .logGaugeMetadata(currentPerfSession.aqsSessionId(), ApplicationProcessState.FOREGROUND)
-      return
-    }
-
-    val updatedSession = PerfSession.createWithId(UUID.randomUUID().toString())
-    updatedSession.setAQSId(sessionDetails)
+    val updatedSession = PerfSession.createWithId(sessionDetails.sessionId)
     SessionManager.getInstance().updatePerfSession(updatedSession)
     GaugeManager.getInstance()
-      .logGaugeMetadata(updatedSession.aqsSessionId(), ApplicationProcessState.FOREGROUND)
+      .logGaugeMetadata(updatedSession.sessionId(), ApplicationProcessState.FOREGROUND)
   }
 }

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

@@ -23,62 +23,53 @@
 import com.google.firebase.perf.util.Clock;
 import com.google.firebase.perf.util.Timer;
 import com.google.firebase.perf.v1.SessionVerbosity;
-import com.google.firebase.sessions.api.SessionSubscriber;
 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 String sessionId;
   private final Timer creationTime;
-  @Nullable private String aqsSessionId;
-
+  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(@NonNull String sessionId) {
-    String prunedSessionId = sessionId.replace("-", "");
-    PerfSession session = new PerfSession(prunedSessionId, new Clock());
-    session.setGaugeAndEventCollectionEnabled(shouldCollectGaugesAndEvents());
-
+  public static PerfSession createWithId(@Nullable String aqsSessionId) {
+    String sessionId = UUID.randomUUID().toString().replace("-", "");
+    Boolean isAqsReady = false;
+    if (aqsSessionId != null) {
+      sessionId = aqsSessionId;
+      isAqsReady = true;
+    }
+    PerfSession session = new PerfSession(sessionId, new Clock(), isAqsReady);
+    session.setGaugeAndEventCollectionEnabled(shouldCollectGaugesAndEvents(sessionId));
     return session;
   }
 
   /** Creates a PerfSession with the provided {@code sessionId} and {@code clock}. */
   @VisibleForTesting(otherwise = VisibleForTesting.PACKAGE_PRIVATE)
-  public PerfSession(String sessionId, Clock clock) {
+  public PerfSession(String sessionId, Clock clock, boolean isAqsReady) {
     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 of the session. */
+  /** Returns the sessionId for the given session. */
   public String sessionId() {
     return sessionId;
   }
 
-  /** Returns the AQS sessionId for the given session. */
-  @Nullable
-  public String aqsSessionId() {
-    return aqsSessionId;
-  }
-
-  /** Sets the AQS sessionId for the given session. */
-  public void setAQSId(SessionSubscriber.SessionDetails aqs) {
-    if (aqsSessionId == null) {
-      aqsSessionId = aqs.getSessionId();
-    }
-  }
-
   /**
    * Returns a timer object that has been seeded with the system time at which the session began.
    */
@@ -105,18 +96,6 @@ public boolean isVerbose() {
     return isGaugeAndEventCollectionEnabled;
   }
 
-  /** Checks if the current {@link com.google.firebase.perf.v1.PerfSession} is verbose or not. */
-  @VisibleForTesting
-  static boolean isVerbose(@NonNull com.google.firebase.perf.v1.PerfSession perfSession) {
-    for (SessionVerbosity sessionVerbosity : perfSession.getSessionVerbosityList()) {
-      if (sessionVerbosity == SessionVerbosity.GAUGES_AND_SYSTEM_EVENTS) {
-        return true;
-      }
-    }
-
-    return false;
-  }
-
   /**
    * Checks if it has been more than {@link ConfigResolver#getSessionsMaxDurationMinutes()} time
    * since the creation time of the current session.
@@ -128,7 +107,6 @@ public boolean isSessionRunningTooLong() {
 
   /** Creates and returns the proto object for PerfSession object. */
   public com.google.firebase.perf.v1.PerfSession build() {
-    // TODO(b/394127311): Switch to using AQS.
     com.google.firebase.perf.v1.PerfSession.Builder sessionMetric =
         com.google.firebase.perf.v1.PerfSession.newBuilder().setSessionId(sessionId);
 
@@ -179,11 +157,10 @@ public static com.google.firebase.perf.v1.PerfSession[] buildAndSort(
   }
 
   /** If true, Session Gauge collection is enabled. */
-  public static boolean shouldCollectGaugesAndEvents() {
+  public static boolean shouldCollectGaugesAndEvents(String sessionId) {
     ConfigResolver configResolver = ConfigResolver.getInstance();
-
     return configResolver.isPerformanceMonitoringEnabled()
-        && Math.random() < configResolver.getSessionsSamplingRate();
+        && (Math.abs(sessionId.hashCode() % 100) < configResolver.getSessionsSamplingRate() * 100);
   }
 
   /**
@@ -207,6 +184,7 @@ 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);
   }
 
@@ -224,4 +202,16 @@ public PerfSession[] newArray(int size) {
           return new PerfSession[size];
         }
       };
+
+  /** Checks if the current {@link com.google.firebase.perf.v1.PerfSession} is verbose or not. */
+  @VisibleForTesting
+  static boolean isVerbose(@NonNull com.google.firebase.perf.v1.PerfSession perfSession) {
+    for (SessionVerbosity sessionVerbosity : perfSession.getSessionVerbosityList()) {
+      if (sessionVerbosity == SessionVerbosity.GAUGES_AND_SYSTEM_EVENTS) {
+        return true;
+      }
+    }
+
+    return false;
+  }
 }

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

@@ -19,6 +19,8 @@
 import androidx.annotation.Keep;
 import androidx.annotation.VisibleForTesting;
 import com.google.firebase.perf.application.AppStateMonitor;
+import com.google.firebase.perf.logging.AndroidLogger;
+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.perf.v1.GaugeMetadata;
@@ -28,11 +30,11 @@
 import java.util.Iterator;
 import java.util.Objects;
 import java.util.Set;
-import java.util.UUID;
 
 /** Session manager to generate sessionIDs and broadcast to the application. */
 @Keep // Needed because of b/117526359.
 public class SessionManager {
+  private final AndroidLogger logger = AndroidLogger.getInstance();
 
   @SuppressLint("StaticFieldLeak")
   private static final SessionManager instance = new SessionManager();
@@ -50,15 +52,15 @@ 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");
+
     return perfSession;
   }
 
   private SessionManager() {
-    // Generate a new sessionID for every cold start.
-    this(
-        GaugeManager.getInstance(),
-        PerfSession.createWithId(UUID.randomUUID().toString()),
-        AppStateMonitor.getInstance());
+    // session should quickly updated by session subscriber.
+    this(GaugeManager.getInstance(), PerfSession.createWithId(null), AppStateMonitor.getInstance());
   }
 
   @VisibleForTesting
@@ -83,6 +85,10 @@ 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();
     }
@@ -156,6 +162,9 @@ public void unregisterForSessionUpdates(WeakReference<SessionAwareObject> client
   }
 
   private void startOrStopCollectingGauges(ApplicationProcessState appState) {
+    DebugEnforcementCheck.Companion.checkSession(
+        perfSession.isAqsReady, "Session is not ready while trying to startOrStopCollectingGauges");
+
     if (perfSession.isGaugeAndEventCollectionEnabled()) {
       gaugeManager.startCollectingGauges(perfSession, appState);
     } else {

firebase-perf/src/test/java/com/google/firebase/perf/application/AppStateMonitorTest.java

@@ -39,6 +39,8 @@
 import com.google.firebase.perf.config.DeviceCacheManager;
 import com.google.firebase.perf.metrics.NetworkRequestMetricBuilder;
 import com.google.firebase.perf.metrics.Trace;
+import com.google.firebase.perf.session.PerfSession;
+import com.google.firebase.perf.session.SessionManager;
 import com.google.firebase.perf.session.gauges.GaugeManager;
 import com.google.firebase.perf.transport.TransportManager;
 import com.google.firebase.perf.util.Clock;
@@ -80,6 +82,7 @@ public class AppStateMonitorTest extends FirebasePerformanceTestBase {
   @Before
   public void setUp() {
     currentTime = 0;
+    SessionManager.getInstance().updatePerfSession(PerfSession.createWithId("sessionId"));
     initMocks(this);
     doAnswer((Answer<Timer>) invocationOnMock -> new Timer(currentTime)).when(clock).getTime();