Remove Mandatory Description field on edit task #19749

dhairyasenjaliya · 2023-05-29T17:17:56Z

Details

Fixed Issues

$ #19022
PROPOSAL: #19022 (comment)

Tests

Launch the app -> Login in account
Click on FAB button -> Click on Assign task option
Enter title & description -> add any assignee -> Click on confirm task -> will navigate to task detail page
On task detail page click on Description -> clear title field and press save -> Notice it should allowed to save empty desctiption as its optional field

Verify that no errors appear in the JS console

Offline tests

Same as above

QA Steps

Launch the app -> Login in account
Click on FAB button -> Click on Assign task option
Enter title & description -> add any assignee -> Click on confirm task -> will navigate to task detail page
On task detail page click on Description -> clear title field and press save -> Notice it should allowed to save empty desctiption as its optional field

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

web.mov

Mobile Web - Chrome

mweb-chrome.mov

Mobile Web - Safari

mobile-safari.mp4

Desktop

desktop_dQ2omOhh.mp4

iOS

ios.mp4

Android

android.mov

melvin-bot · 2023-05-29T17:48:55Z

@joelbettner @fedirjh One of you needs to copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

src/pages/tasks/TaskDescriptionPage.js

fedirjh · 2023-05-29T19:39:04Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android / native
- Android / Chrome
- iOS / native
- iOS / Safari
- MacOS / Chrome / Safari
- MacOS / Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

1Web.mov

Mobile Web - Chrome

2Chrome.mov

Mobile Web - Safari

3Safari.mov

Desktop

4Desktop.mov

iOS

5IOS.mov

Android

Android.mov

dhairyasenjaliya · 2023-05-31T17:26:09Z

@fedirjh are we waiting for some input or its just PR Reviewer checklist is missing?

fedirjh · 2023-05-31T17:57:15Z

@dhairyasenjaliya All good , I was waiting for @joelbettner feedback’s on #19749 (comment)

dhairyasenjaliya · 2023-06-02T03:46:30Z

friendly bump for the review @joelbettner

joelbettner

Just a small comment addition requested.

dhairyasenjaliya · 2023-06-02T17:06:36Z

@joelbettner added comment as per suggestion

fedirjh

LGTM

src/pages/tasks/NewTaskDescriptionPage.js

Co-authored-by: Fedi Rajhi <[email protected]>

dhairyasenjaliya · 2023-06-02T20:31:55Z

@fedirjh done I guess again you need to approve PR

OSBotify · 2023-06-02T23:22:57Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-06-05T19:25:29Z

🚀 Deployed to staging by https://github.com/joelbettner in version: 1.3.24-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-06-07T03:29:19Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.24-5 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	failure ❌
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2023-06-07T13:20:58Z

🚀 Deployed to production by https://github.com/roryabraham in version: 1.3.24-5 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	cancelled 🔪
🍎 iOS 🍎	cancelled 🔪
🕸 web 🕸	success ✅

dukenv0307 · 2023-06-09T00:51:23Z

src/libs/actions/Task.js

@@ -325,7 +325,7 @@ function editTaskAndNavigate(report, ownerEmail, title, description, assignee) {
            key: `${ONYXKEYS.COLLECTION.REPORT}${report.reportID}`,
            value: {
                reportName,
-                description: (description || report.description).trim(),
+                description: description.trim(),


@dhairyasenjaliya @fedirjh This change makes a regression, that is after editing the title of task, description is empty briefly, see more detail here https://expensify.slack.com/archives/C049HHMV9SM/p1686020401378739

dukenv0307 · 2023-06-09T01:04:03Z

src/libs/actions/Task.js

@@ -380,7 +380,7 @@ function editTaskAndNavigate(report, ownerEmail, title, description, assignee) {
        {
            taskReportID: report.reportID,
            title: reportName,
-            description: (description || report.description).trim(),
+            description: description.trim(),


This change makes description is updated to empty when you edit the title of the task

With this change in this PR, I think we should call editTaskAndNavigate when update title of task in here with description is the current description of the report instead empty description

App/src/pages/tasks/TaskTitlePage.js

Line 62 in 82ce35f

TaskUtils.editTaskAndNavigate(props.task.report, props.session.email, values.title, '', '');

@dukenv0307 One simple fix for the issue is to pass description from props.task as below :

TaskUtils.editTaskAndNavigate( props.task.report, props.session.email, values.title, props.task.description, props.task.managerEmail );

nope. this will likely cause another regression since we are using the same edit for changing the assignee
what I suggest is to add a new parameter isDescriptionPage for the description something like the below and add true on the description page since we are allowing empty value as well

function editTaskAndNavigate(report, ownerEmail, title, description, assignee, isDescriptionPage = false) { value: { reportName, description: (isDescriptionPage ? description : report.description).trim(), managerEmail: assignee || report.managerEmail, },

nope. this will likely cause another regression since we are using the same edit for changing the assignee

@dhairyasenjaliya Hmmm how will that cause regression ? If we update other instances , it should be fine , we have access to props.task on all tasks forms

@dukenv0307 One simple fix for the issue is to pass description from props.task as below

@fedirjh yes, I recommended it here #19749 (comment)

nope. this will likely cause another regression since we are using the same edit for changing the assignee

@dhairyasenjaliya I don't think we need to add a new parameter for this function. I think we only need to add the correct description when we edit anything of task that doesn't description field.

@fedirjh So if we create a PR to fix this regression in here, can you help me to revert the change in my PR here #19990

yeah agree but let's say we have an empty description on edit then it will rely on props.task. description which has an old value then it will set the old value rather than empty, so what I think we need to make a way for the description field that it checks if we are coming from the description page then only we truly set those new value it maybe old, empty or new text

Let's wait till the GH ticket is created

dhairyasenjaliya marked this pull request as ready for review May 29, 2023 17:48

dhairyasenjaliya requested a review from a team as a code owner May 29, 2023 17:48

melvin-bot bot requested review from fedirjh and joelbettner and removed request for a team May 29, 2023 17:48

Remove Mandatory Description field on edit task

ff5f9c1

dhairyasenjaliya force-pushed the taskDescription branch from 888ab54 to ff5f9c1 Compare May 29, 2023 17:53

Removed Un-used import

a19a8de

fedirjh reviewed May 29, 2023

View reviewed changes

src/pages/tasks/TaskDescriptionPage.js Show resolved Hide resolved

fedirjh reviewed May 29, 2023

View reviewed changes

src/pages/tasks/TaskDescriptionPage.js Show resolved Hide resolved

Label correction

dddcbf9

fedirjh previously approved these changes May 31, 2023

View reviewed changes

joelbettner suggested changes Jun 2, 2023

View reviewed changes

added bit explanation for optional validate

298c57f

dhairyasenjaliya dismissed fedirjh’s stale review via 298c57f June 2, 2023 17:05

fedirjh previously approved these changes Jun 2, 2023

View reviewed changes

src/pages/tasks/NewTaskDescriptionPage.js Outdated Show resolved Hide resolved

Update src/pages/tasks/NewTaskDescriptionPage.js

9842146

Co-authored-by: Fedi Rajhi <[email protected]>

dhairyasenjaliya dismissed fedirjh’s stale review via 9842146 June 2, 2023 20:31

fedirjh approved these changes Jun 2, 2023

View reviewed changes

joelbettner approved these changes Jun 2, 2023

View reviewed changes

joelbettner merged commit 4220152 into Expensify:main Jun 2, 2023

OSBotify mentioned this pull request Jun 5, 2023

Deploy Checklist: New Expensify 2023-06-05 #20195

Closed

51 tasks

lanitochka17 mentioned this pull request Jun 6, 2023

Assign task - Creating a task offline does not save "Title" and "Description" #20230

Closed

6 tasks

melvin-bot bot mentioned this pull request Jun 6, 2023

[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 #19022

Closed

6 tasks

fedirjh mentioned this pull request Jun 9, 2023

Show assigned user as mention in the task preview #19990

Merged

57 tasks

dukenv0307 reviewed Jun 9, 2023

View reviewed changes

dukenv0307 mentioned this pull request Jun 12, 2023

Task description is empty briefly after updating task title #20555

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Remove Mandatory Description field on edit task #19749

Remove Mandatory Description field on edit task #19749

dhairyasenjaliya commented May 29, 2023 •

edited

Loading

melvin-bot bot commented May 29, 2023

fedirjh commented May 29, 2023

dhairyasenjaliya commented May 31, 2023

fedirjh commented May 31, 2023

dhairyasenjaliya commented Jun 2, 2023

joelbettner left a comment

dhairyasenjaliya commented Jun 2, 2023

fedirjh left a comment

dhairyasenjaliya commented Jun 2, 2023 •

edited

Loading

OSBotify commented Jun 2, 2023

OSBotify commented Jun 5, 2023

OSBotify commented Jun 7, 2023

OSBotify commented Jun 7, 2023

dukenv0307 Jun 9, 2023

dukenv0307 Jun 9, 2023

dukenv0307 Jun 9, 2023

fedirjh Jun 9, 2023

dhairyasenjaliya Jun 9, 2023 •

edited

Loading

fedirjh Jun 9, 2023 •

edited

Loading

dukenv0307 Jun 9, 2023

dukenv0307 Jun 9, 2023

dhairyasenjaliya Jun 9, 2023

fedirjh Jun 9, 2023

Remove Mandatory Description field on edit task #19749

Remove Mandatory Description field on edit task #19749

Conversation

dhairyasenjaliya commented May 29, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented May 29, 2023

fedirjh commented May 29, 2023

Reviewer Checklist

Screenshots/Videos

dhairyasenjaliya commented May 31, 2023

fedirjh commented May 31, 2023

dhairyasenjaliya commented Jun 2, 2023

joelbettner left a comment

Choose a reason for hiding this comment

dhairyasenjaliya commented Jun 2, 2023

fedirjh left a comment

Choose a reason for hiding this comment

dhairyasenjaliya commented Jun 2, 2023 • edited Loading

OSBotify commented Jun 2, 2023

OSBotify commented Jun 5, 2023

OSBotify commented Jun 7, 2023

OSBotify commented Jun 7, 2023

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

dhairyasenjaliya Jun 9, 2023 • edited Loading

Choose a reason for hiding this comment

fedirjh Jun 9, 2023 • edited Loading

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

dhairyasenjaliya commented May 29, 2023 •

edited

Loading

dhairyasenjaliya commented Jun 2, 2023 •

edited

Loading

dhairyasenjaliya Jun 9, 2023 •

edited

Loading

fedirjh Jun 9, 2023 •

edited

Loading