Populate firebaseInstallationId field in session (#4801)

Author: mrober

firebase-sessions/firebase-sessions.gradle.kts

@@ -54,6 +54,7 @@ dependencies {
   testImplementation(libs.androidx.test.junit)
   testImplementation(libs.androidx.test.runner)
   testImplementation(libs.junit)
+  testImplementation(libs.kotlin.coroutines.test)
   testImplementation(libs.robolectric)
   testImplementation(libs.truth)
 

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

@@ -39,7 +39,11 @@ class FirebaseSessionsTests {
   fun setUp() {
     Firebase.initialize(
       ApplicationProvider.getApplicationContext(),
-      FirebaseOptions.Builder().setApplicationId("APP_ID").build()
+      FirebaseOptions.Builder()
+        .setApplicationId(APP_ID)
+        .setApiKey(API_KEY)
+        .setProjectId(PROJECT_ID)
+        .build()
     )
   }
 
@@ -53,4 +57,10 @@ class FirebaseSessionsTests {
     // This will be replaced with real tests.
     assertThat(FirebaseSessions.instance.greeting()).isEqualTo("Matt says hi!")
   }
+
+  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"
+  }
 }

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

@@ -23,10 +23,16 @@ import com.google.firebase.FirebaseApp
 import com.google.firebase.installations.FirebaseInstallationsApi
 import com.google.firebase.ktx.Firebase
 import com.google.firebase.ktx.app
+import kotlinx.coroutines.CoroutineDispatcher
 
 class FirebaseSessions
-internal constructor(firebaseApp: FirebaseApp, firebaseInstallations: FirebaseInstallationsApi) {
+internal constructor(
+  firebaseApp: FirebaseApp,
+  firebaseInstallations: FirebaseInstallationsApi,
+  backgroundDispatcher: CoroutineDispatcher
+) {
   private val sessionGenerator = SessionGenerator(collectEvents = true)
+  private val sessionCoordinator = SessionCoordinator(firebaseInstallations, backgroundDispatcher)
 
   init {
     val sessionInitiator = SessionInitiator(WallClock::elapsedRealtime, this::initiateSessionStart)
@@ -36,7 +42,6 @@ internal constructor(firebaseApp: FirebaseApp, firebaseInstallations: FirebaseIn
     } else {
       Log.w(TAG, "Failed to register lifecycle callbacks, unexpected context ${context.javaClass}.")
     }
-    Log.i(TAG, "Firebase Installations ID: ${firebaseInstallations.id}")
   }
 
   @Discouraged(message = "This will be replaced with a real API.")
@@ -46,7 +51,9 @@ internal constructor(firebaseApp: FirebaseApp, firebaseInstallations: FirebaseIn
     val sessionDetails = sessionGenerator.generateNewSession()
     val sessionEvent = SessionEvents.startSession(sessionDetails)
 
-    Log.i(TAG, "Initiate session start: $sessionEvent")
+    if (sessionDetails.collectEvents) {
+      sessionCoordinator.attemptLoggingSessionEvent(sessionEvent)
+    }
   }
 
   companion object {

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

@@ -16,11 +16,15 @@ package com.google.firebase.sessions
 
 import androidx.annotation.Keep
 import com.google.firebase.FirebaseApp
+import com.google.firebase.annotations.concurrent.Background
 import com.google.firebase.components.Component
 import com.google.firebase.components.ComponentRegistrar
 import com.google.firebase.components.Dependency
+import com.google.firebase.components.Qualified.qualified
+import com.google.firebase.components.Qualified.unqualified
 import com.google.firebase.installations.FirebaseInstallationsApi
 import com.google.firebase.platforminfo.LibraryVersionComponent
+import kotlinx.coroutines.CoroutineDispatcher
 
 /**
  * [ComponentRegistrar] for setting up [FirebaseSessions].
@@ -33,12 +37,14 @@ internal class FirebaseSessionsRegistrar : ComponentRegistrar {
     listOf(
       Component.builder(FirebaseSessions::class.java)
         .name(LIBRARY_NAME)
-        .add(Dependency.required(FirebaseApp::class.java))
-        .add(Dependency.required(FirebaseInstallationsApi::class.java))
+        .add(Dependency.required(firebaseApp))
+        .add(Dependency.required(firebaseInstallationsApi))
+        .add(Dependency.required(backgroundDispatcher))
         .factory { container ->
           FirebaseSessions(
-            container.get(FirebaseApp::class.java),
-            container.get(FirebaseInstallationsApi::class.java)
+            container.get(firebaseApp),
+            container.get(firebaseInstallationsApi),
+            container.get(backgroundDispatcher),
           )
         }
         .eagerInDefaultApp()
@@ -48,5 +54,10 @@ internal class FirebaseSessionsRegistrar : ComponentRegistrar {
 
   companion object {
     private const val LIBRARY_NAME = "fire-sessions"
+
+    private val firebaseApp = unqualified(FirebaseApp::class.java)
+    private val firebaseInstallationsApi = unqualified(FirebaseInstallationsApi::class.java)
+    private val backgroundDispatcher =
+      qualified(Background::class.java, CoroutineDispatcher::class.java)
   }
 }

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

@@ -0,0 +1,55 @@
+/*
+ * 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.
+ * 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.sessions
+
+import android.util.Log
+import com.google.firebase.installations.FirebaseInstallationsApi
+import kotlinx.coroutines.CoroutineDispatcher
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.tasks.await
+
+/**
+ * [SessionCoordinator] is responsible for coordinating the systems in this SDK involved with
+ * sending a [SessionEvent].
+ *
+ * @hide
+ */
+internal class SessionCoordinator(
+  private val firebaseInstallations: FirebaseInstallationsApi,
+  backgroundDispatcher: CoroutineDispatcher
+) {
+  private val scope = CoroutineScope(backgroundDispatcher)
+
+  fun attemptLoggingSessionEvent(sessionEvent: SessionEvent) =
+    scope.launch {
+      sessionEvent.sessionData.firebaseInstallationId =
+        try {
+          firebaseInstallations.id.await()
+        } catch (ex: Exception) {
+          Log.w(TAG, "Session Installations Error", ex)
+          // Use an empty fid if there is any failure.
+          ""
+        }
+
+      Log.i(TAG, "Initiate session start: $sessionEvent")
+    }
+
+  companion object {
+    private const val TAG = "SessionCoordinator"
+  }
+}

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

@@ -55,4 +55,7 @@ internal data class SessionInfo(
 
   /** What order this Session came in this run of the app. For the first Session this will be 0. */
   val sessionIndex: Int,
+
+  /** Identifies a unique device+app installation: go/firebase-installations */
+  var firebaseInstallationId: String = "",
 )

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

@@ -48,12 +48,20 @@ internal object SessionEvents {
             ctx.add(FieldDescriptor.of("session_id"), sessionInfo.sessionId)
             ctx.add(FieldDescriptor.of("first_session_id"), sessionInfo.firstSessionId)
             ctx.add(FieldDescriptor.of("session_index"), sessionInfo.sessionIndex)
+            ctx.add(
+              FieldDescriptor.of("firebase_installation_id"),
+              sessionInfo.firebaseInstallationId
+            )
           }
         }
       }
       .build()
 
-  /** Construct a Session Start event */
+  /**
+   * Construct a Session Start event.
+   *
+   * Some mutable fields, e.g. firebaseInstallationId, get populated later.
+   */
   fun startSession(sessionDetails: SessionDetails) =
     SessionEvent(
       eventType = EventType.SESSION_START,

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

@@ -0,0 +1,58 @@
+/*
+ * 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.
+ * 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.sessions
+
+import androidx.test.ext.junit.runners.AndroidJUnit4
+import com.google.common.truth.Truth.assertThat
+import com.google.firebase.sessions.testing.FakeFirebaseInstallations
+import kotlinx.coroutines.ExperimentalCoroutinesApi
+import kotlinx.coroutines.test.StandardTestDispatcher
+import kotlinx.coroutines.test.runCurrent
+import kotlinx.coroutines.test.runTest
+import org.junit.Test
+import org.junit.runner.RunWith
+
+@OptIn(ExperimentalCoroutinesApi::class)
+@RunWith(AndroidJUnit4::class)
+class SessionCoordinatorTest {
+  @Test
+  fun attemptLoggingSessionEvent_populatesFid() = runTest {
+    val sessionCoordinator =
+      SessionCoordinator(
+        firebaseInstallations = FakeFirebaseInstallations("FaKeFiD"),
+        backgroundDispatcher = StandardTestDispatcher(testScheduler),
+      )
+
+    // Construct an event with no fid set.
+    val sessionEvent =
+      SessionEvent(
+        eventType = EventType.SESSION_START,
+        sessionData =
+          SessionInfo(
+            sessionId = "id",
+            firstSessionId = "first",
+            sessionIndex = 3,
+          ),
+      )
+
+    sessionCoordinator.attemptLoggingSessionEvent(sessionEvent)
+
+    runCurrent()
+
+    assertThat(sessionEvent.sessionData.firebaseInstallationId).isEqualTo("FaKeFiD")
+  }
+}

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

@@ -34,6 +34,7 @@ class SessionEventEncoderTest {
             sessionId = "id",
             firstSessionId = "first",
             sessionIndex = 9,
+            firebaseInstallationId = "fid"
           ),
       )
 
@@ -47,7 +48,8 @@ class SessionEventEncoderTest {
           "session_data":{
             "session_id":"id",
             "first_session_id":"first",
-            "session_index":9
+            "session_index":9,
+            "firebase_installation_id":"fid"
           }
         }
         """
@@ -79,7 +81,8 @@ class SessionEventEncoderTest {
           "session_data":{
             "session_id":"",
             "first_session_id":"",
-            "session_index":0
+            "session_index":0,
+            "firebase_installation_id":""
           }
         }
         """

firebase-sessions/src/test/kotlin/com/google/firebase/sessions/testing/FakeFirebaseInstallations.kt

@@ -0,0 +1,37 @@
+/*
+ * 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.
+ * 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.sessions.testing
+
+import com.google.android.gms.tasks.Task
+import com.google.android.gms.tasks.Tasks
+import com.google.firebase.installations.FirebaseInstallationsApi
+import com.google.firebase.installations.InstallationTokenResult
+import com.google.firebase.installations.internal.FidListener
+import com.google.firebase.installations.internal.FidListenerHandle
+
+/** Fake [FirebaseInstallationsApi] that implements [getId] and always returns the given [fid]. */
+internal class FakeFirebaseInstallations(private val fid: String = "") : FirebaseInstallationsApi {
+  override fun getId(): Task<String> = Tasks.forResult(fid)
+
+  override fun getToken(forceRefresh: Boolean): Task<InstallationTokenResult> =
+    throw NotImplementedError("getToken not faked.")
+
+  override fun delete(): Task<Void> = throw NotImplementedError("delete not faked.")
+
+  override fun registerFidListener(listener: FidListener): FidListenerHandle =
+    throw NotImplementedError("registerFidListener not faked.")
+}