Fixes #4470, #4471, #4472, #4473, #4474, #4708: Handle configuration change using on saved instance

app/src/main/java/org/oppia/android/app/player/state/ImageRegionSelectionInteractionView.kt

@@ -51,6 +51,7 @@ class ImageRegionSelectionInteractionView @JvmOverloads constructor(
   private lateinit var onRegionClicked: OnClickableAreaClickedListener
   private lateinit var imageUrl: String
   private lateinit var clickableAreas: List<ImageWithRegions.LabeledRegion>
+  private lateinit var lastSelectedRegion: ImageWithRegions.LabeledRegion
 
   /**
    * Sets the URL for the image & initiates loading it. This is intended to be called via
@@ -66,6 +67,11 @@ class ImageRegionSelectionInteractionView @JvmOverloads constructor(
     maybeInitializeClickableAreas()
   }
 
+  fun setLastSelectedRegion(lastSelectedRegion: ImageWithRegions.LabeledRegion) {
+    this.lastSelectedRegion = lastSelectedRegion
+    maybeInitializeClickableAreas()
+  }
+
   fun setClickableAreas(clickableAreas: List<ImageWithRegions.LabeledRegion>) {
     this.clickableAreas = clickableAreas
     // Resets the backgrounds for all regions if any have been loaded. This ensures the backgrounds
@@ -120,6 +126,9 @@ class ImageRegionSelectionInteractionView @JvmOverloads constructor(
         clickableAreas
       )
       areasImage.addRegionViews()
+      if (::lastSelectedRegion.isInitialized && lastSelectedRegion.hasRegion()) {
+        areasImage.toggleRegion(lastSelectedRegion, view = null)
+      }
       performAttachment(areasImage)
     }
   }

app/src/main/java/org/oppia/android/app/player/state/StateFragment.kt

@@ -8,6 +8,7 @@ import android.view.ViewGroup
 import org.oppia.android.app.fragment.FragmentComponentImpl
 import org.oppia.android.app.fragment.InjectableFragment
 import org.oppia.android.app.model.HelpIndex
+import org.oppia.android.app.model.RawUserAnswer
 import org.oppia.android.app.model.UserAnswer
 import org.oppia.android.app.player.state.answerhandling.InteractionAnswerErrorOrAvailabilityCheckReceiver
 import org.oppia.android.app.player.state.answerhandling.InteractionAnswerHandler
@@ -19,9 +20,15 @@ import org.oppia.android.app.player.state.listener.PreviousResponsesHeaderClickL
 import org.oppia.android.app.player.state.listener.ReturnToTopicNavigationButtonListener
 import org.oppia.android.app.player.state.listener.ShowHintAvailabilityListener
 import org.oppia.android.app.player.state.listener.SubmitNavigationButtonListener
+import org.oppia.android.util.extensions.getProto
 import org.oppia.android.util.extensions.getStringFromBundle
+import org.oppia.android.util.extensions.putProto
 import javax.inject.Inject
 
+private const val STATE_FRAGMENT_RAW_USER_ANSWER_KEY = "StateFragment.raw_user_answer"
+private const val STATE_FRAGMENT_ARE_PREVIOUS_RESPONSES_HEADER_EXPANDED_KEY =
+  "StateFragment.are_previous_responses_header_expanded"
+
 /** Fragment that represents the current state of an exploration. */
 class StateFragment :
   InjectableFragment(),
@@ -79,12 +86,20 @@ class StateFragment :
     val storyId = arguments!!.getStringFromBundle(STATE_FRAGMENT_STORY_ID_ARGUMENT_KEY)!!
     val explorationId =
       arguments!!.getStringFromBundle(STATE_FRAGMENT_EXPLORATION_ID_ARGUMENT_KEY)!!
+    val rawUserAnswer = savedInstanceState?.getProto(
+      STATE_FRAGMENT_RAW_USER_ANSWER_KEY, RawUserAnswer.getDefaultInstance()
+    ) ?: RawUserAnswer.getDefaultInstance()
+    val arePreviousResponsesExpanded =
+      savedInstanceState?.getBoolean(STATE_FRAGMENT_ARE_PREVIOUS_RESPONSES_HEADER_EXPANDED_KEY)
+        ?: false
     return stateFragmentPresenter.handleCreateView(
       inflater,
       container,
       internalProfileId,
       topicId,
       storyId,
+      rawUserAnswer,
+      arePreviousResponsesExpanded,
       explorationId
     )
   }
@@ -129,6 +144,18 @@ class StateFragment :
     stateFragmentPresenter.revealHint(hintIndex)
   }
 
+  override fun onSaveInstanceState(outState: Bundle) {
+    super.onSaveInstanceState(outState)
+    outState.putProto(
+      STATE_FRAGMENT_RAW_USER_ANSWER_KEY,
+      stateFragmentPresenter.getRawUserAnswer()
+    )
+    outState.putBoolean(
+      STATE_FRAGMENT_ARE_PREVIOUS_RESPONSES_HEADER_EXPANDED_KEY,
+      stateFragmentPresenter.getArePreviousResponsesExpanded()
+    )
+  }
+
   fun revealSolution() = stateFragmentPresenter.revealSolution()
 
   fun dismissConceptCard() = stateFragmentPresenter.dismissConceptCard()

app/src/main/java/org/oppia/android/app/player/state/StateFragmentPresenter.kt

@@ -24,6 +24,7 @@ import org.oppia.android.app.model.CheckpointState
 import org.oppia.android.app.model.EphemeralState
 import org.oppia.android.app.model.HelpIndex
 import org.oppia.android.app.model.ProfileId
+import org.oppia.android.app.model.RawUserAnswer
 import org.oppia.android.app.model.State
 import org.oppia.android.app.model.UserAnswer
 import org.oppia.android.app.player.audio.AudioButtonListener
@@ -47,6 +48,9 @@ import org.oppia.android.util.data.DataProvider
 import org.oppia.android.util.data.DataProviders.Companion.toLiveData
 import org.oppia.android.util.gcsresource.DefaultResourceBucketName
 import org.oppia.android.util.parser.html.ExplorationHtmlParserEntityType
+import org.oppia.android.util.platformparameter.EnableHintBulbAnimation
+import org.oppia.android.util.platformparameter.EnableInteractionConfigChangeStateRetention
+import org.oppia.android.util.platformparameter.PlatformParameterValue
 import org.oppia.android.util.system.OppiaClock
 import javax.inject.Inject
 
@@ -71,6 +75,10 @@ class StateFragmentPresenter @Inject constructor(
   private val storyProgressController: StoryProgressController,
   private val oppiaLogger: OppiaLogger,
   @DefaultResourceBucketName private val resourceBucketName: String,
+  @EnableInteractionConfigChangeStateRetention
+  private val isConfigChangeStateRetentionEnabled: PlatformParameterValue<Boolean>,
+  @EnableHintBulbAnimation
+  private val isHintBulbAnimationEnabled: PlatformParameterValue<Boolean>,
   private val assemblerBuilderFactory: StatePlayerRecyclerViewAssembler.Builder.Factory,
   private val splitScreenManager: SplitScreenManager,
   private val oppiaClock: OppiaClock
@@ -105,6 +113,8 @@ class StateFragmentPresenter @Inject constructor(
     internalProfileId: Int,
     topicId: String,
     storyId: String,
+    rawUserAnswer: RawUserAnswer,
+    arePreviousResponsesExpanded: Boolean,
     explorationId: String
   ): View? {
     profileId = ProfileId.newBuilder().setInternalId(internalProfileId).build()
@@ -118,7 +128,13 @@ class StateFragmentPresenter @Inject constructor(
       /* attachToRoot= */ false
     )
     recyclerViewAssembler = createRecyclerViewAssembler(
-      assemblerBuilderFactory.create(resourceBucketName, entityType, profileId),
+      assemblerBuilderFactory.create(
+        resourceBucketName,
+        entityType,
+        profileId,
+        rawUserAnswer,
+        arePreviousResponsesExpanded
+      ),
       binding.congratulationsTextView,
       binding.congratulationsTextConfettiView,
       binding.fullScreenConfettiView
@@ -164,7 +180,7 @@ class StateFragmentPresenter @Inject constructor(
 
   fun handleAnswerReadyForSubmission(answer: UserAnswer) {
     // An interaction has indicated that an answer is ready for submission.
-    handleSubmitAnswer(answer)
+    handleSubmitAnswer(answer, canSubmitAnswer = true)
   }
 
   fun onContinueButtonClicked() {
@@ -208,9 +224,7 @@ class StateFragmentPresenter @Inject constructor(
 
   fun handleKeyboardAction() {
     hideKeyboard()
-    if (viewModel.getCanSubmitAnswer().get() == true) {
-      handleSubmitAnswer(viewModel.getPendingAnswer(recyclerViewAssembler::getPendingAnswerHandler))
-    }
+    handleSubmitAnswer(viewModel.getPendingAnswer(recyclerViewAssembler::getPendingAnswerHandler))
   }
 
   fun onHintAvailable(helpIndex: HelpIndex, isCurrentStatePendingState: Boolean) {
@@ -261,6 +275,11 @@ class StateFragmentPresenter @Inject constructor(
     subscribeToHintSolution(explorationProgressController.submitSolutionIsRevealed())
   }
 
+  /** Returns whether previously submitted wrong answers are currently expanded. */
+  fun getArePreviousResponsesExpanded(): Boolean {
+    return recyclerViewAssembler.arePreviousResponsesExpanded
+  }
+
   private fun getStateViewModel(): StateViewModel {
     return viewModelProvider.getForFragment(fragment, StateViewModel::class.java)
   }
@@ -358,6 +377,9 @@ class StateFragmentPresenter @Inject constructor(
   private fun subscribeToAnswerOutcome(
     answerOutcomeResultLiveData: LiveData<AsyncResult<AnswerOutcome>>
   ) {
+    if (viewModel.getCanSubmitAnswer().get() == true) {
+      recyclerViewAssembler.resetRawUserAnswer()
+    }
     val answerOutcomeLiveData = getAnswerOutcome(answerOutcomeResultLiveData)
     answerOutcomeLiveData.observe(
       fragment,
@@ -401,8 +423,15 @@ class StateFragmentPresenter @Inject constructor(
     }
   }
 
-  private fun handleSubmitAnswer(answer: UserAnswer) {
-    subscribeToAnswerOutcome(explorationProgressController.submitAnswer(answer).toLiveData())
+  private fun handleSubmitAnswer(
+    answer: UserAnswer,
+    canSubmitAnswer: Boolean = viewModel.getCanSubmitAnswer().get() ?: false
+  ) {
+    // This check seems to avoid a crash on configuration change when attempting to resubmit answers
+    // after encountering a submit-time error, but it's also more correct to keep it.
+    if (canSubmitAnswer) {
+      subscribeToAnswerOutcome(explorationProgressController.submitAnswer(answer).toLiveData())
+    }
   }
 
   fun dismissConceptCard() {
@@ -451,6 +480,13 @@ class StateFragmentPresenter @Inject constructor(
   /** Returns the checkpoint state for the current exploration. */
   fun getExplorationCheckpointState() = explorationCheckpointState
 
+  /** Returns the [RawUserAnswer] representing the user's current pending answer. */
+  fun getRawUserAnswer(): RawUserAnswer {
+    return if (isConfigChangeStateRetentionEnabled.value) {
+      viewModel.getRawUserAnswer(recyclerViewAssembler::getPendingAnswerHandler)
+    } else RawUserAnswer.getDefaultInstance()
+  }
+
   private fun markExplorationCompleted() {
     storyProgressController.recordCompletedChapter(
       profileId,
@@ -494,6 +530,8 @@ class StateFragmentPresenter @Inject constructor(
 
   private fun setHintOpenedAndUnRevealed(isHintUnrevealed: Boolean) {
     viewModel.setHintOpenedAndUnRevealedVisibility(isHintUnrevealed)
+    if (!isHintBulbAnimationEnabled.value) return
+
     if (isHintUnrevealed) {
       val hintBulbAnimation = AnimationUtils.loadAnimation(
         context,

app/src/main/java/org/oppia/android/app/player/state/StatePlayerRecyclerViewAssembler.kt

@@ -25,6 +25,7 @@ import org.oppia.android.app.model.EphemeralState.StateTypeCase
 import org.oppia.android.app.model.HelpIndex
 import org.oppia.android.app.model.Interaction
 import org.oppia.android.app.model.ProfileId
+import org.oppia.android.app.model.RawUserAnswer
 import org.oppia.android.app.model.StringList
 import org.oppia.android.app.model.SubtitledHtml
 import org.oppia.android.app.model.UserAnswer
@@ -144,7 +145,9 @@ class StatePlayerRecyclerViewAssembler private constructor(
   backgroundCoroutineDispatcher: CoroutineDispatcher,
   private val hasConversationView: Boolean,
   private val resourceHandler: AppLanguageResourceHandler,
-  private val translationController: TranslationController
+  private val translationController: TranslationController,
+  private var rawUserAnswer: RawUserAnswer,
+  arePreviousResponsesExpanded: Boolean
 ) : HtmlParser.CustomOppiaTagActionListener {
   /**
    * A list of view models corresponding to past view models that are hidden by default. These are
@@ -158,7 +161,8 @@ class StatePlayerRecyclerViewAssembler private constructor(
    * Whether the previously submitted wrong answers should be expanded. This value is intentionally
    * not retained upon configuration changes since the user can just re-expand the list.
    */
-  private var hasPreviousResponsesExpanded: Boolean = false
+  var arePreviousResponsesExpanded: Boolean = arePreviousResponsesExpanded
+    private set
 
   private val lifecycleSafeTimerFactory = LifecycleSafeTimerFactory(backgroundCoroutineDispatcher)
 
@@ -300,6 +304,13 @@ class StatePlayerRecyclerViewAssembler private constructor(
     return Pair(conversationPendingItemList, extraInteractionPendingItemList)
   }
 
+  /**
+   * Resets rawUserAnswer to it's default instance.
+   */
+  fun resetRawUserAnswer() {
+    rawUserAnswer = RawUserAnswer.getDefaultInstance()
+  }
+
   private fun addInteractionForPendingState(
     pendingItemList: MutableList<StateItemViewModel>,
     interaction: Interaction,
@@ -311,13 +322,17 @@ class StatePlayerRecyclerViewAssembler private constructor(
     pendingItemList += interactionViewModelFactory.create(
       gcsEntityId,
       hasConversationView,
+      rawUserAnswer,
       interaction,
       fragment as InteractionAnswerReceiver,
       fragment as InteractionAnswerErrorOrAvailabilityCheckReceiver,
       hasPreviousButton,
       isSplitView.get()!!,
       writtenTranslationContext
-    )
+    ).also {
+      // Ensure that potential errors are re-detected in cases of configuration changes.
+      (it as? InteractionAnswerHandler)?.checkPendingAnswerError(rawUserAnswer.lastErrorCategory)
+    }
   }
 
   private fun addContentItem(
@@ -353,7 +368,7 @@ class StatePlayerRecyclerViewAssembler private constructor(
         PreviousResponsesHeaderViewModel(
           answersAndResponses.size - 1,
           hasConversationView,
-          ObservableBoolean(hasPreviousResponsesExpanded),
+          ObservableBoolean(arePreviousResponsesExpanded),
           fragment as PreviousResponsesHeaderClickListener,
           isSplitView.get()!!,
           resourceHandler
@@ -364,7 +379,7 @@ class StatePlayerRecyclerViewAssembler private constructor(
       }
       // Only add previous answers if current responses are expanded, or if collapsing is disabled.
       val showPreviousAnswers = !playerFeatureSet.wrongAnswerCollapsing ||
-        hasPreviousResponsesExpanded
+        arePreviousResponsesExpanded
       for (answerAndResponse in answersAndResponses.take(answersAndResponses.size - 1)) {
         if (playerFeatureSet.pastAnswerSupport) {
           // Earlier answers can't be correct (since otherwise new answers wouldn't be able to be
@@ -442,7 +457,7 @@ class StatePlayerRecyclerViewAssembler private constructor(
     }
     // Ensure the header matches the updated state.
     headerModel.isExpanded.set(expandPreviousAnswers)
-    hasPreviousResponsesExpanded = expandPreviousAnswers
+    arePreviousResponsesExpanded = expandPreviousAnswers
   }
 
   /**
@@ -454,7 +469,7 @@ class StatePlayerRecyclerViewAssembler private constructor(
     check(playerFeatureSet.wrongAnswerCollapsing) {
       "Cannot collapse previous answers for assembler that doesn't support wrong answer collapsing"
     }
-    hasPreviousResponsesExpanded = false
+    arePreviousResponsesExpanded = false
   }
 
   /**
@@ -889,7 +904,9 @@ class StatePlayerRecyclerViewAssembler private constructor(
     private val resourceHandler: AppLanguageResourceHandler,
     private val translationController: TranslationController,
     private val multiTypeBuilderFactory: BindableAdapter.MultiTypeBuilder.Factory,
-    private val singleTypeBuilderFactory: BindableAdapter.SingleTypeBuilder.Factory
+    private val singleTypeBuilderFactory: BindableAdapter.SingleTypeBuilder.Factory,
+    private val rawUserAnswer: RawUserAnswer,
+    private val arePreviousResponsesExpanded: Boolean
   ) {
 
     private val adapterBuilder: BindableAdapter.MultiTypeBuilder<StateItemViewModel,
@@ -1375,7 +1392,9 @@ class StatePlayerRecyclerViewAssembler private constructor(
         backgroundCoroutineDispatcher,
         hasConversationView,
         resourceHandler,
-        translationController
+        translationController,
+        rawUserAnswer,
+        arePreviousResponsesExpanded
       )
       if (playerFeatureSet.conceptCardSupport) {
         customTagListener.proxyListener = assembler
@@ -1395,13 +1414,19 @@ class StatePlayerRecyclerViewAssembler private constructor(
       private val resourceHandler: AppLanguageResourceHandler,
       private val translationController: TranslationController,
       private val multiAdapterBuilderFactory: BindableAdapter.MultiTypeBuilder.Factory,
-      private val singleAdapterFactory: BindableAdapter.SingleTypeBuilder.Factory
+      private val singleAdapterFactory: BindableAdapter.SingleTypeBuilder.Factory,
     ) {
       /**
        * Returns a new [Builder] for the specified GCS resource bucket information for loading
        * assets, and the current logged in [ProfileId].
        */
-      fun create(resourceBucketName: String, entityType: String, profileId: ProfileId): Builder {
+      fun create(
+        resourceBucketName: String,
+        entityType: String,
+        profileId: ProfileId,
+        rawUserAnswer: RawUserAnswer,
+        arePreviousResponsesExpanded: Boolean
+      ): Builder {
         return Builder(
           accessibilityService,
           htmlParserFactory,
@@ -1415,7 +1440,9 @@ class StatePlayerRecyclerViewAssembler private constructor(
           resourceHandler,
           translationController,
           multiAdapterBuilderFactory,
-          singleAdapterFactory
+          singleAdapterFactory,
+          rawUserAnswer,
+          arePreviousResponsesExpanded
         )
       }
     }