Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Edit Task Front End #18672

Merged
merged 33 commits into from
May 14, 2023
Merged

Edit Task Front End #18672

merged 33 commits into from
May 14, 2023

Conversation

cdanwards
Copy link
Contributor

@cdanwards cdanwards commented May 9, 2023

Details

Fixed Issues

$ #16856
PROPOSAL: GH_LINK_ISSUE(COMMENT)

Tests

Low.Res.Desktop.mov
  • Navigate to or create a task report
  • Click on the title component, a form should appear
  • Edit the title content then hit save, it should navigate back to the report
  • Click on the description component, a form should appear
  • Edit the description content then hit save, it should navigate back to the report
  • Click on the assignee component, a selector should appear
  • Edit the assignee content, it should navigate back to the report
  • Verify that no errors appear in the JS console
  • Verify that messages have appeared on the report indicating the edigts

Offline tests

Same as Tests

QA Steps

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (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
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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 followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • 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
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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
  • [ x] If any new file was added I verified that:
    • [x ] 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Low.Res.Desktop.mov
Mobile Web - Chrome
Low.Res.Android.mov
Mobile Web - Safari
Low.Res.iOS.mov
Desktop
Low.Res.Desktop.1.mov
iOS
Low.Res.iOS.mov
Android
Low.Res.Android.mov

src/libs/actions/Task.js Outdated Show resolved Hide resolved
Comment on lines 133 to 137

function beginEditingTask() {
Onyx.merge(ONYXKEYS.TASK, {isEditing: true});
}

/** Sets the task editing property in the store to false */
function endEditingTask() {
Onyx.merge(ONYXKEYS.TASK, {isEditing: false});
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How come we need to know if we are currently editing a task or not? There is another form we could use that we are currently using for title / description which is EDIT_TASK_FORM

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is for the TaskAssigneeSelectorModal I'm reusing it and want it to effectively do the same thing, just call a different function if we're editing / creating a new task. Alternatively I could instead do a check to see if a report exists on the TASK onyx key, which I'm setting whenever we're on a task report page.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha, yeah this approach is probably better

Alternatively I could instead do a check to see if a report exists on the TASK onyx key, which I'm setting whenever we're on a task report page.

This might not work since the task won't always be stored in onyx

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just saw this comment, updating now!

src/libs/actions/Task.js Outdated Show resolved Hide resolved
@cdanwards cdanwards force-pushed the dan-editTaskFrontend branch 2 times, most recently from dc97fe6 to b499ba5 Compare May 11, 2023 14:01
@cdanwards cdanwards marked this pull request as ready for review May 11, 2023 16:49
@cdanwards cdanwards requested a review from a team as a code owner May 11, 2023 16:49
@melvin-bot melvin-bot bot requested review from jasperhuangg and removed request for a team May 11, 2023 16:49
@melvin-bot
Copy link

melvin-bot bot commented May 11, 2023

@jasperhuangg Please 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]

@cdanwards cdanwards changed the title [WIP] Edit Task Front End Edit Task Front End May 11, 2023
src/libs/ReportUtils.js Outdated Show resolved Hide resolved
Comment on lines -136 to +159
if (option.alternateText) {
// Check to see if we're creating a new task
// If there's no route params, we're creating a new task
if (!props.route.params && option.alternateText) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What does the alternateText contain that is being checked here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The alternateText being passed in the email we assign to assignee. It's just a check to make sure it's not malformed data.

src/languages/en.js Outdated Show resolved Hide resolved
Comment on lines 179 to 193
...report,
reportName: title || report.reportName,
description: description || report.description,
assignee: assignee || report.assignee,
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When do we not have the title and just the report object?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

EditTask is running individually when saving in the Title, Description, or Assignee page, so 2 of the 3 editable options will be blank when running the function.

src/libs/actions/Task.js Outdated Show resolved Hide resolved
src/pages/home/TaskHeaderView.js Outdated Show resolved Hide resolved
src/libs/actions/Task.js Outdated Show resolved Hide resolved
@thienlnam
Copy link
Contributor

Screenshot 2023-05-11 at 11 14 39 AM Also seeing a lot of console errors when creating a new task on this branch, not sure if it's related to not selecting an assignee

Another thing is that when an asisgnee is not selected, it just doesn't show up in the detailed view can we have it so that it shows like an empty description?
Screenshot 2023-05-11 at 11 16 48 AM

@cdanwards
Copy link
Contributor Author

@thienlnam yup! Looks like just some errors when there's not an assignee. Fixed that up, but do we want to have a different "Unassigned" state? Just have that text?

@thienlnam
Copy link
Contributor

Yeah, let's just do the text for now to keep it consistent

src/CONST.js Outdated Show resolved Hide resolved
src/libs/actions/Task.js Outdated Show resolved Hide resolved
@fedirjh

This comment was marked as outdated.

@fedirjh
Copy link
Contributor

fedirjh commented May 12, 2023

I got this error , I get this when I update the assignee from the recent list

Screenshot 2023-05-12 at 8 15 28 PM

src/libs/actions/Task.js Outdated Show resolved Hide resolved
@cdanwards
Copy link
Contributor Author

@fedirjh was this when an assignee wasn't in contacts?

@fedirjh
Copy link
Contributor

fedirjh commented May 12, 2023

was this when an assignee wasn't in contacts?

@cdanwards Yes, I think we should cover that case so the app don’t crash.

@cdanwards
Copy link
Contributor Author

@fedirjh @thienlnam I updated the getAssignee function so that it won't error when we're selecting an assignee that's not in our contacts, but it can lead to a UI state where there's nothing present, like the unassigned UI state.

Copy link
Contributor

@fedirjh fedirjh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the getAssignee function so that it won't error when we're selecting an assignee that's not in our contacts, but it can lead to a UI state where there's nothing present, like the unassigned UI state.

I am not sure of that, I think this is similar to the issue with the create task when you select an assignee outside of your contact? I think both cases have the same fix .

@thienlnam Should we have an option to un-assign someone ?

@cdanwards another bug , The money request reports are included in share somewhere of create task, they don’t have a title , I think we should exclude them from share somewhere page

Screenshot 2023-05-12 at 9 06 23 PM

Comment on lines +1395 to +1482
type: CONST.REPORT.MESSAGE.TYPE.TEXT,
style: 'normal',
text: ' edited this task',

This comment was marked as resolved.

Comment on lines +199 to +213
if (reportAction.actionName === CONST.REPORT.ACTIONS.TYPE.TASKEDITED) {
return false;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this fine for now ? as the edit report action is not being showing in task report

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, the edit reportAction should not be shown on the task report at all

src/pages/home/TaskHeaderView.js Outdated Show resolved Hide resolved
@cdanwards cdanwards force-pushed the dan-editTaskFrontend branch from 33e8c6d to daf9ae1 Compare May 14, 2023 01:30
@thienlnam thienlnam requested a review from fedirjh May 14, 2023 05:59
@fedirjh
Copy link
Contributor

fedirjh commented May 14, 2023

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
Web.Task.Edit.mov
Mobile Web - Chrome
Edit.Task.mWeb.Chome.mov
Edit.Task.mWeb.Chome.2.mov
Mobile Web - Safari
Edit.Task.mWeb.Safari.mov
Desktop
Edit.Task.Desktop.mov
iOS
Edit.Task.IOS.mov
Android
Edit.Task.Android.mov

Copy link
Contributor

@thienlnam thienlnam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Amazing! Nice work all

@thienlnam thienlnam merged commit 2e73562 into Expensify:main May 14, 2023
@melvin-bot melvin-bot bot added the Emergency label May 14, 2023
@melvin-bot
Copy link

melvin-bot bot commented May 14, 2023

@thienlnam looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

fedirjh

This comment was marked as outdated.

@OSBotify
Copy link
Contributor

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

@thienlnam
Copy link
Contributor

All tests had passed

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/thienlnam in version: 1.3.14-0 🚀

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

@@ -1429,6 +1429,7 @@ function buildOptimisticCreatedReportAction(ownerEmail) {
actionName: CONST.REPORT.ACTIONS.TYPE.CREATED,
pendingAction: CONST.RED_BRICK_ROAD_PENDING_ACTION.ADD,
actorAccountID: currentUserAccountID,
actorEmail: currentUserEmail,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line caused regression - #19010
As actorEmail is added to created action, now it meets this condition:

return currentAction.actorEmail === previousAction.actorEmail;

which allows grouping with new incoming message.

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 1.3.14-14 🚀

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

let assigneeChatReportID;
if (assignee && assignee !== report.assignee) {
assigneeChatReportID = ReportUtils.getChatByParticipants([assignee]).reportID;
optimisticAssigneeAddComment = ReportUtils.buildOptimisticTaskCommentReportAction(report.reportID, reportName, assignee, `Assigned a task to you: ${reportName}`);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding this action while in DM will duplicate the Task preview which caused this issue #19126

function getShareDestination(reportID, reports, personalDetails) {
const report = lodashGet(reports, `report_${reportID}`, {});
return {
icons: ReportUtils.getIcons(report, personalDetails),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✋ Coming from #21582

The task can be created inside the money request thread. So we should get the correct avatar by passing the isPayer from ReportUtils.isIOUReport result.

return {
icons: ReportUtils.getIcons(report, personalDetails),
displayName: ReportUtils.getReportName(report),
subtitle: ReportUtils.getChatRoomSubtitle(report),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👋 Coming from #22296
ReportUtils.getChatRoomSubtitle returns an empty string for 1 to 1 DM's, which resulted in no subtitle for task assignee
We get the correct subtitle for those chats (email/phone number of another participant) from report.participants[0] now

@sobitneupane
Copy link
Contributor

This issue was not handled in this PR.

Issue: #27296
Title: Web - App marks task as unread even when no changes are done

It might have been out of the scope of this PR.

value: {
reportName,
description: description || report.description,
assignee: assignee || report.assignee,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should set errorFields: null for report in optimisticData, otherwise it will cause this bug #33782

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants