Distinguish User Data Field required for Web User or Mobile Worker

[Jtang-1]

Product Description

When editing a User Field, checking "Required" will also display a dropdown with the selection "Web Users", "Mobile Workers" or "Both". When

• "Web Users" is selected, that field is required only when editing a Web User or for Web User Invite.
• "Mobile Workers" is selected, that field is required only when editing a Mobile Worker and creating a Mobile Worker.
• "Both" is selected, that field is required in all cases.

Technical Summary

USH-4867
Design Spec

Commits are fairly clean, can review commit by commit.

Feature Flag

no FF

Safety Assurance

Safety story

Tested locally and on staging. The blast radius is limited to Custom User Data.

Automated test coverage

Added tests

• Field property containing lists are serialized upon form submission and cleaned data contains the expected list
• Field model is serialized correctly
• Form fields that should be required are set as required upon form creation _make_field
• View helper function is_field_required to check if a field is required (taking into consideration required_for)
• Filtering and getting Fields from CustomDataFieldsDefinition works

QA Plan

QA-7171

Migrations

• The migrations in this code can be safely applied first independently of the code

Rollback instructions

• This PR can be reverted after deploy with no further considerations

Labels & Review

• Risk label is set correctly
• The set of people pinged as reviewers is appropriate for the level of risk of the change

[sentry-io]

🔍 Existing Issues For Review

Your pull request is modifying functions with the following pre-existing issues:

📄 File: corehq/apps/custom_data_fields/edit_model.py

Function	Unhandled Issue
page_context	MultiValueDictKeyError: 'data_fields' /a/{domain}... Event Count: 7
page_context	MultiValueDictKeyError: 'data_fields' /a/{domain}... Event Count: 2

---

_{Did you find this useful? React with a 👍 or 👎}

[orangejenny]

UI thought: What if this were a dropdown of "Mobile Workers", "Web Users", "both", or "neither"? That seems simpler to think about than a checkbox plus a dropdown.

[orangejenny]

Isn't this a change from current behavior? From skimming the ticket and design document, it sounds like right now fields are required for both mobile and web users. It sounds like mobile workers only is the desired default behavior, but are you certain this change won't affect existing projects in a way they don't expect?

[Jtang-1]

Yes it is a change in current behavior and you're correct that right now, fields are required for both mobile and web users. We discussed/are discussing it in this comment thread. The decision from that discussion thread was to migrate existing projects to have required fields apply to "mobile worker".

But you're right that it would be disruptive to change current behavior. So I think the better strategy would be to migrate such that required fields still apply to both web users and mobile workers. And then domains who do not want required fields applied to web users can configure it as such. I followed up in that comment thread to get Mruga's thoughts

[orangejenny]

Skimmed and left a couple of comments, didn't review closely.

[Jtang-1]

I did consider including a "None" option in the dropdown and getting rid of the checkbox. But I'm assuming most fields are not going to be required so I think it reduces clutter to just have a checkbox and not unnecessarily display a bunch of dropdowns with text. Also, this same input template is used for other custom data fields so it would also be more consistent to use a checkbox for them all (rather than having only a dropdown here and a checkbox for the other ones)