Technical Analytics: Milestone 2 - Add Ability To Log Feature Flags

domain/src/main/java/org/oppia/android/domain/oppialogger/analytics/ApplicationLifecycleObserver.kt

@@ -176,6 +176,7 @@ class ApplicationLifecycleObserver @Inject constructor(
 
   private fun logAllFeatureFlags() {
     CoroutineScope(backgroundDispatcher).launch {
+      // TODO(#5240): Replace appSessionId generation to the modified Twitter snowflake algorithm.
       val appSessionId = loggingIdentifierController.getAppSessionIdFlow().value
       featureFlagsLogger.logAllFeatureFlags(appSessionId)
     }.invokeOnCompletion { failure ->
@@ -189,6 +190,30 @@ class ApplicationLifecycleObserver @Inject constructor(
     }
   }
 
+  private fun logAppInForegroundTime() {
+    CoroutineScope(backgroundDispatcher).launch {
+      val sessionId = loggingIdentifierController.getSessionIdFlow().value
+      val installationId = loggingIdentifierController.fetchInstallationId()
+      val timeInForeground = oppiaClock.getCurrentTimeMs() - appStartTimeMillis
+      analyticsController.logLowPriorityEvent(
+        oppiaLogger.createAppInForegroundTimeContext(
+          installationId = installationId,
+          appSessionId = sessionId,
+          foregroundTime = timeInForeground
+        ),
+        profileId = null
+      )
+    }.invokeOnCompletion { failure ->
+      if (failure != null) {
+        oppiaLogger.e(
+          "ApplicationLifecycleObserver",
+          "Encountered error while trying to log app's time in the foreground.",
+          failure
+        )
+      }
+    }
+  }
+
   private fun getStartupLatencyMillis(initialTimestampMillis: Long): Long =
     oppiaClock.getCurrentTimeMs() - initialTimestampMillis
 

domain/src/test/java/org/oppia/android/domain/oppialogger/LoggingIdentifierControllerTest.kt

@@ -251,6 +251,44 @@ class LoggingIdentifierControllerTest {
     assertThat(sessionIdFlow.value).isEqualTo("59aea8d4-af4b-3249-b889-dfeba06d0495")
   }
 
+  @Test
+  fun testGetAppSessionId_initialState_returnsRandomId() {
+    val appSessionIdProvider = loggingIdentifierController.getAppSessionId()
+
+    val appSessionId = monitorFactory.waitForNextSuccessfulResult(appSessionIdProvider)
+    assertThat(appSessionId).isEqualTo("2a11efe0-70f8-3a40-8d94-4fc3a2bd4f14")
+  }
+
+  @Test
+  fun testGetAppSessionId_secondCall_returnsSameRandomId() {
+    monitorFactory.ensureDataProviderExecutes(loggingIdentifierController.getAppSessionId())
+
+    val sessionIdProvider = loggingIdentifierController.getAppSessionId()
+
+    // The second call should return the same ID (since the ID doesn't automatically change).
+    val appSessionId = monitorFactory.waitForNextSuccessfulResult(sessionIdProvider)
+    assertThat(appSessionId).isEqualTo("2a11efe0-70f8-3a40-8d94-4fc3a2bd4f14")
+  }
+
+  @Test
+  fun testGetAppSessionIdFlow_initialState_returnsFlowWithRandomId() {
+    val appSessionIdFlow = loggingIdentifierController.getAppSessionIdFlow()
+
+    val appSessionId = appSessionIdFlow.waitForLatestValue()
+    assertThat(appSessionId).isEqualTo("2a11efe0-70f8-3a40-8d94-4fc3a2bd4f14")
+  }
+
+  @Test
+  fun testGetAppSessionIdFlow_secondCall_returnsFlowWithSameRandomId() {
+    loggingIdentifierController.getSessionIdFlow().waitForLatestValue()
+
+    val appSessionIdFlow = loggingIdentifierController.getAppSessionIdFlow()
+
+    // The second call should return the same ID (since the ID doesn't automatically change).
+    val appSessionId = appSessionIdFlow.waitForLatestValue()
+    assertThat(appSessionId).isEqualTo("2a11efe0-70f8-3a40-8d94-4fc3a2bd4f14")
+  }
+
   private fun <T : MessageLite> writeFileCache(cacheName: String, value: T) {
     getCacheFile(cacheName).writeBytes(value.toByteArray())
   }

domain/src/test/java/org/oppia/android/domain/oppialogger/analytics/ApplicationLifecycleObserverTest.kt

@@ -115,6 +115,12 @@ class ApplicationLifecycleObserverTest {
   @Inject
   lateinit var fakePerformanceMetricsEventLogger: FakePerformanceMetricsEventLogger
 
+  @Inject
+  lateinit var fakeConsoleLogger: ConsoleLogger
+
+  @Inject
+  lateinit var networkLoggingInterceptor: NetworkLoggingInterceptor
+
   @Inject
   lateinit var featureFlagsLogger: FeatureFlagsLogger
 
@@ -420,6 +426,7 @@ class ApplicationLifecycleObserverTest {
       mapOf(TEST_FEATURE_FLAG to testFeatureFlag)
     )
 
+    // TODO(#5240): Replace appSessionId generation to the modified Twitter snowflake algorithm.
     val sessionIdProvider = loggingIdentifierController.getAppSessionId()
     val sessionId = monitorFactory.waitForNextSuccessfulResult(sessionIdProvider)
 
@@ -439,6 +446,111 @@ class ApplicationLifecycleObserverTest {
     }
   }
 
+  @Test
+  fun testObserver_onAppInForeground_thenInBackground_logsAppInForegroundTime() {
+    setUpTestApplicationComponent()
+    fakeOppiaClock.setFakeTimeMode(FakeOppiaClock.FakeTimeMode.MODE_UPTIME_MILLIS)
+
+    applicationLifecycleObserver.onCreate()
+    applicationLifecycleObserver.onAppInForeground()
+    testCoroutineDispatchers.runCurrent()
+
+    val sessionIdProvider = loggingIdentifierController.getSessionId()
+    val sessionId = monitorFactory.waitForNextSuccessfulResult(sessionIdProvider)
+    val installationIdProvider = loggingIdentifierController.getInstallationId()
+    val installationId = monitorFactory.waitForNextSuccessfulResult(installationIdProvider)
+
+    testCoroutineDispatchers.advanceTimeBy(TEST_TIMESTAMP_APP_IN_FOREGROUND_MILLIS)
+    applicationLifecycleObserver.onAppInBackground()
+    testCoroutineDispatchers.runCurrent()
+
+    val eventLog = getOneOfLastTwoEventsLogged(APP_IN_FOREGROUND_TIME)
+    val eventLogContext = eventLog.context
+
+    assertThat(eventLogContext.activityContextCase)
+      .isEqualTo(APP_IN_FOREGROUND_TIME)
+    assertThat(eventLogContext.appInForegroundTime.foregroundTime.toLong())
+      .isEqualTo(TEST_TIMESTAMP_APP_IN_FOREGROUND_MILLIS)
+    assertThat(eventLogContext.appInForegroundTime.appSessionId).isEqualTo(sessionId)
+    assertThat(eventLogContext.appInForegroundTime.installationId).isEqualTo(installationId)
+  }
+
+  @Test
+  fun testObserver_onAppInForeground_onConsoleError_logsConsoleErrors() {
+    setUpTestApplicationComponent()
+
+    applicationLifecycleObserver.onCreate()
+    applicationLifecycleObserver.onAppInForeground()
+    testCoroutineDispatchers.runCurrent()
+
+    val testTag = "TestObserver"
+    val testMessage = "Test error message"
+
+    fakeConsoleLogger.e(testTag, testMessage)
+    testCoroutineDispatchers.runCurrent()
+
+    val eventLog = fakeAnalyticsEventLogger.getMostRecentEvent()
+    val eventLogContext = eventLog.context
+
+    assertThat(eventLogContext.activityContextCase).isEqualTo(ActivityContextCase.CONSOLE_LOG)
+    assertThat(eventLogContext.consoleLog.fullErrorLog).isEqualTo(testMessage)
+    assertThat(eventLogContext.consoleLog.logLevel).isEqualTo(LogLevel.ERROR.toString())
+    assertThat(eventLogContext.consoleLog.logTag).isEqualTo(testTag)
+  }
+
+  @Test
+  fun testObserver_onAppInForeground_onNetworkCall_logsNetworkCalls() {
+    setUpTestApplicationComponent()
+    setUpRetrofitApiCall()
+
+    applicationLifecycleObserver.onCreate()
+    applicationLifecycleObserver.onAppInForeground()
+    testCoroutineDispatchers.runCurrent()
+
+    mockWebServer.enqueue(MockResponse().setBody(testResponseBody))
+    client.newCall(request).execute()
+    testCoroutineDispatchers.runCurrent()
+
+    val eventLog = fakeAnalyticsEventLogger.getMostRecentEvent()
+    val eventLogContext = eventLog.context
+    val retrofitCallContext = eventLogContext.retrofitCallContext
+
+    assertThat(eventLogContext.activityContextCase)
+      .isEqualTo(ActivityContextCase.RETROFIT_CALL_CONTEXT)
+    assertThat(retrofitCallContext.requestUrl).isEqualTo(mockWebServerUrl.toString())
+    assertThat(retrofitCallContext.responseStatusCode).isEqualTo(HttpURLConnection.HTTP_OK)
+    assertThat(retrofitCallContext.headers).contains(headerString)
+    assertThat(retrofitCallContext.body).isEqualTo(testResponseBody)
+  }
+
+  @Test
+  fun testObserver_onAppInForeground_onNetworkCall_logsFailedNetworkCalls() {
+    setUpTestApplicationComponent()
+    setUpRetrofitApiCall()
+
+    applicationLifecycleObserver.onCreate()
+    applicationLifecycleObserver.onAppInForeground()
+    testCoroutineDispatchers.runCurrent()
+
+    val pageNotFound = HttpURLConnection.HTTP_NOT_FOUND
+    val mockResponse = MockResponse()
+      .setResponseCode(pageNotFound)
+      .setBody(testResponseBody)
+
+    mockWebServer.enqueue(mockResponse)
+    client.newCall(request).execute()
+    testCoroutineDispatchers.runCurrent()
+
+    val eventLog = getOneOfLastTwoEventsLogged(ActivityContextCase.RETROFIT_CALL_FAILED_CONTEXT)
+    val eventLogContext = eventLog.context
+    val retrofitCallFailedContext = eventLogContext.retrofitCallFailedContext
+
+    assertThat(eventLogContext.activityContextCase)
+      .isEqualTo(ActivityContextCase.RETROFIT_CALL_FAILED_CONTEXT)
+    assertThat(retrofitCallFailedContext.requestUrl).isEqualTo(mockWebServerUrl.toString())
+    assertThat(retrofitCallFailedContext.responseStatusCode).isEqualTo(pageNotFound)
+  }
+
   private fun waitInBackgroundFor(millis: Long) {
     applicationLifecycleObserver.onAppInBackground()
     testCoroutineDispatchers.runCurrent()

domain/src/test/java/org/oppia/android/domain/oppialogger/analytics/BUILD.bazel

@@ -305,6 +305,8 @@ oppia_android_test(
         "//domain/src/main/java/org/oppia/android/domain/oppialogger/analytics:prod_module",
         "//testing",
         "//testing/src/main/java/org/oppia/android/testing/data:data_provider_test_monitor",
+        "//testing/src/main/java/org/oppia/android/testing/junit:oppia_parameterized_test_runner",
+        "//testing/src/main/java/org/oppia/android/testing/junit:parameterized_robolectric_test_runner",
         "//testing/src/main/java/org/oppia/android/testing/logging:event_log_subject",
         "//testing/src/main/java/org/oppia/android/testing/logging:sync_status_test_module",
         "//testing/src/main/java/org/oppia/android/testing/platformparameter:test_module",

domain/src/test/java/org/oppia/android/domain/oppialogger/analytics/FeatureFlagsLoggerTest.kt

@@ -2,8 +2,8 @@ package org.oppia.android.domain.oppialogger.analytics
 
 import android.app.Application
 import android.content.Context
+import android.os.Build
 import androidx.test.core.app.ApplicationProvider
-import androidx.test.ext.junit.runners.AndroidJUnit4
 import dagger.BindsInstance
 import dagger.Component
 import dagger.Module
@@ -18,6 +18,12 @@ import org.oppia.android.domain.oppialogger.LoggingIdentifierModule
 import org.oppia.android.domain.platformparameter.PlatformParameterSingletonModule
 import org.oppia.android.testing.FakeAnalyticsEventLogger
 import org.oppia.android.testing.TestLogReportingModule
+import org.oppia.android.testing.junit.OppiaParameterizedTestRunner
+import org.oppia.android.testing.junit.OppiaParameterizedTestRunner.Iteration
+import org.oppia.android.testing.junit.OppiaParameterizedTestRunner.Parameter
+import org.oppia.android.testing.junit.OppiaParameterizedTestRunner.RunParameterized
+import org.oppia.android.testing.junit.OppiaParameterizedTestRunner.SelectRunnerPlatform
+import org.oppia.android.testing.junit.ParameterizedRobolectricTestRunner
 import org.oppia.android.testing.logging.EventLogSubject.Companion.assertThat
 import org.oppia.android.testing.logging.SyncStatusTestModule
 import org.oppia.android.testing.platformparameter.EnableTestFeatureFlag
@@ -38,7 +44,19 @@ import org.oppia.android.util.logging.EnableFileLog
 import org.oppia.android.util.logging.GlobalLogLevel
 import org.oppia.android.util.logging.LogLevel
 import org.oppia.android.util.networking.NetworkConnectionUtilDebugModule
+import org.oppia.android.util.platformparameter.APP_AND_OS_DEPRECATION
+import org.oppia.android.util.platformparameter.DOWNLOADS_SUPPORT
+import org.oppia.android.util.platformparameter.EDIT_ACCOUNTS_OPTIONS_UI
+import org.oppia.android.util.platformparameter.ENABLE_NPS_SURVEY
+import org.oppia.android.util.platformparameter.ENABLE_ONBOARDING_FLOW_V2
+import org.oppia.android.util.platformparameter.ENABLE_PERFORMANCE_METRICS_COLLECTION
+import org.oppia.android.util.platformparameter.EXTRA_TOPIC_TABS_UI
+import org.oppia.android.util.platformparameter.FAST_LANGUAGE_SWITCHING_IN_LESSON
+import org.oppia.android.util.platformparameter.INTERACTION_CONFIG_CHANGE_STATE_RETENTION
+import org.oppia.android.util.platformparameter.LEARNER_STUDY_ANALYTICS
+import org.oppia.android.util.platformparameter.LOGGING_LEARNER_STUDY_IDS
 import org.oppia.android.util.platformparameter.PlatformParameterValue
+import org.oppia.android.util.platformparameter.SPOTLIGHT_UI
 import org.robolectric.annotation.Config
 import org.robolectric.annotation.LooperMode
 import javax.inject.Inject
@@ -47,9 +65,13 @@ import javax.inject.Singleton
 /** Tests for [FeatureFlagsLogger]. */
 // FunctionName: test names are conventionally named with underscores.
 @Suppress("FunctionName")
-@RunWith(AndroidJUnit4::class)
+@RunWith(OppiaParameterizedTestRunner::class)
+@SelectRunnerPlatform(ParameterizedRobolectricTestRunner::class)
 @LooperMode(LooperMode.Mode.PAUSED)
-@Config(application = FeatureFlagsLoggerTest.TestApplication::class)
+@Config(
+  application = FeatureFlagsLoggerTest.TestApplication::class,
+  sdk = [Build.VERSION_CODES.O]
+)
 class FeatureFlagsLoggerTest {
   @Inject lateinit var testCoroutineDispatchers: TestCoroutineDispatchers
   @Inject lateinit var featureFlagsLogger: FeatureFlagsLogger
@@ -60,11 +82,25 @@ class FeatureFlagsLoggerTest {
   @field:[Inject EnableTestFeatureFlagWithEnabledDefault]
   lateinit var testFeatureFlagWithEnabledDefault: PlatformParameterValue<Boolean>
 
+  @Parameter var index: Int = Int.MIN_VALUE
+  @Parameter lateinit var flagName: String
+
   @Before
   fun setup() {
     setUpTestApplicationComponent()
   }
 
+  @Test
+  fun testLogFeatureFlags_logFeatureFlags_hasCorrectUserUUID() {
+    featureFlagsLogger.logAllFeatureFlags(TEST_SESSION_ID)
+    testCoroutineDispatchers.runCurrent()
+
+    val eventLog = fakeAnalyticsEventLogger.getMostRecentEvent()
+    assertThat(eventLog).hasFeatureFlagContextThat {
+      hasUniqueUserUuidThat().isEqualTo("")
+    }
+  }
+
   @Test
   fun testLogFeatureFlags_logFeatureFlags_hasCorrectSessionId() {
     featureFlagsLogger.logAllFeatureFlags(TEST_SESSION_ID)
@@ -115,7 +151,7 @@ class FeatureFlagsLoggerTest {
   }
 
   @Test
-  fun testLogFeatureFlags_ensuresAllAnnotatedClassesAreLogged() {
+  fun testLogFeatureFlags_correctNumberOfFeatureFlagsIsLogged() {
     val expectedClassNames = 12
 
     featureFlagsLogger.logAllFeatureFlags(TEST_SESSION_ID)
@@ -127,6 +163,43 @@ class FeatureFlagsLoggerTest {
     }
   }
 
+  @Test
+  @RunParameterized(
+    Iteration("downloads_support", "index=0", "flagName=$DOWNLOADS_SUPPORT"),
+    Iteration("extra_topic_tabs_ui", "index=1", "flagName=$EXTRA_TOPIC_TABS_UI"),
+    Iteration("learner_study_analytics", "index=2", "flagName=$LEARNER_STUDY_ANALYTICS"),
+    Iteration(
+      "fast_language_switching_in_lesson", "index=3",
+      "flagName=$FAST_LANGUAGE_SWITCHING_IN_LESSON"
+    ),
+    Iteration("logging_learner_study_ids", "index=4", "flagName=$LOGGING_LEARNER_STUDY_IDS"),
+    Iteration("edit_accounts_options_ui", "index=5", "flagName=$EDIT_ACCOUNTS_OPTIONS_UI"),
+    Iteration(
+      "enable_performance_metrics_collection", "index=6",
+      "flagName=$ENABLE_PERFORMANCE_METRICS_COLLECTION"
+    ),
+    Iteration("spotlight_ui", "index=7", "flagName=$SPOTLIGHT_UI"),
+    Iteration(
+      "interaction_config_change_state_retention", "index=8",
+      "flagName=$INTERACTION_CONFIG_CHANGE_STATE_RETENTION"
+    ),
+    Iteration("app_and_os_deprecation", "index=9", "flagName=$APP_AND_OS_DEPRECATION"),
+    Iteration("enable_nps_survey", "index=10", "flagName=$ENABLE_NPS_SURVEY"),
+    Iteration("enable_onboarding_flow_v2", "index=11", "flagName=$ENABLE_ONBOARDING_FLOW_V2"),
+  )
+  fun testLogFeatureFlags_allFeatureFlagNamesAreLogged() {
+    featureFlagsLogger.logAllFeatureFlags(TEST_SESSION_ID)
+
+    testCoroutineDispatchers.runCurrent()
+
+    val eventLog = fakeAnalyticsEventLogger.getMostRecentEvent()
+    assertThat(eventLog).hasFeatureFlagContextThat {
+      hasFeatureFlagItemContextThatAtIndex(index) {
+        hasFeatureFlagNameThat().isEqualTo(flagName)
+      }
+    }
+  }
+
   private fun setUpTestApplicationComponent() {
     ApplicationProvider.getApplicationContext<TestApplication>().inject(this)
   }