Merged sessions-sharedrepo into main (#7039)

Merged `sessions-sharedrepo` into `main`

This merge brings in the new sessions shared repo implementation, which
facilitates the Perf+AQS integration. This also includes improvements
that will benefit Crashlytics e.g. providing sessions for early crashes

All individual commits on the `sessions-sharedrepo` branch were reviewed
and approved in their respective pull requests

---------

Co-authored-by: themiswang <[email protected]>

Author: mrober

firebase-sessions/CHANGELOG.md

@@ -1,36 +1,20 @@
 # Unreleased
 * [changed] Added internal api for Crashlytics to notify Sessions of crash events
+* [changed] Use multi-process DataStore instead of Preferences DataStore
+* [changed] Update the heuristic to detect cold app starts
 
 # 2.1.1
 * [unchanged] Updated to keep SDK versions aligned.
 
-
-## Kotlin
-The Kotlin extensions library transitively includes the updated
-`firebase-sessions` library. The Kotlin extensions library has no additional
-updates.
-
 # 2.1.0
 * [changed] Add warning for known issue b/328687152
 * [changed] Use Dagger for dependency injection
 * [changed] Updated datastore dependency to v1.1.3 to
   fix [CVE-2024-7254](https://github.com/advisories/GHSA-735f-pc8j-v9w8).
 
-
-## Kotlin
-The Kotlin extensions library transitively includes the updated
-`firebase-sessions` library. The Kotlin extensions library has no additional
-updates.
-
 # 2.0.9
 * [fixed] Make AQS resilient to background init in multi-process apps.
 
-
-## Kotlin
-The Kotlin extensions library transitively includes the updated
-`firebase-sessions` library. The Kotlin extensions library has no additional
-updates.
-
 # 2.0.7
 * [fixed] Removed extraneous logs that risk leaking internal identifiers.
 

firebase-sessions/benchmark/src/main/kotlin/com/google/firebase/benchmark/sessions/StartupBenchmark.kt

@@ -20,6 +20,8 @@ import androidx.benchmark.macro.StartupMode
 import androidx.benchmark.macro.StartupTimingMetric
 import androidx.benchmark.macro.junit4.MacrobenchmarkRule
 import androidx.test.ext.junit.runners.AndroidJUnit4
+import androidx.test.platform.app.InstrumentationRegistry
+import java.io.FileInputStream
 import org.junit.Rule
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -31,12 +33,43 @@ class StartupBenchmark {
   @Test
   fun startup() =
     benchmarkRule.measureRepeated(
-      packageName = "com.google.firebase.testing.sessions",
+      packageName = PACKAGE_NAME,
       metrics = listOf(StartupTimingMetric()),
       iterations = 5,
       startupMode = StartupMode.COLD,
     ) {
       pressHome()
       startActivityAndWait()
     }
+
+  @Test
+  fun startup_clearAppData() =
+    benchmarkRule.measureRepeated(
+      packageName = PACKAGE_NAME,
+      metrics = listOf(StartupTimingMetric()),
+      iterations = 5,
+      startupMode = StartupMode.COLD,
+      setupBlock = { clearAppData(packageName) },
+    ) {
+      pressHome()
+      startActivityAndWait()
+    }
+
+  private fun clearAppData(packageName: String) {
+    val fileDescriptor =
+      InstrumentationRegistry.getInstrumentation()
+        .uiAutomation
+        .executeShellCommand("pm clear $packageName")
+    val fileInputStream = FileInputStream(fileDescriptor.fileDescriptor)
+    // Read the output to ensure the app data was cleared successfully
+    val result = fileInputStream.bufferedReader().use { it.readText().trim() }
+    fileDescriptor.close()
+    if (result != "Success") {
+      throw IllegalStateException("Unable to clear app data for $packageName - $result")
+    }
+  }
+
+  private companion object {
+    const val PACKAGE_NAME = "com.google.firebase.testing.sessions"
+  }
 }

firebase-sessions/firebase-sessions.gradle.kts

@@ -21,14 +21,19 @@ plugins {
   id("firebase-vendor")
   id("kotlin-android")
   id("kotlin-kapt")
+  id("kotlinx-serialization")
 }
 
 firebaseLibrary {
   libraryGroup = "crashlytics"
 
   testLab.enabled = true
   publishJavadoc = false
-  releaseNotes { enabled.set(false) }
+
+  releaseNotes {
+    enabled = false
+    hasKTX = false
+  }
 }
 
 android {
@@ -76,7 +81,8 @@ dependencies {
   implementation("com.google.android.datatransport:transport-api:3.2.0")
   implementation(libs.javax.inject)
   implementation(libs.androidx.annotation)
-  implementation(libs.androidx.datastore.preferences)
+  implementation(libs.androidx.datastore)
+  implementation(libs.kotlinx.serialization.json)
 
   vendor(libs.dagger.dagger) { exclude(group = "javax.inject", module = "javax.inject") }
 

firebase-sessions/src/androidTest/kotlin/com/google/firebase/sessions/FirebaseSessionsTests.kt

@@ -20,12 +20,10 @@ import androidx.test.core.app.ApplicationProvider
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import com.google.common.truth.Truth.assertThat
 import com.google.firebase.Firebase
-import com.google.firebase.FirebaseApp
 import com.google.firebase.FirebaseOptions
 import com.google.firebase.initialize
 import com.google.firebase.sessions.settings.SessionsSettings
-import org.junit.After
-import org.junit.Before
+import org.junit.BeforeClass
 import org.junit.Test
 import org.junit.runner.RunWith
 
@@ -36,23 +34,6 @@ import org.junit.runner.RunWith
  */
 @RunWith(AndroidJUnit4::class)
 class FirebaseSessionsTests {
-  @Before
-  fun setUp() {
-    Firebase.initialize(
-      ApplicationProvider.getApplicationContext(),
-      FirebaseOptions.Builder()
-        .setApplicationId(APP_ID)
-        .setApiKey(API_KEY)
-        .setProjectId(PROJECT_ID)
-        .build()
-    )
-  }
-
-  @After
-  fun cleanUp() {
-    FirebaseApp.clearInstancesForTest()
-  }
-
   @Test
   fun firebaseSessionsDoesInitialize() {
     assertThat(FirebaseSessions.instance).isNotNull()
@@ -61,13 +42,25 @@ class FirebaseSessionsTests {
   @Test
   fun firebaseSessionsDependenciesDoInitialize() {
     assertThat(SessionFirelogPublisher.instance).isNotNull()
-    assertThat(SessionGenerator.instance).isNotNull()
     assertThat(SessionsSettings.instance).isNotNull()
   }
 
   companion object {
     private const val APP_ID = "1:1:android:1a"
     private const val API_KEY = "API-KEY-API-KEY-API-KEY-API-KEY-API-KEY"
     private const val PROJECT_ID = "PROJECT-ID"
+
+    @BeforeClass
+    @JvmStatic
+    fun setUp() {
+      Firebase.initialize(
+        ApplicationProvider.getApplicationContext(),
+        FirebaseOptions.Builder()
+          .setApplicationId(APP_ID)
+          .setApiKey(API_KEY)
+          .setProjectId(PROJECT_ID)
+          .build(),
+      )
+    }
   }
 }

firebase-sessions/src/androidTest/kotlin/com/google/firebase/sessions/SessionLifecycleServiceBinderTest.kt

@@ -1,5 +1,4 @@
-<?xml version="1.0" encoding="utf-8"?>
-<!-- Copyright 2023 Google LLC -->
+<?xml version="1.0" encoding="utf-8"?><!-- Copyright 2023 Google LLC -->
 <!-- -->
 <!-- Licensed under the Apache License, Version 2.0 (the "License"); -->
 <!-- you may not use this file except in compliance with the License. -->
@@ -19,11 +18,8 @@
 
   <application>
     <service
-      android:name="com.google.firebase.sessions.SessionLifecycleService"
-      android:enabled="true"
-      android:exported="false" />
-    <service android:name="com.google.firebase.components.ComponentDiscoveryService"
-      android:exported="false">
+      android:exported="false"
+      android:name="com.google.firebase.components.ComponentDiscoveryService">
       <meta-data
         android:name="com.google.firebase.components:com.google.firebase.sessions.FirebaseSessionsRegistrar"
         android:value="com.google.firebase.components.ComponentRegistrar" />

firebase-sessions/src/main/AndroidManifest.xml

@@ -21,6 +21,7 @@ import com.google.android.datatransport.Encoding
 import com.google.android.datatransport.Event
 import com.google.android.datatransport.TransportFactory
 import com.google.firebase.inject.Provider
+import com.google.firebase.sessions.FirebaseSessions.Companion.TAG
 import javax.inject.Inject
 import javax.inject.Singleton
 
@@ -61,8 +62,6 @@ constructor(private val transportFactoryProvider: Provider<TransportFactory>) :
   }
 
   companion object {
-    private const val TAG = "EventGDTLogger"
-
     private const val AQS_LOG_SOURCE = "FIREBASE_APPQUALITY_SESSION"
   }
 }

firebase-sessions/src/main/kotlin/com/google/firebase/sessions/EventGDTLogger.kt

@@ -38,14 +38,14 @@ constructor(
   private val firebaseApp: FirebaseApp,
   private val settings: SessionsSettings,
   @Background backgroundDispatcher: CoroutineContext,
-  lifecycleServiceBinder: SessionLifecycleServiceBinder,
+  sessionsActivityLifecycleCallbacks: SessionsActivityLifecycleCallbacks,
 ) {
 
   init {
-    Log.d(TAG, "Initializing Firebase Sessions SDK.")
+    Log.d(TAG, "Initializing Firebase Sessions ${BuildConfig.VERSION_NAME}.")
     val appContext = firebaseApp.applicationContext.applicationContext
     if (appContext is Application) {
-      appContext.registerActivityLifecycleCallbacks(SessionsActivityLifecycleCallbacks)
+      appContext.registerActivityLifecycleCallbacks(sessionsActivityLifecycleCallbacks)
 
       CoroutineScope(backgroundDispatcher).launch {
         val subscribers = FirebaseSessionsDependencies.getRegisteredSubscribers()
@@ -56,16 +56,12 @@ constructor(
           if (!settings.sessionsEnabled) {
             Log.d(TAG, "Sessions SDK disabled. Not listening to lifecycle events.")
           } else {
-            val lifecycleClient = SessionLifecycleClient(backgroundDispatcher)
-            lifecycleClient.bindToService(lifecycleServiceBinder)
-            SessionsActivityLifecycleCallbacks.lifecycleClient = lifecycleClient
-
             firebaseApp.addLifecycleEventListener { _, _ ->
               Log.w(
                 TAG,
                 "FirebaseApp instance deleted. Sessions library will stop collecting data.",
               )
-              SessionsActivityLifecycleCallbacks.lifecycleClient = null
+              sessionsActivityLifecycleCallbacks.onAppDelete()
             }
           }
         }
@@ -79,7 +75,7 @@ constructor(
   }
 
   companion object {
-    private const val TAG = "FirebaseSessions"
+    internal const val TAG = "FirebaseSessions"
 
     val instance: FirebaseSessions
       get() = Firebase.app[FirebaseSessions::class.java]