Introduce background and blocking dispatchers for Firebase alignment.

Author: visumickey

firebase-sessions/firebase-sessions.gradle.kts

@@ -50,6 +50,7 @@ dependencies {
   implementation("com.google.firebase:firebase-encoders:17.0.0")
   implementation("com.google.firebase:firebase-installations-interop:17.1.0")
   implementation(libs.androidx.annotation)
+  testImplementation(project(mapOf("path" to ":integ-testing")))
 
   runtimeOnly("com.google.firebase:firebase-installations:17.1.3")
   runtimeOnly(project(":firebase-datatransport"))

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

@@ -33,11 +33,18 @@ internal constructor(
   private val firebaseApp: FirebaseApp,
   firebaseInstallations: FirebaseInstallationsApi,
   backgroundDispatcher: CoroutineDispatcher,
+  blockingDispatcher: CoroutineDispatcher,
   transportFactoryProvider: Provider<TransportFactory>,
 ) {
   private val applicationInfo = SessionEvents.getApplicationInfo(firebaseApp)
   private val sessionSettings =
-    SessionsSettings(firebaseApp.applicationContext, firebaseInstallations, applicationInfo)
+    SessionsSettings(
+      firebaseApp.applicationContext,
+      blockingDispatcher,
+      backgroundDispatcher,
+      firebaseInstallations,
+      applicationInfo
+    )
   private val sessionGenerator = SessionGenerator(collectEvents = shouldCollectEvents())
   private val eventGDTLogger = EventGDTLogger(transportFactoryProvider)
   private val sessionCoordinator =

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

@@ -18,6 +18,7 @@ import androidx.annotation.Keep
 import com.google.android.datatransport.TransportFactory
 import com.google.firebase.FirebaseApp
 import com.google.firebase.annotations.concurrent.Background
+import com.google.firebase.annotations.concurrent.Blocking
 import com.google.firebase.components.*
 import com.google.firebase.components.Qualified.qualified
 import com.google.firebase.components.Qualified.unqualified
@@ -45,6 +46,7 @@ internal class FirebaseSessionsRegistrar : ComponentRegistrar {
         .add(Dependency.required(firebaseApp))
         .add(Dependency.required(firebaseInstallationsApi))
         .add(Dependency.required(backgroundDispatcher))
+        .add(Dependency.required(blockingDispatcher))
         .add(Dependency.requiredProvider(transportFactory))
         .factory { container ->
           // Make sure FirebaseSessionsEarly has started up
@@ -53,6 +55,7 @@ internal class FirebaseSessionsRegistrar : ComponentRegistrar {
             container.get(firebaseApp),
             container.get(firebaseInstallationsApi),
             container.get(backgroundDispatcher),
+            container.get(blockingDispatcher),
             container.getProvider(transportFactory),
           )
         }
@@ -69,6 +72,8 @@ internal class FirebaseSessionsRegistrar : ComponentRegistrar {
     private val firebaseInstallationsApi = unqualified(FirebaseInstallationsApi::class.java)
     private val backgroundDispatcher =
       qualified(Background::class.java, CoroutineDispatcher::class.java)
+    private val blockingDispatcher =
+      qualified(Blocking::class.java, CoroutineDispatcher::class.java)
     private val transportFactory = unqualified(TransportFactory::class.java)
   }
 }

firebase-sessions/src/main/kotlin/com/google/firebase/sessions/settings/RemoteSettings.kt

@@ -22,8 +22,10 @@ import androidx.datastore.preferences.preferencesDataStore
 import com.google.firebase.installations.FirebaseInstallationsApi
 import com.google.firebase.sessions.ApplicationInfo
 import java.util.concurrent.atomic.AtomicBoolean
+import kotlin.coroutines.CoroutineContext
 import kotlin.time.Duration
 import kotlin.time.Duration.Companion.seconds
+import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.runBlocking
@@ -33,6 +35,8 @@ import org.json.JSONObject
 
 internal class RemoteSettings(
   val context: Context,
+  val blockingDispatcher: CoroutineContext,
+  val backgroundDispatcher: CoroutineContext,
   val firebaseInstallationsApi: FirebaseInstallationsApi,
   val appInfo: ApplicationInfo,
   private val configsFetcher: CrashlyticsSettingsFetcher = RemoteSettingsFetcher(appInfo),
@@ -62,15 +66,17 @@ internal class RemoteSettings(
     }
 
   override fun updateSettings() {
-    runBlocking { launch(Dispatchers.Default) { fetchConfigs() } }
+    // TODO: Move to blocking coroutine dispatcher.
+    runBlocking(Dispatchers.Default) { launch { fetchConfigs() } }
   }
 
   override fun isSettingsStale(): Boolean {
     return settingsCache.hasCacheExpired()
   }
 
   internal fun clearCachedSettings() {
-    runBlocking { launch(Dispatchers.Default) { settingsCache.removeConfigs() } }
+    val scope = CoroutineScope(backgroundDispatcher)
+    scope.launch { settingsCache.removeConfigs() }
   }
 
   suspend private fun fetchConfigs() {
@@ -134,6 +140,7 @@ internal class RemoteSettings(
           }
         }
 
+        val scope = CoroutineScope(backgroundDispatcher)
         sessionsEnabled?.let { settingsCache.updateSettingsEnabled(sessionsEnabled) }
 
         sessionTimeoutSeconds?.let {

firebase-sessions/src/main/kotlin/com/google/firebase/sessions/settings/SessionsSettings.kt

@@ -19,6 +19,7 @@ package com.google.firebase.sessions.settings
 import android.content.Context
 import com.google.firebase.installations.FirebaseInstallationsApi
 import com.google.firebase.sessions.ApplicationInfo
+import kotlin.coroutines.CoroutineContext
 import kotlin.time.Duration
 import kotlin.time.Duration.Companion.minutes
 
@@ -29,11 +30,19 @@ import kotlin.time.Duration.Companion.minutes
  */
 internal class SessionsSettings(
   val context: Context,
+  val blockingDispatcher: CoroutineContext,
+  val backgroundDispatcher: CoroutineContext,
   val firebaseInstallationsApi: FirebaseInstallationsApi,
   val appInfo: ApplicationInfo,
   private val localOverrideSettings: LocalOverrideSettings = LocalOverrideSettings(context),
   private val remoteSettings: RemoteSettings =
-    RemoteSettings(context, firebaseInstallationsApi, appInfo)
+    RemoteSettings(
+      context,
+      blockingDispatcher,
+      backgroundDispatcher,
+      firebaseInstallationsApi,
+      appInfo
+    )
 ) {
   // Order of preference for all the configs below:
   // 1. Honor local overrides

firebase-sessions/src/test/kotlin/com/google/firebase/sessions/EventGDTLoggerTest.kt

@@ -21,13 +21,16 @@ import com.google.android.datatransport.Event
 import com.google.android.datatransport.TransportFactory
 import com.google.common.truth.Truth.assertThat
 import com.google.firebase.FirebaseApp
+import com.google.firebase.concurrent.TestOnlyExecutors
 import com.google.firebase.sessions.settings.SessionsSettings
 import com.google.firebase.sessions.testing.FakeFirebaseApp
 import com.google.firebase.sessions.testing.FakeFirebaseInstallations
 import com.google.firebase.sessions.testing.FakeProvider
 import com.google.firebase.sessions.testing.FakeTimeProvider
 import com.google.firebase.sessions.testing.FakeTransportFactory
 import com.google.firebase.sessions.testing.TestSessionEventData
+import kotlinx.coroutines.asCoroutineDispatcher
+import kotlinx.coroutines.test.runTest
 import org.junit.After
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -37,7 +40,7 @@ import org.robolectric.RobolectricTestRunner
 class EventGDTLoggerTest {
 
   @Test
-  fun event_logsToGoogleDataTransport() {
+  fun event_logsToGoogleDataTransport() = runTest {
     val fakeFirebaseApp = FakeFirebaseApp()
     val firebaseInstallations = FakeFirebaseInstallations("FaKeFiD")
     val sessionEvent =
@@ -46,6 +49,8 @@ class EventGDTLoggerTest {
         TestSessionEventData.TEST_SESSION_DETAILS,
         SessionsSettings(
           fakeFirebaseApp.firebaseApp.applicationContext,
+          TestOnlyExecutors.blocking().asCoroutineDispatcher() + coroutineContext,
+          TestOnlyExecutors.background().asCoroutineDispatcher() + coroutineContext,
           firebaseInstallations,
           SessionEvents.getApplicationInfo(fakeFirebaseApp.firebaseApp)
         ),

firebase-sessions/src/test/kotlin/com/google/firebase/sessions/RemoteSettingsTest.kt

@@ -19,11 +19,14 @@ package com.google.firebase.sessions
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import com.google.common.truth.Truth.assertThat
 import com.google.firebase.FirebaseApp
+import com.google.firebase.concurrent.TestOnlyExecutors
 import com.google.firebase.sessions.settings.RemoteSettings
 import com.google.firebase.sessions.testing.FakeFirebaseApp
 import com.google.firebase.sessions.testing.FakeFirebaseInstallations
 import com.google.firebase.sessions.testing.FakeRemoteConfigFetcher
 import kotlin.time.Duration.Companion.minutes
+import kotlinx.coroutines.asCoroutineDispatcher
+import kotlinx.coroutines.test.runTest
 import org.json.JSONObject
 import org.junit.After
 import org.junit.Test
@@ -33,7 +36,7 @@ import org.junit.runner.RunWith
 class RemoteSettingsTest {
 
   @Test
-  fun RemoteSettings_successfulFetchCachesValues() {
+  fun RemoteSettings_successfulFetchCachesValues() = runTest {
     val firebaseApp = FakeFirebaseApp().firebaseApp
     val context = firebaseApp.applicationContext
     val firebaseInstallations = FakeFirebaseInstallations("FaKeFiD")
@@ -42,6 +45,8 @@ class RemoteSettingsTest {
     val remoteSettings =
       RemoteSettings(
         context,
+        TestOnlyExecutors.blocking().asCoroutineDispatcher() + coroutineContext,
+        TestOnlyExecutors.background().asCoroutineDispatcher() + coroutineContext,
         firebaseInstallations,
         SessionEvents.getApplicationInfo(firebaseApp),
         fakeFetcher,
@@ -62,7 +67,7 @@ class RemoteSettingsTest {
   }
 
   @Test
-  fun RemoteSettings_successfulFetchWithLessConfigsCachesOnlyReceivedValues() {
+  fun RemoteSettings_successfulFetchWithLessConfigsCachesOnlyReceivedValues() = runTest {
     val firebaseApp = FakeFirebaseApp().firebaseApp
     val context = firebaseApp.applicationContext
     val firebaseInstallations = FakeFirebaseInstallations("FaKeFiD")
@@ -71,6 +76,8 @@ class RemoteSettingsTest {
     val remoteSettings =
       RemoteSettings(
         context,
+        TestOnlyExecutors.blocking().asCoroutineDispatcher() + coroutineContext,
+        TestOnlyExecutors.background().asCoroutineDispatcher() + coroutineContext,
         firebaseInstallations,
         SessionEvents.getApplicationInfo(firebaseApp),
         fakeFetcher,
@@ -93,15 +100,20 @@ class RemoteSettingsTest {
   }
 
   @Test
-  fun RemoteSettings_successfulRefetchUpdatesCache() {
+  fun RemoteSettings_successfulRefetchUpdatesCache() = runTest {
     val firebaseApp = FakeFirebaseApp().firebaseApp
     val context = firebaseApp.applicationContext
     val firebaseInstallations = FakeFirebaseInstallations("FaKeFiD")
     val fakeFetcher = FakeRemoteConfigFetcher()
 
+    val blockingDispatcher = TestOnlyExecutors.blocking().asCoroutineDispatcher() + coroutineContext
+    val backgroundDispatcher =
+      TestOnlyExecutors.background().asCoroutineDispatcher() + coroutineContext
     val remoteSettings =
       RemoteSettings(
         context,
+        blockingDispatcher,
+        backgroundDispatcher,
         firebaseInstallations,
         SessionEvents.getApplicationInfo(firebaseApp),
         fakeFetcher,
@@ -112,6 +124,7 @@ class RemoteSettingsTest {
     fakeFetcher.responseJSONObject = fetchedResponse
     remoteSettings.updateSettings()
 
+    //    runCurrent()
     assertThat(remoteSettings.sessionEnabled).isFalse()
     assertThat(remoteSettings.samplingRate).isEqualTo(0.75)
     assertThat(remoteSettings.sessionRestartTimeout).isEqualTo(40.minutes)
@@ -134,7 +147,7 @@ class RemoteSettingsTest {
   }
 
   @Test
-  fun RemoteSettings_successfulFetchWithEmptyConfigRetainsOldConfigs() {
+  fun RemoteSettings_successfulFetchWithEmptyConfigRetainsOldConfigs() = runTest {
     val firebaseApp = FakeFirebaseApp().firebaseApp
     val context = firebaseApp.applicationContext
     val firebaseInstallations = FakeFirebaseInstallations("FaKeFiD")
@@ -143,6 +156,8 @@ class RemoteSettingsTest {
     val remoteSettings =
       RemoteSettings(
         context,
+        TestOnlyExecutors.blocking().asCoroutineDispatcher() + coroutineContext,
+        TestOnlyExecutors.background().asCoroutineDispatcher() + coroutineContext,
         firebaseInstallations,
         SessionEvents.getApplicationInfo(firebaseApp),
         fakeFetcher,

firebase-sessions/src/test/kotlin/com/google/firebase/sessions/SessionCoordinatorTest.kt

@@ -56,6 +56,8 @@ class SessionCoordinatorTest {
         TestSessionEventData.TEST_SESSION_DETAILS,
         SessionsSettings(
           fakeFirebaseApp.firebaseApp.applicationContext,
+          TestOnlyExecutors.blocking().asCoroutineDispatcher() + coroutineContext,
+          TestOnlyExecutors.background().asCoroutineDispatcher() + coroutineContext,
           firebaseInstallations,
           SessionEvents.getApplicationInfo(fakeFirebaseApp.firebaseApp)
         ),

firebase-sessions/src/test/kotlin/com/google/firebase/sessions/SessionEventEncoderTest.kt

@@ -20,12 +20,15 @@ import android.os.Build
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import com.google.common.truth.Truth.assertThat
 import com.google.firebase.FirebaseApp
+import com.google.firebase.concurrent.TestOnlyExecutors
 import com.google.firebase.sessions.SessionEvents.SESSION_EVENT_ENCODER
 import com.google.firebase.sessions.settings.SessionsSettings
 import com.google.firebase.sessions.testing.FakeFirebaseApp
 import com.google.firebase.sessions.testing.FakeFirebaseInstallations
 import com.google.firebase.sessions.testing.FakeTimeProvider
 import com.google.firebase.sessions.testing.TestSessionEventData
+import kotlinx.coroutines.asCoroutineDispatcher
+import kotlinx.coroutines.test.runTest
 import org.junit.After
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -39,7 +42,7 @@ class SessionEventEncoderTest {
   }
 
   @Test
-  fun sessionEvent_encodesToJson() {
+  fun sessionEvent_encodesToJson() = runTest {
     val fakeFirebaseApp = FakeFirebaseApp()
     val firebaseInstallations = FakeFirebaseInstallations("FaKeFiD")
     val sessionEvent =
@@ -48,6 +51,8 @@ class SessionEventEncoderTest {
         TestSessionEventData.TEST_SESSION_DETAILS,
         SessionsSettings(
           fakeFirebaseApp.firebaseApp.applicationContext,
+          TestOnlyExecutors.blocking().asCoroutineDispatcher() + coroutineContext,
+          TestOnlyExecutors.background().asCoroutineDispatcher() + coroutineContext,
           firebaseInstallations,
           SessionEvents.getApplicationInfo(fakeFirebaseApp.firebaseApp)
         ),

firebase-sessions/src/test/kotlin/com/google/firebase/sessions/SessionEventTest.kt

@@ -19,6 +19,7 @@ package com.google.firebase.sessions
 import android.os.Bundle
 import com.google.common.truth.Truth.assertThat
 import com.google.firebase.FirebaseApp
+import com.google.firebase.concurrent.TestOnlyExecutors
 import com.google.firebase.sessions.settings.SessionsSettings
 import com.google.firebase.sessions.testing.FakeFirebaseApp
 import com.google.firebase.sessions.testing.FakeFirebaseInstallations
@@ -27,6 +28,8 @@ import com.google.firebase.sessions.testing.TestSessionEventData.TEST_DATA_COLLE
 import com.google.firebase.sessions.testing.TestSessionEventData.TEST_SESSION_DATA
 import com.google.firebase.sessions.testing.TestSessionEventData.TEST_SESSION_DETAILS
 import com.google.firebase.sessions.testing.TestSessionEventData.TEST_SESSION_EVENT
+import kotlinx.coroutines.asCoroutineDispatcher
+import kotlinx.coroutines.test.runTest
 import org.junit.After
 import org.junit.Test
 import org.junit.runner.RunWith
@@ -35,7 +38,7 @@ import org.robolectric.RobolectricTestRunner
 @RunWith(RobolectricTestRunner::class)
 class SessionEventTest {
   @Test
-  fun sessionStart_populatesSessionDetailsCorrectly() {
+  fun sessionStart_populatesSessionDetailsCorrectly() = runTest {
     val fakeFirebaseApp = FakeFirebaseApp()
     val firebaseInstallations = FakeFirebaseInstallations("FaKeFiD")
     val sessionEvent =
@@ -44,6 +47,8 @@ class SessionEventTest {
         TEST_SESSION_DETAILS,
         SessionsSettings(
           fakeFirebaseApp.firebaseApp.applicationContext,
+          TestOnlyExecutors.blocking().asCoroutineDispatcher() + coroutineContext,
+          TestOnlyExecutors.background().asCoroutineDispatcher() + coroutineContext,
           firebaseInstallations,
           SessionEvents.getApplicationInfo(fakeFirebaseApp.firebaseApp)
         ),
@@ -54,7 +59,7 @@ class SessionEventTest {
   }
 
   @Test
-  fun sessionStart_samplingRate() {
+  fun sessionStart_samplingRate() = runTest {
     val metadata = Bundle()
     metadata.putDouble("firebase_sessions_sampling_rate", 0.5)
     val fakeFirebaseApp = FakeFirebaseApp(metadata)
@@ -66,6 +71,8 @@ class SessionEventTest {
         TEST_SESSION_DETAILS,
         SessionsSettings(
           fakeFirebaseApp.firebaseApp.applicationContext,
+          TestOnlyExecutors.blocking().asCoroutineDispatcher() + coroutineContext,
+          TestOnlyExecutors.background().asCoroutineDispatcher() + coroutineContext,
           firebaseInstallations,
           SessionEvents.getApplicationInfo(fakeFirebaseApp.firebaseApp)
         ),