Fix #4452, #4453, #4454, #4445, #4446, #4447, #4448: Add spotlight functionality

app/src/main/AndroidManifest.xml

@@ -39,7 +39,7 @@
     <activity
       android:name=".app.testing.SpotlightFragmentTestActivity"
       android:label="@string/test_activity_label"
-      android:theme="@style/OppiaThemeWithoutActionBar"/>
+      android:theme="@style/OppiaThemeWithoutActionBar" />
     <activity
       android:name=".app.administratorcontrols.appversion.AppVersionActivity"
       android:label="@string/app_version_activity_title"

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

@@ -185,6 +185,7 @@ interface ActivityComponentImpl :
       StateAssemblerPaddingBindingAdaptersTestActivity
   )
 
+  fun inject(spotlightFragmentTestActivity: SpotlightFragmentTestActivity)
   fun inject(stateFragmentTestActivity: StateFragmentTestActivity)
   fun inject(storyActivity: StoryActivity)
   fun inject(testFontScaleConfigurationUtilActivity: TestFontScaleConfigurationUtilActivity)
@@ -198,5 +199,4 @@ interface ActivityComponentImpl :
   fun inject(viewEventLogsActivity: ViewEventLogsActivity)
   fun inject(viewEventLogsTestActivity: ViewEventLogsTestActivity)
   fun inject(walkthroughActivity: WalkthroughActivity)
-  fun inject(spotlightFragmentTestActivity: SpotlightFragmentTestActivity)
 }

app/src/main/java/org/oppia/android/app/customview/ChapterNotStartedContainerConstraintLayout.kt

@@ -14,7 +14,7 @@ import org.oppia.android.app.view.ViewComponentFactory
 import org.oppia.android.app.view.ViewComponentImpl
 import javax.inject.Inject
 
-/** Custom view to hold the chapter that has not yet been started. */
+/** Custom view that represents an incomplete chapter. */
 class ChapterNotStartedContainerConstraintLayout @JvmOverloads constructor(
   context: Context,
   attrs: AttributeSet? = null,
@@ -30,7 +30,7 @@ class ChapterNotStartedContainerConstraintLayout @JvmOverloads constructor(
   @Inject
   lateinit var resourceHandler: AppLanguageResourceHandler
 
-  /** Set the index of the story of which this custom view is a part of. */
+  /** Sets the index of the story of which this custom view is a part of. */
   fun setStoryIndex(index: Int) {
     // Only spotlight the first chapter of the "first" story. We know for sure that for a new user,
     // the first chapter shall be a type of not started chapter view. The index tells which story

app/src/main/java/org/oppia/android/app/customview/PromotedStoryCardView.kt

@@ -14,7 +14,7 @@ import org.oppia.android.app.view.ViewComponentFactory
 import org.oppia.android.app.view.ViewComponentImpl
 import javax.inject.Inject
 
-/** Custom view to hold the promoted story cards. */
+/** [MaterialCardView] that represents stories promoted to the learner. */
 class PromotedStoryCardView @JvmOverloads constructor(
   context: Context,
   attrs: AttributeSet? = null,
@@ -30,17 +30,17 @@ class PromotedStoryCardView @JvmOverloads constructor(
   private var isSpotlit = false
 
   /** Sets the index at which this custom view is located inside the recycler view. */
-  fun setIndex(index: Int) {
-    if (!isSpotlit) {
+  fun setPromotedStoryIndex(index: Int) {
+    // This view can get attached multiple times and we must make sure that the spotlight is
+    // requested only once. Only spotlight the item at the first index of the recycler view.
+    if (!isSpotlit && index == 0) {
       isSpotlit = true
       val spotlightTarget = SpotlightTarget(
         this,
         resourceHandler.getStringInLocale(R.string.promoted_story_spotlight_hint),
         feature = Spotlight.FeatureCase.PROMOTED_STORIES
       )
-      if (index == 0) {
-        checkNotNull(getSpotlightFragment()).requestSpotlightViewWithDelayedLayout(spotlightTarget)
-      }
+      checkNotNull(getSpotlightFragment()).requestSpotlightViewWithDelayedLayout(spotlightTarget)
     }
   }
 

app/src/main/java/org/oppia/android/app/fragment/FragmentComponentImpl.kt

@@ -161,6 +161,7 @@ interface FragmentComponentImpl : FragmentComponent, ViewComponentBuilderInjecto
   fun inject(resumeLessonFragment: ResumeLessonFragment)
   fun inject(revealSolutionDialogFragment: RevealSolutionDialogFragment)
   fun inject(revisionCardFragment: RevisionCardFragment)
+  fun inject(spotlightFragment: SpotlightFragment)
   fun inject(stateFragment: StateFragment)
   fun inject(stopExplorationDialogFragment: StopExplorationDialogFragment)
   fun inject(storyFragment: StoryFragment)
@@ -176,5 +177,4 @@ interface FragmentComponentImpl : FragmentComponent, ViewComponentBuilderInjecto
   fun inject(walkthroughFinalFragment: WalkthroughFinalFragment)
   fun inject(walkthroughTopicListFragment: WalkthroughTopicListFragment)
   fun inject(walkthroughWelcomeFragment: WalkthroughWelcomeFragment)
-  fun inject(spotlightFragment: SpotlightFragment)
 }

app/src/main/java/org/oppia/android/app/home/HomeActivityPresenter.kt

@@ -1,6 +1,5 @@
 package org.oppia.android.app.home
 
-import android.os.Bundle
 import android.view.View
 import androidx.appcompat.app.AppCompatActivity
 import androidx.appcompat.widget.Toolbar
@@ -10,7 +9,6 @@ import org.oppia.android.app.activity.ActivityScope
 import org.oppia.android.app.drawer.NavigationDrawerFragment
 import org.oppia.android.app.spotlight.SpotlightFragment
 import org.oppia.android.app.spotlight.SpotlightManager
-import org.oppia.android.app.topic.PROFILE_ID_ARGUMENT_KEY
 import javax.inject.Inject
 
 const val TAG_HOME_FRAGMENT = "HOME_FRAGMENT"
@@ -32,13 +30,10 @@ class HomeActivityPresenter @Inject constructor(private val activity: AppCompatA
     }
 
     if (getSpotlightFragment() == null) {
-      val spotlightFragment = SpotlightFragment()
-      val args = Bundle()
-      args.putInt(PROFILE_ID_ARGUMENT_KEY, internalProfileId)
-      spotlightFragment.arguments = args
       activity.supportFragmentManager.beginTransaction().add(
         R.id.home_spotlight_fragment_placeholder,
-        spotlightFragment, SpotlightManager.SPOTLIGHT_FRAGMENT_TAG
+        SpotlightFragment.newInstance(internalProfileId),
+        SpotlightManager.SPOTLIGHT_FRAGMENT_TAG
       ).commitNow()
     }
   }
@@ -69,6 +64,6 @@ class HomeActivityPresenter @Inject constructor(private val activity: AppCompatA
   private fun getSpotlightFragment(): SpotlightFragment? {
     return activity.supportFragmentManager.findFragmentById(
       R.id.home_spotlight_fragment_placeholder
-    ) as SpotlightFragment?
+    ) as? SpotlightFragment
   }
 }

app/src/main/java/org/oppia/android/app/onboarding/OnboardingActivityPresenter.kt

@@ -1,12 +1,10 @@
 package org.oppia.android.app.onboarding
 
-import android.os.Bundle
 import androidx.appcompat.app.AppCompatActivity
 import org.oppia.android.R
 import org.oppia.android.app.activity.ActivityScope
 import org.oppia.android.app.spotlight.SpotlightFragment
 import org.oppia.android.app.spotlight.SpotlightManager
-import org.oppia.android.app.topic.PROFILE_ID_ARGUMENT_KEY
 import javax.inject.Inject
 
 /** The presenter for [OnboardingActivity]. */
@@ -22,13 +20,10 @@ class OnboardingActivityPresenter @Inject constructor(private val activity: AppC
     }
 
     if (getSpotlightFragment() == null) {
-      val spotlightFragment = SpotlightFragment()
-      val args = Bundle()
-      args.putInt(PROFILE_ID_ARGUMENT_KEY, -1)
-      spotlightFragment.arguments = args
       activity.supportFragmentManager.beginTransaction().add(
         R.id.onboarding_spotlight_fragment_placeholder,
-        spotlightFragment, SpotlightManager.SPOTLIGHT_FRAGMENT_TAG
+        SpotlightFragment.newInstance(internalProfileId = 0),
+        SpotlightManager.SPOTLIGHT_FRAGMENT_TAG
       ).commitNow()
     }
   }
@@ -46,6 +41,6 @@ class OnboardingActivityPresenter @Inject constructor(private val activity: AppC
       .supportFragmentManager
       .findFragmentById(
         R.id.onboarding_spotlight_fragment_placeholder
-      ) as SpotlightFragment?
+      ) as? SpotlightFragment
   }
 }

app/src/main/java/org/oppia/android/app/onboarding/OnboardingFragmentPresenter.kt

@@ -60,10 +60,10 @@ class OnboardingFragmentPresenter @Inject constructor(
     return binding.root
   }
 
-  private fun getSpotlightFragment(): SpotlightFragment {
+  private fun getSpotlightFragment(): SpotlightFragment? {
     return activity.supportFragmentManager.findFragmentByTag(
       SpotlightManager.SPOTLIGHT_FRAGMENT_TAG
-    ) as SpotlightFragment
+    ) as? SpotlightFragment
   }
 
   fun startSpotlight() {
@@ -73,7 +73,7 @@ class OnboardingFragmentPresenter @Inject constructor(
       SpotlightShape.Circle,
       Spotlight.FeatureCase.ONBOARDING_NEXT_BUTTON
     )
-    getSpotlightFragment().requestSpotlightViewWithDelayedLayout(nextSpotlightTarget)
+    checkNotNull(getSpotlightFragment()).requestSpotlightViewWithDelayedLayout(nextSpotlightTarget)
   }
 
   private fun setUpViewPager() {

app/src/main/java/org/oppia/android/app/player/audio/AudioFragmentPresenter.kt

@@ -35,6 +35,8 @@ import org.oppia.android.domain.profile.ProfileManagementController
 import org.oppia.android.util.data.AsyncResult
 import org.oppia.android.util.data.DataProviders.Companion.toLiveData
 import org.oppia.android.util.networking.NetworkConnectionUtil
+import org.oppia.android.util.platformparameter.EnableSpotlightUi
+import org.oppia.android.util.platformparameter.PlatformParameterValue
 import javax.inject.Inject
 
 const val TAG_LANGUAGE_DIALOG = "LANGUAGE_DIALOG"
@@ -52,7 +54,8 @@ class AudioFragmentPresenter @Inject constructor(
   private val networkConnectionUtil: NetworkConnectionUtil,
   private val viewModelProvider: ViewModelProvider<AudioViewModel>,
   private val oppiaLogger: OppiaLogger,
-  private val resourceHandler: AppLanguageResourceHandler
+  private val resourceHandler: AppLanguageResourceHandler,
+  @EnableSpotlightUi private val enableSpotlightUi: PlatformParameterValue<Boolean>
 ) {
   var userIsSeeking = false
   var userProgress = 0
@@ -119,16 +122,6 @@ class AudioFragmentPresenter @Inject constructor(
     return binding.root
   }
 
-  private fun subscribeToSpotlightStatusLiveData() {
-    getSpotlightFragment().getSpotlightStatusLiveData().observe(fragment) { isSpotlightActive ->
-      if (isSpotlightActive) {
-        handleOnStop()
-      } else {
-        handleOnPlay()
-      }
-    }
-  }
-
   private fun startSpotlights() {
     val audioLanguageIconSpotlightTarget = SpotlightTarget(
       binding.audioLanguageIcon,
@@ -214,12 +207,6 @@ class AudioFragmentPresenter @Inject constructor(
     }
   }
 
-  private fun handleOnPlay() {
-    if (!activity.isChangingConfigurations && prepared) {
-      viewModel.togglePlayPause(UiAudioPlayStatus.PAUSED)
-    }
-  }
-
   /** Releases audio player resources */
   fun handleOnDestroy() {
     if (!activity.isChangingConfigurations) {
@@ -297,13 +284,12 @@ class AudioFragmentPresenter @Inject constructor(
     audioButtonListener.scrollToTop()
     if (feedbackId == null) {
       // This isn't reloading content since it's the first case of the content auto-playing.
-      loadMainContentAudio(allowAutoPlay = true, reloadingContent = false)
+      loadMainContentAudio(allowAutoPlay = !enableSpotlightUi.value, reloadingContent = false)
     } else {
-      loadFeedbackAudio(feedbackId!!, true)
+      loadFeedbackAudio(feedbackId!!, !enableSpotlightUi.value)
     }
     fragment.view?.startAnimation(AnimationUtils.loadAnimation(context, R.anim.slide_down_audio))
     startSpotlights()
-    subscribeToSpotlightStatusLiveData()
   }
 
   private fun hideAudioFragment() {

app/src/main/java/org/oppia/android/app/player/exploration/ExplorationActivityPresenter.kt

@@ -1,11 +1,12 @@
 package org.oppia.android.app.player.exploration
 
 import android.content.Context
-import android.os.Bundle
+import android.view.View
 import android.view.inputmethod.EditorInfo
 import android.widget.TextView
 import androidx.appcompat.app.AppCompatActivity
 import androidx.appcompat.widget.Toolbar
+import androidx.core.view.doOnPreDraw
 import androidx.databinding.DataBindingUtil
 import androidx.lifecycle.LiveData
 import androidx.lifecycle.Observer
@@ -26,7 +27,6 @@ import org.oppia.android.app.spotlight.SpotlightFragment
 import org.oppia.android.app.spotlight.SpotlightManager
 import org.oppia.android.app.spotlight.SpotlightShape
 import org.oppia.android.app.spotlight.SpotlightTarget
-import org.oppia.android.app.topic.PROFILE_ID_ARGUMENT_KEY
 import org.oppia.android.app.topic.TopicActivity
 import org.oppia.android.app.translation.AppLanguageResourceHandler
 import org.oppia.android.app.utility.FontScaleConfigurationUtil
@@ -136,39 +136,40 @@ class ExplorationActivityPresenter @Inject constructor(
     }
 
     if (getSpotlightFragment() == null) {
-      val spotlightFragment = SpotlightFragment()
-      val args = Bundle()
-      args.putInt(PROFILE_ID_ARGUMENT_KEY, profileId.internalId)
-      spotlightFragment.arguments = args
       activity.supportFragmentManager.beginTransaction().add(
         R.id.exploration_spotlight_fragment_placeholder,
-        spotlightFragment, SpotlightManager.SPOTLIGHT_FRAGMENT_TAG
+        SpotlightFragment.newInstance(profileId.internalId),
+        SpotlightManager.SPOTLIGHT_FRAGMENT_TAG
       ).commitNow()
     }
   }
 
   fun requestVoiceOverIconSpotlight(numberOfLogins: Int) {
     if (numberOfLogins >= 3) {
-      // Spotlight the voice-over icon after 3 or more logins.
-      val audioPlayerSpotlightTarget = SpotlightTarget(
-        binding.actionAudioPlayer,
-        resourceHandler.getStringInLocaleWithWrapping(
-          R.string.voiceover_icon_spotlight_hint,
-          resourceHandler.getStringInLocale(R.string.app_name)
-        ),
-        SpotlightShape.Circle,
-        Spotlight.FeatureCase.VOICEOVER_PLAY_ICON
-      )
-      checkNotNull(getSpotlightFragment()).requestSpotlightViewWithDelayedLayout(
-        audioPlayerSpotlightTarget
-      )
+      // Spotlight the voice-over icon after 3 or more logins, and only if it's visible. Note that
+      // the doOnPreDraw here ensures that the visibility check for the button is up-to-date before
+      // a decision is made on whether to show the button.
+      binding.actionAudioPlayer.doOnPreDraw {
+        if (it.visibility == View.VISIBLE) {
+          val audioPlayerSpotlightTarget = SpotlightTarget(
+            it,
+            resourceHandler.getStringInLocaleWithWrapping(
+              R.string.voiceover_icon_spotlight_hint,
+              resourceHandler.getStringInLocale(R.string.app_name)
+            ),
+            SpotlightShape.Circle,
+            Spotlight.FeatureCase.VOICEOVER_PLAY_ICON
+          )
+          checkNotNull(getSpotlightFragment()).requestSpotlight(audioPlayerSpotlightTarget)
+        }
+      }
     }
   }
 
   private fun getSpotlightFragment(): SpotlightFragment? {
     return activity.supportFragmentManager.findFragmentByTag(
       SpotlightManager.SPOTLIGHT_FRAGMENT_TAG
-    ) as SpotlightFragment?
+    ) as? SpotlightFragment
   }
 
   fun loadExplorationFragment(readingTextSize: ReadingTextSize) {

app/src/main/java/org/oppia/android/app/player/exploration/ExplorationFragmentPresenter.kt

@@ -73,16 +73,14 @@ class ExplorationFragmentPresenter @Inject constructor(
       fragment
     ) { result ->
       val readingTextSize = retrieveArguments().readingTextSize
-      if (result is AsyncResult.Success && result.value.readingTextSize != readingTextSize) {
-        selectNewReadingTextSize(result.value.readingTextSize)
-
-        // Since text views are based on sp for sizing, the activity needs to be recreated so that
-        // sp can be correctly recomputed.
-        fragment.requireActivity().recreate()
-      } else {
-        if (result is AsyncResult.Success) {
-          showSpotlights(result.value.numberOfLogins)
-        }
+      if (result is AsyncResult.Success) {
+        if (result.value.readingTextSize != readingTextSize) {
+
+          // Since text views are based on sp for sizing, the activity needs to be recreated so that
+          // sp can be correctly recomputed.
+          selectNewReadingTextSize(result.value.readingTextSize)
+          fragment.requireActivity().recreate()
+        } else showSpotlights(result.value.numberOfLogins)
       }
     }
   }
@@ -92,7 +90,7 @@ class ExplorationFragmentPresenter @Inject constructor(
       fragment.requireActivity().findViewById<View>(R.id.exploration_toolbar) as Toolbar
     explorationToolbar.forEach {
       if (it is ImageButton) {
-        // this toolbar contains only one image button, which is the back navigation icon
+        // This toolbar contains only one image button, which is the back navigation icon.
         val backButtonSpotlightTarget = SpotlightTarget(
           it,
           resourceHandler.getStringInLocale(R.string.exploration_exit_button_spotlight_hint),
@@ -110,7 +108,7 @@ class ExplorationFragmentPresenter @Inject constructor(
   private fun getSpotlightFragment(): SpotlightFragment? {
     return fragment.requireActivity().supportFragmentManager.findFragmentByTag(
       SpotlightManager.SPOTLIGHT_FRAGMENT_TAG
-    ) as SpotlightFragment?
+    ) as? SpotlightFragment
   }
 
   fun handlePlayAudio() {

app/src/main/java/org/oppia/android/app/player/exploration/RequestVoiceOverIconSpotlightListener.kt

@@ -1,7 +1,7 @@
 package org.oppia.android.app.player.exploration
 
-/** Interface to request voice-over icon spotlight. */
+/** Listener for scenarios when the user should be shown a spotlight for playing voiceovers. */
 interface RequestVoiceOverIconSpotlightListener {
-  /** Requests the spotlight fragment to show voice-over icon spotlight. */
+  /** Requests to show a voice-over icon spotlight. */
   fun requestVoiceOverIconSpotlight(numberOfLogins: Int)
 }