Remove serialization (this will be handled in encoders) and rename SessionState

Author: mrober

firebase-sessions/firebase-sessions.gradle.kts

@@ -42,16 +42,11 @@ android {
 }
 
 dependencies {
-  implementation(project(":encoders:firebase-encoders"))
-  implementation(project(":encoders:firebase-encoders-json"))
   implementation(project(":firebase-common"))
   implementation(project(":firebase-common:ktx"))
   implementation(project(":firebase-components"))
   implementation(libs.androidx.annotation)
 
-  testImplementation(libs.androidx.test.junit)
-  testImplementation(libs.androidx.test.runner)
-  testImplementation(libs.robolectric)
   testImplementation(libs.junit)
   testImplementation(libs.truth)
 

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

@@ -22,9 +22,9 @@ import androidx.annotation.Discouraged
 import com.google.firebase.FirebaseApp
 import com.google.firebase.ktx.Firebase
 import com.google.firebase.ktx.app
+import com.google.firebase.sessions.EventType.SESSION_START
 
 class FirebaseSessions internal constructor(firebaseApp: FirebaseApp) {
-
   private val sessionGenerator = SessionGenerator(collectEvents = true)
 
   init {
@@ -41,10 +41,19 @@ class FirebaseSessions internal constructor(firebaseApp: FirebaseApp) {
   fun greeting(): String = "Matt says hi!"
 
   private fun initiateSessionStart() {
-    // TODO(mrober): Generate a session
-    Log.i(TAG, "Initiate session start")
+    val sessionState = sessionGenerator.generateNewSession()
+    val sessionEvent =
+      SessionEvent(
+        eventType = SESSION_START,
+        sessionData =
+          SessionInfo(
+            sessionState.sessionId,
+            sessionState.firstSessionId,
+            sessionState.sessionIndex
+          ),
+      )
 
-    sessionGenerator.generateNewSession()
+    Log.i(TAG, "Initiate session start: $sessionEvent")
   }
 
   companion object {

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

@@ -16,18 +16,13 @@
 
 package com.google.firebase.sessions
 
-import com.google.firebase.encoders.ValueEncoder
-import com.google.firebase.encoders.ValueEncoderContext
-import com.google.firebase.encoders.annotations.Encodable
-
 /**
  * Contains the relevant information around an App Quality Session.
  *
  * See go/app-quality-unified-session-definition for more details. Keep in sync with
  * https://github.com/firebase/firebase-ios-sdk/blob/master/FirebaseSessions/ProtoSupport/Protos/sessions.proto
  */
 // TODO(mrober): Add and populate all fields from sessions.proto
-// TODO(mrober): Can the firebase-encoders-processor work on Kotlin data classes?
 internal data class SessionEvent(
   /** The type of event being reported. */
   val eventType: EventType,
@@ -36,8 +31,10 @@ internal data class SessionEvent(
   val sessionData: SessionInfo,
 )
 
-internal enum class EventType(override val number: Int) : NumberedEnum {
+/** Enum denoting all possible session event types. */
+internal enum class EventType(val number: Int) {
   EVENT_TYPE_UNKNOWN(0),
+
   /** This event type is fired as soon as a new session begins. */
   SESSION_START(1),
 }
@@ -56,21 +53,4 @@ 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,
-
-  /** The data collection status. */
-  // TODO(mrober): Refactor to DataCollectionStatus to split out each SDK state, and sampling rate.
-  val dataCollectionStatus: Boolean,
 )
-
-/** Represents an explicitly numbered proto enum for serialization. */
-// TODO(mrober): Could NumberedEnum be part of firebase-encoders?
-internal interface NumberedEnum {
-  val number: Int
-
-  companion object {
-    /** Encode the enum as the number. */
-    val ENCODER = ValueEncoder { numberedEnum: NumberedEnum, ctx: ValueEncoderContext ->
-      ctx.add(numberedEnum.number)
-    }
-  }
-}

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

@@ -18,45 +18,53 @@ package com.google.firebase.sessions
 
 import java.util.UUID
 
+/**
+ * [SessionState] is a data class responsible for storing information about the current Session.
+ *
+ * @hide
+ */
+internal data class SessionState(
+  val sessionId: String,
+  val firstSessionId: String,
+  val collectEvents: Boolean,
+  val sessionIndex: Int,
+)
+
 /**
  * The [SessionGenerator] is responsible for generating the Session ID, and keeping the
- * [SessionInfo] up to date with the latest values.
+ * [SessionState] up to date with the latest values.
  *
  * @hide
  */
-internal class SessionGenerator(collectEvents: Boolean) {
+internal class SessionGenerator(private var collectEvents: Boolean) {
   private var firstSessionId = ""
   private var sessionIndex: Int = -1
-  private var dataCollectionStatus = collectEvents
 
-  private var thisSession: SessionInfo =
-    SessionInfo(
+  private var thisSession: SessionState =
+    SessionState(
       sessionId = "",
       firstSessionId = "",
-      dataCollectionStatus = collectEvents,
-      sessionIndex = sessionIndex
+      collectEvents,
+      sessionIndex,
     )
 
   // Generates a new Session ID. If there was already a generated Session ID
   // from the last session during the app's lifecycle, it will also set the last Session ID
-  fun generateNewSession() {
+  fun generateNewSession(): SessionState {
     val newSessionId = UUID.randomUUID().toString().replace("-", "").lowercase()
 
     // If firstSessionId is set, use it. Otherwise set it to the
     // first generated Session ID
-    firstSessionId = if (firstSessionId.isEmpty()) newSessionId else firstSessionId
+    firstSessionId = firstSessionId.ifEmpty { newSessionId }
 
     sessionIndex += 1
 
     thisSession =
-      SessionInfo(
-        sessionId = newSessionId,
-        firstSessionId = firstSessionId,
-        dataCollectionStatus = dataCollectionStatus,
-        sessionIndex = sessionIndex
-      )
+      SessionState(sessionId = newSessionId, firstSessionId, collectEvents, sessionIndex)
+
+    return thisSession
   }
 
-  val currentSession: SessionInfo
+  val currentSession: SessionState
     get() = thisSession
 }

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

@@ -42,21 +42,21 @@ class SessionGeneratorTest {
 
     assertThat(sessionGenerator.currentSession.sessionId).isEqualTo("")
     assertThat(sessionGenerator.currentSession.firstSessionId).isEqualTo("")
-    assertThat(sessionGenerator.currentSession.dataCollectionStatus).isEqualTo(false)
+    assertThat(sessionGenerator.currentSession.collectEvents).isFalse()
     assertThat(sessionGenerator.currentSession.sessionIndex).isEqualTo(-1)
   }
 
   @Test
-  fun generateNewSessionID_generatesValidSessionInfo() {
+  fun generateNewSessionID_generatesValidSessionState() {
     val sessionGenerator = SessionGenerator(collectEvents = true)
 
     sessionGenerator.generateNewSession()
 
-    assertThat(isValidSessionId(sessionGenerator.currentSession.sessionId)).isEqualTo(true)
-    assertThat(isValidSessionId(sessionGenerator.currentSession.firstSessionId)).isEqualTo(true)
+    assertThat(isValidSessionId(sessionGenerator.currentSession.sessionId)).isTrue()
+    assertThat(isValidSessionId(sessionGenerator.currentSession.firstSessionId)).isTrue()
     assertThat(sessionGenerator.currentSession.firstSessionId)
       .isEqualTo(sessionGenerator.currentSession.sessionId)
-    assertThat(sessionGenerator.currentSession.dataCollectionStatus).isEqualTo(true)
+    assertThat(sessionGenerator.currentSession.collectEvents).isTrue()
     assertThat(sessionGenerator.currentSession.sessionIndex).isEqualTo(0)
   }
 
@@ -68,32 +68,32 @@ class SessionGeneratorTest {
 
     sessionGenerator.generateNewSession()
 
-    val firstSessionInfo = sessionGenerator.currentSession
+    val firstSessionState = sessionGenerator.currentSession
 
-    assertThat(isValidSessionId(firstSessionInfo.sessionId)).isEqualTo(true)
-    assertThat(isValidSessionId(firstSessionInfo.firstSessionId)).isEqualTo(true)
-    assertThat(firstSessionInfo.firstSessionId).isEqualTo(firstSessionInfo.sessionId)
-    assertThat(firstSessionInfo.sessionIndex).isEqualTo(0)
+    assertThat(isValidSessionId(firstSessionState.sessionId)).isTrue()
+    assertThat(isValidSessionId(firstSessionState.firstSessionId)).isTrue()
+    assertThat(firstSessionState.firstSessionId).isEqualTo(firstSessionState.sessionId)
+    assertThat(firstSessionState.sessionIndex).isEqualTo(0)
 
     sessionGenerator.generateNewSession()
-    val secondSessionInfo = sessionGenerator.currentSession
+    val secondSessionState = sessionGenerator.currentSession
 
-    assertThat(isValidSessionId(secondSessionInfo.sessionId)).isEqualTo(true)
-    assertThat(isValidSessionId(secondSessionInfo.firstSessionId)).isEqualTo(true)
+    assertThat(isValidSessionId(secondSessionState.sessionId)).isTrue()
+    assertThat(isValidSessionId(secondSessionState.firstSessionId)).isTrue()
     // Ensure the new firstSessionId is equal to the first Session ID from earlier
-    assertThat(secondSessionInfo.firstSessionId).isEqualTo(firstSessionInfo.sessionId)
+    assertThat(secondSessionState.firstSessionId).isEqualTo(firstSessionState.sessionId)
     // Session Index should increase
-    assertThat(secondSessionInfo.sessionIndex).isEqualTo(1)
+    assertThat(secondSessionState.sessionIndex).isEqualTo(1)
 
     // Do a third round just in case
     sessionGenerator.generateNewSession()
-    val thirdSessionInfo = sessionGenerator.currentSession
+    val thirdSessionState = sessionGenerator.currentSession
 
-    assertThat(isValidSessionId(thirdSessionInfo.sessionId)).isEqualTo(true)
-    assertThat(isValidSessionId(thirdSessionInfo.firstSessionId)).isEqualTo(true)
+    assertThat(isValidSessionId(thirdSessionState.sessionId)).isTrue()
+    assertThat(isValidSessionId(thirdSessionState.firstSessionId)).isTrue()
     // Ensure the new firstSessionId is equal to the first Session ID from earlier
-    assertThat(thirdSessionInfo.firstSessionId).isEqualTo(firstSessionInfo.sessionId)
+    assertThat(thirdSessionState.firstSessionId).isEqualTo(firstSessionState.sessionId)
     // Session Index should increase
-    assertThat(thirdSessionInfo.sessionIndex).isEqualTo(2)
+    assertThat(thirdSessionState.sessionIndex).isEqualTo(2)
   }
 }