Add GDT to Firebase Sessions

Author: samedson

firebase-sessions/firebase-sessions.gradle.kts

@@ -51,6 +51,10 @@ dependencies {
 
   runtimeOnly("com.google.firebase:firebase-installations:17.1.3")
 
+  implementation("com.google.android.datatransport:transport-api:3.0.0")
+  // implementation("com.google.android.datatransport:transport-runtime:3.1.8")
+  // implementation("com.google.android.datatransport:transport-backend-cct:3.1.8")
+
   testImplementation(libs.androidx.test.junit)
   testImplementation(libs.androidx.test.runner)
   testImplementation(libs.junit)

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

@@ -19,6 +19,7 @@ package com.google.firebase.sessions
 import android.app.Application
 import android.util.Log
 import androidx.annotation.Discouraged
+import com.google.android.datatransport.TransportFactory
 import com.google.firebase.FirebaseApp
 import com.google.firebase.installations.FirebaseInstallationsApi
 import com.google.firebase.ktx.Firebase
@@ -29,10 +30,12 @@ class FirebaseSessions
 internal constructor(
   private val firebaseApp: FirebaseApp,
   firebaseInstallations: FirebaseInstallationsApi,
-  backgroundDispatcher: CoroutineDispatcher
+  backgroundDispatcher: CoroutineDispatcher,
+  transportFactory: TransportFactory,
 ) {
   private val sessionGenerator = SessionGenerator(collectEvents = true)
-  private val sessionCoordinator = SessionCoordinator(firebaseInstallations, backgroundDispatcher)
+  private val sessionCoordinator =
+    SessionCoordinator(firebaseInstallations, backgroundDispatcher, transportFactory)
 
   init {
     val sessionInitiator = SessionInitiator(WallClock::elapsedRealtime, this::initiateSessionStart)

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

@@ -15,6 +15,7 @@
 package com.google.firebase.sessions
 
 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.components.Component
@@ -40,11 +41,13 @@ internal class FirebaseSessionsRegistrar : ComponentRegistrar {
         .add(Dependency.required(firebaseApp))
         .add(Dependency.required(firebaseInstallationsApi))
         .add(Dependency.required(backgroundDispatcher))
+        .add(Dependency.required(transportFactory))
         .factory { container ->
           FirebaseSessions(
             container.get(firebaseApp),
             container.get(firebaseInstallationsApi),
             container.get(backgroundDispatcher),
+            container.get(transportFactory),
           )
         }
         .eagerInDefaultApp()
@@ -59,5 +62,6 @@ internal class FirebaseSessionsRegistrar : ComponentRegistrar {
     private val firebaseInstallationsApi = unqualified(FirebaseInstallationsApi::class.java)
     private val backgroundDispatcher =
       qualified(Background::class.java, CoroutineDispatcher::class.java)
+    private val transportFactory = unqualified(TransportFactory::class.java)
   }
 }

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

@@ -17,11 +17,16 @@
 package com.google.firebase.sessions
 
 import android.util.Log
+import com.google.android.datatransport.TransportFactory
 import com.google.firebase.installations.FirebaseInstallationsApi
 import kotlinx.coroutines.CoroutineDispatcher
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.launch
 import kotlinx.coroutines.tasks.await
+import sun.jvm.hotspot.debugger.win32.coff.DebugVC50X86RegisterEnums.TAG
+
+
+
 
 /**
  * [SessionCoordinator] is responsible for coordinating the systems in this SDK involved with
@@ -31,7 +36,8 @@ import kotlinx.coroutines.tasks.await
  */
 internal class SessionCoordinator(
   private val firebaseInstallations: FirebaseInstallationsApi,
-  backgroundDispatcher: CoroutineDispatcher
+  backgroundDispatcher: CoroutineDispatcher,
+  private val transportFactory: TransportFactory,
 ) {
   private val scope = CoroutineScope(backgroundDispatcher)
 
@@ -47,6 +53,25 @@ internal class SessionCoordinator(
         }
 
       Log.i(TAG, "Initiate session start: $sessionEvent")
+
+      try {
+        transportFactory
+          .getTransport(
+            FirelogAnalytics.FCM_LOG_SOURCE,
+            MessagingClientEventExtension::class.java,
+            Encoding.of("proto"),
+            MessagingClientEventExtension::toByteArray
+          )
+          .send(
+            Event.ofData(
+              MessagingClientEventExtension.newBuilder()
+                .setMessagingClientEvent(clientEvent)
+                .build()
+            )
+          )
+      } catch (e: RuntimeException) {
+        Log.w(TAG, "Failed to log Session Start event: ", e)
+      }
     }
 
   companion object {

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

@@ -19,6 +19,7 @@ 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 com.google.firebase.sessions.testing.FakeTransportFactory
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.test.StandardTestDispatcher
 import kotlinx.coroutines.test.runCurrent
@@ -35,6 +36,7 @@ class SessionCoordinatorTest {
       SessionCoordinator(
         firebaseInstallations = FakeFirebaseInstallations("FaKeFiD"),
         backgroundDispatcher = StandardTestDispatcher(testScheduler),
+        transportFactory = FakeTransportFactory(),
       )
 
     // Construct an event with no fid set.

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

@@ -0,0 +1,43 @@
+/*
+ * 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.datatransport.Encoding
+import com.google.android.datatransport.Transformer
+import com.google.android.datatransport.Transport
+import com.google.android.datatransport.TransportFactory
+
+/** Fake [FakeTransportFactory] that implements [getTransport]. */
+internal class FakeTransportFactory() : TransportFactory {
+  @Deprecated("This is deprecated in the API")
+  override fun <T> getTransport(
+    name: String?,
+    payloadType: java.lang.Class<T>?,
+    payloadTransformer: Transformer<T, ByteArray?>?
+  ): Transport<T>? {
+    return null
+  }
+
+  override fun <T> getTransport(
+    name: String?,
+    payloadType: java.lang.Class<T>?,
+    payloadEncoding: Encoding?,
+    payloadTransformer: Transformer<T, ByteArray?>?
+  ): Transport<T>? {
+    return null
+  }
+}