Handle scrolling to question by introducing a separate parameter

Author: grzesiek2010

collect_app/src/main/java/org/odk/collect/android/activities/FormFillingActivity.java

@@ -564,14 +564,15 @@ private void setupViewModels(FormEntryViewModelFactory formEntryViewModelFactory
 
         formEntryViewModel.getCurrentIndex().observe(this, indexAndValidationResult -> {
             if (indexAndValidationResult != null) {
-                FormIndex formIndex = indexAndValidationResult.component1();
-                FailedValidationResult validationResult = indexAndValidationResult.component2();
-                formIndexAnimationHandler.handle(formIndex);
+                FormIndex screenIndex = indexAndValidationResult.getFirst();
+                FormIndex questionIndex = indexAndValidationResult.getSecond();
+                FailedValidationResult validationResult = indexAndValidationResult.getThird();
+                formIndexAnimationHandler.handle(screenIndex);
                 if (validationResult != null) {
                     handleValidationResult(validationResult);
                 } else {
                     if (odkView != null) {
-                        odkView.scrollToTopOf(formIndex);
+                        odkView.scrollToTopOf(questionIndex);
                     }
                 }
             }

collect_app/src/main/java/org/odk/collect/android/formentry/FormEntryViewModel.java

@@ -54,7 +54,7 @@
 import java.util.Objects;
 import java.util.function.Supplier;
 
-import kotlin.Pair;
+import kotlin.Triple;
 import timber.log.Timber;
 
 public class FormEntryViewModel extends ViewModel implements SelectChoiceLoader {
@@ -63,7 +63,7 @@ public class FormEntryViewModel extends ViewModel implements SelectChoiceLoader
 
     private final MutableLiveData<FormError> error = new MutableLiveData<>(null);
     private final MutableNonNullLiveData<Boolean> hasBackgroundRecording = new MutableNonNullLiveData<>(false);
-    private final MutableLiveData<Pair<FormIndex, FailedValidationResult>> currentIndex = new MutableLiveData<>(null);
+    private final MutableLiveData<Triple<FormIndex, FormIndex, FailedValidationResult>> currentIndex = new MutableLiveData<>(null);
     private final MutableLiveData<Consumable<ValidationResult>>
             validationResult = new MutableLiveData<>(new Consumable<>(null));
     @NonNull
@@ -118,7 +118,7 @@ public FormController getFormController() {
         return formController;
     }
 
-    public LiveData<Pair<FormIndex, FailedValidationResult>> getCurrentIndex() {
+    public LiveData<Triple<FormIndex, FormIndex, FailedValidationResult>> getCurrentIndex() {
         return currentIndex;
     }
 
@@ -379,9 +379,9 @@ private void updateIndex(boolean isAsync, @Nullable FailedValidationResult valid
 
             AuditUtils.logCurrentScreen(formController, formController.getAuditEventLogger(), clock.get());
             if (isAsync) {
-                currentIndex.postValue(new Pair<>(questionIndex != null ? questionIndex : formController.getFormIndex(), validationResult));
+                currentIndex.postValue(new Triple<>(formController.getFormIndex(), questionIndex, validationResult));
             } else {
-                currentIndex.setValue(new Pair<>(questionIndex != null ? questionIndex : formController.getFormIndex(), validationResult));
+                currentIndex.setValue(new Triple<>(formController.getFormIndex(), questionIndex, validationResult));
             }
         }
     }

collect_app/src/main/java/org/odk/collect/android/formentry/FormIndexAnimationHandler.kt

@@ -15,18 +15,16 @@ class FormIndexAnimationHandler(private val listener: Listener) {
     private var lastIndex: FormIndex? = null
 
     fun handle(index: FormIndex) {
-        lastIndex?.let {
-            if (index.toString().startsWith(it.toString())) {
-                listener.onScreenRefresh(false)
-            } else if (index > it) {
+        if (lastIndex == null) {
+            listener.onScreenRefresh(true)
+        } else {
+            if (index > lastIndex) {
                 listener.onScreenChange(Direction.FORWARDS)
-            } else if (index < it) {
+            } else if (index < lastIndex) {
                 listener.onScreenChange(Direction.BACKWARDS)
             } else {
                 listener.onScreenRefresh(false)
             }
-        } ?: run {
-            listener.onScreenRefresh(true)
         }
 
         lastIndex = index

collect_app/src/test/java/org/odk/collect/android/formentry/FormEntryViewModelTest.java

@@ -510,29 +510,34 @@ public void answerQuestion_whenQuestionIsAutoAdvance_andAnswerViolatesConstraint
         FormIndex originalIndex = formController.getFormIndex();
         viewModel.answerQuestion(formIndex, new StringData("answer"));
         scheduler.flush(true);
-        assertThat(getOrAwaitValue(viewModel.getCurrentIndex()).getSecond(), equalTo(failedValidationResult));
+        assertThat(getOrAwaitValue(viewModel.getCurrentIndex()).getThird(), equalTo(failedValidationResult));
         assertThat(formController.getFormIndex(), equalTo(new FormIndex(null, originalIndex.getLocalIndex(), 0, new TreeReference())));
     }
 
     @Test
-    public void answerQuestion_setsCurrentIndexToUpdatedQuestionIndex() {
+    public void answerQuestion_setsQuestionIndexToUpdatedQuestionIndex() {
         TreeReference reference = new TreeReference();
         reference.add("blah", TreeReference.INDEX_UNBOUND);
         FormIndex formIndex = new FormIndex(null, 1, 1, reference);
         FormEntryPrompt prompt = new MockFormEntryPromptBuilder()
                 .build();
         formController.setPrompt(formIndex, prompt);
 
+        FormIndex originalIndex = formController.getFormIndex();
         viewModel.answerQuestion(formIndex, new StringData("answer"));
         scheduler.flush(true);
         assertThat(
                 getOrAwaitValue(viewModel.getCurrentIndex()).getFirst(),
+                equalTo(originalIndex)
+        );
+        assertThat(
+                getOrAwaitValue(viewModel.getCurrentIndex()).getSecond(),
                 equalTo(formIndex)
         );
     }
 
     @Test
-    public void answerQuestion_whenQuestionIsAutoAdvance_setsCurrentIndexToNextScreenIndex() {
+    public void answerQuestion_whenQuestionIsAutoAdvance_setsScreenIndexToNextScreenIndex() {
         TreeReference reference = new TreeReference();
         reference.add("blah", TreeReference.INDEX_UNBOUND);
         FormIndex formIndex = new FormIndex(null, 1, 1, reference);
@@ -549,10 +554,14 @@ public void answerQuestion_whenQuestionIsAutoAdvance_setsCurrentIndexToNextScree
                 getOrAwaitValue(viewModel.getCurrentIndex()).getFirst(),
                 equalTo(new FormIndex(null, originalIndex.getLocalIndex() + 1, 0, new TreeReference()))
         );
+        assertThat(
+                getOrAwaitValue(viewModel.getCurrentIndex()).getSecond(),
+                equalTo(null)
+        );
     }
 
     @Test
-    public void answerQuestion_whenQuestionIsAutoAdvance_andAnswerViolatesConstraint_setsCurrentIndexToCurrentScreenIndex() {
+    public void answerQuestion_whenQuestionIsAutoAdvance_andAnswerViolatesConstraint_setsScreenIndexToCurrentScreenIndex() {
         TreeReference reference = new TreeReference();
         reference.add("blah", TreeReference.INDEX_UNBOUND);
         FormIndex formIndex = new FormIndex(null, 1, 1, reference);
@@ -572,5 +581,9 @@ public void answerQuestion_whenQuestionIsAutoAdvance_andAnswerViolatesConstraint
                 getOrAwaitValue(viewModel.getCurrentIndex()).getFirst(),
                 equalTo(originalIndex)
         );
+        assertThat(
+                getOrAwaitValue(viewModel.getCurrentIndex()).getSecond(),
+                equalTo(null)
+        );
     }
 }