Merge pull request #81 from embrace-io/extract-session-number

Extract session ordinal logic to preference service

embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/prefs/EmbracePreferencesService.kt

@@ -226,9 +226,11 @@ internal class EmbracePreferencesService(
  get() = prefs.getBooleanPreference(LAST_USER_MESSAGE_FAILED_KEY, false)
  set(value) = prefs.setBooleanPreference(LAST_USER_MESSAGE_FAILED_KEY, value)
 
- override var sessionNumber: Int
- get() = prefs.getIntegerPreference(LAST_SESSION_NUMBER_KEY) ?: 0
- set(value) = prefs.setIntegerPreference(LAST_SESSION_NUMBER_KEY, value)
+ override fun getIncrementAndGetSessionNumber(): Int {
+ val sessionNumber = (prefs.getIntegerPreference(LAST_SESSION_NUMBER_KEY) ?: 0) + 1
+ prefs.setIntegerPreference(LAST_SESSION_NUMBER_KEY, sessionNumber)
+ return sessionNumber
+ }
 
  override var javaScriptBundleURL: String?
  get() = prefs.getStringPreference(JAVA_SCRIPT_BUNDLE_URL_KEY)

embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/prefs/PreferencesService.kt

@@ -84,9 +84,11 @@ internal interface PreferencesService {
  var userMessageNeedsRetry: Boolean
 
  /**
- * Last session number. Increments by one.
+ * Increments and returns the session number ordinal. This is an integer that increments
+ * at the start of every session. This allows us to check the % of sessions that didn't get
+ * delivered to the backend.
  */
- var sessionNumber: Int
+ fun getIncrementAndGetSessionNumber(): Int
 
  /**
  * Last javaScript bundle string url.

embrace-android-sdk/src/main/java/io/embrace/android/embracesdk/session/SessionHandler.kt

@@ -71,7 +71,7 @@ internal class SessionHandler(
  coldStart,
  startType,
  startTime,
- incrementAndGetSessionNumber(),
+ preferencesService.getIncrementAndGetSessionNumber(),
  userService.loadUserInfoFromDisk(),
  sessionProperties.get()
  )
@@ -354,15 +354,6 @@ internal class SessionHandler(
  return fullEndSessionMessage
  }
 
- /**
- * @return session number incremented by 1
- */
- private fun incrementAndGetSessionNumber(): Int {
- val sessionNumber = preferencesService.sessionNumber + 1
- preferencesService.sessionNumber = sessionNumber
- return sessionNumber
- }
-
  /**
  * It starts a background job that will schedule a callback to automatically end the session.
  */

embrace-android-sdk/src/test/java/io/embrace/android/embracesdk/fakes/FakePreferenceService.kt

@@ -19,7 +19,6 @@ internal class FakePreferenceService(
  @Deprecated("") override var customPersonas: Set<String>? = null,
  override var lastConfigFetchDate: Long? = null,
  override var userMessageNeedsRetry: Boolean = false,
- override var sessionNumber: Int = 0,
  override var reactNativeVersionNumber: String? = null,
  override var unityVersionNumber: String? = null,
  override var unityBuildIdNumber: String? = null,
@@ -34,7 +33,8 @@ internal class FakePreferenceService(
  override var jailbroken: Boolean? = null,
  override var applicationExitInfoHistory: Set<String>? = null,
  override var cpuName: String? = null,
- override var egl: String? = null
+ override var egl: String? = null,
+ val sessionNumber: () -> Int = { 0 }
 ) : PreferencesService {
 
  var networkCaptureRuleOver = false
@@ -47,5 +47,7 @@ internal class FakePreferenceService(
  override fun decreaseNetworkCaptureRuleRemainingCount(id: String, maxCount: Int) {
  }
 
+ override fun getIncrementAndGetSessionNumber(): Int = sessionNumber()
+
  override fun isUsersFirstDay(): Boolean = firstDay
 }

embrace-android-sdk/src/test/java/io/embrace/android/embracesdk/prefs/EmbracePreferencesServiceTest.kt

@@ -188,13 +188,10 @@ internal class EmbracePreferencesServiceTest {
 
  @Test
  fun `test session number is saved`() {
- assertEquals(0, service.sessionNumber)
-
- service.sessionNumber = 1234
- assertEquals(1234, service.sessionNumber)
-
- service.sessionNumber = -1
- assertEquals(0, service.sessionNumber)
+ assertEquals(1, service.getIncrementAndGetSessionNumber())
+ assertEquals(2, service.getIncrementAndGetSessionNumber())
+ assertEquals(3, service.getIncrementAndGetSessionNumber())
+ assertEquals(4, service.getIncrementAndGetSessionNumber())
  }
 
  @Test

embrace-android-sdk/src/test/java/io/embrace/android/embracesdk/session/SessionHandlerTest.kt

@@ -20,7 +20,6 @@ import io.embrace.android.embracesdk.fakes.FakeAndroidMetadataService
 import io.embrace.android.embracesdk.fakes.FakeClock
 import io.embrace.android.embracesdk.fakes.FakeConfigService
 import io.embrace.android.embracesdk.fakes.FakeGatingService
-import io.embrace.android.embracesdk.fakes.FakePreferenceService
 import io.embrace.android.embracesdk.fakes.FakeUserService
 import io.embrace.android.embracesdk.fakes.fakeAutoDataCaptureBehavior
 import io.embrace.android.embracesdk.fakes.fakeDataCaptureEventBehavior
@@ -36,6 +35,7 @@ import io.embrace.android.embracesdk.ndk.NdkService
 import io.embrace.android.embracesdk.payload.Session
 import io.embrace.android.embracesdk.payload.SessionMessage
 import io.embrace.android.embracesdk.payload.UserInfo
+import io.embrace.android.embracesdk.prefs.PreferencesService
 import io.embrace.android.embracesdk.session.EmbraceSessionService.Companion.SESSION_CACHING_INTERVAL
 import io.embrace.android.embracesdk.session.properties.EmbraceSessionProperties
 import io.mockk.Called
@@ -66,7 +66,7 @@ internal class SessionHandlerTest {
 
  companion object {
  private val logger: InternalEmbraceLogger = InternalEmbraceLogger()
- private val preferencesService: FakePreferenceService = FakePreferenceService()
+ private val preferencesService: PreferencesService = mockk(relaxed = true)
  private val mockUserService: FakeUserService = FakeUserService()
  private val mockNetworkConnectivityService: NetworkConnectivityService =
  mockk(relaxUnitFun = true)
@@ -86,7 +86,7 @@ internal class SessionHandlerTest {
  private val mockSessionPeriodicCacheExecutorService: ScheduledExecutorService = mockk(relaxed = true)
  private const val sessionUuid = "99fcae22-0db5-4b63-b49d-315eecce4889"
  private const val now = 123L
- private const val sessionNumber = 5
+ private var sessionNumber = 5
  private val mockSessionProperties: EmbraceSessionProperties = mockk(relaxed = true)
  private val emptyMapSessionProperties: Map<String, String> = emptyMap()
  private val mockUserInfo: UserInfo = mockk()
@@ -123,7 +123,6 @@ internal class SessionHandlerTest {
  @Before
  fun before() {
  mockActiveSession = mockk(relaxed = true)
- preferencesService.sessionNumber = sessionNumber
  every { mockSessionProperties.get() } returns emptyMapSessionProperties
 
  metadataService = FakeAndroidMetadataService()
@@ -238,7 +237,6 @@ internal class SessionHandlerTest {
  with(checkNotNull(sessionMessage?.session)) {
  assertEquals(sessionUuid, this.sessionId)
  assertEquals(startTime, now)
- assertEquals(sessionNumber + 1, number)
  assertTrue(isColdStart)
  assertEquals(sessionStartType, startType)
  assertEquals(emptyMapSessionProperties, properties)
@@ -251,6 +249,7 @@ internal class SessionHandlerTest {
  assertEquals(metadataService.getDeviceInfo(), deviceInfo)
  assertEquals(metadataService.getAppInfo(), appInfo)
  }
+ verify(exactly = 1) { preferencesService.getIncrementAndGetSessionNumber() }
  }
 
  @Test
@@ -280,7 +279,7 @@ internal class SessionHandlerTest {
  @Test
  fun `onSession started successfully with no preference service session number`() {
  // return absent session number
- preferencesService.sessionNumber = 0
+ sessionNumber = 0
  sessionLocalConfig = SessionLocalConfig(maxSessionSeconds = 5, asyncEnd = false)
  every { mockBreadcrumbService.getLastViewBreadcrumbScreenName() } returns "screen"
  val sessionStartType = Session.SessionLifeEventType.STATE
@@ -295,7 +294,7 @@ internal class SessionHandlerTest {
  mockPeriodicCachingRunnable
  )
 
- assertEquals(1, preferencesService.sessionNumber)
+ verify(exactly = 1) { preferencesService.getIncrementAndGetSessionNumber() }
  assertNotNull(sessionMessage)
  assertNotNull(sessionMessage!!.session)
  // no need to verify anything else because it's already verified in another test case