Remove app updates from session manager and add unit tests

Author: tejasd

firebase-perf/firebase-perf.gradle

@@ -118,7 +118,7 @@ dependencies {
     api("com.google.firebase:firebase-components:18.0.0")
     api("com.google.firebase:firebase-config:21.5.0")
     api("com.google.firebase:firebase-installations:17.2.0")
-    api("com.google.firebase:firebase-sessions:2.0.7") {
+    api(project(":firebase-sessions")) {
         exclude group: 'com.google.firebase', module: 'firebase-common'
         exclude group: 'com.google.firebase', module: 'firebase-common-ktx'
         exclude group: 'com.google.firebase', module: 'firebase-components'

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

@@ -19,21 +19,21 @@
 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.session.gauges.GaugeManager;
 import com.google.firebase.perf.v1.ApplicationProcessState;
 import com.google.firebase.perf.v1.GaugeMetadata;
 import com.google.firebase.perf.v1.GaugeMetric;
 import java.lang.ref.WeakReference;
 import java.util.HashSet;
 import java.util.Iterator;
+import java.util.Objects;
 import java.util.Set;
 import java.util.UUID;
 import java.util.concurrent.Future;
 
 /** Session manager to generate sessionIDs and broadcast to the application. */
 @Keep // Needed because of b/117526359.
-public class SessionManager extends AppStateUpdateHandler {
+public class SessionManager {
 
   @SuppressLint("StaticFieldLeak")
   private static final SessionManager instance = new SessionManager();
@@ -69,7 +69,6 @@ public SessionManager(
     this.gaugeManager = gaugeManager;
     this.perfSession = perfSession;
     this.appStateMonitor = appStateMonitor;
-    registerForAppState();
   }
 
   /**
@@ -80,34 +79,6 @@ public void setApplicationContext(final Context appContext) {
     gaugeManager.initializeGaugeMetadataManager(appContext);
   }
 
-  @Override
-  public void onUpdateAppState(ApplicationProcessState newAppState) {
-    super.onUpdateAppState(newAppState);
-
-    if (appStateMonitor.isColdStart()) {
-      // We want the Session to remain unchanged if this is a cold start of the app since we already
-      // update the PerfSession in FirebasePerfProvider#onAttachInfo().
-      return;
-    }
-
-    if (newAppState == ApplicationProcessState.FOREGROUND) {
-      // A new foregrounding of app will force a new sessionID generation.
-      PerfSession session = PerfSession.createWithId(UUID.randomUUID().toString());
-      updatePerfSession(session);
-    } else {
-      // If the session is running for too long, generate a new session and collect gauges as
-      // necessary.
-      if (perfSession.isSessionRunningTooLong()) {
-        PerfSession session = PerfSession.createWithId(UUID.randomUUID().toString());
-        updatePerfSession(session);
-      } else {
-        // For any other state change of the application, modify gauge collection state as
-        // necessary.
-        startOrStopCollectingGauges(newAppState);
-      }
-    }
-  }
-
   /**
    * Checks if the current {@link PerfSession} is expired/timed out. If so, stop collecting gauges.
    *
@@ -129,7 +100,7 @@ public void stopGaugeCollectionIfSessionRunningTooLong() {
    */
   public void updatePerfSession(PerfSession perfSession) {
     // Do not update the perf session if it is the exact same sessionId.
-    if (perfSession.sessionId() == this.perfSession.sessionId()) {
+    if (Objects.equals(perfSession.sessionId(), this.perfSession.sessionId())) {
       return;
     }
 

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

@@ -16,9 +16,6 @@
 
 import static com.google.common.truth.Truth.assertThat;
 import static org.mockito.ArgumentMatchers.any;
-import static org.mockito.ArgumentMatchers.anyString;
-import static org.mockito.ArgumentMatchers.eq;
-import static org.mockito.ArgumentMatchers.nullable;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.never;
 import static org.mockito.Mockito.spy;
@@ -40,7 +37,6 @@
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
-import org.mockito.AdditionalMatchers;
 import org.mockito.ArgumentMatchers;
 import org.mockito.InOrder;
 import org.mockito.Mock;
@@ -86,101 +82,12 @@ public void setApplicationContext_initializeGaugeMetadataManager()
     inOrder.verify(mockGaugeManager).initializeGaugeMetadataManager(any());
   }
 
-  @Test
-  public void testOnUpdateAppStateDoesNothingDuringAppStart() {
-    String oldSessionId = SessionManager.getInstance().perfSession().sessionId();
-
-    assertThat(oldSessionId).isNotNull();
-    assertThat(oldSessionId).isEqualTo(SessionManager.getInstance().perfSession().sessionId());
-
-    AppStateMonitor.getInstance().setIsColdStart(true);
-
-    SessionManager.getInstance().onUpdateAppState(ApplicationProcessState.FOREGROUND);
-    assertThat(oldSessionId).isEqualTo(SessionManager.getInstance().perfSession().sessionId());
-  }
-
-  @Test
-  public void testOnUpdateAppStateGeneratesNewSessionIdOnForegroundState() {
-    String oldSessionId = SessionManager.getInstance().perfSession().sessionId();
-
-    assertThat(oldSessionId).isNotNull();
-    assertThat(oldSessionId).isEqualTo(SessionManager.getInstance().perfSession().sessionId());
-
-    SessionManager.getInstance().onUpdateAppState(ApplicationProcessState.FOREGROUND);
-    assertThat(oldSessionId).isNotEqualTo(SessionManager.getInstance().perfSession().sessionId());
-  }
-
-  @Test
-  public void testOnUpdateAppStateDoesntGenerateNewSessionIdOnBackgroundState() {
-    String oldSessionId = SessionManager.getInstance().perfSession().sessionId();
-
-    assertThat(oldSessionId).isNotNull();
-    assertThat(oldSessionId).isEqualTo(SessionManager.getInstance().perfSession().sessionId());
-
-    SessionManager.getInstance().onUpdateAppState(ApplicationProcessState.BACKGROUND);
-    assertThat(oldSessionId).isEqualTo(SessionManager.getInstance().perfSession().sessionId());
-  }
-
-  @Test
-  public void testOnUpdateAppStateGeneratesNewSessionIdOnBackgroundStateIfPerfSessionExpires() {
-    when(mockPerfSession.isSessionRunningTooLong()).thenReturn(true);
-    SessionManager testSessionManager =
-        new SessionManager(mockGaugeManager, mockPerfSession, mockAppStateMonitor);
-    String oldSessionId = testSessionManager.perfSession().sessionId();
-
-    assertThat(oldSessionId).isNotNull();
-    assertThat(oldSessionId).isEqualTo(testSessionManager.perfSession().sessionId());
-
-    testSessionManager.onUpdateAppState(ApplicationProcessState.BACKGROUND);
-    assertThat(oldSessionId).isNotEqualTo(testSessionManager.perfSession().sessionId());
-  }
-
-  @Test
-  public void
-      testOnUpdateAppStateDoesntMakeGaugeManagerLogGaugeMetadataOnForegroundStateIfSessionIsNonVerbose() {
-    forceNonVerboseSession();
-
-    SessionManager testSessionManager =
-        new SessionManager(mockGaugeManager, mockPerfSession, mockAppStateMonitor);
-    testSessionManager.onUpdateAppState(ApplicationProcessState.FOREGROUND);
-
-    verify(mockGaugeManager, never())
-        .logGaugeMetadata(
-            anyString(), nullable(com.google.firebase.perf.v1.ApplicationProcessState.class));
-  }
-
-  @Test
-  public void
-      testOnUpdateAppStateDoesntMakeGaugeManagerLogGaugeMetadataOnBackgroundStateEvenIfSessionIsVerbose() {
-    forceVerboseSession();
-
-    SessionManager testSessionManager =
-        new SessionManager(mockGaugeManager, mockPerfSession, mockAppStateMonitor);
-    testSessionManager.onUpdateAppState(ApplicationProcessState.BACKGROUND);
-
-    verify(mockGaugeManager, never())
-        .logGaugeMetadata(
-            anyString(), nullable(com.google.firebase.perf.v1.ApplicationProcessState.class));
-  }
-
-  @Test
-  public void testOnUpdateAppStateMakesGaugeManagerStartCollectingGaugesIfSessionIsVerbose() {
-    forceVerboseSession();
-
-    SessionManager testSessionManager =
-        new SessionManager(mockGaugeManager, mockPerfSession, mockAppStateMonitor);
-    testSessionManager.onUpdateAppState(ApplicationProcessState.FOREGROUND);
-
-    verify(mockGaugeManager)
-        .startCollectingGauges(AdditionalMatchers.not(eq(mockPerfSession)), any());
-  }
-
   // LogGaugeData on new perf session when Verbose
   // NotLogGaugeData on new perf session when not Verbose
   // Mark Session as expired after time limit.
 
   @Test
-  public void testOnUpdateAppStateMakesGaugeManagerStopCollectingGaugesIfSessionIsNonVerbose() {
+  public void testUpdatePerfSessionMakesGaugeManagerStopCollectingGaugesIfSessionIsNonVerbose() {
     forceNonVerboseSession();
 
     SessionManager testSessionManager =
@@ -191,7 +98,7 @@ public void testOnUpdateAppStateMakesGaugeManagerStopCollectingGaugesIfSessionIs
   }
 
   @Test
-  public void testOnUpdateAppStateMakesGaugeManagerStopCollectingGaugesWhenSessionsDisabled() {
+  public void testUpdatePerfSessionMakesGaugeManagerStopCollectingGaugesWhenSessionsDisabled() {
     forceSessionsFeatureDisabled();
 
     SessionManager testSessionManager =
@@ -221,22 +128,25 @@ public void testSessionIdDoesNotUpdateIfPerfSessionRunsTooLong() {
   }
 
   @Test
-  public void testPerfSessionExpiredMakesGaugeManagerStopsCollectingGaugesIfSessionIsVerbose() {
-    forceVerboseSession();
+  public void testUpdatePerfSessionStartsCollectingGaugesIfSessionIsVerbose() {
     Timer mockTimer = mock(Timer.class);
     when(mockClock.getTime()).thenReturn(mockTimer);
+    when(mockAppStateMonitor.getAppState()).thenReturn(ApplicationProcessState.FOREGROUND);
 
-    PerfSession session = new PerfSession("sessionId", mockClock);
-    SessionManager testSessionManager =
-        new SessionManager(mockGaugeManager, session, mockAppStateMonitor);
+    PerfSession previousSession = new PerfSession("previousSession", mockClock);
+    previousSession.setGaugeAndEventCollectionEnabled(false);
 
-    assertThat(session.isSessionRunningTooLong()).isFalse();
+    PerfSession newSession = new PerfSession("newSession", mockClock);
+    newSession.setGaugeAndEventCollectionEnabled(true);
 
-    when(mockTimer.getDurationMicros())
-        .thenReturn(TimeUnit.HOURS.toMicros(5)); // Default Max Session Length is 4 hours
+    SessionManager testSessionManager =
+        new SessionManager(mockGaugeManager, previousSession, mockAppStateMonitor);
+    testSessionManager.updatePerfSession(newSession);
+    testSessionManager.setApplicationContext(mockApplicationContext);
 
-    assertThat(session.isSessionRunningTooLong()).isTrue();
-    verify(mockGaugeManager, times(0)).logGaugeMetadata(any(), any());
+    verify(mockGaugeManager, times(1)).initializeGaugeMetadataManager(mockApplicationContext);
+    verify(mockGaugeManager, times(1))
+        .startCollectingGauges(newSession, ApplicationProcessState.FOREGROUND);
   }
 
   @Test

firebase-sessions/src/main/kotlin/com/google/firebase/sessions/api/FirebaseSessionsDependencies.kt

@@ -40,19 +40,6 @@ object FirebaseSessionsDependencies {
    */
   @JvmStatic
   fun addDependency(subscriberName: SessionSubscriber.Name) {
-    if (subscriberName == SessionSubscriber.Name.PERFORMANCE) {
-      throw IllegalArgumentException(
-        """
-          Incompatible versions of Firebase Perf and Firebase Sessions.
-          A safe combination would be:
-            firebase-sessions:1.1.0
-            firebase-crashlytics:18.5.0
-            firebase-perf:20.5.0
-          For more information contact Firebase Support.
-        """
-          .trimIndent()
-      )
-    }
     if (dependencies.containsKey(subscriberName)) {
       Log.d(TAG, "Dependency $subscriberName already added.")
       return