[HOLD for payment 2023-06-13] [$1000] On task description editing page field is showing mandatory when editing an existing task where by actually field should be optional

[kavimuru]

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

---

Action Performed:

1. Launch the app -> Login in account
2. Click on FAB button -> Click on Assign task option
3. Enter title & description -> add any assignee -> Click on confirm task -> will navigate to task detail page
4. On task detail page click on Description -> clear title field and press save -> Notice error message is This field is required instead of please enter a title

Expected Result:

On task description editing page field should be optional user can remove description & can save

Actual Result:

On task description editing page field is mandatory & user can't remove values

Workaround:

Can the user still use Expensify without this being fixed? Have you informed them of the workaround?

Platforms:

Which of our officially supported platforms is this issue occurring on?

• Android / native
• Android / Chrome
• iOS / native
• iOS / Safari
• MacOS / Chrome / Safari
• MacOS / Desktop

Version Number: 1.3.14.9
Reproducible in staging?: y
Reproducible in production?: y
If this was caught during regression testing, add the test name, ID and link from TestRail:
Email or phone of affected tester (no customers):
Logs: https://stackoverflow.com/c/expensify/questions/4856
Notes/Photos/Videos: Any additional supporting documentation

Expensify/Expensify Issue URL:
Issue reported by: @dhairyasenjaliya
Slack conversation: https://expensify.slack.com/archives/C049HHMV9SM/p1684138155046919

View all open jobs on GitHub

Upwork Automation - Do Not Edit

• Upwork Job URL: https://www.upwork.com/jobs/~0136c1b2820ecd2721
• Upwork Job ID: 1658850991367442432
• Last Price Increase: 2023-05-17

[melvin-bot]

Triggered auto assignment to @zanyrenney (Bug), see https://stackoverflow.com/c/expensify/questions/14418 for more details.

[melvin-bot]

Bug0 Triage Checklist (Main S/O)

• This "bug" occurs on a supported platform (ensure Platforms in OP are ✅)
• This bug is not a duplicate report (check E/App issues and #expensify-bugs)
  • If it is, comment with a link to the original report, close the issue and add any novel details to the original issue instead
• This bug is reproducible using the reproduction steps in the OP. S/O
  • If the reproduction steps are clear and you're unable to reproduce the bug, check with the reporter and QA first, then close the issue.
  • If the reproduction steps aren't clear and you determine the correct steps, please update the OP.
• This issue is filled out as thoroughly and clearly as possible
  • Pay special attention to the title, results, platforms where the bug occurs, and if the bug happens on staging/production.
• I have reviewed and subscribed to the linked Slack conversation to ensure Slack/Github stay in sync

[kavimuru]

Proposal

by
@Dhairya Senjaliya

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

• On task description editing page field is showing mandatory where by actually field is optional

What is the root cause of that problem?

The reason is we are validating on validate() Form to check if field is empty then throws the error message

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

We need to remove _.isEmpty(values.description validation from validate() function
And also on Task-actions we have one more condition where by if we have blank values on form then we are replacing it with old description name which we need to remove

// Change 1
// TaskDescriptionPage.js
-  const validate = useCallback(
-    (values) => {
-      const errors = {};
-      if (_.isEmpty(values.description)) {
-        errors.description = props.translate('common.error.fieldRequired');
-      }
-      return errors;
-    },
-    [props],
-  );
+.  const validate = useCallback(() => ({}), []);
          <TextInput
            inputID="description"
            name="description"
-           label={props.translate('newTaskPage.description')}
+           label={props.translate('newTaskPage.descriptionOptional')}
            defaultValue={(props.task.report && props.task.report.description) || ''}
            ref={(el) => (inputRef.current = el)}
          />
// Change 2
```diff
// libs/actions/Task.js
On editTaskAndNavigate()
 const optimisticData = [
    {
      onyxMethod: Onyx.METHOD.MERGE,
      key: `${ONYXKEYS.COLLECTION.REPORT_ACTIONS}${report.reportID}`,
      value: {[editTaskReportAction.reportActionID]: editTaskReportAction},
    },
    {
      onyxMethod: Onyx.METHOD.MERGE,
      key: `${ONYXKEYS.COLLECTION.REPORT}${report.reportID}`,
      value: {
        reportName,
-		description: description || report.description,
+       description,
      	assignee: assignee || report.assignee,
      },
    },
 ];
// Optional change
  API.write(
    'EditTask',
    {
      taskReportID: report.reportID,
      title: reportName,
-      description: description || report.description,
+      description: description,
      assignee: assignee || report.assignee,
      editedTaskReportActionID: editTaskReportAction.reportActionID,
      assigneeChatReportActionID: optimisticAssigneeAddComment ? optimisticAssigneeAddComment.reportAction.reportActionID : 0,
    },
    {optimisticData, successData, failureData},
  );

What alternative solutions did you explore? (Optional)

• N/A

[zanyrenney]

commented in slack -- https://expensify.slack.com/archives/C049HHMV9SM/p1684334268630209?thread_ts=1684138155.046919&cid=C049HHMV9SM

[zanyrenney]

checking here in slack too about version numbers : https://expensify.slack.com/archives/C01SKUP7QR0/p1684334987930659

[zanyrenney]

Okay, did some more testing and I understand the bug better now. It's that when you edit an existing task description, it is showing the error, not that the description field always throws an error.

[zanyrenney]

Repro:

[melvin-bot]

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

[melvin-bot]

Current assignee @zanyrenney is eligible for the External assigner, not assigning anyone new.

[melvin-bot]

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

[melvin-bot]

Triggered auto assignment to @joelbettner (External), see https://stackoverflow.com/c/expensify/questions/7972 for more details.

[ahmdshrif]

Proposal

Problem:

The current issue in the app is that on the task description editing page, the field is mandatory and users are unable to remove the values. This contradicts the expected behavior, where the field should be optional, allowing users to remove the description and save the task without any text in the field.

###Root Cause:
The root cause of this problem is the validation check that enforces the title field to be filled in. When the user clears the title field and attempts to save the task, instead of accepting an empty field, the validation triggers an error message stating, "This field is required" instead of "Please enter a title."

Solution:

To address this issue, we propose removing the validation that enforces the title field to be non-empty on the task description editing page. By making the field optional, users will be able to remove the description and save the task without encountering any validation errors.

to implement that we should remove these lines

App/src/pages/tasks/TaskDescriptionPage.js

Lines 49 to 51 in 02fff92

	if (_.isEmpty(values.description)) {
	errors.description = props.translate('common.error.fieldRequired');
	}

or remove the validation function.

[fedirjh]

And also on Task-actions we have one more condition where by if we have blank values on form then we are replacing it with old description name which we need to remove

@dhairyasenjaliya can you elaborate more on why this is needed ? Also please note that we don’t allow diff code in the proposal

[dhairyasenjaliya]

@fedirjh As mentioned description field is an optional field (users can leave it blank and also can remove it if they added it in the first place), but here while calling API editTaskAndNavigate where we have a condition whereby if we try to edit description and if that description is blank then we are passing old report as description which will never allow setting description field to be empty (which user should be able to do)

• quick demo why we need to remove

Screen.Recording.2023-05-19.at.10.03.11.AM.mov

[fedirjh]

@dhairyasenjaliya's proposal looks good to me. I think we should proceed with it.

cc @joelbettner

🎀 👀 🎀 C+ reviewed

[zanyrenney]

Thank you @fedirjh ! Bump to @joelbettner please can you give us a 👍🏼 if you agree so we can move forward here please?

[dhairyasenjaliya]

still waiting for @joelbettner to create PR

[alexpensify]

Alright, we are waiting for the automation to kick in here.

[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 1.3.24-5 and is now subject to a 7-day regression period 📆. Here is the list of pull requests that resolve this issue:

• Remove Mandatory Description field on edit task #19749

If no regressions arise, payment will be issued on 2023-06-13. 🎊

After the hold period is over and BZ checklist items are completed, please complete any of the applicable payments for this issue, and check them off once done.

• External issue reporter
• Contributor that fixed the issue
• Contributor+ that helped on the issue and/or PR

As a reminder, here are the bonuses/penalties that should be applied for any External issue:

• Merged PR within 3 business days of assignment - 50% bonus
• Merged PR more than 9 business days after assignment - 50% penalty

[melvin-bot]

BugZero Checklist: The PR fixing this issue has been merged! The following checklist (instructions) will need to be completed before the issue can be closed:

• [@fedirjh] The PR that introduced the bug has been identified. Link to the PR:
• [@fedirjh] The offending PR has been commented on, pointing out the bug it caused and why, so the author and reviewers can learn from the mistake. Link to comment:
• [@fedirjh] A discussion in #expensify-bugs has been started about whether any other steps should be taken (e.g. updating the PR review checklist) in order to catch this type of bug sooner. Link to discussion:
• [@fedirjh] Determine if we should create a regression test for this bug.
• [@fedirjh] If we decide to create a regression test for the bug, please propose the regression test steps to ensure the same bug will not reach production again.
• [@zanyrenney] Link the GH issue for creating/updating the regression test once above steps have been agreed upon:

[zanyrenney]

Invited Dhairya
Fedi Rajhi - please accept the job offers!

[zanyrenney]

payouts due

[dhairyasenjaliya]

@zanyrenney also urgency bonus applicable on this

[zanyrenney]

yep i will add that as the bonus amount :)

[fedirjh]

• Link to the PR: Tasks Detailed View #17940
• Link to comment: Tasks Detailed View #17940 (comment)
• Link to discussion: I don't think an additional discussion is needed here. Commenting on the offending PR is enough for this issue. This bug should have been caught during PR review.
• Determine if we should create a regression test for this bug. ✅

---

Regression Test Proposal

1. Open the app
2. Click on FAB button -> Click on Assign task option
3. Enter title & description -> Select assignee -> Click on confirm to create new task
4. Navigate to task detail page
5. Click on Description -> Clear description field and press save
6. Verify that you can save empty description as it's an optional field

• Do we agree 👍 or 👎

[zanyrenney]

Agree @fedirjh that sounds like a sensible regression test to add 👍🏼

[joelbettner]

On hold. Not overdue.

[dhairyasenjaliya]

bump @zanyrenney

[zanyrenney]

@dhairyasenjaliya - I have paid you in one payment for contribution + reporting bonus + timeline bonus.

[zanyrenney]

@fedirjh paid you and the bonus 🎉

[zanyrenney]

All good here - I have bumped the regression test to be completed. But I am closing this out now as we are all sorted and regression test has its own issue!

[dhairyasenjaliya]

hey @zanyrenney can you please close the Upwork contract as well

[dhairyasenjaliya]

Bump on closing @zanyrenney