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

Update MentionUserRenderer.js Issue 26016 #33539

Merged
merged 3 commits into from
Feb 20, 2024

Conversation

nikhildewoolkar
Copy link
Contributor

Details

Fixed Issues

$#26016

Open the app
Open any report
Write '@' to trigger mentions
Select any one mention, make any letter of mention as capital and send
Hover on mention to observe that tooltip doesn't display the right display name and avatar
For same mention as step 4 or select different mention and capitalize all letters and send
Observe that now it is not displayed as mention

$
PROPOSAL:
#26016 (comment)

Tests

  • Verify that no errors appear in the JS console

Offline 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: 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 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 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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

289936066-8a8d561f-8f41-4892-a9ac-48381e8765df

MacOS: Desktop

289936066-8a8d561f-8f41-4892-a9ac-48381e8765df

@nikhildewoolkar nikhildewoolkar requested a review from a team as a code owner December 23, 2023 09:11
@melvin-bot melvin-bot bot requested review from youssef-lr and removed request for a team December 23, 2023 09:11
Copy link

melvin-bot bot commented Dec 23, 2023

@youssef-lr 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]

@nikhildewoolkar
Copy link
Contributor Author

This is new PR for issue #26016. I have filled the PR Author Checklist.
@neil-marcellini @neil-marcellini @adelekennedy @rushatgabhane
Kindly review PR.
Screenshots added below in comments. Screenshots not applicable for mobile application.
289936066-8a8d561f-8f41-4892-a9ac-48381e8765df

@youssef-lr
Copy link
Contributor

youssef-lr commented Dec 28, 2023

This is still an issue for unknown emails or when typing the mention fully and then pressing space, i.e. not selecting it with tab.

Screen.Recording.2023-12-28.at.13.27.01.mov

@sobitneupane
Copy link
Contributor

@youssef-lr I could not reproduce the issue that you mentioned.
Screenshot 2024-01-03 at 16 01 36

Copy link
Contributor

@sobitneupane sobitneupane left a comment

Choose a reason for hiding this comment

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

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 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(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 form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label 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
Screen.Recording.2024-01-03.at.16.52.24.mov
Android: mWeb Chrome
iOS: Native
Screen.Recording.2024-01-03.at.16.11.16.mov
iOS: mWeb Safari
Screen.Recording.2024-01-03.at.16.05.21.mov
MacOS: Chrome / Safari
Screen.Recording.2024-01-03.at.15.54.55.mov
MacOS: Desktop
Screen.Recording.2024-01-03.at.16.03.48.mov

Copy link

melvin-bot bot commented Jan 3, 2024

🎯 @sobitneupane, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #33867.

@nikhildewoolkar
Copy link
Contributor Author

Kindly review and approve ASAP @youssef-lr @sobitneupane

@youssef-lr
Copy link
Contributor

on it today

@nikhildewoolkar
Copy link
Contributor Author

Any updates? @sobitneupane @youssef-lr

@youssef-lr
Copy link
Contributor

Sorry couldn't get to this, I'm on it shortly.

@nikhildewoolkar
Copy link
Contributor Author

Kindly check and review @sobitneupane @youssef-lr

@nikhildewoolkar
Copy link
Contributor Author

nikhildewoolkar commented Jan 19, 2024

Hello ,
Kindly check the PR. Let's solve and close this issue. @youssef-lr @sobitneupane @neil-marcellini

@youssef-lr
Copy link
Contributor

@sobitneupane to reproduce do not select the user, press space after typing the email when it contains an uppercase then send the comment

Screen.Recording.2024-01-23.at.10.26.41.mov

@youssef-lr
Copy link
Contributor

Or better, to highlight the issue, copy & paste this hi @youssef@test.Com how are you then hit send.

@sobitneupane
Copy link
Contributor

@nikhildewoolkar Can you please work on the issue.

@nikhildewoolkar
Copy link
Contributor Author

@sobitneupane @youssef-lr this reproducible bug isn't related to my problem statement. #26016
Because i tested before raising PR. Please check and let me know.

@sobitneupane
Copy link
Contributor

@nikhildewoolkar I don't think it is different from the original issue. We are supposed to handle all the cases related to the issue.

If there are any blockers, please let us know. We can work together to solve the issue.

@nikhildewoolkar
Copy link
Contributor Author

@nikhildewoolkar I don't think it is different from the original issue. We are supposed to handle all the cases related to the issue.

If there are any blockers, please let us know. We can work together to solve the issue.

I have checked all the things which @youssef-lr suggested with tests cases and example to recreate bug provided by @youssef-lr but it is working fine. adding video evidence below. Kindly @sobitneupane @youssef-lr check PR again and let me know.

WhatsApp.Video.2024-02-03.at.14.07.15.1.1.mp4

@sobitneupane
Copy link
Contributor

sobitneupane commented Feb 8, 2024

To my surprise, I also could not reproduce the issue.

Screen.Recording.2024-02-08.at.21.18.59.mov

@nikhildewoolkar
Copy link
Contributor Author

nikhildewoolkar commented Feb 8, 2024

To my surprise, I also could not reproduce the issue.

Screen.Recording.2024-02-08.at.21.18.59.mov

If its done lets merge this and close this issue @sobitneupane @youssef-lr

@youssef-lr
Copy link
Contributor

This seems to have been fixed in another PR. I can't reproduce on staging.

@youssef-lr
Copy link
Contributor

Check the conflicts in this file, it was fixed by this line tnode.data = tnode.data.replace(displayNameOrLogin, getMentionDisplayText(displayNameOrLogin, htmlAttributeAccountID));.

@nikhildewoolkar
Copy link
Contributor Author

This seems to have been fixed in another PR. I can't reproduce on staging.

kindly review pr

@youssef-lr
Copy link
Contributor

youssef-lr commented Feb 8, 2024

@nikhildewoolkar I'm afraid we cannot merge this PR, we can't simply replace getMentionDisplayText with toLowerCase as it's doing a lot of things. And also, simply adding toLowerCase did not fully fix the issue. What do you think @sobitneupane?

@nikhildewoolkar
Copy link
Contributor Author

nikhildewoolkar commented Feb 8, 2024

When we select from mentionautocomplete dropdown the it lowercases it. So why is it a problem here? @youssef-lr this is what exactly decided in proposal and we should not be overthinking on this issue which has been dragging from 2 months. so i am eager to take it over to finish line. Thank you 😄

@youssef-lr conflicts has been resolved and review it again.

@nikhildewoolkar
Copy link
Contributor Author

@sobitneupane @youssef-lr please review.

@sobitneupane
Copy link
Contributor

@nikhildewoolkar I will kindly request your patience.

A lot has changed recently. I will update soon

@sobitneupane
Copy link
Contributor

@youssef-lr We still have the issue in staging where we don't show tooltip for mentions with caps.

Screen.Recording.2024-02-12.at.19.59.17.mov

The issue is because of the wrong accountID returned in

accountID = PersonalDetailsUtils.getAccountIDsByLogins([displayNameOrLogin])?.[0];

We need to pass lowercase letter to get the correct accountID.

So, only change required here is

displayNameOrLogin = tnode.data.replace(CONST.UNICODE.LTR, '').slice(1);

to

displayNameOrLogin = tnode.data.replace(CONST.UNICODE.LTR, '').slice(1).toLowerCase()

We are passing displayNameOrLogin as fallbackUserDetails. So, I think we should make displayNameOrLogin lowercase.

@sobitneupane
Copy link
Contributor

@nikhildewoolkar Can you please merge main. A lot has changed recently. This is what we have in main.

Your PR doesn't reflect those changes.

@nikhildewoolkar
Copy link
Contributor Author

@sobitneupane fixed the merge conflict

@youssef-lr
Copy link
Contributor

@sobitneupane @nikhildewoolkar indeed it seems like we need the lowercase here to fix the tool tip issue. I think we should update this check here to turn the login into a lowercase for a more bulletproof solution.

diff --git a/src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.tsx b/src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.tsx
index 8908350728..ad9cfb4e63 100644
--- a/src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.tsx
+++ b/src/components/HTMLEngineProvider/HTMLRenderers/MentionUserRenderer.tsx
@@ -43,7 +43,7 @@ function MentionUserRenderer({style, tnode, TDefaultRenderer, currentUserPersona
         navigationRoute = ROUTES.PROFILE.getRoute(htmlAttribAccountID);
     } else if ('data' in tnode && !isEmptyObject(tnode.data)) {
         // We need to remove the LTR unicode and leading @ from data as it is not part of the login
-        displayNameOrLogin = tnode.data.replace(CONST.UNICODE.LTR, '').slice(1).toLowerCase();
+        displayNameOrLogin = tnode.data.replace(CONST.UNICODE.LTR, '').slice(1);
 
         accountID = PersonalDetailsUtils.getAccountIDsByLogins([displayNameOrLogin])?.[0];
         navigationRoute = ROUTES.DETAILS.getRoute(displayNameOrLogin);
diff --git a/src/libs/PersonalDetailsUtils.ts b/src/libs/PersonalDetailsUtils.ts
index a881dd4112..55aee10e61 100644
--- a/src/libs/PersonalDetailsUtils.ts
+++ b/src/libs/PersonalDetailsUtils.ts
@@ -64,7 +64,7 @@ function getPersonalDetailsByIDs(accountIDs: number[], currentUserAccountID: num
  */
 function getAccountIDsByLogins(logins: string[]): number[] {
     return logins.reduce<number[]>((foundAccountIDs, login) => {
-        const currentDetail = personalDetails.find((detail) => detail?.login === login);
+        const currentDetail = personalDetails.find((detail) => detail?.login === login?.toLowerCase());
         if (!currentDetail) {
             // generate an account ID because in this case the detail is probably new, so we don't have a real accountID yet
             foundAccountIDs.push(UserUtils.generateAccountID(login));

@sobitneupane
Copy link
Contributor

@youssef-lr Yup. We can do that. @nikhildewoolkar Can you please make the suggested changes.

@neil-marcellini neil-marcellini self-requested a review February 14, 2024 19:34
@youssef-lr
Copy link
Contributor

friendly bump @nikhildewoolkar!

@nikhildewoolkar
Copy link
Contributor Author

suggested changes done. check and review once.

@youssef-lr
Copy link
Contributor

Thanks!

@youssef-lr youssef-lr merged commit 0797c0a into Expensify:main Feb 20, 2024
15 checks passed
@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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/youssef-lr in version: 1.4.44-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/puneetlath in version: 1.4.44-13 🚀

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

@nikhildewoolkar
Copy link
Contributor Author

This issue has been resolved and still i didn't receive any upwork task link. Kindly share updates on this.

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.

4 participants