[HOLD for payment 2024-11-13] [$250] Report fields - Initial value field shows disabled list value but it is not shown in the list

[IuliiaHerets]

If you haven’t already, check out our contributing guidelines for onboarding and email contributors@expensify.com to request to join our Slack channel!

---

Version Number: v9.0.27-0
Reproducible in staging?: Y
Reproducible in production?: Y
Issue reported by: Applause Internal Team

Action Performed:

1. Go to staging.new.expensify.com
2. Go to workspace settings > Report fields.
3. Click Add field > Click Type > Select List.
4. Click List values.
5. Add a few list values.
6. Return to the previous page.
7. Click Initial value > Select any list value as default list value.
8. Click List values.
9. Disable all the list values.
10. Save the list type report field.
11. Click on the added list type report field.
12. Click List values.
13. Add a new list value.
14. Return to previous page.
15. Note that Initial value field shows the disabled list value, but when opening the page, the disabled list value is absent.

Expected Result:

The Initial value field should not display the disabled list value (disabled in Step 9) because the list value is disabled.
The field should be empty while clickable.

Actual Result:

The Initial value field shows the disabled list value, but it is not shown in the list in Initial value page.

Workaround:

Unknown

Platforms:

• Android: Native
• Android: mWeb Chrome
• iOS: Native
• iOS: mWeb Safari
• MacOS: Chrome / Safari
• MacOS: Desktop

Screenshots/Videos

Bug6590738_1725293979256.20240903_000954.mp4

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~021831343278141946652
• Upwork Job ID: 1831343278141946652
• Last Price Increase: 2024-10-22
• Automatic offers:
• akinwale | Reviewer | 104573420
• abzokhattab | Contributor | 104573428

Issue Owner

Current Issue Owner: @CortneyOfstad

[melvin-bot]

Triggered auto assignment to @dylanexpensify (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details. Please add this bug to a GH project, as outlined in the SO.

[IuliiaHerets]

@dylanexpensify FYI I haven't added the External label as I wasn't 100% sure about this issue. Please take a look and add the label if you agree it's a bug and can be handled by external contributors

[etCoderDysto]

Edited by proposal-police: This proposal was edited at 2024-09-02 20:15:33 UTC.

Proposal

Please re-state the problem that we are trying to solve in this issue.

Report fields - Initial value field shows disabled list value but it is not shown in the list

What is the root cause of that problem?

We are not checking if the default value (reportField.defaultValue) is disabled before returning reportField.defaultValue in getReportFieldInitialValue

App/src/libs/WorkspaceReportFieldUtils.ts

Lines 73 to 78 in 33b331d

	function getReportFieldInitialValue(reportField: PolicyReportField | null): string {
	if (!reportField) {
	return '';
	}
	if (reportField.type === CONST.REPORT_FIELD_TYPES.LIST) {

What changes do you think we should make in order to solve the problem?

We should check if the default value is disabled first, and return empty string if it is disabled

function getReportFieldInitialValue(reportField: PolicyReportField | null): string {
    const indexOfDefaultValue = reportField?.values.indexOf(reportField?.defaultValue);
    const defalutValueDisabled = indexOfDefaultValue && reportField?.disabledOptions[indexOfDefaultValue];
    if (defalutValueDisabled) {
        return '';
    }

Note: We can move the suggested change into this if condition here, to make the change only to list report field and not text and date report fields.

What alternative solutions did you explore? (Optional)

[etCoderDysto]

I am able to reproduce this.

[Nodebrute]

Yes, I tested it again and the issue is reproducible.

[abzokhattab]

Edited by proposal-police: This proposal was edited at 2024-09-02 20:43:53 UTC.

Proposal

Please re-state the problem that we are trying to solve in this issue.

In the report fields, the initial value field displays a disabled list value, but this value is not shown in the list.

What is the root cause of that problem?

• When all list values are disabled, the InitialListValueSelector component is not rendered because the condition availableListValuesLength > 0 is not met:
  

  App/src/pages/workspace/reportFields/CreateReportFieldsPage.tsx

  Lines 179 to 185 in f86116f

  	{inputValues[INPUT_IDS.TYPE] === CONST.REPORT_FIELD_TYPES.LIST && availableListValuesLength > 0 && (
  	<InputWrapper
  	InputComponent={InitialListValueSelector}
  	inputID={INPUT_IDS.INITIAL_VALUE}
  	label={translate('common.initialValue')}
  	subtitle={translate('workspace.reportFields.listValuesInputSubtitle')}
  	/>

• As a result, this useEffect inside the picker doesn't get the chance to set the current value of the initial value in the form to empty string because the component will not be rendered. and therefore keeps the staled value .. which is used when submitting the form

What changes do you think we should make in order to solve the problem?

First solution:

• A simple solution would be to hide the picker instead of preventing it from rendering.
• This can be achieved by adding the prop isVisible=true to the InitialListValueSelector/index.tsx.Then, include this condition to return null if the value is false:

if (!isVisible) {
    return;
}

• Next, update this code to:

{inputValues[INPUT_IDS.TYPE] === CONST.REPORT_FIELD_TYPES.LIST && (
    <InputWrapper
        InputComponent={InitialListValueSelector}
        inputID={INPUT_IDS.INITIAL_VALUE}
        label={translate('common.initialValue')}
        isVisible={availableListValuesLength > 0}
        onInputChange={(value) => ReportField.setInitialCreateReportFieldsForm(value)}
        subtitle={translate('workspace.reportFields.listValuesInputSubtitle')}
    />
)}

• This approach ensures that the useEffect will still execute even after all values are disabled.

Second solution:

another approach would be to show a placeholder or disable the menu item if the availableListValuesLength > 0 is false

Third solution:

Another approach would be to check if the default value is disabled when submitting the form. If it is, replace the default value with an empty string here.

    const submitForm = useCallback(
        (values: FormOnyxValues<typeof ONYXKEYS.FORMS.WORKSPACE_REPORT_FIELDS_FORM>) => {
            const initialValueIndex = formDraft?.[INPUT_IDS.LIST_VALUES].indexOf(values[INPUT_IDS.INITIAL_VALUE]) ?? -1;
            const initialValue = formDraft?.[INPUT_IDS.DISABLED_LIST_VALUES]?.[initialValueIndex] ? '' : values[INPUT_IDS.INITIAL_VALUE];
            ReportField.createReportField(policyID, {
                name: values[INPUT_IDS.NAME],
                type: values[INPUT_IDS.TYPE],
                initialValue,
            });
            Navigation.goBack();
        },
        [formDraft, policyID],
    );

or better would be to check if availableListValuesLength == 0 and assign the initial value to "" otherwise return the form's initial value

[melvin-bot]

Job added to Upwork: https://www.upwork.com/jobs/~021831343278141946652

[melvin-bot]

Triggered auto assignment to Contributor-plus team member for initial proposal review - @akinwale (External)