1001 fix form validation opensrp

datacapture/src/main/java/com/google/android/fhir/datacapture/validation/RequiredConstraintValidator.kt

@@ -27,12 +27,12 @@ internal object RequiredConstraintValidator : ConstraintValidator {
     questionnaireResponseItem: QuestionnaireResponse.QuestionnaireResponseItemComponent,
     context: Context
   ): ConstraintValidator.ConstraintValidationResult {
-    if (questionnaireItem.required && questionnaireResponseItem.answer.isEmpty()) {
-      return ConstraintValidator.ConstraintValidationResult(
-        false,
-        context.getString(R.string.required_constraint_validation_error_msg)
-      )
+    if (!questionnaireItem.required || questionnaireResponseItem.answer.any { it.hasValue() }) {
+      return ConstraintValidator.ConstraintValidationResult(true, null)
     }
-    return ConstraintValidator.ConstraintValidationResult(true, null)
+    return ConstraintValidator.ConstraintValidationResult(
+      false,
+      context.getString(R.string.required_constraint_validation_error_msg)
+    )
   }
 }

datacapture/src/main/java/com/google/android/fhir/datacapture/views/QuestionnaireItemEditTextStringViewHolderDelegate.kt

@@ -35,13 +35,8 @@ internal class QuestionnaireItemEditTextStringViewHolderDelegate(isSingleLine: B
   override fun getValue(
     text: String
   ): QuestionnaireResponse.QuestionnaireResponseItemAnswerComponent? {
-    return text.let {
-      if (it.isEmpty()) {
-        null
-      } else {
-        QuestionnaireResponse.QuestionnaireResponseItemAnswerComponent().setValue(StringType(it))
-      }
-    }
+    return QuestionnaireResponse.QuestionnaireResponseItemAnswerComponent()
+      .setValue(StringType(text))
   }
 
   override fun getText(

datacapture/src/main/java/com/google/android/fhir/datacapture/views/QuestionnaireItemEditTextViewHolderFactory.kt

@@ -18,6 +18,7 @@ package com.google.android.fhir.datacapture.views
 
 import android.content.Context
 import android.text.Editable
+import android.text.TextWatcher
 import android.view.View
 import android.view.View.FOCUS_DOWN
 import android.view.inputmethod.EditorInfo
@@ -45,23 +46,30 @@ internal abstract class QuestionnaireItemEditTextViewHolderDelegate(
   private lateinit var textInputLayout: TextInputLayout
   private lateinit var textInputEditText: TextInputEditText
   override lateinit var questionnaireItemViewItem: QuestionnaireItemViewItem
+  private var textWatcher: TextWatcher? = null
 
   override fun init(itemView: View) {
     header = itemView.findViewById(R.id.header)
     textInputLayout = itemView.findViewById(R.id.text_input_layout)
     textInputEditText = itemView.findViewById(R.id.text_input_edit_text)
     textInputEditText.setRawInputType(rawInputType)
     textInputEditText.isSingleLine = isSingleLine
-    textInputEditText.doAfterTextChanged { editable: Editable? ->
-      questionnaireItemViewItem.singleAnswerOrNull = getValue(editable.toString())
-      onAnswerChanged(textInputEditText.context)
-    }
   }
 
   override fun bind(questionnaireItemViewItem: QuestionnaireItemViewItem) {
     header.bind(questionnaireItemViewItem.questionnaireItem)
     textInputLayout.hint = questionnaireItemViewItem.questionnaireItem.localizedFlyoverSpanned
-    textInputEditText.setText(getText(questionnaireItemViewItem.singleAnswerOrNull))
+    textInputEditText.removeTextChangedListener(textWatcher)
+
+    val answer = questionnaireItemViewItem.singleAnswerOrNull
+    if (answer == null) {
+      // Clear the text input and any error message if the question has not been answered.
+      textInputEditText.setText("")
+      displayValidationResult(ValidationResult(true, listOf()))
+    } else {
+      textInputEditText.setText(getText(answer))
+      onAnswerChanged(textInputEditText.context)
+    }
     textInputEditText.setOnFocusChangeListener { view, focused ->
       if (!focused) {
         (view.context.applicationContext.getSystemService(Context.INPUT_METHOD_SERVICE) as
@@ -79,6 +87,11 @@ internal abstract class QuestionnaireItemEditTextViewHolderDelegate(
       }
       view.focusSearch(FOCUS_DOWN)?.requestFocus(FOCUS_DOWN) ?: false
     }
+    textWatcher =
+      textInputEditText.doAfterTextChanged { editable: Editable? ->
+        questionnaireItemViewItem.singleAnswerOrNull = getValue(editable.toString())
+        onAnswerChanged(textInputEditText.context)
+      }
   }
 
   override fun displayValidationResult(validationResult: ValidationResult) {

datacapture/src/main/java/com/google/android/fhir/datacapture/views/QuestionnaireItemViewHolderFactory.kt

@@ -62,7 +62,16 @@ open class QuestionnaireItemViewHolder(
     delegate.questionnaireItemViewItem = questionnaireItemViewItem
     delegate.bind(questionnaireItemViewItem)
     delegate.setReadOnly(questionnaireItemViewItem.questionnaireItem.readOnly)
-    delegate.displayValidationResult(delegate.getValidationResult(itemView.context))
+    // Only validate questionnaire items with answer(s). This is so that we do not show all the
+    // validation errors at once when the user opens a new questionnaire for the first time.
+    // Instead, the validation errors are shown when the user goes through each question.
+    // Notice the difference between a questionnaire response item without answer, and a
+    // questionnaire with an answer without value.
+    if (delegate.questionnaireItemViewItem.modified ||
+        delegate.questionnaireItemViewItem.questionnaireResponseItem.answer.size > 0
+    ) {
+      delegate.displayValidationResult(delegate.getValidationResult(itemView.context))
+    }
   }
 }
 
@@ -101,6 +110,9 @@ interface QuestionnaireItemViewHolderDelegate {
    */
   fun onAnswerChanged(context: Context) {
     questionnaireItemViewItem.questionnaireResponseItemChangedCallback()
+    // purpose of this field is to let the validation execute ( if the answer has been added, this
+    // tells that the User has made an interaction to that particular input field
+    questionnaireItemViewItem.modified = true
     displayValidationResult(getValidationResult(context))
   }
 

datacapture/src/main/java/com/google/android/fhir/datacapture/views/QuestionnaireItemViewItem.kt

@@ -35,6 +35,10 @@ import org.hl7.fhir.r4.model.QuestionnaireResponse
  * @param questionnaireResponseItemChangedCallback function that should be called whenever the
  * `questionnaireResponseItemBuilder` is changed to inform the rest of the questionnaire to be
  * updated
+ *
+ * @param modified True once user has interacted with the questionnaire item (when `onAnswerChanged`
+ * triggers). Only modified fields will be validated. This is to avoid an influx of validation
+ * errors when the user first opens the questionnaire.
  */
 data class QuestionnaireItemViewItem(
   val questionnaireItem: Questionnaire.QuestionnaireItemComponent,
@@ -44,6 +48,7 @@ data class QuestionnaireItemViewItem(
       {
     emptyList()
   },
+  var modified: Boolean = false,
   val questionnaireResponseItemChangedCallback: () -> Unit
 ) {
   /**

datacapture/src/test/java/com/google/android/fhir/datacapture/validation/RequiredConstraintValidatorTest.kt

@@ -66,4 +66,25 @@ class RequiredConstraintValidatorTest {
     assertThat(validationResult.isValid).isFalse()
     assertThat(validationResult.message).isEqualTo("Missing answer for required field.")
   }
+
+  @Test
+  fun shouldReturnInvalidResult_noAnswerHasValue() {
+    val questionnaireItem = Questionnaire.QuestionnaireItemComponent().apply { required = true }
+    val questionnaireResponseItem =
+      QuestionnaireResponse.QuestionnaireResponseItemComponent().apply {
+        // one answer with no value
+        addAnswer(QuestionnaireResponse.QuestionnaireResponseItemAnswerComponent())
+        // second answer with no value
+        addAnswer(QuestionnaireResponse.QuestionnaireResponseItemAnswerComponent())
+      }
+
+    val validationResult =
+      RequiredConstraintValidator.validate(
+        questionnaireItem,
+        questionnaireResponseItem,
+        InstrumentationRegistry.getInstrumentation().context
+      )
+    assertThat(validationResult.isValid).isFalse()
+    assertThat(validationResult.message).isEqualTo("Missing answer for required field.")
+  }
 }

datacapture/src/test/java/com/google/android/fhir/datacapture/views/QuestionnaireItemAutoCompleteViewHolderFactoryTest.kt

@@ -19,9 +19,11 @@ package com.google.android.fhir.datacapture.views
 import android.view.ViewGroup
 import android.widget.FrameLayout
 import android.widget.TextView
+import androidx.core.view.children
 import androidx.core.view.get
 import com.google.android.fhir.datacapture.R
 import com.google.android.fhir.datacapture.displayString
+import com.google.android.material.chip.Chip
 import com.google.android.material.textfield.TextInputLayout
 import com.google.common.truth.Truth.assertThat
 import org.hl7.fhir.r4.model.Coding
@@ -162,14 +164,44 @@ class QuestionnaireItemAutoCompleteViewHolderFactoryInstrumentedTest {
     viewHolder.bind(
       QuestionnaireItemViewItem(
         Questionnaire.QuestionnaireItemComponent().apply { required = true },
-        QuestionnaireResponse.QuestionnaireResponseItemComponent()
+        QuestionnaireResponse.QuestionnaireResponseItemComponent(),
+        modified = true
       ) {}
     )
 
     assertThat(viewHolder.itemView.findViewById<TextInputLayout>(R.id.text_input_layout).error)
       .isEqualTo("Missing answer for required field.")
   }
 
+  @Test
+  fun displayValidationResult_showErrorWhenAnswersAreRemoved() {
+    val questionnaire =
+      Questionnaire.QuestionnaireItemComponent().apply {
+        required = true
+        addAnswerOption(
+          Questionnaire.QuestionnaireItemAnswerOptionComponent().apply {
+            value = Coding().apply { display = "display" }
+          }
+        )
+      }
+    val questionnaireResponseWithAnswer =
+      QuestionnaireResponse.QuestionnaireResponseItemComponent().apply {
+        addAnswer(
+          QuestionnaireResponse.QuestionnaireResponseItemAnswerComponent().apply {
+            value = Coding().apply { display = "display" }
+          }
+        )
+      }
+
+    viewHolder.bind(QuestionnaireItemViewItem(questionnaire, questionnaireResponseWithAnswer) {})
+
+    (viewHolder.itemView.findViewById<ViewGroup>(R.id.flexboxLayout).children.first() as Chip)
+      .performCloseIconClick()
+
+    assertThat(viewHolder.itemView.findViewById<TextInputLayout>(R.id.text_input_layout).error)
+      .isEqualTo("Missing answer for required field.")
+  }
+
   @Test
   fun displayValidationResult_noError_shouldShowNoErrorMessage() {
     viewHolder.bind(

datacapture/src/test/java/com/google/android/fhir/datacapture/views/QuestionnaireItemBooleanTypePickerViewHolderFactoryTest.kt

@@ -280,7 +280,8 @@ class QuestionnaireItemBooleanTypePickerViewHolderFactoryTest {
     viewHolder.bind(
       QuestionnaireItemViewItem(
         Questionnaire.QuestionnaireItemComponent().apply { required = true },
-        QuestionnaireResponse.QuestionnaireResponseItemComponent()
+        QuestionnaireResponse.QuestionnaireResponseItemComponent(),
+        modified = true
       ) {}
     )
 

datacapture/src/test/java/com/google/android/fhir/datacapture/views/QuestionnaireItemCheckBoxGroupViewHolderFactoryTest.kt

@@ -343,7 +343,8 @@ class QuestionnaireItemCheckBoxGroupViewHolderFactoryTest {
           repeats = true
           required = true
         },
-        QuestionnaireResponse.QuestionnaireResponseItemComponent()
+        QuestionnaireResponse.QuestionnaireResponseItemComponent(),
+        modified = true
       ) {}
     )
 

datacapture/src/test/java/com/google/android/fhir/datacapture/views/QuestionnaireItemDateTimePickerViewHolderFactoryTest.kt

@@ -107,7 +107,8 @@ class QuestionnaireItemDateTimePickerViewHolderFactoryTest {
     viewHolder.bind(
       QuestionnaireItemViewItem(
         Questionnaire.QuestionnaireItemComponent().apply { required = true },
-        QuestionnaireResponse.QuestionnaireResponseItemComponent()
+        QuestionnaireResponse.QuestionnaireResponseItemComponent(),
+        modified = true
       ) {}
     )
 

datacapture/src/test/java/com/google/android/fhir/datacapture/views/QuestionnaireItemDropDownViewHolderFactoryTest.kt

@@ -189,7 +189,8 @@ class QuestionnaireItemDropDownViewHolderFactoryTest {
     viewHolder.bind(
       QuestionnaireItemViewItem(
         Questionnaire.QuestionnaireItemComponent().apply { required = true },
-        QuestionnaireResponse.QuestionnaireResponseItemComponent()
+        QuestionnaireResponse.QuestionnaireResponseItemComponent(),
+        modified = true
       ) {}
     )
 

datacapture/src/test/java/com/google/android/fhir/datacapture/views/QuestionnaireItemEditTextMultiLineViewHolderFactoryTest.kt

@@ -133,7 +133,6 @@ class QuestionnaireItemEditTextMultiLineViewHolderFactoryTest {
       ) {}
 
     viewHolder.bind(questionnaireItemViewItem)
-    viewHolder.itemView.findViewById<TextInputEditText>(R.id.text_input_edit_text).setText("")
 
     assertThat(questionnaireItemViewItem.questionnaireResponseItem.answer.size).isEqualTo(0)
   }

datacapture/src/test/java/com/google/android/fhir/datacapture/views/QuestionnaireItemEditTextQuantityViewHolderFactoryTest.kt

@@ -156,7 +156,8 @@ class QuestionnaireItemEditTextQuantityViewHolderFactoryTest {
     viewHolder.bind(
       QuestionnaireItemViewItem(
         Questionnaire.QuestionnaireItemComponent().apply { required = true },
-        QuestionnaireResponse.QuestionnaireResponseItemComponent()
+        QuestionnaireResponse.QuestionnaireResponseItemComponent(),
+        modified = true
       ) {}
     )
 

datacapture/src/test/java/com/google/android/fhir/datacapture/views/QuestionnaireItemEditTextSingleLineViewHolderFactoryTest.kt

@@ -131,7 +131,6 @@ class QuestionnaireItemEditTextSingleLineViewHolderFactoryTest {
       ) {}
 
     viewHolder.bind(questionnaireItemViewItem)
-    viewHolder.itemView.findViewById<TextInputEditText>(R.id.text_input_edit_text).setText("")
 
     assertThat(questionnaireItemViewItem.questionnaireResponseItem.answer.size).isEqualTo(0)
   }

datacapture/src/test/java/com/google/android/fhir/datacapture/views/QuestionnaireItemGroupViewHolderFactoryTest.kt

@@ -55,7 +55,8 @@ class QuestionnaireItemGroupViewHolderFactoryTest {
     viewHolder.bind(
       QuestionnaireItemViewItem(
         Questionnaire.QuestionnaireItemComponent().apply { required = true },
-        QuestionnaireResponse.QuestionnaireResponseItemComponent()
+        QuestionnaireResponse.QuestionnaireResponseItemComponent(),
+        modified = true
       ) {}
     )
 

datacapture/src/test/java/com/google/android/fhir/datacapture/views/QuestionnaireItemRadioGroupViewHolderFactoryTest.kt

@@ -306,7 +306,8 @@ class QuestionnaireItemRadioGroupViewHolderFactoryTest {
     viewHolder.bind(
       QuestionnaireItemViewItem(
         Questionnaire.QuestionnaireItemComponent().apply { required = true },
-        QuestionnaireResponse.QuestionnaireResponseItemComponent()
+        QuestionnaireResponse.QuestionnaireResponseItemComponent(),
+        modified = true
       ) {}
     )
 

demo/src/main/assets/new-patient-registration-paginated.json

@@ -383,6 +383,74 @@
               }
             ]
           }
+        },
+        {
+          "type": "choice",
+          "repeats": true,
+          "code": [],
+          "extension": [
+            {
+              "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl",
+              "valueCodeableConcept": {
+                "coding": [
+                  {
+                    "system": "http://hl7.org/fhir/questionnaire-item-control",
+                    "code": "autocomplete",
+                    "display": "Auto-complete"
+                  }
+                ],
+                "text": "Auto-complete"
+              }
+            }
+          ],
+          "required": true,
+          "linkId": "4",
+          "text": "Do you have any existing conditions",
+          "prefix": "Q4:",
+          "answerOption": [
+            {
+              "valueCoding": {
+                "code": "asthma",
+                "display": "Asthma"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "copd",
+                "display": "Chronic Lung Disease"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "depression",
+                "display": "Depression"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "t2dm",
+                "display": "Diabetes"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "hypertension",
+                "display": "Hypertension"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "hypertension",
+                "display": "High Blood Pressure"
+              }
+            },
+            {
+              "valueCoding": {
+                "code": "hypercholesterolaemia",
+                "display": "High Cholesterol"
+              }
+            }
+          ]
         }
       ]
     }