Fix encoding for Session Events (#4870)

samedson · web-flow · commit 229d597c3aaf · 2023-04-11T10:12:35.000-04:00
diff --git a/firebase-sessions/src/main/kotlin/com/google/firebase/sessions/EventGDTLogger.kt b/firebase-sessions/src/main/kotlin/com/google/firebase/sessions/EventGDTLogger.kt
@@ -16,6 +16,7 @@
 
 package com.google.firebase.sessions
 
+import android.util.Log
 import com.google.android.datatransport.*
 import com.google.android.datatransport.TransportFactory
 import com.google.firebase.inject.Provider
@@ -53,11 +54,14 @@ internal class EventGDTLogger(private val transportFactoryProvider: Provider<Tra
   }
 
   private fun encode(value: SessionEvent): ByteArray {
-    return SessionEvents.SESSION_EVENT_ENCODER.encode(value).toByteArray()
+    val jsonEvent = SessionEvents.SESSION_EVENT_ENCODER.encode(value)
+    Log.d(TAG, "Encoded Session Start event $jsonEvent")
+    return jsonEvent.toByteArray()
   }
 
   companion object {
-    // TODO What do we put for the AQS Log Source
+    private const val TAG = "EventGDTLogger"
+
     private const val AQS_LOG_SOURCE = "FIREBASE_APPQUALITY_SESSION"
   }
 }
diff --git a/firebase-sessions/src/main/kotlin/com/google/firebase/sessions/SessionCoordinator.kt b/firebase-sessions/src/main/kotlin/com/google/firebase/sessions/SessionCoordinator.kt
@@ -50,7 +50,7 @@ internal class SessionCoordinator(
       try {
         eventGDTLogger.log(sessionEvent)
 
-        Log.i(TAG, "Logged Session Start event: $sessionEvent")
+        Log.i(TAG, "Logged Session Start event: ${sessionEvent.sessionData.sessionId}")
       } catch (e: RuntimeException) {
         Log.w(TAG, "Failed to log Session Start event: ", e)
       }
diff --git a/firebase-sessions/src/main/kotlin/com/google/firebase/sessions/SessionEvent.kt b/firebase-sessions/src/main/kotlin/com/google/firebase/sessions/SessionEvent.kt
@@ -59,6 +59,41 @@ 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,
 
+  /** Tracks when the event was initiated */
+  var eventTimestampUs: Long,
+
+  /** Data collection status of the dependent product SDKs. */
+  var dataCollectionStatus: DataCollectionStatus = DataCollectionStatus(),
+
   /** Identifies a unique device+app installation: go/firebase-installations */
   var firebaseInstallationId: String = "",
 )
+
+/** Contains the data collection state for all dependent SDKs and sampling info */
+internal data class DataCollectionStatus(
+  val performance: DataCollectionState = DataCollectionState.COLLECTION_ENABLED,
+  val crashlytics: DataCollectionState = DataCollectionState.COLLECTION_ENABLED,
+  val sessionSamplingRate: Double = 1.0,
+)
+
+/** Enum denoting different data collection states. */
+internal enum class DataCollectionState(override val number: Int) : NumberedEnum {
+  COLLECTION_UNKNOWN(0),
+
+  // This product SDK is not present in this version of the app.
+  COLLECTION_SDK_NOT_INSTALLED(1),
+
+  // The product SDK is present and collecting all product-level events.
+  COLLECTION_ENABLED(2),
+
+  // The product SDK is present but data collection for it has been locally
+  // disabled.
+  COLLECTION_DISABLED(3),
+
+  // The product SDK is present but data collection has been remotely disabled.
+  COLLECTION_DISABLED_REMOTE(4),
+
+  // Indicates that the product SDK is present, but session data is being
+  // collected, but the product-level events are not being uploaded.
+  COLLECTION_SAMPLED(5),
+}
diff --git a/firebase-sessions/src/main/kotlin/com/google/firebase/sessions/SessionEvents.kt b/firebase-sessions/src/main/kotlin/com/google/firebase/sessions/SessionEvents.kt
@@ -39,6 +39,7 @@ internal object SessionEvents {
           run {
             ctx.add(FieldDescriptor.of("event_type"), sessionEvent.eventType)
             ctx.add(FieldDescriptor.of("session_data"), sessionEvent.sessionData)
+            ctx.add(FieldDescriptor.of("application_info"), sessionEvent.applicationInfo)
           }
         }
 
@@ -53,6 +54,42 @@ internal object SessionEvents {
               FieldDescriptor.of("firebase_installation_id"),
               sessionInfo.firebaseInstallationId
             )
+            ctx.add(FieldDescriptor.of("event_timestamp_us"), sessionInfo.eventTimestampUs)
+            ctx.add(FieldDescriptor.of("data_collection_status"), sessionInfo.dataCollectionStatus)
+          }
+        }
+
+        it.registerEncoder(DataCollectionStatus::class.java) {
+          dataCollectionStatus: DataCollectionStatus,
+          ctx: ObjectEncoderContext ->
+          run {
+            ctx.add(FieldDescriptor.of("performance"), dataCollectionStatus.performance)
+            ctx.add(FieldDescriptor.of("crashlytics"), dataCollectionStatus.crashlytics)
+            ctx.add(
+              FieldDescriptor.of("session_sampling_rate"),
+              dataCollectionStatus.sessionSamplingRate
+            )
+          }
+        }
+
+        it.registerEncoder(ApplicationInfo::class.java) {
+          applicationInfo: ApplicationInfo,
+          ctx: ObjectEncoderContext ->
+          run {
+            ctx.add(FieldDescriptor.of("app_id"), applicationInfo.appId)
+            ctx.add(FieldDescriptor.of("device_model"), applicationInfo.deviceModel)
+            ctx.add(FieldDescriptor.of("session_sdk_version"), applicationInfo.sessionSdkVersion)
+            ctx.add(FieldDescriptor.of("log_environment"), applicationInfo.logEnvironment)
+            ctx.add(FieldDescriptor.of("android_app_info"), applicationInfo.androidAppInfo)
+          }
+        }
+
+        it.registerEncoder(AndroidApplicationInfo::class.java) {
+          androidAppInfo: AndroidApplicationInfo,
+          ctx: ObjectEncoderContext ->
+          run {
+            ctx.add(FieldDescriptor.of("package_name"), androidAppInfo.packageName)
+            ctx.add(FieldDescriptor.of("version_name"), androidAppInfo.versionName)
           }
         }
       }
@@ -63,14 +100,19 @@ internal object SessionEvents {
    *
    * Some mutable fields, e.g. firebaseInstallationId, get populated later.
    */
-  fun startSession(firebaseApp: FirebaseApp, sessionDetails: SessionDetails) =
+  fun startSession(
+    firebaseApp: FirebaseApp,
+    sessionDetails: SessionDetails,
+    currentTimeUs: Long = System.currentTimeMillis() * 1000
+  ) =
     SessionEvent(
       eventType = EventType.SESSION_START,
       sessionData =
         SessionInfo(
           sessionDetails.sessionId,
           sessionDetails.firstSessionId,
           sessionDetails.sessionIndex,
+          currentTimeUs,
         ),
       applicationInfo = getApplicationInfo(firebaseApp)
     )
diff --git a/firebase-sessions/src/test/kotlin/com/google/firebase/sessions/EventGDTLoggerTest.kt b/firebase-sessions/src/test/kotlin/com/google/firebase/sessions/EventGDTLoggerTest.kt
@@ -38,7 +38,8 @@ class EventGDTLoggerTest {
     val sessionEvent =
       SessionEvents.startSession(
         FakeFirebaseApp.fakeFirebaseApp(),
-        TestSessionEventData.TEST_SESSION_DETAILS
+        TestSessionEventData.TEST_SESSION_DETAILS,
+        TestSessionEventData.TEST_SESSION_TIMESTAMP_US,
       )
     val fakeTransportFactory = FakeTransportFactory()
     val fakeTransportFactoryProvider = FakeProvider(fakeTransportFactory as TransportFactory)
diff --git a/firebase-sessions/src/test/kotlin/com/google/firebase/sessions/SessionCoordinatorTest.kt b/firebase-sessions/src/test/kotlin/com/google/firebase/sessions/SessionCoordinatorTest.kt
@@ -19,7 +19,9 @@ 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.FakeEventGDTLogger
+import com.google.firebase.sessions.testing.FakeFirebaseApp
 import com.google.firebase.sessions.testing.FakeFirebaseInstallations
+import com.google.firebase.sessions.testing.TestSessionEventData
 import kotlinx.coroutines.ExperimentalCoroutinesApi
 import kotlinx.coroutines.test.StandardTestDispatcher
 import kotlinx.coroutines.test.runCurrent
@@ -42,22 +44,10 @@ class SessionCoordinatorTest {
 
     // Construct an event with no fid set.
     val sessionEvent =
-      SessionEvent(
-        eventType = EventType.SESSION_START,
-        sessionData =
-          SessionInfo(
-            sessionId = "id",
-            firstSessionId = "first",
-            sessionIndex = 3,
-          ),
-        applicationInfo =
-          ApplicationInfo(
-            appId = "",
-            deviceModel = "",
-            sessionSdkVersion = "",
-            logEnvironment = LogEnvironment.LOG_ENVIRONMENT_PROD,
-            androidAppInfo = AndroidApplicationInfo(packageName = "", versionName = "")
-          )
+      SessionEvents.startSession(
+        FakeFirebaseApp.fakeFirebaseApp(),
+        TestSessionEventData.TEST_SESSION_DETAILS,
+        TestSessionEventData.TEST_SESSION_TIMESTAMP_US,
       )
 
     sessionCoordinator.attemptLoggingSessionEvent(sessionEvent)
diff --git a/firebase-sessions/src/test/kotlin/com/google/firebase/sessions/SessionEventEncoderTest.kt b/firebase-sessions/src/test/kotlin/com/google/firebase/sessions/SessionEventEncoderTest.kt
@@ -18,48 +18,61 @@ 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.sessions.SessionEvents.SESSION_EVENT_ENCODER
+import com.google.firebase.sessions.testing.FakeFirebaseApp
+import com.google.firebase.sessions.testing.TestSessionEventData
+import org.junit.After
 import org.junit.Test
 import org.junit.runner.RunWith
 
 @RunWith(AndroidJUnit4::class)
 class SessionEventEncoderTest {
+
+  @After
+  fun cleanUp() {
+    FirebaseApp.clearInstancesForTest()
+  }
+
   @Test
   fun sessionEvent_encodesToJson() {
     val sessionEvent =
-      SessionEvent(
-        eventType = EventType.SESSION_START,
-        sessionData =
-          SessionInfo(
-            sessionId = "id",
-            firstSessionId = "first",
-            sessionIndex = 9,
-            firebaseInstallationId = "fid"
-          ),
-        applicationInfo =
-          ApplicationInfo(
-            appId = "",
-            deviceModel = "",
-            sessionSdkVersion = "",
-            logEnvironment = LogEnvironment.LOG_ENVIRONMENT_PROD,
-            AndroidApplicationInfo(packageName = "", versionName = ""),
-          )
+      SessionEvents.startSession(
+        FakeFirebaseApp.fakeFirebaseApp(),
+        TestSessionEventData.TEST_SESSION_DETAILS,
+        TestSessionEventData.TEST_SESSION_TIMESTAMP_US,
       )
 
     val json = SESSION_EVENT_ENCODER.encode(sessionEvent)
 
     assertThat(json)
       .isEqualTo(
         """
-        {
-          "event_type":1,
-          "session_data":{
-            "session_id":"id",
-            "first_session_id":"first",
-            "session_index":9,
-            "firebase_installation_id":"fid"
+          {
+            "event_type":1,
+            "session_data":{
+              "session_id":"a1b2c3",
+              "first_session_id":"a1a1a1",
+              "session_index":3,
+              "firebase_installation_id":"",
+              "event_timestamp_us":12340000,
+              "data_collection_status":{
+                "performance":2,
+                "crashlytics":2,
+                "session_sampling_rate":1.0
+              }
+            },
+            "application_info":{
+              "app_id":"1:12345:android:app",
+              "device_model":"",
+              "session_sdk_version":"0.1.0",
+              "log_environment":3,
+              "android_app_info":{
+                "package_name":"com.google.firebase.sessions.test",
+                "version_name":"1.0.0"
+              }
+            }
           }
-        }
         """
           .lines()
           .joinToString("") { it.trim() }
@@ -76,6 +89,7 @@ class SessionEventEncoderTest {
             sessionId = "",
             firstSessionId = "",
             sessionIndex = 0,
+            eventTimestampUs = 0,
           ),
         applicationInfo =
           ApplicationInfo(
@@ -92,15 +106,31 @@ class SessionEventEncoderTest {
     assertThat(json)
       .isEqualTo(
         """
-        {
-          "event_type":0,
-          "session_data":{
-            "session_id":"",
-            "first_session_id":"",
-            "session_index":0,
-            "firebase_installation_id":""
+          {
+            "event_type":0,
+            "session_data":{
+              "session_id":"",
+              "first_session_id":"",
+              "session_index":0,
+              "firebase_installation_id":"",
+              "event_timestamp_us":0,
+              "data_collection_status":{
+                "performance":2,
+                "crashlytics":2,
+                "session_sampling_rate":1.0
+              }
+            },
+            "application_info":{
+              "app_id":"",
+              "device_model":"",
+              "session_sdk_version":"",
+              "log_environment":3,
+              "android_app_info":{
+                "package_name":"",
+                "version_name":""
+              }
+            }
           }
-        }
         """
           .lines()
           .joinToString("") { it.trim() }
diff --git a/firebase-sessions/src/test/kotlin/com/google/firebase/sessions/SessionEventTest.kt b/firebase-sessions/src/test/kotlin/com/google/firebase/sessions/SessionEventTest.kt
@@ -32,7 +32,8 @@ class SessionEventTest {
     val sessionEvent =
       SessionEvents.startSession(
         FakeFirebaseApp.fakeFirebaseApp(),
-        TestSessionEventData.TEST_SESSION_DETAILS
+        TestSessionEventData.TEST_SESSION_DETAILS,
+        TestSessionEventData.TEST_SESSION_TIMESTAMP_US,
       )
 
     assertThat(sessionEvent).isEqualTo(TestSessionEventData.EXPECTED_DEFAULT_SESSION_EVENT)
diff --git a/firebase-sessions/src/test/kotlin/com/google/firebase/sessions/testing/TestSessionEventData.kt b/firebase-sessions/src/test/kotlin/com/google/firebase/sessions/testing/TestSessionEventData.kt
@@ -29,6 +29,8 @@ internal object TestSessionEventData {
       sessionIndex = 3,
     )
 
+  const val TEST_SESSION_TIMESTAMP_US: Long = 12340000
+
   val EXPECTED_DEFAULT_SESSION_EVENT =
     SessionEvent(
       eventType = EventType.SESSION_START,
@@ -37,6 +39,8 @@ internal object TestSessionEventData {
           sessionId = "a1b2c3",
           firstSessionId = "a1a1a1",
           sessionIndex = 3,
+          firebaseInstallationId = "",
+          eventTimestampUs = TestSessionEventData.TEST_SESSION_TIMESTAMP_US,
         ),
       applicationInfo =
         ApplicationInfo(

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`
`17`	`17`	`package com.google.firebase.sessions`
`18`	`18`
	`19`	`+import android.util.Log`
`19`	`20`	`import com.google.android.datatransport.*`
`20`	`21`	`import com.google.android.datatransport.TransportFactory`
`21`	`22`	`import com.google.firebase.inject.Provider`
`@@ -53,11 +54,14 @@ internal class EventGDTLogger(private val transportFactoryProvider: Provider<Tra`
`53`	`54`	`}`
`54`	`55`
`55`	`56`	`private fun encode(value: SessionEvent): ByteArray {`
`56`		`- return SessionEvents.SESSION_EVENT_ENCODER.encode(value).toByteArray()`
	`57`	`+ val jsonEvent = SessionEvents.SESSION_EVENT_ENCODER.encode(value)`
	`58`	`+ Log.d(TAG, "Encoded Session Start event $jsonEvent")`
	`59`	`+ return jsonEvent.toByteArray()`
`57`	`60`	`}`
`58`	`61`
`59`	`62`	`companion object {`
`60`		`- // TODO What do we put for the AQS Log Source`
	`63`	`+ private const val TAG = "EventGDTLogger"`
	`64`	`+`
`61`	`65`	`private const val AQS_LOG_SOURCE = "FIREBASE_APPQUALITY_SESSION"`
`62`	`66`	`}`
`63`	`67`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ internal class SessionCoordinator(`
`50`	`50`	`try {`
`51`	`51`	`eventGDTLogger.log(sessionEvent)`
`52`	`52`
`53`		`- Log.i(TAG, "Logged Session Start event: $sessionEvent")`
	`53`	`+ Log.i(TAG, "Logged Session Start event: ${sessionEvent.sessionData.sessionId}")`
`54`	`54`	`} catch (e: RuntimeException) {`
`55`	`55`	`Log.w(TAG, "Failed to log Session Start event: ", e)`
`56`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,8 @@ class SessionEventTest {`
`32`	`32`	`val sessionEvent =`
`33`	`33`	`SessionEvents.startSession(`
`34`	`34`	`FakeFirebaseApp.fakeFirebaseApp(),`
`35`		`- TestSessionEventData.TEST_SESSION_DETAILS`
	`35`	`+ TestSessionEventData.TEST_SESSION_DETAILS,`
	`36`	`+ TestSessionEventData.TEST_SESSION_TIMESTAMP_US,`
`36`	`37`	`)`
`37`	`38`
`38`	`39`	`assertThat(sessionEvent).isEqualTo(TestSessionEventData.EXPECTED_DEFAULT_SESSION_EVENT)`