Fix#4881: Build UI for the Android NPS Survey

app/BUILD.bazel

@@ -155,6 +155,7 @@ LISTENERS = [
     "src/main/java/org/oppia/android/app/recyclerview/OnItemDragListener.kt",
     "src/main/java/org/oppia/android/app/settings/profile/LoadProfileEditDeletionDialogListener.kt",
     "src/main/java/org/oppia/android/app/settings/profile/RouteToProfileEditListener.kt",
+    "src/main/java/org/oppia/android/app/survey/SelectedAnswerAvailabilityReceiver.kt",
     "src/main/java/org/oppia/android/app/topic/RouteToRevisionCardListener.kt",
     "src/main/java/org/oppia/android/app/topic/lessons/ChapterSummarySelector.kt",
     "src/main/java/org/oppia/android/app/topic/lessons/StorySummarySelector.kt",
@@ -235,6 +236,12 @@ VIEW_MODELS_WITH_RESOURCE_IMPORTS = [
     "src/main/java/org/oppia/android/app/profileprogress/RecentlyPlayedStorySummaryViewModel.kt",
     "src/main/java/org/oppia/android/app/story/storyitemviewmodel/StoryChapterSummaryViewModel.kt",
     "src/main/java/org/oppia/android/app/story/storyitemviewmodel/StoryHeaderViewModel.kt",
+    "src/main/java/org/oppia/android/app/survey/SurveyViewModel.kt",
+    "src/main/java/org/oppia/android/app/survey/surveyitemviewmodel/FreeFormItemsViewModel.kt",
+    "src/main/java/org/oppia/android/app/survey/surveyitemviewmodel/MarketFitItemsViewModel.kt",
+    "src/main/java/org/oppia/android/app/survey/surveyitemviewmodel/MultipleChoiceOptionContentViewModel.kt",
+    "src/main/java/org/oppia/android/app/survey/surveyitemviewmodel/NpsItemsViewModel.kt",
+    "src/main/java/org/oppia/android/app/survey/surveyitemviewmodel/UserTypeItemsViewModel.kt",
     "src/main/java/org/oppia/android/app/topic/TopicViewModel.kt",
     "src/main/java/org/oppia/android/app/topic/info/TopicInfoViewModel.kt",
     "src/main/java/org/oppia/android/app/topic/lessons/ChapterSummaryViewModel.kt",
@@ -342,6 +349,7 @@ VIEW_MODELS = [
     "src/main/java/org/oppia/android/app/story/StoryFragmentScroller.kt",
     "src/main/java/org/oppia/android/app/story/storyitemviewmodel/StoryItemViewModel.kt",
     "src/main/java/org/oppia/android/app/story/StoryViewModel.kt",
+    "src/main/java/org/oppia/android/app/survey/surveyitemviewmodel/SurveyAnswerItemViewModel.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",
@@ -402,7 +410,10 @@ VIEWS_WITH_RESOURCE_IMPORTS = [
     "src/main/java/org/oppia/android/app/customview/LessonThumbnailImageView.kt",
     "src/main/java/org/oppia/android/app/customview/PromotedStoryCardView.kt",
     "src/main/java/org/oppia/android/app/customview/SegmentedCircularProgressView.kt",
+    "src/main/java/org/oppia/android/app/customview/SurveyOnboardingBackgroundView.kt",
     "src/main/java/org/oppia/android/app/customview/VerticalDashedLineView.kt",
+    "src/main/java/org/oppia/android/app/survey/SurveyMultipleChoiceOptionView.kt",
+    "src/main/java/org/oppia/android/app/survey/SurveyNpsItemOptionView.kt",
     "src/main/java/org/oppia/android/app/utility/ClickableAreasImage.kt",
 ]
 
@@ -621,6 +632,7 @@ kt_android_library(
         "//domain/src/main/java/org/oppia/android/domain/audio:cellular_audio_dialog_controller",
         "//model/src/main/proto:arguments_java_proto_lite",
         "//model/src/main/proto:question_java_proto_lite",
+        "//model/src/main/proto:survey_java_proto_lite",
         "//model/src/main/proto:topic_java_proto_lite",
         "//third_party:androidx_recyclerview_recyclerview",
     ],
@@ -781,6 +793,8 @@ kt_android_library(
         "//domain/src/main/java/org/oppia/android/domain/oppialogger:startup_listener",
         "//domain/src/main/java/org/oppia/android/domain/profile:profile_management_controller",
         "//domain/src/main/java/org/oppia/android/domain/spotlight:spotlight_state_controller",
+        "//domain/src/main/java/org/oppia/android/domain/survey:gating_controller",
+        "//domain/src/main/java/org/oppia/android/domain/survey:survey_controller",
         "//model/src/main/proto:arguments_java_proto_lite",
         "//third_party:androidx_databinding_databinding-adapters",
         "//third_party:androidx_databinding_databinding-common",

app/src/main/AndroidManifest.xml

@@ -307,6 +307,11 @@
     <activity
       android:name=".app.testing.activity.TestActivity"
       android:theme="@style/OppiaThemeWithoutActionBar" />
+    <activity
+      android:name=".app.survey.SurveyActivity"
+      android:label="@string/survey_activity_title"
+      android:theme="@style/OppiaThemeWithoutActionBar"
+      android:windowSoftInputMode="adjustResize" />
 
     <provider
       android:name="androidx.work.impl.WorkManagerInitializer"

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

@@ -54,6 +54,7 @@ import org.oppia.android.app.settings.profile.ProfileRenameActivity
 import org.oppia.android.app.settings.profile.ProfileResetPinActivity
 import org.oppia.android.app.splash.SplashActivity
 import org.oppia.android.app.story.StoryActivity
+import org.oppia.android.app.survey.SurveyActivity
 import org.oppia.android.app.testing.AdministratorControlsFragmentTestActivity
 import org.oppia.android.app.testing.AppCompatCheckBoxBindingAdaptersTestActivity
 import org.oppia.android.app.testing.AudioFragmentTestActivity
@@ -206,4 +207,5 @@ interface ActivityComponentImpl :
   fun inject(viewEventLogsActivity: ViewEventLogsActivity)
   fun inject(viewEventLogsTestActivity: ViewEventLogsTestActivity)
   fun inject(walkthroughActivity: WalkthroughActivity)
+  fun inject(surveyActivity: SurveyActivity)
 }

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

@@ -0,0 +1,110 @@
+package org.oppia.android.app.customview
+
+import android.content.Context
+import android.graphics.Canvas
+import android.graphics.Color
+import android.graphics.Paint
+import android.graphics.Path
+import android.util.AttributeSet
+import android.view.View
+import androidx.core.content.ContextCompat
+import androidx.core.view.ViewCompat
+import androidx.fragment.app.Fragment
+import androidx.fragment.app.FragmentManager
+import org.oppia.android.R
+import org.oppia.android.app.translation.AppLanguageResourceHandler
+import org.oppia.android.app.view.ViewComponentFactory
+import org.oppia.android.app.view.ViewComponentImpl
+import javax.inject.Inject
+
+/**
+ * CustomView to add a background to [SurveyWelcomeDialogFragment] and [SurveyOutroDialogFragment].
+ * Without chaptersFinished and totalChapters values this custom-view cannot be created.
+ *
+ * Reference: // https://proandroiddev.com/how-i-drew-custom-shapes-in-bottom-bar-c4539d86afd7 and
+ * // https://ciechanow.ski/drawing-bezier-curves/
+ */
+class SurveyOnboardingBackgroundView : View {
+  @Inject
+  lateinit var resourceHandler: AppLanguageResourceHandler
+
+  private val isRtl by lazy {
+    resourceHandler.getLayoutDirection() == ViewCompat.LAYOUT_DIRECTION_RTL
+  }
+
+  private lateinit var paint: Paint
+  private lateinit var path: Path
+  private var strokeWidth = 2f
+
+  constructor(context: Context) : super(context)
+  constructor(context: Context, attrs: AttributeSet) : super(context, attrs)
+  constructor(context: Context, attrs: AttributeSet, defStyleAttr: Int) : super(
+    context,
+    attrs,
+    defStyleAttr
+  )
+
+  init {
+    setupCurvePaint()
+  }
+
+  override fun onDraw(canvas: Canvas) {
+    if (isRtl)
+      rotationY = 180f
+    super.onDraw(canvas)
+
+    canvas.drawPath(path, paint)
+  }
+
+  override fun onSizeChanged(w: Int, h: Int, oldw: Int, oldh: Int) {
+    super.onSizeChanged(w, h, oldw, oldh)
+    val width = this.width.toFloat()
+    val height = this.height.toFloat()
+
+    val controlPoint1X = width * 0.5f
+    val controlPoint1Y = 0f
+
+    val controlPoint2X = width * 0.5f
+    val controlPoint2Y = height * 0.2f
+
+    val controlPoint3X = width * 1f
+    val controlPoint3Y = height * 0.1f
+
+    path.reset()
+    path.moveTo(0f, height * 0.1f)
+    path.cubicTo(
+      controlPoint1X,
+      controlPoint1Y,
+      controlPoint2X,
+      controlPoint2Y,
+      controlPoint3X,
+      controlPoint3Y
+    )
+
+    path.lineTo(width, height)
+    path.lineTo(0f, height)
+    path.lineTo(0f, 0f)
+  }
+
+  private fun setupCurvePaint() {
+    path = Path()
+    paint = Paint(Paint.ANTI_ALIAS_FLAG)
+    paint.apply {
+      style = Paint.Style.FILL_AND_STROKE
+      strokeWidth = [email protected]
+      color = ContextCompat.getColor(
+        context,
+        R.color.component_color_survey_onboarding_background_color
+      )
+    }
+    setBackgroundColor(Color.TRANSPARENT)
+  }
+
+  override fun onAttachedToWindow() {
+    super.onAttachedToWindow()
+
+    val viewComponentFactory = FragmentManager.findFragment<Fragment>(this) as ViewComponentFactory
+    val viewComponent = viewComponentFactory.createViewComponent(this) as ViewComponentImpl
+    viewComponent.inject(this)
+  }
+}

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

@@ -65,6 +65,10 @@ import org.oppia.android.app.shim.IntentFactoryShimModule
 import org.oppia.android.app.shim.ViewBindingShimModule
 import org.oppia.android.app.spotlight.SpotlightFragment
 import org.oppia.android.app.story.StoryFragment
+import org.oppia.android.app.survey.ExitSurveyConfirmationDialogFragment
+import org.oppia.android.app.survey.SurveyFragment
+import org.oppia.android.app.survey.SurveyOutroDialogFragment
+import org.oppia.android.app.survey.SurveyWelcomeDialogFragment
 import org.oppia.android.app.testing.DragDropTestFragment
 import org.oppia.android.app.testing.ExplorationTestActivityPresenter
 import org.oppia.android.app.testing.ImageRegionSelectionTestFragment
@@ -177,4 +181,8 @@ interface FragmentComponentImpl : FragmentComponent, ViewComponentBuilderInjecto
   fun inject(walkthroughFinalFragment: WalkthroughFinalFragment)
   fun inject(walkthroughTopicListFragment: WalkthroughTopicListFragment)
   fun inject(walkthroughWelcomeFragment: WalkthroughWelcomeFragment)
+  fun inject(surveyFragment: SurveyFragment)
+  fun inject(exitSurveyConfirmationDialogFragment: ExitSurveyConfirmationDialogFragment)
+  fun inject(surveyWelcomeDialogFragment: SurveyWelcomeDialogFragment)
+  fun inject(surveyOutroDialogFragment: SurveyOutroDialogFragment)
 }

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

@@ -19,20 +19,24 @@ import org.oppia.android.app.model.ExplorationActivityParams
 import org.oppia.android.app.model.ProfileId
 import org.oppia.android.app.model.ReadingTextSize
 import org.oppia.android.app.model.Spotlight
+import org.oppia.android.app.model.SurveyQuestionName
 import org.oppia.android.app.options.OptionsActivity
 import org.oppia.android.app.player.stopplaying.ProgressDatabaseFullDialogFragment
 import org.oppia.android.app.player.stopplaying.UnsavedExplorationDialogFragment
 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.survey.SurveyWelcomeDialogFragment
+import org.oppia.android.app.survey.TAG_SURVEY_WELCOME_DIALOG
 import org.oppia.android.app.topic.TopicActivity
 import org.oppia.android.app.translation.AppLanguageResourceHandler
 import org.oppia.android.app.utility.FontScaleConfigurationUtil
 import org.oppia.android.app.viewmodel.ViewModelProvider
 import org.oppia.android.databinding.ExplorationActivityBinding
 import org.oppia.android.domain.exploration.ExplorationDataController
 import org.oppia.android.domain.oppialogger.OppiaLogger
+import org.oppia.android.domain.survey.SurveyGatingController
 import org.oppia.android.domain.translation.TranslationController
 import org.oppia.android.util.data.AsyncResult
 import org.oppia.android.util.data.DataProviders.Companion.toLiveData
@@ -54,7 +58,8 @@ class ExplorationActivityPresenter @Inject constructor(
   private val fontScaleConfigurationUtil: FontScaleConfigurationUtil,
   private val translationController: TranslationController,
   private val oppiaLogger: OppiaLogger,
-  private val resourceHandler: AppLanguageResourceHandler
+  private val resourceHandler: AppLanguageResourceHandler,
+  private val surveyGatingController: SurveyGatingController
 ) {
   private lateinit var explorationToolbar: Toolbar
   private lateinit var explorationToolbarTitle: TextView
@@ -279,8 +284,9 @@ class ExplorationActivityPresenter @Inject constructor(
               oppiaLogger.e("ExplorationActivity", "Failed to stop exploration", it.error)
             is AsyncResult.Success -> {
               oppiaLogger.d("ExplorationActivity", "Successfully stopped exploration")
-              backPressActivitySelector()
-              (activity as ExplorationActivity).finish()
+              if (isCompletion) {
+                maybeShowSurveyDialog(profileId, topicId)
+              }
             }
           }
         }
@@ -304,6 +310,8 @@ class ExplorationActivityPresenter @Inject constructor(
    * current exploration.
    */
   fun backButtonPressed() {
+    // check if survey should be shown
+    maybeShowSurveyDialog(profileId, topicId)
     // If checkpointing is not enabled, show StopExplorationDialogFragment to exit the exploration,
     // this is expected to happen if the exploration is marked as completed.
     if (!isCheckpointingEnabled) {
@@ -500,4 +508,47 @@ class ExplorationActivityPresenter @Inject constructor(
       }
     }
   }
+
+  private fun maybeShowSurveyDialog(profileId: ProfileId, topicId: String) {
+    surveyGatingController.maybeShowSurvey(profileId, topicId).toLiveData()
+      .observe(
+        activity,
+        { gatingResult ->
+          when (gatingResult) {
+            is AsyncResult.Pending -> {
+              oppiaLogger.d("ExplorationActivity", "A gating decision is pending")
+            }
+            is AsyncResult.Failure -> {
+              oppiaLogger.e(
+                "ExplorationActivity",
+                "Failed to retrieve gating decision",
+                gatingResult.error
+              )
+              backPressActivitySelector()
+            }
+            is AsyncResult.Success -> {
+              if (gatingResult.value) {
+                val dialogFragment =
+                  SurveyWelcomeDialogFragment.newInstance(profileId, topicId, SURVEY_QUESTIONS)
+                val transaction = activity.supportFragmentManager.beginTransaction()
+                transaction
+                  .add(dialogFragment, TAG_SURVEY_WELCOME_DIALOG)
+                  .addToBackStack(null)
+                  .commit()
+              } else {
+                backPressActivitySelector()
+              }
+            }
+          }
+        }
+      )
+  }
+
+  companion object {
+    private val SURVEY_QUESTIONS = listOf(
+      SurveyQuestionName.USER_TYPE,
+      SurveyQuestionName.MARKET_FIT,
+      SurveyQuestionName.NPS
+    )
+  }
 }