Fixes #4897: Follow up alpha MR6 fixes

app/BUILD.bazel

@@ -186,10 +186,10 @@ DATABINDING_LAYOUTS = ["src/main/res/layout*/**"]
 # keep sorted
 VIEW_MODELS_WITH_RESOURCE_IMPORTS = [
     "src/main/java/org/oppia/android/app/administratorcontrols/appversion/AppVersionViewModel.kt",
+    "src/main/java/org/oppia/android/app/administratorcontrols/learneranalytics/ControlButtonsViewModel.kt",
     "src/main/java/org/oppia/android/app/administratorcontrols/learneranalytics/DeviceIdItemViewModel.kt",
     "src/main/java/org/oppia/android/app/administratorcontrols/learneranalytics/ProfileLearnerIdItemViewModel.kt",
     "src/main/java/org/oppia/android/app/administratorcontrols/learneranalytics/ProfileListViewModel.kt",
-    "src/main/java/org/oppia/android/app/administratorcontrols/learneranalytics/ShareIdsViewModel.kt",
     "src/main/java/org/oppia/android/app/administratorcontrols/learneranalytics/SyncStatusItemViewModel.kt",
     "src/main/java/org/oppia/android/app/devoptions/forcenetworktype/ForceNetworkTypeViewModel.kt",
     "src/main/java/org/oppia/android/app/devoptions/mathexpressionparser/MathExpressionParserViewModel.kt",
@@ -344,6 +344,7 @@ VIEW_MODELS = [
     "src/main/java/org/oppia/android/app/story/StoryViewModel.kt",
     "src/main/java/org/oppia/android/app/testing/BindableAdapterTestDataModel.kt",
     "src/main/java/org/oppia/android/app/testing/BindableAdapterTestViewModel.kt",
+    "src/main/java/org/oppia/android/app/testing/CircularProgressIndicatorAdaptersTestViewModel.kt",
     "src/main/java/org/oppia/android/app/topic/conceptcard/ConceptCardViewModel.kt",
     "src/main/java/org/oppia/android/app/topic/lessons/TopicLessonViewModel.kt",
     "src/main/java/org/oppia/android/app/topic/lessons/TopicLessonsItemViewModel.kt",
@@ -472,6 +473,7 @@ BINDING_ADAPTERS_WITH_RESOURCE_IMPORTS = [
 # keep sorted
 BINDING_ADAPTERS = [
     "src/main/java/org/oppia/android/app/databinding/AppCompatCheckBoxBindingAdapters.java",
+    "src/main/java/org/oppia/android/app/databinding/CircularProgressIndicatorAdapters.java",
     "src/main/java/org/oppia/android/app/databinding/ConstraintLayoutAdapters.java",
     "src/main/java/org/oppia/android/app/databinding/EditTextBindingAdapters.java",
     "src/main/java/org/oppia/android/app/databinding/GuidelineBindingAdapters.java",

app/src/main/AndroidManifest.xml

@@ -197,6 +197,7 @@
     <activity android:name=".app.testing.AppCompatCheckBoxBindingAdaptersTestActivity" />
     <activity android:name=".app.testing.AudioFragmentTestActivity" />
     <activity android:name=".app.testing.BindableAdapterTestActivity" />
+    <activity android:name=".app.testing.CircularProgressIndicatorAdaptersTestActivity" />
     <activity android:name=".app.testing.ConceptCardFragmentTestActivity" />
     <activity android:name=".app.testing.DragDropTestActivity" />
     <activity android:name=".app.testing.DrawableBindingAdaptersTestActivity" />

app/src/main/java/org/oppia/android/app/activity/ActivityComponentImpl.kt

@@ -57,6 +57,7 @@ import org.oppia.android.app.story.StoryActivity
 import org.oppia.android.app.testing.AdministratorControlsFragmentTestActivity
 import org.oppia.android.app.testing.AppCompatCheckBoxBindingAdaptersTestActivity
 import org.oppia.android.app.testing.AudioFragmentTestActivity
+import org.oppia.android.app.testing.CircularProgressIndicatorAdaptersTestActivity
 import org.oppia.android.app.testing.ConceptCardFragmentTestActivity
 import org.oppia.android.app.testing.DragDropTestActivity
 import org.oppia.android.app.testing.DrawableBindingAdaptersTestActivity
@@ -123,6 +124,7 @@ interface ActivityComponentImpl :
   fun inject(appVersionActivity: AppVersionActivity)
   fun inject(audioFragmentTestActivity: AudioFragmentTestActivity)
   fun inject(audioLanguageActivity: AudioLanguageActivity)
+  fun inject(circularProgressAdaptersTestActivity: CircularProgressIndicatorAdaptersTestActivity)
   fun inject(completedStoryListActivity: CompletedStoryListActivity)
   fun inject(conceptCardFragmentTestActivity: ConceptCardFragmentTestActivity)
   fun inject(developerOptionsActivity: DeveloperOptionsActivity)

app/src/main/java/org/oppia/android/app/administratorcontrols/learneranalytics/ControlButtonsViewModel.kt

@@ -0,0 +1,223 @@
+package org.oppia.android.app.administratorcontrols.learneranalytics
+
+import android.annotation.SuppressLint
+import android.content.ActivityNotFoundException
+import android.content.Intent
+import androidx.appcompat.app.AppCompatActivity
+import androidx.lifecycle.LiveData
+import androidx.lifecycle.MutableLiveData
+import androidx.lifecycle.Transformations
+import com.google.protobuf.MessageLite
+import org.oppia.android.app.administratorcontrols.learneranalytics.ProfileListViewModel.ProfileListItemViewModel
+import org.oppia.android.app.model.OppiaEventLogs
+import org.oppia.android.domain.oppialogger.OppiaLogger
+import org.oppia.android.domain.oppialogger.analytics.AnalyticsController
+import org.oppia.android.util.data.AsyncResult
+import org.oppia.android.util.data.DataProviders.Companion.toLiveData
+import org.oppia.android.util.logging.SyncStatusManager
+import org.oppia.android.util.logging.SyncStatusManager.SyncStatus
+import java.io.ByteArrayOutputStream
+import java.util.Base64
+import java.util.zip.GZIPOutputStream
+import javax.inject.Inject
+
+/**
+ * [ProfileListItemViewModel] that represents the portion of the learner analytics admin page which
+ * provides some control buttons for ID/logs sharing and syncing.
+ */
+@SuppressLint("StaticFieldLeak") // False positive (Android doesn't manage this model's lifecycle).
+class ControlButtonsViewModel private constructor(
+  private val oppiaLogger: OppiaLogger,
+  private val activity: AppCompatActivity,
+  private val analyticsController: AnalyticsController,
+  private val syncStatusManager: SyncStatusManager,
+  private val viewModels: List<ProfileListItemViewModel>
+) : ProfileListItemViewModel(ProfileListViewModel.ProfileListItemViewType.SHARE_IDS) {
+  private var monitoredUploadProgress: LiveData<ForceSyncProgress> =
+    MutableLiveData(ForceSyncProgress())
+
+  /** The current [ForceSyncProgress], as affected by [onUploadLogsNowButtonClicked]. */
+  val forceUploadProgress: LiveData<ForceSyncProgress> get() = monitoredUploadProgress
+
+  /** The current [SyncStatus] of event logs. */
+  val syncStatus: LiveData<SyncStatus> by lazy {
+    Transformations.map(syncStatusManager.getSyncStatus().toLiveData(), this::processSyncStatus)
+  }
+
+  /**
+   * Indicates the user wants to share learner & device IDs, along with event log metrics, with
+   * another app.
+   */
+  fun onShareButtonClicked() {
+    // Reference: https://developer.android.com/guide/components/intents-common#Email from
+    // https://stackoverflow.com/a/15022153/3689782.
+    val logs = retrieveEventLogs(viewModels.filterIsInstance<ProfileLearnerIdItemViewModel>())
+    val sharedText = viewModels.mapNotNull { viewModel ->
+      when (viewModel) {
+        is DeviceIdItemViewModel -> listOf("Oppia app installation ID: ${viewModel.deviceId.value}")
+        is ProfileLearnerIdItemViewModel -> {
+          val profile = viewModel.profile
+          val stats = viewModel.profileSpecificEventsUploadStats.value
+          val learnerStats = stats?.learnerStats
+          val uncategorizedStats = stats?.uncategorizedStats
+          listOfNotNull(
+            "- Profile name: ${profile.name}, learner ID: ${profile.learnerId}",
+            learnerStats?.awaitingUploadEventCountText?.let { "  - Uploading learner events: $it" },
+            learnerStats?.uploadedEventCountText?.let { "  - Uploaded learner events: $it" },
+            uncategorizedStats?.awaitingUploadEventCountText?.let {
+              "  - Uploading uncategorized events: $it"
+            },
+            uncategorizedStats?.uploadedEventCountText?.let {
+              "  - Uploaded uncategorized events: $it"
+            }
+          )
+        }
+        is SyncStatusItemViewModel -> {
+          listOf(
+            "Current sync status: ${viewModel.syncStatus.value}.",
+            "Encoded event logs:"
+          ) + (logs?.toCompressedBase64()?.chunked(BASE64_LINE_WRAP_LIMIT) ?: listOf("Missing"))
+        }
+        else -> null
+      }
+    }.flatten().joinToString(separator = "\n")
+    try {
+      activity.startActivity(
+        Intent(Intent.ACTION_SEND).apply {
+          type = "text/plain"
+          addFlags(Intent.FLAG_ACTIVITY_NEW_TASK)
+          putExtra(Intent.EXTRA_TEXT, sharedText)
+        }
+      )
+    } catch (e: ActivityNotFoundException) {
+      oppiaLogger.e("ControlButtonsViewModel", "No activity found to receive shared IDs.", e)
+    }
+  }
+
+  /**
+   * Indicates that the user wishes to upload any pending event logs immediately, rather than
+   * waiting for the app to schedule an event upload.
+   *
+   * The status of the upload result can be observed via [forceUploadProgress].
+   *
+   * [canStartUploadingLogs] should be used to determine whether now is a valid time to start
+   * uploading logs.
+   */
+  fun onUploadLogsNowButtonClicked() {
+    monitoredUploadProgress =
+      Transformations.map(
+        analyticsController.uploadEventLogs().toLiveData(), this::processUploadedEventLogs
+      )
+    notifyChange() // Recompute bindings since the live data instance has changed.
+  }
+
+  /**
+   * Returns whether current conditions, per [isCurrentlyUploading] and [syncStatus], indicate that
+   * there are events that can be manually force-uploaded by the user.
+   *
+   * Note that both [isCurrentlyUploading] and [syncStatus] permit null values because of an issue
+   * with databinding wherein multiple [LiveData]s bound at the same time may result in one or both
+   * of the values correspond to the *current* [LiveData] value which may be null if the [LiveData]
+   * hasn't been updated yet (even if its type indicates non-nullness). Permitting null allows the
+   * implementation to work around this case by assuming that either value missing means no
+   * determination can be made whether logs can start being uploaded.
+   */
+  fun canStartUploadingLogs(isCurrentlyUploading: Boolean?, syncStatus: SyncStatus?): Boolean =
+    isCurrentlyUploading == false && syncStatus == SyncStatus.WAITING_TO_START_UPLOADING
+
+  private fun retrieveEventLogs(viewModels: List<ProfileLearnerIdItemViewModel>): OppiaEventLogs? =
+    viewModels.firstOrNull()?.oppiaEventLogs?.value?.let { processEventLogs(it) }
+
+  private fun processUploadedEventLogs(result: AsyncResult<Pair<Int, Int>>): ForceSyncProgress {
+    return when (result) {
+      is AsyncResult.Pending -> ForceSyncProgress(eventsUploaded = 0, totalEventsToUpload = 0)
+      is AsyncResult.Success -> {
+        val (currentUploadedEventCount, totalEventCount) = result.value
+        ForceSyncProgress(currentUploadedEventCount, totalEventCount)
+      }
+      is AsyncResult.Failure -> ForceSyncProgress().also {
+        oppiaLogger.e(
+          "ControlButtonsViewModel", "Encountered failure while uploading events.", result.error
+        )
+      }
+    }
+  }
+
+  private fun processSyncStatus(result: AsyncResult<SyncStatus>): SyncStatus {
+    return when (result) {
+      is AsyncResult.Pending -> SyncStatus.INITIAL_UNKNOWN
+      is AsyncResult.Success -> result.value
+      is AsyncResult.Failure -> SyncStatus.INITIAL_UNKNOWN.also {
+        oppiaLogger.e(
+          "ControlButtonsViewModel",
+          "Encountered failure while retrieving sync status.",
+          result.error
+        )
+      }
+    }
+  }
+
+  private fun processEventLogs(result: AsyncResult<OppiaEventLogs>): OppiaEventLogs? {
+    return when (result) {
+      is AsyncResult.Pending -> null
+      is AsyncResult.Success -> result.value
+      is AsyncResult.Failure -> {
+        oppiaLogger.e(
+          "ControlButtonsViewModel", "Encountered failure while on-disk event logs.", result.error
+        )
+        null
+      }
+    }
+  }
+
+  /**
+   * Progress representation structure that provides the UI with an indication of how much of an
+   * upload event operation has completed, and how much remains.
+   *
+   * Note that a [totalEventsToUpload] value of 0 indicates there are 0 left in the **current**
+   * operation, but there may have been events to upload in the past.
+   *
+   * @property eventsUploaded the number of events that have uploaded so far
+   * @property totalEventsToUpload the total number of events to upload, or none, or
+   *     [DEFAULT_UNKNOWN_EVENTS_TO_UPLOAD_COUNT] if it's not yet known how many events can be
+   *     uploaded
+   */
+  data class ForceSyncProgress(
+    val eventsUploaded: Int = 0,
+    val totalEventsToUpload: Int = DEFAULT_UNKNOWN_EVENTS_TO_UPLOAD_COUNT
+  ) {
+    /** Returns whether there are events that can be uploaded. */
+    fun hasEventsToUpload(): Boolean = totalEventsToUpload != DEFAULT_UNKNOWN_EVENTS_TO_UPLOAD_COUNT
+
+    /** Returns whether there are events currently being uploaded. */
+    fun isCurrentlyUploading(): Boolean = eventsUploaded < totalEventsToUpload
+  }
+
+  /** Factory for creating new [ControlButtonsViewModel]s. */
+  class Factory @Inject constructor(
+    private val oppiaLogger: OppiaLogger,
+    private val activity: AppCompatActivity,
+    private val analyticsController: AnalyticsController,
+    private val syncStatusManager: SyncStatusManager
+  ) {
+    /** Returns a new [ControlButtonsViewModel]. */
+    fun create(viewModels: List<ProfileListItemViewModel>): ControlButtonsViewModel {
+      return ControlButtonsViewModel(
+        oppiaLogger, activity, analyticsController, syncStatusManager, viewModels
+      )
+    }
+  }
+
+  private companion object {
+    private const val BASE64_LINE_WRAP_LIMIT = 80
+    private const val DEFAULT_UNKNOWN_EVENTS_TO_UPLOAD_COUNT = Integer.MIN_VALUE
+
+    // Copied from ProtoStringEncoder (which isn't available in production code).
+    private fun <M : MessageLite> M.toCompressedBase64(): String {
+      val compressedMessage = ByteArrayOutputStream().also { byteOutputStream ->
+        GZIPOutputStream(byteOutputStream).use(::writeTo)
+      }.toByteArray()
+      return Base64.getEncoder().encodeToString(compressedMessage)
+    }
+  }
+}

app/src/main/java/org/oppia/android/app/administratorcontrols/learneranalytics/ProfileAndDeviceIdFragmentPresenter.kt

@@ -8,9 +8,9 @@ import org.oppia.android.app.administratorcontrols.learneranalytics.ProfileListV
 import org.oppia.android.app.administratorcontrols.learneranalytics.ProfileListViewModel.ProfileListItemViewType
 import org.oppia.android.app.recyclerview.BindableAdapter
 import org.oppia.android.databinding.ProfileAndDeviceIdFragmentBinding
+import org.oppia.android.databinding.ProfileListControlButtonsBinding
 import org.oppia.android.databinding.ProfileListDeviceIdItemBinding
 import org.oppia.android.databinding.ProfileListLearnerIdItemBinding
-import org.oppia.android.databinding.ProfileListShareIdsItemBinding
 import org.oppia.android.databinding.ProfileListSyncStatusItemBinding
 import javax.inject.Inject
 
@@ -47,7 +47,7 @@ class ProfileAndDeviceIdFragmentPresenter @Inject constructor(
         is DeviceIdItemViewModel -> ProfileListItemViewType.DEVICE_ID
         is ProfileLearnerIdItemViewModel -> ProfileListItemViewType.LEARNER_ID
         is SyncStatusItemViewModel -> ProfileListItemViewType.SYNC_STATUS
-        is ShareIdsViewModel -> ProfileListItemViewType.SHARE_IDS
+        is ControlButtonsViewModel -> ProfileListItemViewType.SHARE_IDS
         else -> error("Encountered unexpected view model: $viewModel")
       }
     }.registerViewDataBinder(
@@ -67,9 +67,9 @@ class ProfileAndDeviceIdFragmentPresenter @Inject constructor(
       transformViewModel = { it as SyncStatusItemViewModel }
     ).registerViewDataBinder(
       viewType = ProfileListItemViewType.SHARE_IDS,
-      inflateDataBinding = ProfileListShareIdsItemBinding::inflate,
-      setViewModel = ProfileListShareIdsItemBinding::setViewModel,
-      transformViewModel = { it as ShareIdsViewModel }
+      inflateDataBinding = ProfileListControlButtonsBinding::inflate,
+      setViewModel = ProfileListControlButtonsBinding::setViewModel,
+      transformViewModel = { it as ControlButtonsViewModel }
     ).build()
   }
 }