Add `background-geopoint` question type which exposes `xforms-value-changed` event with `odk:setgeopoint` action #726

RuthShryock · 2024-10-02T15:36:50Z

Closes #716

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

This solution introduces a new background-geopoint question type that triggers the odk:setgeopoint action when the xforms-value-changed event occurs. The design and implementation were based on discussions from this forum post. The solution followed the proposal and was straightforward to implement based on the details in the issue.

What are the regression risks?

Because this introduces a new question type and modifies how setvalue triggers are handled, there is a risk of breaking existing workflows that rely on the current setvalue behavior. I refactored some functions to handle both setvalue and the new setgeopoint triggers, however, this needs to be tested thoroughly to ensure that the changes don’t break any of the existing setvalue functionality.

Does this change require updates to documentation?

Yes: XLSForm/xlsform.github.io#277

Before submitting this PR, please make sure you have:

included test cases for core behavior and edge cases in tests
run python -m unittest and verified all tests pass
run ruff format pyxform tests and ruff check pyxform tests to lint code
verified that any code or assets from external sources are properly credited in comments

tests/test_background_geopoint.py

pyxform/question.py

pyxform/survey.py

tests/test_background_geopoint.py

lindsay-stevens · 2024-10-03T08:25:10Z

Thanks for this PR - looks like it will do what was agreed earlier. My comments are mainly to polish it: increase test coverage, optimise error messages, try to avoid performance regressions / tech debt.

lognaturel · 2024-10-09T17:53:59Z

Thanks and welcome, @RuthShryock!

tiritea · 2024-10-14T19:17:30Z

Are there any further outstanding issues that need to be addressed to merge this PR?

lognaturel · 2024-10-14T19:56:20Z

@lindsay-stevens I've only taken a quick look and it's looking good. Could you please do a final review, especially looking at the perf concerns you had brought up?

Maybe if there are smaller things pending we can file an follow-on issue as we sometimes do. Thanks!

…an odk:setgeopoint action in response to an xforms-value-changed event

… name uniqueness in survey class

… setvalue question types and also when used in groups and repeats

- builder.py: - de-duplicate elif call to create_question_from_dict - use relevant class dictionaries directly instead of passing around - replace regex with strip() to avoid replacing whitespace everywhere in the question name (whitespace invalid in question names). - question.py: - avoid calling self.get_root() repeatedly as it iterates the form (up the tree from the current question). - remove `if` block in nest_set_nodes since it is only called when there are items to be processed. - question_types.py: - add validation functions for workbook_to_json. used external strings for re-use, easier testing, and (maybe someday) i18n. - xls2json.py: - move background-geopoint questions to workbook_to_json from survey.py and question.py to allow row references in errors - test_background_geopoint.py: - change the test class name to match unittest idiom / test discovery - remove `note` question from all tests since this is not relevant to the feature being tested or any specific edge cases of interest. - remove xpath expressions testing only the presence of groups, since these are tested already as part of the xpath to find the inputs within the groups. - readability improvements: - structured test method names - state the overall test case expectation in docstring - indicate the topic of the xpaths - wrap long xpaths and use single-quotes for predicates - shorten test fixture names and tidy up markdown formatting

lindsay-stevens · 2024-10-19T01:03:41Z

@lognaturel I added a commit to address the remaining review feedback. Could you please take a look and merge/rebase if it looks good to you? Thanks

lognaturel · 2024-10-21T17:37:35Z

Thanks, everyone!

RuthShryock mentioned this pull request Oct 2, 2024

Add background-geopoint question type XLSForm/xlsform.github.io#277

Open