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

[Mentions v2] Support mentions in editing comments #40565

Open
wants to merge 20 commits into
base: main
Choose a base branch
from

Conversation

war-in
Copy link
Contributor

@war-in war-in commented Apr 19, 2024

Details

Fixed Issues

$ #39550
PROPOSAL:

Tests

  1. Go to a room
  2. Create a comment with user and room mentions
  3. Click on Edit comment
  4. Verify that all mentions are in the edit view
  5. Modify comment by adding at least one user and one room mentions (you can remove some mentions too)
  6. Save the comment
  7. Verify that all previous and new mentions are there
  8. Open some Private notes and verify that editing mentions works correctly

Offline tests

QA Steps

  1. Go to a room
  2. Create a comment with user and room mentions
  3. Click on Edit comment
  4. Verify that all mentions are in the edit view
  5. Modify comment by adding at least one user and one room mentions
  6. Save the comment
  7. Verify that all previous and new mentions are there
  8. Open some Private notes and verify that editing mentions works correctly

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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 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(theme.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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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.

Screenshots/Videos

Android: Native
android.-.native.mov
Android: mWeb Chrome
Screen.Recording.Apr.22.mov
iOS: Native
ios.-.native.mov
iOS: mWeb Safari
ios.-.web.mov
MacOS: Chrome / Safari
web.mov
MacOS: Desktop
desktop.mov

package.json Outdated Show resolved Hide resolved
return;
}

reportIDToNameMap[report.reportID] = report.reportName ?? report.displayName ?? report.reportID;
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure if we should fallback to id, but we did it before so should be fine

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, I think it makes sense to fallback to reportID. And if we would prefer reportID to empty string "", then we can use logical OR || and add comment to disable lint check

// eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing

src/libs/OnyxAwareParser.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@robertKozik robertKozik left a comment

Choose a reason for hiding this comment

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

LGTM, lets wait for the expensify-common PR merge.
and the task on which we are holding :D

@war-in war-in marked this pull request as ready for review April 23, 2024 11:01
@war-in war-in requested a review from a team as a code owner April 23, 2024 11:01
@melvin-bot melvin-bot bot requested review from abdulrahuman5196 and removed request for a team April 23, 2024 11:01
Copy link

melvin-bot bot commented Apr 23, 2024

@abdulrahuman5196 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]

@abdulrahuman5196
Copy link
Contributor

I am assuming this PR is on hold. Do let me know otherwise or once it comes to review

# Conflicts:
#	src/libs/ReportUtils.ts
# Conflicts:
#	src/libs/ReportUtils.ts
#	src/pages/tasks/TaskDescriptionPage.tsx
@war-in
Copy link
Contributor Author

war-in commented May 23, 2024

I am assuming this PR is on hold. Do let me know otherwise or once it comes to review

@abdulrahuman5196 PR is ready for review :)

#39550 (comment)

# Conflicts:
#	src/pages/home/report/ContextMenu/ContextMenuActions.tsx
@war-in
Copy link
Contributor Author

war-in commented May 27, 2024

@abdulrahuman5196 kind bump :)

@abdulrahuman5196
Copy link
Contributor

Hi @puneetlath / @war-in I am occupied at the moment. Kindly unassign me and involve a different C+ to move faster.

@eh2077
Copy link
Contributor

eh2077 commented May 29, 2024

Hi @puneetlath / @war-in I am occupied at the moment. Kindly unassign me and involve a different C+ to move faster.

I can help with it.

@puneetlath puneetlath requested review from eh2077 and removed request for abdulrahuman5196 May 29, 2024 15:46
@eh2077
Copy link
Contributor

eh2077 commented May 30, 2024

@war-in User mention is empty when editing

0-edit-user-mention-is-empty.mp4
0-user-mention-is-empty.mp4

@rlinoz rlinoz self-requested a review May 31, 2024 14:40
@war-in
Copy link
Contributor Author

war-in commented Jun 3, 2024

@eh2077 thanks for catching it! It seems that we need to bump expensify-common dependency and it will be fixed. PR bumping the dependency was reverted recently so I need to take care of it first. Will post an update then

@war-in
Copy link
Contributor Author

war-in commented Jun 3, 2024

Good news :) @blazejkustra is working on the bump (here). Once it's merged our issue should be fixed!

@blazejkustra
Copy link
Contributor

@war-in #42387 was just merged 🚀

# Conflicts:
#	src/components/LHNOptionsList/OptionRowLHN.tsx
#	src/hooks/useCopySelectionHelper.ts
#	src/hooks/useHtmlPaste/index.ts
#	src/pages/PrivateNotes/PrivateNotesEditPage.tsx
#	src/pages/RoomDescriptionPage.tsx
#	src/pages/home/report/ContextMenu/ContextMenuActions.tsx
#	src/pages/home/report/ReportActionCompose/ComposerWithSuggestions/ComposerWithSuggestions.tsx
#	src/pages/home/report/ReportActionItemMessageEdit.tsx
#	src/pages/tasks/TaskDescriptionPage.tsx
#	src/pages/workspace/taxes/NamePage.tsx
@war-in
Copy link
Contributor Author

war-in commented Jun 7, 2024

@eh2077 I've just merged the main and all issues should be fixed 🎉 It's ready for review now :)

@eh2077
Copy link
Contributor

eh2077 commented Jun 7, 2024

I'm working on the checklist

@eh2077
Copy link
Contributor

eh2077 commented Jun 7, 2024

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: mWeb Chrome
    • iOS: Native
    • iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • 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(theme.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 the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • 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

Android: Native
0-android.mp4
Android: mWeb Chrome
0-mobile-chrome.mp4
iOS: Native
0-ios.mp4
iOS: mWeb Safari
0-mobile-safari.mp4
MacOS: Chrome / Safari
0-web.mp4
MacOS: Desktop
0-desktop.mp4

@war-in
Copy link
Contributor Author

war-in commented Jun 10, 2024

@eh2077 can I assume you're approving this PR? 🤔

If so, should @rlinoz review it now?

Copy link
Contributor

@eh2077 eh2077 left a comment

Choose a reason for hiding this comment

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

LGTM!

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.

None yet

5 participants