Controls whether or not the sessions SDK hooks up any lifecycle callb… (

#5443) …acks based on the sdk enablement in SessionsSettings.
firebase · Oct 19, 2023 · 859cb0c · 859cb0c
1 parent 1a70bdc
commit 859cb0c
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 13 deletions.
diff --git a/firebase-sessions/src/main/kotlin/com/google/firebase/sessions/FirebaseSessions.kt b/firebase-sessions/src/main/kotlin/com/google/firebase/sessions/FirebaseSessions.kt
@@ -23,30 +23,53 @@ import com.google.firebase.FirebaseApp
 import com.google.firebase.app
 import com.google.firebase.sessions.api.FirebaseSessionsDependencies
 import com.google.firebase.sessions.api.SessionSubscriber
+import com.google.firebase.sessions.settings.SessionsSettings
+import kotlin.coroutines.CoroutineContext
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.launch
 
 /** The [FirebaseSessions] API provides methods to register a [SessionSubscriber]. */
-class FirebaseSessions internal constructor(private val firebaseApp: FirebaseApp) {
+class FirebaseSessions
+internal constructor(
+  private val firebaseApp: FirebaseApp,
+  private val settings: SessionsSettings,
+  backgroundDispatcher: CoroutineContext,
+) {
 
   init {
-    val appContext = firebaseApp.applicationContext.applicationContext
-    if (appContext is Application) {
-      SessionLifecycleClient.bindToService(appContext)
-      appContext.registerActivityLifecycleCallbacks(SessionsActivityLifecycleCallbacks)
+    Log.d(TAG, "Initializing Firebase Sessions SDK.")
+    CoroutineScope(backgroundDispatcher).launch {
+      val appContext = firebaseApp.applicationContext.applicationContext
+      settings.updateSettings()
+      if (!settings.sessionsEnabled) {
+        Log.d(TAG, "Sessions SDK disabled. Not listening to lifecycle events.")
+      } else if (appContext is Application) {
+        SessionLifecycleClient.bindToService(appContext)
+        appContext.registerActivityLifecycleCallbacks(SessionsActivityLifecycleCallbacks)
 
-      firebaseApp.addLifecycleEventListener { _, _ ->
-        Log.w(TAG, "FirebaseApp instance deleted. Sessions library will not collect session data.")
-        appContext.unregisterActivityLifecycleCallbacks(SessionsActivityLifecycleCallbacks)
+        firebaseApp.addLifecycleEventListener { _, _ ->
+          Log.w(
+            TAG,
+            "FirebaseApp instance deleted. Sessions library will not collect session data."
+          )
+          appContext.unregisterActivityLifecycleCallbacks(SessionsActivityLifecycleCallbacks)
+        }
+      } else {
+        Log.e(
+          TAG,
+          "Failed to register lifecycle callbacks, unexpected context ${appContext.javaClass}."
+        )
       }
-    } else {
-      Log.e(
-        TAG,
-        "Failed to register lifecycle callbacks, unexpected context ${appContext.javaClass}."
-      )
     }
   }
 
   /** Register the [subscriber]. This must be called for every dependency. */
   fun register(subscriber: SessionSubscriber) {
+    if (!settings.sessionsEnabled) {
+      Log.d(TAG, "Sessions SDK disabled. Ignoring dependency registration.")
+      return
+    }
+
     FirebaseSessionsDependencies.register(subscriber)
 
     Log.d(

diff --git a/firebase-sessions/src/main/kotlin/com/google/firebase/sessions/FirebaseSessionsRegistrar.kt b/firebase-sessions/src/main/kotlin/com/google/firebase/sessions/FirebaseSessionsRegistrar.kt
@@ -41,9 +41,13 @@ internal class FirebaseSessionsRegistrar : ComponentRegistrar {
       Component.builder(FirebaseSessions::class.java)
         .name(LIBRARY_NAME)
         .add(Dependency.required(firebaseApp))
+        .add(Dependency.required(sessionsSettings))
+        .add(Dependency.required(backgroundDispatcher))
         .factory { container ->
           FirebaseSessions(
             container.get(firebaseApp),
+            container.get(sessionsSettings),
+            container.get(backgroundDispatcher),
           )
         }
         .build(),

diff --git a/firebase-sessions/src/main/kotlin/com/google/firebase/sessions/settings/RemoteSettings.kt b/firebase-sessions/src/main/kotlin/com/google/firebase/sessions/settings/RemoteSettings.kt
@@ -68,6 +68,7 @@ internal class RemoteSettings(
     fetchInProgress.withLock {
       // Double check if cache is expired. If not, return.
       if (!settingsCache.hasCacheExpired()) {
+        Log.d(TAG, "Remote settings cache not expired. Using cached values.")
         return
       }
 
@@ -89,9 +90,11 @@ internal class RemoteSettings(
           "X-Crashlytics-API-Client-Version" to appInfo.sessionSdkVersion
         )
 
+      Log.d(TAG, "Fetching settings from server.")
       configsFetcher.doConfigFetch(
         headerOptions = options,
         onSuccess = {
+          Log.d(TAG, "Fetched settings: $it")
           var sessionsEnabled: Boolean? = null
           var sessionSamplingRate: Double? = null
           var sessionTimeoutSeconds: Int? = null