Merge branch 'fireperf-aqs' into td/aqs-usage

Author: tejasd

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 com.google.firebase.sessions.api.SessionSubscriber;
 import java.lang.annotation.Retention;
@@ -173,6 +175,7 @@ public static FirebasePerformance getInstance() {
       this.sessionSubscriber = new FirebasePerformanceSessionSubscriber(false);
       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,32 @@
+/*
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+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

@@ -17,7 +17,6 @@
 package com.google.firebase.perf.session
 
 import com.google.firebase.perf.session.gauges.GaugeManager
-import com.google.firebase.perf.util.Constants
 import com.google.firebase.perf.v1.ApplicationProcessState
 import com.google.firebase.sessions.api.SessionSubscriber
 import java.util.UUID
@@ -28,26 +27,18 @@ class FirebasePerformanceSessionSubscriber(override val isDataCollectionEnabled:
   override val sessionSubscriberName: SessionSubscriber.Name = SessionSubscriber.Name.PERFORMANCE
 
   override fun onSessionChanged(sessionDetails: SessionSubscriber.SessionDetails) {
-    val sessionManager = SessionManager.getInstance()
-    val currentPerfSession = sessionManager.perfSession()
-    val gaugeManager = GaugeManager.getInstance()
+    val currentPerfSession = SessionManager.getInstance().perfSession()
 
     // A [PerfSession] was created before a session was started.
-    if (currentPerfSession.aqsSessionId().equals(Constants.UNDEFINED_AQS_ID)) {
-      currentPerfSession.setAQSId(sessionDetails)
-      gaugeManager.logGaugeMetadata(
-        currentPerfSession.aqsSessionId(),
-        ApplicationProcessState.FOREGROUND
-      )
-      // Gauge collection is started in [FirebasePerfEarly] - but it's not scheduled to be
-      // uploaded. This starts uploading the gauges if it's verbose.
-      gaugeManager.updateGaugeCollection(ApplicationProcessState.FOREGROUND)
+    if (!currentPerfSession.isAqsReady) {
+      GaugeManager.getInstance()
+        .logGaugeMetadata(currentPerfSession.sessionId(), ApplicationProcessState.FOREGROUND)
       return
     }
 
     val updatedSession = PerfSession.createWithId(UUID.randomUUID().toString())
-    updatedSession.setAQSId(sessionDetails)
-    gaugeManager.logGaugeMetadata(updatedSession.aqsSessionId(), ApplicationProcessState.FOREGROUND)
-    sessionManager.updatePerfSession(updatedSession)
+    SessionManager.getInstance().updatePerfSession(updatedSession)
+    GaugeManager.getInstance()
+      .logGaugeMetadata(updatedSession.sessionId(), ApplicationProcessState.FOREGROUND)
   }
 }

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

@@ -21,70 +21,58 @@
 import androidx.annotation.VisibleForTesting;
 import com.google.firebase.perf.config.ConfigResolver;
 import com.google.firebase.perf.util.Clock;
-import com.google.firebase.perf.util.Constants;
 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;
-  // TODO(b/394127311): Remove this once this isn't needed.
-  private String aqsSessionId = Constants.UNDEFINED_AQS_ID;
-
+  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;
+    Boolean isAqsReady;
+    if (aqsSessionId != null) {
+      sessionId = aqsSessionId;
+      isAqsReady = true;
+    } else {
+      sessionId = UUID.randomUUID().toString().replace("-", "");
+      isAqsReady = false;
+    }
+    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. */
-  public String aqsSessionId() {
-    // This is a fallback for if/when the AQS ID is undefined.
-    if (aqsSessionId.equals(Constants.UNDEFINED_AQS_ID)) {
-      // TODO(b/394127311): Explore returning a valid - but different ID.
-      return Constants.UNDEFINED_AQS_ID;
-    }
-    return aqsSessionId;
-  }
-
-  /** Returns the AQS sessionId for the given session. */
-  public void setAQSId(SessionSubscriber.SessionDetails aqs) {
-    if (aqsSessionId.equals(Constants.UNDEFINED_AQS_ID)) {
-      aqsSessionId = aqs.getSessionId();
-    }
-  }
-
   /**
    * Returns a timer object that has been seeded with the system time at which the session began.
    */
@@ -111,18 +99,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.
@@ -134,9 +110,8 @@ 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(aqsSessionId);
+        com.google.firebase.perf.v1.PerfSession.newBuilder().setSessionId(sessionId);
 
     // If gauge collection is enabled, enable gauge collection verbosity.
     if (isGaugeAndEventCollectionEnabled) {
@@ -185,11 +160,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);
   }
 
   /**
@@ -213,6 +187,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);
   }
 
@@ -230,4 +205,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/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();
 

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

@@ -66,7 +66,6 @@ public void setUp() {
   public void testInstanceCreation() {
     assertThat(SessionManager.getInstance()).isNotNull();
     assertThat(SessionManager.getInstance()).isEqualTo(SessionManager.getInstance());
-    assertThat(SessionManager.getInstance().perfSession().sessionId()).isNotNull();
   }
 
   @Test
@@ -113,7 +112,7 @@ public void testSessionIdDoesNotUpdateIfPerfSessionRunsTooLong() {
     Timer mockTimer = mock(Timer.class);
     when(mockClock.getTime()).thenReturn(mockTimer);
 
-    PerfSession session = new PerfSession("sessionId", mockClock);
+    PerfSession session = new PerfSession("sessionId", mockClock, true);
     SessionManager testSessionManager =
         new SessionManager(mockGaugeManager, session, mockAppStateMonitor);
 
@@ -132,10 +131,10 @@ public void testUpdatePerfSessionStartsCollectingGaugesIfSessionIsVerbose() {
     when(mockClock.getTime()).thenReturn(mockTimer);
     when(mockAppStateMonitor.getAppState()).thenReturn(ApplicationProcessState.FOREGROUND);
 
-    PerfSession previousSession = new PerfSession("previousSession", mockClock);
+    PerfSession previousSession = new PerfSession("previousSession", mockClock, true);
     previousSession.setGaugeAndEventCollectionEnabled(false);
 
-    PerfSession newSession = new PerfSession("newSession", mockClock);
+    PerfSession newSession = new PerfSession("newSession", mockClock, true);
     newSession.setGaugeAndEventCollectionEnabled(true);
 
     SessionManager testSessionManager =