Select from repeat inside that same repeat transforms choice_filter expressions with current()

[lognaturel]

Related to #503

Software and hardware versions

pyxform v1.3.3

Problem description

Select from repeat transforms choice_filter expressions with current().

Steps to reproduce the problem

Use current() in a choice_filter expression for a select from repeat inside that same repeat. Note that the behavior is correct when it's not a select from repeat or when it's a select from repeat not inside the same repeat.

    def test_explicit_choice_filter_with_current__passes_current_expression_through(self):
        xlsform_md = """
        | survey  |                      |        |         |                         |
        |         | type                 | name   | label   | choice_filter           |
        |         | select_one yes_no    | outer  | Yes?    | name = current()/../foo |
        |         | begin repeat         | repeat | Repeat  |                         |
        |         | select_one ${inner}  | dynamic| Dynamic | name = current()/../foo |
        |         | select_one yes_no    | inner  | Yes?    | name = current()/../foo |
        |         | end repeat           | repeat |         |                         |
        |         | select_one ${inner}  | dynamic| Dynamic | name = current()/../foo |
        | choices |                      |        |         |                         |
        |         | list_name            | name   | label   |                         |
        |         | yes_no               | yes    | Yes     |                         |
        |         | yes_no               | no     | No      |                         |
        """
        self.assertPyxformXform(
            name="data",
            debug=True,
            md=xlsform_md,
            xml__contains=[
                '<itemset nodeset="../../repeat[name = current()/../foo]">',
            ],
        )

Expected behavior

Expressions with current() should always be passed through.

[KeynesYouDigIt]

@lognaturel Would this be a good issue for me to take a crack at now? Or is anything else more pressing?

[lognaturel]

Thanks, @KeynesYouDigIt! I don't have a good sense of what this fix will look like. Some initial analysis to see whether there's a straightforward solution would be much appreciated. If there isn't, it might be best to leave on the back burner but having that first dive done would be very helpful.

[lindsay-stevens]

For future reference, I checked this case with the changes in #777 but it's still broken. Firstly it seems very strange that pyxform nor ODK Validate complain that there are two questions named dynamic (one in a repeat, one at survey level). Secondly while the output appears to be as expected (test code below) - ODK Validate says it's invalid:

Selection choice label text and image uri are both missing for: ${dynamic} choice: 1.
Selection value is missing for: ${dynamic} choice: 1. The XML is invalid.
Selection choice label text and image uri are both missing for: ${dynamic} choice: 1.
Selection value is missing for: ${dynamic} choice: 1. The XML is invalid.
Selection choice label text and image uri are both missing for: ${dynamic} choice: 2.
Selection value is missing for: ${dynamic} choice: 2. The XML is invalid.
Selection choice label text and image uri are both missing for: ${dynamic} choice: 1.
Selection value is missing for: ${dynamic} choice: 1. The XML is invalid.
Selection choice label text and image uri are both missing for: ${dynamic} choice: 2.
Selection value is missing for: ${dynamic} choice: 2. The XML is invalid.
Selection choice label text and image uri are both missing for: ${dynamic} choice: 1.
Selection value is missing for: ${dynamic} choice: 1. The XML is invalid.
Selection choice label text and image uri are both missing for: ${dynamic} choice: 2.
Selection value is missing for: ${dynamic} choice: 2. The XML is invalid.

Test case:

    def test_explicit_choice_filter_with_current_passes_expression_through_verbatim(self):
        """Should find that choice_filter expressions without references are verbatim."""
        # Repro case for pyxform/#504
        md = """
        | survey  |                      |         |         |                         |
        |         | type                 | name    | label   | choice_filter           |
        |         | select_one yes_no    | outer   | Yes?    | name = current()/../foo |
        |         | begin repeat         | repeat  | Repeat  |                         |
        |         | select_one ${inner}  | dynamic | Dynamic | name = current()/../foo |
        |         | select_one yes_no    | inner   | Yes?    | name = current()/../foo |
        |         | end repeat           | repeat  |         |                         |
        |         | select_one ${inner}  | dynamic2 | Dynamic | name = current()/../foo |
        | choices |                      |         |         |                         |
        |         | list_name            | name    | label   |                         |
        |         | yes_no               | yes     | Yes     |                         |
        |         | yes_no               | no      | No      |                         |
        """
        self.assertPyxformXform(
            md=md,
            xml__xpath_match=[
                """
                /h:html/h:body/x:select1[@ref='/test_name/outer']/x:itemset[
                  @nodeset="instance('yes_no')/root/item[name = current()/../foo]"
                ]
                """,
                """
                /h:html/h:body/x:group[@ref='/test_name/repeat']
                  /x:repeat[@nodeset='/test_name/repeat']
                    /x:select1[@ref='/test_name/repeat/dynamic']
                      /x:itemset[@nodeset='../../repeat[name = current()/../foo]']
                """,
                """
                /h:html/h:body/x:group[@ref='/test_name/repeat']
                  /x:repeat[@nodeset='/test_name/repeat']
                    /x:select1[@ref='/test_name/repeat/inner']
                      /x:itemset[@nodeset="instance('yes_no')/root/item[name = current()/../foo]"]
                """,
                """
                /h:html/h:body/x:select1[@ref='/test_name/dynamic']/x:itemset[
                  @nodeset='/test_name/repeat[name = current()/../foo]'
                ]
                """,
            ],
        )

[lognaturel]

Secondly while the output appears to be as expected (test code below) - ODK Validate says it's invalid

I ran into this recently with a choice label that references a form field. Validate visits the form linearly without inputting any values. The check for select labels looks for non-empty values but with dynamic labels from repeats or explicit form references, the labels are expected to be empty until some other data is entered.

https://github.com/getodk/validate/blob/60a6b68cc39cdf61a32c164f9ec273cfdbee85a0/src/org/opendatakit/validate/FormValidator.java#L329 -- I'm not sure this check is all that useful. pyxform has its own checks for non-empty labels or images, right?