Fix #5001: Set Up Firestore and Upload Free Form Responses

.github/CODEOWNERS

@@ -93,8 +93,10 @@
 # All domain and utility-specific shared test infrastructure.
 /testing/src/main/java/org/oppia/android/testing/FakeAnalyticsEventLogger.kt @oppia/android-app-infrastructure-reviewers
 /testing/src/main/java/org/oppia/android/testing/FakeExceptionLogger.kt @oppia/android-app-infrastructure-reviewers
+/testing/src/main/java/org/oppia/android/testing/FakeFirebaseAuthInstanceWrapperImpl.kt @oppia/android-app-infrastructure-reviewers
 /testing/src/main/java/org/oppia/android/testing/FakeFirebaseAuthWrapperImpl.kt @oppia/android-app-infrastructure-reviewers
 /testing/src/main/java/org/oppia/android/testing/FakeFirestoreEventLogger.kt @oppia/android-app-infrastructure-reviewers
+/testing/src/main/java/org/oppia/android/testing/FakeFirestoreInstanceWrapperImpl.kt @oppia/android-app-infrastructure-reviewers
 /testing/src/main/java/org/oppia/android/testing/FakePerformanceMetricAssessor.kt @oppia/android-app-infrastructure-reviewers
 /testing/src/main/java/org/oppia/android/testing/FakePerformanceMetricsEventLogger.kt @oppia/android-app-infrastructure-reviewers
 /testing/src/main/java/org/oppia/android/testing/TestAuthenticationModule.kt @oppia/android-app-infrastructure-reviewers

app/build.gradle

@@ -171,7 +171,7 @@ dependencies {
       'com.google.firebase:firebase-analytics-ktx:17.5.0',
       'com.google.firebase:firebase-core:17.5.0',
       'com.google.firebase:firebase-crashlytics:17.0.0',
-      'com.google.firebase:firebase-firestore-ktx:21.5.0',
+      'com.google.firebase:firebase-firestore-ktx:24.2.1',
       'com.google.firebase:firebase-auth-ktx:19.3.1',
       'com.google.guava:guava:28.1-android',
       'com.google.protobuf:protobuf-javalite:3.17.3',

app/src/main/java/org/oppia/android/app/devoptions/vieweventlogs/ViewEventLogsViewModel.kt

@@ -1,6 +1,7 @@
 package org.oppia.android.app.devoptions.vieweventlogs
 
 import org.oppia.android.app.fragment.FragmentScope
+import org.oppia.android.app.model.EventLog
 import org.oppia.android.app.translation.AppLanguageResourceHandler
 import org.oppia.android.app.viewmodel.ObservableViewModel
 import org.oppia.android.util.locale.OppiaLocale
@@ -25,7 +26,7 @@ class ViewEventLogsViewModel @Inject constructor(
   // Retrieves events from cache that are meant to be uploaded to Firebase Analytics.
   private val analyticsEvents = debugAnalyticsEventLogger.getEventList()
 
-  private val eventList = analyticsEvents + firestoreEvents
+  private val eventList = mutableListOf<EventLog>()
 
   /**
    * List of [EventLogItemViewModel] used to populate recyclerview of [ViewEventLogsFragment]
@@ -36,8 +37,14 @@ class ViewEventLogsViewModel @Inject constructor(
   }
 
   private fun processEventLogsList(): List<EventLogItemViewModel> {
-    return eventList.map {
-      EventLogItemViewModel(it, machineLocale, resourceHandler)
-    }.reversed()
+    return eventList
+      .apply {
+        addAll(analyticsEvents)
+        addAll(firestoreEvents)
+      }
+      .map {
+        EventLogItemViewModel(it, machineLocale, resourceHandler)
+      }
+      .sortedByDescending { it.eventLog.timestamp }
   }
 }

app/src/main/java/org/oppia/android/app/survey/SurveyOutroDialogFragmentPresenter.kt

@@ -56,11 +56,11 @@ class SurveyOutroDialogFragmentPresenter @Inject constructor(
   private fun endSurveyWithCallback(callback: () -> Unit) {
     surveyController.stopSurveySession(surveyCompleted = true).toLiveData().observe(
       activity,
-      {
-        when (it) {
+      { result ->
+        when (result) {
           is AsyncResult.Pending -> oppiaLogger.d("SurveyActivity", "Stopping survey session")
           is AsyncResult.Failure -> {
-            oppiaLogger.d("SurveyActivity", "Failed to stop the survey session, ${it.error}")
+            oppiaLogger.d("SurveyActivity", "Failed to stop the survey session", result.error)
             activity.finish() // Can't recover from the session failing to stop.
           }
           is AsyncResult.Success -> {

app/src/sharedTest/java/org/oppia/android/app/devoptions/ViewEventLogsFragmentTest.kt

@@ -81,10 +81,9 @@ import org.oppia.android.domain.platformparameter.PlatformParameterSingletonModu
 import org.oppia.android.domain.question.QuestionModule
 import org.oppia.android.domain.topic.PrimeTopicAssetsControllerModule
 import org.oppia.android.domain.workmanager.WorkManagerConfigurationModule
+import org.oppia.android.testing.FakeFirestoreInstanceWrapperImpl
 import org.oppia.android.testing.OppiaTestRule
-import org.oppia.android.testing.RunOn
 import org.oppia.android.testing.TestAuthenticationModule
-import org.oppia.android.testing.TestPlatform
 import org.oppia.android.testing.junit.InitializeDefaultLocaleRule
 import org.oppia.android.testing.robolectric.RobolectricModule
 import org.oppia.android.testing.threading.TestCoroutineDispatchers
@@ -108,7 +107,6 @@ import org.oppia.android.util.logging.firebase.FirebaseExceptionLogger
 import org.oppia.android.util.logging.firebase.FirebaseLogUploaderModule
 import org.oppia.android.util.logging.firebase.FirestoreEventLogger
 import org.oppia.android.util.logging.firebase.FirestoreInstanceWrapper
-import org.oppia.android.util.logging.firebase.FirestoreInstanceWrapperImpl
 import org.oppia.android.util.logging.performancemetrics.PerformanceMetricsAssessorModule
 import org.oppia.android.util.logging.performancemetrics.PerformanceMetricsConfigurationsModule
 import org.oppia.android.util.logging.performancemetrics.PerformanceMetricsEventLogger
@@ -397,9 +395,7 @@ class ViewEventLogsFragmentTest {
     }
   }
 
-  @Test // TODO(#5143): On robolectric, there is a conflict between Firestore's Sqlite and
-  // robolectric's ShadowSQLiteConnection but this is resolved in newer versions of robolectric.
-  @RunOn(TestPlatform.ESPRESSO)
+  @Test
   fun testViewEventLogsFragment_dateAndTimeIsDisplayedCorrectly() {
     launch(ViewEventLogsTestActivity::class.java).use { scenario ->
       testCoroutineDispatchers.runCurrent()
@@ -728,7 +724,7 @@ class ViewEventLogsFragmentTest {
 
     @Provides
     @Singleton
-    fun provideFirebaseFirestoreInstanceWrapper(wrapperImpl: FirestoreInstanceWrapperImpl):
+    fun provideFirebaseFirestoreInstanceWrapper(wrapperImpl: FakeFirestoreInstanceWrapperImpl):
       FirestoreInstanceWrapper = wrapperImpl
   }
 

app/src/sharedTest/java/org/oppia/android/app/testing/FractionInputInteractionViewTestActivityTest.kt

@@ -72,6 +72,7 @@ import org.oppia.android.domain.topic.PrimeTopicAssetsControllerModule
 import org.oppia.android.domain.workmanager.WorkManagerConfigurationModule
 import org.oppia.android.testing.DisableAccessibilityChecks
 import org.oppia.android.testing.OppiaTestRule
+import org.oppia.android.testing.TestAuthenticationModule
 import org.oppia.android.testing.TestLogReportingModule
 import org.oppia.android.testing.espresso.EditTextInputAction
 import org.oppia.android.testing.junit.InitializeDefaultLocaleRule
@@ -578,7 +579,8 @@ class FractionInputInteractionViewTestActivityTest {
       LoggingIdentifierModule::class, ApplicationLifecycleModule::class,
       SyncStatusModule::class, MetricLogSchedulerModule::class, TestingBuildFlavorModule::class,
       EventLoggingConfigurationModule::class, ActivityRouterModule::class,
-      CpuPerformanceSnapshotterModule::class, ExplorationProgressModule::class
+      CpuPerformanceSnapshotterModule::class, ExplorationProgressModule::class,
+      TestAuthenticationModule::class
     ]
   )
   interface TestApplicationComponent : ApplicationComponent {

app/src/sharedTest/java/org/oppia/android/app/testing/RatioInputInteractionViewTestActivityTest.kt

@@ -79,6 +79,7 @@ import org.oppia.android.domain.topic.PrimeTopicAssetsControllerModule
 import org.oppia.android.domain.workmanager.WorkManagerConfigurationModule
 import org.oppia.android.testing.DisableAccessibilityChecks
 import org.oppia.android.testing.OppiaTestRule
+import org.oppia.android.testing.TestAuthenticationModule
 import org.oppia.android.testing.TestLogReportingModule
 import org.oppia.android.testing.espresso.EditTextInputAction
 import org.oppia.android.testing.junit.InitializeDefaultLocaleRule
@@ -446,7 +447,8 @@ class RatioInputInteractionViewTestActivityTest {
       LoggingIdentifierModule::class, ApplicationLifecycleModule::class,
       SyncStatusModule::class, MetricLogSchedulerModule::class, TestingBuildFlavorModule::class,
       EventLoggingConfigurationModule::class, ActivityRouterModule::class,
-      CpuPerformanceSnapshotterModule::class, ExplorationProgressModule::class
+      CpuPerformanceSnapshotterModule::class, ExplorationProgressModule::class,
+      TestAuthenticationModule::class
     ]
   )
   interface TestApplicationComponent : ApplicationComponent {

domain/build.gradle

@@ -93,12 +93,11 @@ dependencies {
       'com.google.dagger:dagger:2.24',
       'com.google.firebase:firebase-analytics-ktx:17.5.0',
       'com.google.firebase:firebase-crashlytics:17.0.0',
-      'com.google.firebase:firebase-firestore-ktx:21.5.0',
+      'com.google.firebase:firebase-firestore-ktx:24.2.1',
       'com.google.firebase:firebase-auth-ktx:19.3.1',
       'com.google.guava:guava:28.1-android',
       'com.google.protobuf:protobuf-javalite:3.17.3',
       "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version",
-      'org.mockito:mockito-core:2.19.0',
   )
   compileOnly(
       'jakarta.xml.bind:jakarta.xml.bind-api:2.3.2',

domain/src/main/java/org/oppia/android/domain/auth/AuthenticationController.kt

@@ -1,30 +1,47 @@
 package org.oppia.android.domain.auth
 
 import kotlinx.coroutines.CompletableDeferred
+import kotlinx.coroutines.CoroutineDispatcher
+import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.TimeoutCancellationException
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.withTimeout
 import org.oppia.android.util.data.AsyncResult
+import org.oppia.android.util.threading.BackgroundDispatcher
+import java.util.concurrent.TimeoutException
 import javax.inject.Inject
-import javax.inject.Singleton
 
 /** Controller for signing in and retrieving a Firebase user. */
-@Singleton
 class AuthenticationController @Inject constructor(
-  private val firebaseAuthWrapper: FirebaseAuthWrapper
+  private val firebaseAuthWrapper: FirebaseAuthWrapper,
+  @BackgroundDispatcher private val backgroundCoroutineDispatcher: CoroutineDispatcher
 ) {
   /** Returns the current signed in user or null if there is no authenticated user. */
   val currentFirebaseUser: FirebaseUserWrapper? = firebaseAuthWrapper.currentUser
 
   /** Returns the result of an authentication task. */
   fun signInAnonymouslyWithFirebase(): CompletableDeferred<AsyncResult<Any?>> {
     val deferredResult = CompletableDeferred<AsyncResult<Any?>>()
-    firebaseAuthWrapper.signInAnonymously(
-      onSuccess = {
-        deferredResult.complete(AsyncResult.Success(null))
-      },
-      onFailure = { exception ->
-        deferredResult.complete(AsyncResult.Failure(exception))
+    val timeoutMillis = 3000L
+    CoroutineScope(backgroundCoroutineDispatcher).launch {
+      try {
+        withTimeout(timeoutMillis) {
+          firebaseAuthWrapper.signInAnonymously(
+            onSuccess = {
+              deferredResult.complete(AsyncResult.Success(null))
+            },
+            onFailure = { exception ->
+              deferredResult.complete(AsyncResult.Failure(exception))
+            }
+          )
+        }
+      } catch (e: TimeoutCancellationException) {
+        // Handle timeout exception
+        deferredResult.complete(
+          AsyncResult.Failure(TimeoutException("Authentication attempt timed out"))
+        )
       }
-    )
-
+    }
     return deferredResult
   }
 }

domain/src/main/java/org/oppia/android/domain/auth/AuthenticationModule.kt

@@ -9,6 +9,11 @@ import javax.inject.Singleton
 class AuthenticationModule {
   @Provides
   @Singleton
-  fun provideFirebaseAuthWrapper(firebaseAuthInstanceWrapperImpl: FirebaseAuthInstanceWrapperImpl):
-    FirebaseAuthWrapper = FirebaseAuthWrapperImpl(firebaseAuthInstanceWrapperImpl)
+  fun provideFirebaseAuthWrapper(firebaseAuthInstanceWrapper: FirebaseAuthInstanceWrapper):
+    FirebaseAuthWrapper = FirebaseAuthWrapperImpl(firebaseAuthInstanceWrapper)
+
+  @Provides
+  @Singleton
+  fun provideFirebaseAuthInstanceWrapper(): FirebaseAuthInstanceWrapper =
+    FirebaseAuthInstanceWrapperImpl()
 }

domain/src/main/java/org/oppia/android/domain/auth/BUILD.bazel

@@ -14,6 +14,8 @@ kt_android_library(
     deps = [
         ":firebase_auth_wrapper",
         "//third_party:javax_inject_javax_inject",
+        "//third_party:org_jetbrains_kotlinx_kotlinx-coroutines-core",
+        "//utility/src/main/java/org/oppia/android/util/threading:annotations",
     ],
 )
 

domain/src/main/java/org/oppia/android/domain/auth/FirebaseAuthInstanceWrapper.kt

@@ -3,5 +3,5 @@ package org.oppia.android.domain.auth
 /** Interface for providing an implementation of [FirebaseAuthInstance]. */
 interface FirebaseAuthInstanceWrapper {
   /** Returns a wrapped instance of FirebaseAuth. */
-  val firebaseAuthInstance: FirebaseAuthInstance
+  val firebaseAuthInstance: FirebaseAuthInstance?
 }

domain/src/main/java/org/oppia/android/domain/auth/FirebaseAuthWrapperImpl.kt

@@ -6,19 +6,19 @@ import javax.inject.Singleton
 /** Production implementation of FirebaseAuthWrapper. */
 @Singleton
 class FirebaseAuthWrapperImpl @Inject constructor(
-  private val firebaseWrapper: FirebaseAuthInstanceWrapperImpl
+  private val firebaseWrapper: FirebaseAuthInstanceWrapper
 ) : FirebaseAuthWrapper {
   override val currentUser: FirebaseUserWrapper?
-    get() = firebaseWrapper.firebaseAuthInstance.firebaseAuth.currentUser?.let {
+    get() = firebaseWrapper.firebaseAuthInstance?.firebaseAuth?.currentUser?.let {
       FirebaseUserWrapper(it.uid)
     }
 
   override fun signInAnonymously(onSuccess: () -> Unit, onFailure: (Throwable) -> Unit) {
-    firebaseWrapper.firebaseAuthInstance.firebaseAuth.signInAnonymously()
-      .addOnSuccessListener {
+    firebaseWrapper.firebaseAuthInstance?.firebaseAuth?.signInAnonymously()
+      ?.addOnSuccessListener {
         onSuccess.invoke()
       }
-      .addOnFailureListener { task ->
+      ?.addOnFailureListener { task ->
         val exception = task.cause
         if (exception != null) {
           onFailure.invoke(exception)

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

@@ -41,13 +41,19 @@ class FirestoreDataController @Inject constructor(
    * error will be thrown if something went wrong during upload.
    */
   suspend fun uploadData() {
-    firestoreEventsStore.readDataAsync().await().eventLogsToUploadList.forEach { eventLog ->
-      authenticateAndUploadToFirestore(eventLog)
+    val eventLogsToUpload = firestoreEventsStore.readDataAsync().await().eventLogsToUploadList
+
+    if (eventLogsToUpload.isNotEmpty()) {
+      eventLogsToUpload.forEach { eventLog ->
+        authenticateAndUploadToFirestore(eventLog)
+      }.also {
+        removeFirstEventLogFromStore()
+      }
     }
   }
 
   /**
-   * Logs a high priority event defined by [eventContext] corresponding to time [timestamp].
+   * Logs an event defined by [eventContext] corresponding to time [timestamp].
    *
    * This will schedule a background upload of the event if there's internet connectivity, otherwise
    * it will cache the event for a later upload.
@@ -158,10 +164,13 @@ class FirestoreDataController @Inject constructor(
   fun getEventLogStore(): DataProvider<OppiaEventLogs> = firestoreEventsStore
 
   /** Removes the first log report that had been recorded for upload. */
-  fun removeFirstEventLogFromStore() {
-    println("removing first event log from store")
+  private fun removeFirstEventLogFromStore() {
     firestoreEventsStore.storeDataAsync(updateInMemoryCache = true) { oppiaEventLogs ->
-      return@storeDataAsync oppiaEventLogs.toBuilder().removeEventLogsToUpload(0).build()
+      if (oppiaEventLogs.eventLogsToUploadCount > 0) {
+        return@storeDataAsync oppiaEventLogs.toBuilder().removeEventLogsToUpload(0).build()
+      } else {
+        return@storeDataAsync oppiaEventLogs // No event logs to remove
+      }
     }.invokeOnCompletion {
       it?.let {
         consoleLogger.e("FirestoreDataController", "Failed to remove event log", it)

domain/src/main/java/org/oppia/android/domain/oppialogger/loguploader/LogUploadWorker.kt

@@ -119,7 +119,6 @@ class LogUploadWorker private constructor(
   private suspend fun uploadFirestoreData(): Result {
     return try {
       dataController.uploadData()
-      dataController.removeFirstEventLogFromStore()
       Result.success()
     } catch (e: Exception) {
       consoleLogger.e(TAG, e.toString(), e)

domain/src/test/java/org/oppia/android/domain/auth/AuthenticationControllerTest.kt

@@ -19,12 +19,11 @@ import org.oppia.android.testing.TestAuthenticationModule
 import org.oppia.android.testing.TestLogReportingModule
 import org.oppia.android.testing.assertThrows
 import org.oppia.android.testing.robolectric.RobolectricModule
-import org.oppia.android.testing.threading.TestCoroutineDispatchers
-import org.oppia.android.testing.threading.TestDispatcherModule
 import org.oppia.android.testing.time.FakeOppiaClockModule
 import org.oppia.android.util.data.DataProvidersInjector
 import org.oppia.android.util.data.DataProvidersInjectorProvider
 import org.oppia.android.util.threading.BackgroundDispatcher
+import org.oppia.android.util.threading.DispatcherModule
 import org.robolectric.annotation.Config
 import org.robolectric.annotation.LooperMode
 import javax.inject.Inject
@@ -46,9 +45,6 @@ class AuthenticationControllerTest {
   @Inject
   lateinit var authenticationController: AuthenticationController
 
-  @Inject
-  lateinit var testCoroutineDispatchers: TestCoroutineDispatchers
-
   @field:[Inject BackgroundDispatcher]
   lateinit var backgroundDispatcher: CoroutineDispatcher
 
@@ -116,7 +112,7 @@ class AuthenticationControllerTest {
   @Component(
     modules = [
       TestModule::class, RobolectricModule::class, FakeOppiaClockModule::class,
-      ApplicationLifecycleModule::class, TestDispatcherModule::class,
+      ApplicationLifecycleModule::class, DispatcherModule::class,
       TestLogReportingModule::class, TestAuthenticationModule::class,
     ]
   )