[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)

[melvin-bot]

Upwork job price has been updated to $50

[hayes102]

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?

inside the getReportFieldInitialValue function we dont check if the value is disabled or not

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, then return empty string

function getReportFieldInitialValue(reportField: PolicyReportField | null): string {
    if (!reportField) return ''; // we shouldnt remove this line as done in the first proposal 
const indexOfDefaultValue = reportField?.values?.indexOf(reportField.defaultValue) ?? -1;
const defaultValueDisabled = indexOfDefaultValue >= 0 && reportField?.disabledOptions?.[indexOfDefaultValue];
if (defaultValueDisabled) return ""

[melvin-bot]

📣 @hayes102! 📣
Hey, it seems we don’t have your contributor details yet! You'll only have to do this once, and this is how we'll hire you on Upwork.
Please follow these steps:

1. Make sure you've read and understood the contributing guidelines.
2. Get the email address used to login to your Expensify account. If you don't already have an Expensify account, create one here. If you have multiple accounts (e.g. one for testing), please use your main account email.
3. Get the link to your Upwork profile. It's necessary because we only pay via Upwork. You can access it by logging in, and then clicking on your name. It'll look like this. If you don't already have an account, sign up for one here.
4. Copy the format below and paste it in a comment on this issue. Replace the placeholder text with your actual details.
   
   Format:

Contributor details
Your Expensify account email: <REPLACE EMAIL HERE>
Upwork Profile Link: <REPLACE LINK HERE>

[hayes102]

Could we please update the price to match the other issues? This issue seems to be tricky to identify and address.. i believe it deserves a higher bounty, can u please confirm? @akinwale

I mean it seems that the company pays more for the simple upgrade version task. so can we please revise the price.

i am eager to get my first job

[melvin-bot]

@akinwale, @dylanexpensify Eep! 4 days overdue now. Issues have feelings too...

[melvin-bot]

⚠️ This issue has had its price increased by 4x or more. Please review the issue and ensure the price is correct.

[melvin-bot]

Upwork job price has been updated to $250

[dylanexpensify]

@akinwale can we review proposals? 🙏

[melvin-bot]

@akinwale, @dylanexpensify 6 days overdue. This is scarier than being forced to listen to Vogon poetry!

[akinwale]

We can move forward with @etCoderDysto's proposal here.

🎀👀🎀 C+ reviewed.

[abzokhattab]

The issue is not assigned to me yet. The pr will be ready once assigned

[melvin-bot]

📣 It's been a week! Do we have any satisfactory proposals yet? Do we need to adjust the bounty for this issue? 💸

[rezkiy37]

@abzokhattab are you going to implement your proposal or I can work on the issue?

The issue is not assigned to me yet. The pr will be ready once assigned

Bump @dylanexpensify

[melvin-bot]

@akinwale, @CortneyOfstad, @MonilBhavsar Still overdue 6 days?! Let's take care of this!

[CortneyOfstad]

Sorry, was OoO so going to get this adjusted!

@abzokhattab assigning you now!

[melvin-bot]

📣 @akinwale 🎉 An offer has been automatically sent to your Upwork account for the Reviewer role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job

[melvin-bot]

📣 @abzokhattab 🎉 An offer has been automatically sent to your Upwork account for the Contributor role 🎉 Thanks for contributing to the Expensify app!

Offer link
Upwork job
Please accept the offer and leave a comment on the Github issue letting us know when we can expect a PR to be ready for review 🧑‍💻
Keep in mind: Code of Conduct | Contributing 📖

[abzokhattab]

PR is ready !

[CortneyOfstad]

PR deployed to staging yesterday, so will keep an eye as to when it deploys to production!

[melvin-bot]

Reviewing label has been removed, please complete the "BugZero Checklist".

[melvin-bot]

The solution for this issue has been 🚀 deployed to production 🚀 in version 9.0.57-10 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• Fix report field initial value #51538

If no regressions arise, payment will be issued on 2024-11-13. 🎊

For reference, here are some details about the assignees on this issue:

• @akinwale requires payment automatic offer (Reviewer)
• @abzokhattab requires payment automatic offer (Contributor)

[melvin-bot]

@akinwale @CortneyOfstad The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed. Please copy/paste the BugZero Checklist from here into a new comment on this GH and complete it. If you have the K2 extension, you can simply click: [this button]

[CortneyOfstad]

Payment set for tomorrow!

[CortneyOfstad]

Payment Summary

@akinwale — paid $250 via Upwork
@abzokhattab — paid $250 via Upwork