Add `hidden-answer` appearance for barcode questions #5870

seadowg · 2023-12-13T10:16:16Z

As discussed at https://forum.getodk.org/t/addition-of-minimal-or-no-answer-appearance-for-question-types-that-launch-an-external-selector/41151/3.

This adds support for a new hidden-answer appearance for barcode questions. If present, barcode contents will never be shown under the "Scan Barcode"/"Replace Barcode" button. It might be that we want to add some indication that the barcode has been scanned (other than the button changing to "Replace Barcode"). For the moment, the intention is for it to be used with a note on the same screen to display a formatted version of the barcode contents.

Why is this the best possible solution? Were any other approaches considered?

New tests and verified manually.

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

Should just add the new appearance. It'd be good to check that the barcode still behaves correctly without the appearance. Other than, not much has been touched.

Do we need any specific form for testing your changes? If so, please attach one.

Any form with barcode (and the new appearance).

Does this change require updates to documentation? If so, please file an issue here and include the link below.

getodk/docs#1723

Before submitting this PR, please make sure you have:

added or modified tests for any new or changed behavior
run ./gradlew connectedAndroidTest (or ./gradlew testLab) and confirmed all checks still pass
added a comment above any new strings describing it for translators
verified that any code or assets from external sources are properly credited in comments and/or in the about file.
verified that any new UI elements use theme colors. UI Components Style guidelines

grzesiek2010 · 2023-12-13T12:54:26Z

collect_app/src/main/java/org/odk/collect/android/utilities/Appearances.kt

@@ -69,6 +69,7 @@ object Appearances {
    const val NEW_FRONT = "new-front"
    const val NEW = "new"
    const val FRONT = "front"
+    const val NO_ANSWER = "no-answer"


no answer sounds confusing to me. The goal is to still keep it but not display so I think something like hidden-answer, protected-answer, secret-answer could be better.

Yeah @lognaturel weren't sure how we felt about it when talked yesterday. hidden-answer is so much better thanks!

grzesiek2010 · 2023-12-13T12:56:08Z

collect_app/src/main/java/org/odk/collect/android/widgets/BarcodeWidget.java

        widgetValueChanged();
    }

+    private void updateVisibility() {
+        if (hasAppearance(getFormEntryPrompt(), Appearances.NO_ANSWER)) {
+            binding.barcodeAnswerText.setVisibility(GONE);


I think it would be better to display ******* for example so that it's clear the answer is still there but protected.

This is intended for use with another question on the same screen (in a field-list) displaying the data so I don't think we'd need that. The goal here was to reduce the noise, not protect the scanned data. I think the responsibility to make it clear that the answer is scanned would be moved to the form designer here (as they're opting in to hide the answer). Good to get @lognaturel's thoughts as well!

Ah ok I thought that the appearance could be used for having protected/secret questions too but there should be a separate one for cases like that and then displaying ******* would make sense.
In the case described on the forum, it's better to display nothing, We should make sure this is clear in the documentation that the new appearance is for hiding questions but not making them protected.

grzesiek2010 · 2023-12-13T13:13:43Z

collect_app/src/main/java/org/odk/collect/android/widgets/BarcodeWidget.java

        widgetValueChanged();
    }

+    private void updateVisibility() {
+        if (hasAppearance(getFormEntryPrompt(), Appearances.NO_ANSWER)) {


If we do not display the answer in the widget we should not display it in the hierarchy view as well I think.

Good point. I feel like it's ok to leave the data in the hierarchy right now as we can improve this later if people need it to hide there as well.

Yeah especially if it's just for hiding questions not making them protected it's not that important.

collect_app/src/test/java/org/odk/collect/android/widgets/BarcodeWidgetTest.java

lognaturel · 2023-12-14T20:37:48Z

Thanks for the naming improvement, @grzesiek2010! The behavior matches my understanding of the requirements. Let's get it in beta!

lognaturel · 2023-12-14T20:38:19Z

@seadowg can you please update the forum thread with the new proposed appearance name to reduce confusion?

dbemke · 2024-01-08T12:50:01Z

@seadowg We have a few questions to the PR (what should be tested) and how the new appearance should work:

should we test only the barcode widget with the appearance hidden-answer or should we also test other widgets behavior with the appearance (e.g. date picker as mentioned at the forum)
the hidden answer isn’t shown in the question but it’s shown in the hierarchy view (according to conversation in the PR)
at the forum you mentioned "This could then be used in a field-list with a note question (using a calculation) to display a formatted version of the data” – is there a form like that which we can use for testing or it doesn’t need to be tested

seadowg · 2024-01-08T14:19:50Z

should we test only the barcode widget with the appearance hidden-answer or should we also test other widgets behavior with the appearance (e.g. date picker as mentioned at the forum)

It should only work for barcode questions for the moment, but no harm in testing that everything still works as expected for other widget types.

the hidden answer isn’t shown in the question but it’s shown in the hierarchy view (according to conversation in the PR)

Good catch. We discussed that earlier here and decided that's ok.

at the forum you mentioned "This could then be used in a field-list with a note question (using a calculation) to display a formatted version of the data” – is there a form like that which we can use for testing or it doesn’t need to be tested

I don't think that specific use case needs to be tested, but it'd definitely be nice to try it out in a field-list.

dbemke · 2024-01-12T14:20:13Z

Tested with Success!

Verified on a device with Android 10

Verified cases:

barcode widget with hidden appearance, barcode widget with hidden appearance required
regression checks in barcodes and QR codes (scanning and reconfiguring)
trying to apply the hidden appearance in the date widget

srujner · 2024-01-12T14:33:46Z

Tested with Success!

Verified on a device with Android 13

Add no-answer appearance for barcode questions

46650b9

seadowg force-pushed the no-answer branch from 05e4ed6 to 46650b9 Compare December 13, 2023 10:37

seadowg changed the title ~~Add no-answer appearance for barcode questions~~ Add no-answer appearance for barcode questions Dec 13, 2023

seadowg mentioned this pull request Dec 13, 2023

Add documentation for new barcode features getodk/docs#1723

Closed

seadowg marked this pull request as ready for review December 13, 2023 12:44

seadowg requested review from grzesiek2010 and lognaturel December 13, 2023 12:44

grzesiek2010 requested changes Dec 13, 2023

View reviewed changes

Change to hidden-answer

375c8fa

seadowg requested a review from grzesiek2010 December 13, 2023 14:17

grzesiek2010 requested changes Dec 13, 2023

View reviewed changes

collect_app/src/test/java/org/odk/collect/android/widgets/BarcodeWidgetTest.java Outdated Show resolved Hide resolved

grzesiek2010 reviewed Dec 13, 2023

View reviewed changes

collect_app/src/test/java/org/odk/collect/android/widgets/BarcodeWidgetTest.java Show resolved Hide resolved

grzesiek2010 reviewed Dec 13, 2023

View reviewed changes

collect_app/src/test/java/org/odk/collect/android/widgets/BarcodeWidgetTest.java Show resolved Hide resolved

seadowg added 2 commits December 14, 2023 10:04

Update test name

dc0834d

Add comments to sections of test

67f36ee

seadowg changed the title ~~Add no-answer appearance for barcode questions~~ Add hidden-answer appearance for barcode questions Dec 14, 2023

Switch to equalTo as the default matcher

95d57a1

seadowg requested a review from grzesiek2010 December 14, 2023 10:57

grzesiek2010 approved these changes Dec 14, 2023

View reviewed changes

seadowg merged commit 62567e1 into getodk:master Dec 15, 2023
6 checks passed

seadowg removed the request for review from lognaturel December 15, 2023 10:54

seadowg deleted the no-answer branch December 15, 2023 10:55

grzesiek2010 added the needs testing label Jan 3, 2024

srujner removed the needs testing label Jan 12, 2024

srujner added the behavior verified label Jan 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `hidden-answer` appearance for barcode questions #5870

Add `hidden-answer` appearance for barcode questions #5870

seadowg commented Dec 13, 2023 •

edited by grzesiek2010

Loading

grzesiek2010 Dec 13, 2023

seadowg Dec 13, 2023

grzesiek2010 Dec 13, 2023

seadowg Dec 13, 2023

grzesiek2010 Dec 13, 2023

grzesiek2010 Dec 13, 2023

seadowg Dec 13, 2023

grzesiek2010 Dec 13, 2023

lognaturel commented Dec 14, 2023

lognaturel commented Dec 14, 2023

dbemke commented Jan 8, 2024

seadowg commented Jan 8, 2024

dbemke commented Jan 12, 2024

srujner commented Jan 12, 2024

Add hidden-answer appearance for barcode questions #5870

Add hidden-answer appearance for barcode questions #5870

Conversation

seadowg commented Dec 13, 2023 • edited by grzesiek2010 Loading

Why is this the best possible solution? Were any other approaches considered?

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

Do we need any specific form for testing your changes? If so, please attach one.

Does this change require updates to documentation? If so, please file an issue here and include the link below.

Before submitting this PR, please make sure you have:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lognaturel commented Dec 14, 2023

lognaturel commented Dec 14, 2023

dbemke commented Jan 8, 2024

seadowg commented Jan 8, 2024

dbemke commented Jan 12, 2024

srujner commented Jan 12, 2024

Add `hidden-answer` appearance for barcode questions #5870

Add `hidden-answer` appearance for barcode questions #5870

seadowg commented Dec 13, 2023 •

edited by grzesiek2010

Loading