Migrate QuestionnaireEditRecyclerview to compose (#2884)

* Migrate QuestionnaireEditRecyclerview to compose

Signed-off-by: Elly Kitoto <[email protected]>

* Fix formatting

Signed-off-by: Elly Kitoto <[email protected]>

* Fix questionnaire edit view rendering in lazycolumn

- Fixed duplicate ids when using repeated groups
- Fixed issues with progress indicator upon scroll
- Fixed issues with showing validation errors
- Fixed issues with state management on individual lazy column rows that renders
form widgets. Tag the created views with the viewholder, and call viewholder bind
method to update view content.

Signed-off-by: Elly Kitoto <[email protected]>

* Throw exception if questionnaire field linkId is not provided

Every field in a questionnaire is expected to have a unique linkId.

Signed-off-by: Elly Kitoto <[email protected]>

* Update tests

Signed-off-by: Elly Kitoto <[email protected]>

* Run spotlessApply

Signed-off-by: Elly Kitoto <[email protected]>

* Add TODO to remove viewholder tagging

View holder tagging on on composable views will no longer be necessary
once all the views are migrated to compose.

Signed-off-by: Elly Kitoto <[email protected]>

* Fix rendering of nested repeated groups within repeated groups

In order to prevent LazyColumn id name collisions when repeated groups are nested
arbitrarily deep, the questionnaire ID is generated from the string derived from
tracking all the accumulated paths from all ancestor repeated groups through
recursive calls.

Signed-off-by: Elly Kitoto <[email protected]>

* Resolve unnessary recompositions in QuestionnaireEditList lazy column

Commented code that invokes the handelInput function that triggers
state change causing multiple recomposition.

Added the onRest callback to the LazyColumn's AndroidView to reset
the view before the update function is called during recomposition.

Signed-off-by: Elly Kitoto <[email protected]>

* Fix code formatting issues

Signed-off-by: Elly Kitoto <[email protected]>

* Run spotless

Signed-off-by: Elly Kitoto <[email protected]>

* Clean up code

Signed-off-by: Elly Kitoto <[email protected]>

---------

Signed-off-by: Elly Kitoto <[email protected]>

Author: ellykits

datacapture/src/androidTest/java/com/google/android/fhir/datacapture/contrib/views/PhoneNumberViewHolderFactoryInstrumentedTest.kt

@@ -31,8 +31,6 @@ import androidx.compose.ui.test.performTextReplacement
 import androidx.test.ext.junit.rules.ActivityScenarioRule
 import androidx.test.ext.junit.runners.AndroidJUnit4
 import androidx.test.platform.app.InstrumentationRegistry
-import com.google.android.fhir.datacapture.QuestionnaireEditAdapter
-import com.google.android.fhir.datacapture.QuestionnaireViewHolderType
 import com.google.android.fhir.datacapture.R
 import com.google.android.fhir.datacapture.test.TestActivity
 import com.google.android.fhir.datacapture.validation.Invalid
@@ -83,25 +81,6 @@ class PhoneNumberViewHolderFactoryInstrumentedTest {
     composeTestRule.unregisterIdlingResource(handlingTextIdlingResource)
   }
 
-  @Test
-  fun createViewHolder_phoneNumberViewHolderFactory_returnsViewHolder() {
-    val questionnaireEditAdapter = QuestionnaireEditAdapter()
-    val viewHolderFromAdapter =
-      questionnaireEditAdapter.createViewHolder(
-        parent,
-        QuestionnaireEditAdapter.ViewType.from(
-            type = QuestionnaireEditAdapter.ViewType.Type.QUESTION,
-            subtype = QuestionnaireViewHolderType.PHONE_NUMBER.value,
-          )
-          .viewType,
-      ) as QuestionnaireEditAdapter.ViewHolder.QuestionHolder
-
-    assertThat(
-        viewHolderFromAdapter.holder.itemView.visibility,
-      )
-      .isEqualTo(View.VISIBLE)
-  }
-
   @Test
   fun shouldSetTextViewText() {
     viewHolder.bind(

datacapture/src/androidTest/java/com/google/android/fhir/datacapture/test/QuestionnaireUiEspressoTest.kt

@@ -21,31 +21,26 @@ import android.os.Bundle
 import android.view.LayoutInflater
 import android.view.View
 import android.view.ViewGroup
-import android.widget.LinearLayout
 import android.widget.TextView
 import androidx.annotation.VisibleForTesting
 import androidx.appcompat.view.ContextThemeWrapper
-import androidx.compose.foundation.layout.fillMaxWidth
-import androidx.compose.foundation.lazy.LazyColumn
-import androidx.compose.foundation.lazy.items
-import androidx.compose.runtime.Composable
-import androidx.compose.ui.Modifier
 import androidx.compose.ui.platform.ComposeView
-import androidx.compose.ui.viewinterop.AndroidView
 import androidx.core.content.res.use
 import androidx.core.os.bundleOf
 import androidx.fragment.app.Fragment
 import androidx.fragment.app.activityViewModels
 import androidx.fragment.app.setFragmentResult
 import androidx.fragment.app.viewModels
+import androidx.lifecycle.Lifecycle
 import androidx.lifecycle.lifecycleScope
-import androidx.recyclerview.widget.LinearLayoutManager
-import androidx.recyclerview.widget.RecyclerView
-import com.google.android.fhir.datacapture.extensions.inflate
+import androidx.lifecycle.repeatOnLifecycle
+import com.google.android.fhir.datacapture.QuestionnaireFragment.Companion.EXTRA_QUESTIONNAIRE_JSON_STRING
+import com.google.android.fhir.datacapture.QuestionnaireFragment.Companion.EXTRA_QUESTIONNAIRE_JSON_URI
+import com.google.android.fhir.datacapture.QuestionnaireFragment.Companion.EXTRA_QUESTIONNAIRE_RESPONSE_JSON_STRING
+import com.google.android.fhir.datacapture.QuestionnaireFragment.Companion.EXTRA_QUESTIONNAIRE_RESPONSE_JSON_URI
 import com.google.android.fhir.datacapture.validation.Invalid
 import com.google.android.fhir.datacapture.views.NavigationViewHolder
 import com.google.android.fhir.datacapture.views.factories.QuestionnaireItemViewHolderFactory
-import com.google.android.fhir.datacapture.views.factories.ReviewViewHolderFactory
 import com.google.android.material.progressindicator.LinearProgressIndicator
 import kotlinx.coroutines.launch
 import org.hl7.fhir.r4.model.Questionnaire
@@ -101,8 +96,8 @@ class QuestionnaireFragment : Fragment() {
 
   /** @suppress */
   override fun onViewCreated(view: View, savedInstanceState: Bundle?) {
-    val questionnaireEditRecyclerView =
-      view.findViewById<RecyclerView>(R.id.questionnaire_edit_recycler_view)
+    val questionnaireEditComposeView =
+      view.findViewById<ComposeView>(R.id.questionnaire_edit_compose_view)
     val questionnaireReviewComposeView =
       view.findViewById<ComposeView>(R.id.questionnaire_review_recycler_view)
     val questionnaireTitle = view.findViewById<TextView>(R.id.questionnaire_title)
@@ -147,103 +142,97 @@ class QuestionnaireFragment : Fragment() {
     }
     val questionnaireProgressIndicator: LinearProgressIndicator =
       view.findViewById(R.id.questionnaire_progress_indicator)
-    val questionnaireEditAdapter =
-      QuestionnaireEditAdapter(questionnaireItemViewHolderFactoryMatchersProvider.get())
 
     val reviewModeEditButton =
       view.findViewById<View>(R.id.review_mode_edit_button).apply {
         setOnClickListener { viewModel.setReviewMode(false) }
       }
 
-    questionnaireEditRecyclerView.adapter = questionnaireEditAdapter
-    val linearLayoutManager = LinearLayoutManager(view.context)
-    questionnaireEditRecyclerView.layoutManager = linearLayoutManager
-    // Animation does work well with views that could gain focus
-    questionnaireEditRecyclerView.itemAnimator = null
-
     // Listen to updates from the view model.
-    viewLifecycleOwner.lifecycleScope.launchWhenCreated {
-      viewModel.questionnaireStateFlow.collect { state ->
-        when (val displayMode = state.displayMode) {
-          is DisplayMode.ReviewMode -> {
-            // Set items
-            questionnaireEditRecyclerView.visibility = View.GONE
-
-            questionnaireReviewComposeView.visibility = View.VISIBLE
-            questionnaireReviewComposeView.setContent { QuestionnaireReviewList(state.items) }
-            reviewModeEditButton.visibility =
-              if (displayMode.showEditButton) {
-                View.VISIBLE
+    viewLifecycleOwner.lifecycleScope.launch {
+      viewLifecycleOwner.repeatOnLifecycle(Lifecycle.State.CREATED) {
+        viewModel.questionnaireStateFlow.collect { state ->
+          when (val displayMode = state.displayMode) {
+            is DisplayMode.ReviewMode -> {
+              // Set items
+
+              questionnaireReviewComposeView.visibility = View.VISIBLE
+              questionnaireReviewComposeView.setContent { QuestionnaireReviewList(state.items) }
+              questionnaireEditComposeView.visibility = View.GONE
+
+              reviewModeEditButton.visibility =
+                if (displayMode.showEditButton) {
+                  View.VISIBLE
+                } else {
+                  View.GONE
+                }
+              questionnaireTitle.visibility = View.VISIBLE
+              questionnaireTitle.text = getString(R.string.questionnaire_review_mode_title)
+
+              // Set bottom navigation
+              if (state.bottomNavItem != null) {
+                bottomNavContainerFrame.visibility = View.VISIBLE
+                NavigationViewHolder(bottomNavContainerFrame)
+                  .bind(state.bottomNavItem.questionnaireNavigationUIState)
               } else {
-                View.GONE
+                bottomNavContainerFrame.visibility = View.GONE
               }
-            questionnaireTitle.visibility = View.VISIBLE
-            questionnaireTitle.text = getString(R.string.questionnaire_review_mode_title)
-
-            // Set bottom navigation
-            if (state.bottomNavItem != null) {
-              bottomNavContainerFrame.visibility = View.VISIBLE
-              NavigationViewHolder(bottomNavContainerFrame)
-                .bind(state.bottomNavItem.questionnaireNavigationUIState)
-            } else {
-              bottomNavContainerFrame.visibility = View.GONE
-            }
 
-            // Hide progress indicator
-            questionnaireProgressIndicator.visibility = View.GONE
-          }
-          is DisplayMode.EditMode -> {
-            // Set items
-            questionnaireReviewComposeView.visibility = View.GONE
-            questionnaireEditAdapter.submitList(state.items)
-            questionnaireEditRecyclerView.visibility = View.VISIBLE
-            reviewModeEditButton.visibility = View.GONE
-            questionnaireTitle.visibility = View.GONE
-
-            // Set bottom navigation
-            if (state.bottomNavItem != null) {
-              bottomNavContainerFrame.visibility = View.VISIBLE
-              NavigationViewHolder(bottomNavContainerFrame)
-                .bind(state.bottomNavItem.questionnaireNavigationUIState)
-            } else {
-              bottomNavContainerFrame.visibility = View.GONE
+              // Hide progress indicator
+              questionnaireProgressIndicator.visibility = View.GONE
             }
-
-            // Set progress indicator
-            questionnaireProgressIndicator.visibility = View.VISIBLE
-            if (displayMode.pagination.isPaginated) {
-              questionnaireProgressIndicator.updateProgressIndicator(
-                calculateProgressPercentage(
-                  count =
-                    (displayMode.pagination.currentPageIndex +
-                      1), // incremented by 1 due to initialPageIndex starts with 0.
-                  totalCount = displayMode.pagination.pages.size,
-                ),
-              )
-            } else {
-              questionnaireEditRecyclerView.addOnScrollListener(
-                object : RecyclerView.OnScrollListener() {
-                  override fun onScrolled(recyclerView: RecyclerView, dx: Int, dy: Int) {
-                    super.onScrolled(recyclerView, dx, dy)
+            is DisplayMode.EditMode -> {
+              // Set items
+              questionnaireReviewComposeView.visibility = View.GONE
+              questionnaireEditComposeView.setContent {
+                QuestionnaireEditList(
+                  items = state.items,
+                  displayMode = displayMode,
+                  questionnaireItemViewHolderMatchers =
+                    questionnaireItemViewHolderFactoryMatchersProvider.get(),
+                  onUpdateProgressIndicator = { currentPage, totalCount ->
                     questionnaireProgressIndicator.updateProgressIndicator(
                       calculateProgressPercentage(
-                        count =
-                          (linearLayoutManager.findLastVisibleItemPosition() +
-                            1), // incremented by 1 due to findLastVisiblePosition() starts with 0.
-                        totalCount = linearLayoutManager.itemCount,
+                        count = (currentPage + 1),
+                        totalCount = totalCount,
                       ),
                     )
-                  }
-                },
-              )
+                  },
+                )
+              }
+              questionnaireEditComposeView.visibility = View.VISIBLE
+              reviewModeEditButton.visibility = View.GONE
+              questionnaireTitle.visibility = View.GONE
+
+              // Set bottom navigation
+              if (state.bottomNavItem != null) {
+                bottomNavContainerFrame.visibility = View.VISIBLE
+                NavigationViewHolder(bottomNavContainerFrame)
+                  .bind(state.bottomNavItem.questionnaireNavigationUIState)
+              } else {
+                bottomNavContainerFrame.visibility = View.GONE
+              }
+
+              // Set progress indicator
+              questionnaireProgressIndicator.visibility = View.VISIBLE
+              if (displayMode.pagination.isPaginated) {
+                questionnaireProgressIndicator.updateProgressIndicator(
+                  calculateProgressPercentage(
+                    count =
+                      (displayMode.pagination.currentPageIndex +
+                        1), // incremented by 1 due to initialPageIndex starts with 0.
+                    totalCount = displayMode.pagination.pages.size,
+                  ),
+                )
+              }
+            }
+            is DisplayMode.InitMode -> {
+              questionnaireReviewComposeView.visibility = View.GONE
+              questionnaireEditComposeView.visibility = View.GONE
+              questionnaireProgressIndicator.visibility = View.GONE
+              reviewModeEditButton.visibility = View.GONE
+              bottomNavContainerFrame.visibility = View.GONE
             }
-          }
-          is DisplayMode.InitMode -> {
-            questionnaireReviewComposeView.visibility = View.GONE
-            questionnaireEditRecyclerView.visibility = View.GONE
-            questionnaireProgressIndicator.visibility = View.GONE
-            reviewModeEditButton.visibility = View.GONE
-            bottomNavContainerFrame.visibility = View.GONE
           }
         }
       }
@@ -288,53 +277,6 @@ class QuestionnaireFragment : Fragment() {
     }
   }
 
-  @Composable
-  private fun QuestionnaireReviewList(items: List<QuestionnaireAdapterItem>) {
-    LazyColumn {
-      items(
-        items = items,
-        key = { item ->
-          when (item) {
-            is QuestionnaireAdapterItem.Question -> item.id
-                ?: throw IllegalStateException("Missing id for the Question: $item")
-            is QuestionnaireAdapterItem.RepeatedGroupHeader -> item.id
-            is QuestionnaireAdapterItem.Navigation -> "navigation"
-            is QuestionnaireAdapterItem.RepeatedGroupAddButton -> item.id
-                ?: throw IllegalStateException("Missing id for the RepeatedGroupAddButton: $item")
-          }
-        },
-      ) { item: QuestionnaireAdapterItem ->
-        AndroidView(
-          factory = { context ->
-            LinearLayout(context).apply {
-              orientation = LinearLayout.VERTICAL
-              when (item) {
-                is QuestionnaireAdapterItem.Question -> {
-                  val viewHolder = ReviewViewHolderFactory.create(this)
-                  viewHolder.bind(item.item)
-                  addView(viewHolder.itemView)
-                }
-                is QuestionnaireAdapterItem.Navigation -> {
-                  val viewHolder =
-                    NavigationViewHolder(inflate(R.layout.pagination_navigation_view))
-                  viewHolder.bind(item.questionnaireNavigationUIState)
-                  addView(viewHolder.itemView)
-                }
-                is QuestionnaireAdapterItem.RepeatedGroupHeader -> {
-                  TODO("Not implemented yet")
-                }
-                is QuestionnaireAdapterItem.RepeatedGroupAddButton -> {
-                  TODO("Not implemented yet")
-                }
-              }
-            }
-          },
-          modifier = Modifier.fillMaxWidth(),
-        )
-      }
-    }
-  }
-
   /** Calculates the progress percentage from given [count] and [totalCount] values. */
   internal fun calculateProgressPercentage(count: Int, totalCount: Int): Int {
     return if (totalCount == 0) 0 else (count * 100 / totalCount)
@@ -589,6 +531,9 @@ class QuestionnaireFragment : Fragment() {
      */
     internal const val EXTRA_SHOW_SUBMIT_ANYWAY_BUTTON = "show-submit-anyway-button"
 
+    /** Test tag for QuestionnaireEditList */
+    const val QUESTIONNAIRE_EDIT_LIST = "questionnaire_edit_list"
+
     fun builder() = Builder()
   }