Enable support for name attribute in XLSForms #5137

rajpatel24 · 2024-10-01T20:32:55Z

Checklist

If you've added code that should be tested, add tests
If you've changed APIs, update (or create!) the documentation
Ensure the tests pass
Run ./python-format.sh to make sure that your code lints and that you've followed our coding style
Write a title and, if necessary, a description of your work suitable for publishing in our release notes
Mention any related issues in this repository (as #ISSUE) and in other repositories (as kobotoolbox/other#ISSUE)
Open an issue in the docs if there are UI/UX changes

Description

This update enhances the OpenRosa to support the name attribute specified in XLSForms. Previously, OpenRosa did not honor the name='data' setting, which affected the implementation of custom confirmation messages. By allowing this attribute to be set and recognized, we ensure that users can utilize custom confirmation messages effectively, improving the overall user experience and flexibility of the forms.

Notes

Implemented logic to check and set the name attribute from XLSForms in the survey object.
The existing behavior where name was not utilized has been modified to honor the name setting, defaulting to the id_string if name is not provided or is invalid.

Related issues

Part of #5112

…nfirmation messages

notion-workspace · 2024-10-08T19:13:09Z

Allow through the name setting from XLSForms

notion-workspace · 2024-10-08T19:13:10Z

Allow through the name setting from XLSForms

notion-workspace · 2024-10-08T19:13:23Z

Allow through the name setting from XLSForms

jnm · 2024-10-10T20:16:08Z

kobo/apps/openrosa/apps/viewer/models/data_dictionary.py

-            survey.update({
-                'name': survey.id_string,
-            })
+            if not survey.name or survey.name == 'None':


Hi @rajpatel24, thanks for working on this! I'm curious: were there conditions where the string None gets passed in as the name? It seems a bit surprising to me

Hi @jnm, When the form lacked a 'name' setting, the name was being set as the string 'None'.

Previously, we ignored the name setting value, whether it was 'None' or an actual string, and always assigned survey.id_string as the default name.

Now, if a valid name string is present, we leave it unchanged. If the name setting is absent, we assign survey.id_string as the default name.

Sorry to hassle on this, but I wanted to know where the string None was coming from. It bothers me because someone could have their XLSForm settings sheet look like this:

name

None

It would be weird, but it'd be valid, and we wouldn't be able to tell the difference between a user-provided None and the one that gets generated when the settings sheet lacks a name altogether.

I did some digging and found that the None string is set by pyxform:

It's a string because of this: https://github.com/XLSForm/pyxform/blob/9d20bfec5128f53ec0d555f7187f3bc4881f667e/pyxform/xls2json.py#L396-L397

None itself comes from default_name=None in https://github.com/XLSForm/pyxform/blob/9d20bfec5128f53ec0d555f7187f3bc4881f667e/pyxform/builder.py#L327

default_name gets overridden by the name value in the settings sheet of the XLSForm here: https://github.com/XLSForm/pyxform/blob/9d20bfec5128f53ec0d555f7187f3bc4881f667e/pyxform/xls2json.py#L469-L470

I see that even though create_survey_from_xls() has a handy default_name parameter, create_survey_from_xls(self.xls, default_name=self.id_string) won't work because our logic relies on create_survey_from_xls() pulling the id_string out of the XLS file in the first place. This is a historical artifact; nowadays, we're always the ones generating the XLS file internally¹, and we always know the id_string in advance.

Let's do a hack, though, instead of blowing up the scope of this PR. Please invent some constant that's unlikely ever to be a user-provided value, like PLACEHOLDER_NAME = '__kobo_placeholder_name_value__', call survey = create_survey_from_xls(self.xls, default_name=PLACEHOLDER_NAME), and then overwrite survey.name only if it's equal to PLACEHOLDER_NAME.

¹ Even when someone uploads their own XLSForm, we convert that to JSON, and then we convert it back to XLS again when deploying.

jnm

Could we have a unit test for this? I think it would ideally:

Create an Asset with the name setting (this can be in the Asset.content; we do not need to mess around with importing an XLSX file)
Deploy that Asset
Inspect the resulting XForm.xml to verify that the first child of the primary instance (the first <instance>) has a node name that matches the name setting set in the Asset.content.

Please ping me on Zulip if you have any questions 🙏

jnm · 2024-10-24T07:13:07Z

kpi/tests/test_assets.py

+            'survey': [
+                {
+                    'type': 'select_one',
+                    'label': 'q1',
+                    'select_from_list_name': 'iu0sl99',
+                },
+            ],
+            'choices': [
+                {'name': 'a11', 'label': ['a11'], 'list_name': 'iu0sl99'},
+                {'name': 'a3', 'label': ['a3'], 'list_name': 'iu0sl99'},
+            ],


Please change the type to something simple like text, and then you can eliminate select_from_list_name as well as choices. It'll just make the test easier to read since we're not testing any features related to select questions

jnm · 2024-10-24T07:16:34Z

kpi/tests/test_assets.py

+        root_element = instance_node.firstChild
+
+        # Assert that the name setting matches the root node name
+        self.assertEqual(asset.content['settings']['name'], root_element.nodeName)


New tests can use the simple assert syntax. I prefer to see the hard-coded value in the same line; we're not generating the value custom_root_node_name dynamically, so it can be written here directly for clarity. Suggestion:

assert root_element.nodeName == 'custom_root_node_name`

jnm · 2024-10-24T07:17:07Z

kpi/tests/test_assets.py

+            'survey': [
+                {
+                    'type': 'select_one',
+                    'label': 'q1',
+                    'select_from_list_name': 'iu0sl99',
+                },
+            ],
+            'choices': [
+                {'name': 'a11', 'label': ['a11'], 'list_name': 'iu0sl99'},
+                {'name': 'a3', 'label': ['a3'], 'list_name': 'iu0sl99'},
+            ],


Please see comment above about simplifying the survey by using a non-select type

jnm · 2024-10-24T07:19:10Z

kpi/tests/test_assets.py

+    def test_asset_without_name_setting(self):
+        """
+        Test if 'name' setting is not provided, the root node should fall back
+        to xform.id_string


Let's say "fall back to the asset UID"

jnm · 2024-10-24T07:20:28Z

kpi/tests/test_assets.py

+        # Assert that the root node name is the xform.id_sting
+        self.assertEqual(xform.id_string, root_element.nodeName)


Let's actually assert that the root_element.nodeName == asset.uid instead of xform.id_string. That's the application behavior we want. It's true that xform.id_string ends up matching the asset UID, but that's more of a side-effect than the thing we primarily care about.

See also previous note about new assert syntax.

Enable support for name attribute in XLSForms to facilitate custom co…

8692e30

…nfirmation messages

rajpatel24 added the Back end label Oct 1, 2024

rajpatel24 changed the title ~~Enable support for name attribute in XLSForms to facilitate custom co…~~ Enable support for name attribute in XLSForms Oct 1, 2024

noliveleger closed this Oct 1, 2024

noliveleger reopened this Oct 1, 2024

rajpatel24 requested a review from noliveleger October 2, 2024 05:51

noliveleger changed the base branch from beta-refactored to kobocat-django-app-part-2 October 3, 2024 23:21

Base automatically changed from kobocat-django-app-part-2 to main October 7, 2024 18:40

rajpatel24 assigned noliveleger Oct 10, 2024

jnm requested changes Oct 10, 2024

View reviewed changes

jnm self-requested a review October 10, 2024 20:16

jnm requested changes Oct 10, 2024

View reviewed changes

Add test for handling name setting in the asset content

001425c

rajpatel24 force-pushed the allow_through_the_name_setting_from_xls_forms branch from bcd064b to 001425c Compare October 14, 2024 19:23

rajpatel24 requested a review from jnm October 15, 2024 09:25

jnm requested changes Oct 24, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Enable support for name attribute in XLSForms #5137

Enable support for name attribute in XLSForms #5137

rajpatel24 commented Oct 1, 2024 •

edited

Loading

notion-workspace bot commented Oct 8, 2024

notion-workspace bot commented Oct 8, 2024

notion-workspace bot commented Oct 8, 2024

jnm Oct 10, 2024

rajpatel24 Oct 15, 2024

jnm Oct 24, 2024

jnm left a comment

jnm Oct 24, 2024

jnm Oct 24, 2024

jnm Oct 24, 2024

jnm Oct 24, 2024

jnm Oct 24, 2024

		# Assert that the root node name is the xform.id_sting
		self.assertEqual(xform.id_string, root_element.nodeName)

Enable support for name attribute in XLSForms #5137

Are you sure you want to change the base?

Enable support for name attribute in XLSForms #5137

Conversation

rajpatel24 commented Oct 1, 2024 • edited Loading

Checklist

Description

Notes

Related issues

notion-workspace bot commented Oct 8, 2024

notion-workspace bot commented Oct 8, 2024

notion-workspace bot commented Oct 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jnm left a 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

rajpatel24 commented Oct 1, 2024 •

edited

Loading