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

Turn channel log member message into HTML #32161

Merged
merged 7 commits into from
Dec 20, 2023
Merged

Conversation

tienifr
Copy link
Contributor

@tienifr tienifr commented Nov 29, 2023

Details

Turn channel log member message into HTML so that room name is shown as link when copy to clipboard.

Fixed Issues

$ #31568
PROPOSAL: #31568 (comment)

Tests

  1. Invite a user to the room
  2. Open #admin room of that workspace
  3. Long press invite message >> Copy to clipboard
  4. Paste then Send the message
  5. Verify the mention in the message is shown correctly
  6. Press the room name in the message
  7. Verify user is directed to the room chat
  • Verify that no errors appear in the JS console

Offline tests

NA

QA Steps

  1. Invite a user to the room
  2. Open #admin room of that workspace
  3. Long press invite message >> Copy to clipboard
  4. Paste then Send the message
  5. Verify the mention in the message is shown correctly
  6. Press the room name in the message
  7. Verify user is directed to the room chat
  • 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
      • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native
Screen.Recording.2023-11-29.at.14.31.31-compressed.mov
Android: mWeb Chrome
Screen.Recording.2023-11-29.at.14.35.33-compressed.mov
iOS: Native
Screen.Recording.2023-11-29.at.14.25.47-compressed.mov
iOS: mWeb Safari
Screen.Recording.2023-11-29.at.14.27.53-compressed.mov
MacOS: Chrome / Safari
Screen.Recording.2023-11-29.at.13.57.27-compressed.mov
MacOS: Desktop
Screen.Recording.2023-11-29.at.14.05.37-compressed.mov

@tienifr tienifr marked this pull request as ready for review November 29, 2023 06:47
@tienifr tienifr requested a review from a team as a code owner November 29, 2023 06:47
@melvin-bot melvin-bot bot requested review from shubham1206agra and removed request for a team November 29, 2023 06:47
Copy link

melvin-bot bot commented Nov 29, 2023

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

@tienifr
Copy link
Contributor Author

tienifr commented Nov 29, 2023

@shubham1206agra Before completing screenshots, I found out one issue that the mention would be displayed as @Hidden after copy-pasting:

Screenshot 2023-11-29 at 13 41 17

Because the personal detail was not retrieved properly here:

App/src/libs/ReportUtils.ts

Lines 4150 to 4154 in 1234b0d

const mentions = (reportAction?.originalMessage as ChangeLog)?.targetAccountIDs?.map(() => {
const personalDetail = allPersonalDetails?.accountID;
const displayNameOrLogin = LocalePhoneNumber.formatPhoneNumber(personalDetail?.login ?? '') || (personalDetail?.displayName ?? '') || Localize.translateLocal('common.hidden');
return `@${displayNameOrLogin}`;
});

The accountID variable was not defined and object retrieval by key was also incorrect. This is a regression from the TS migration (before that everything worked fine).

Do you want me to fix it as well or create another issue to handle that?

@shubham1206agra
Copy link
Contributor

Can you fix it here only?

@tienifr
Copy link
Contributor Author

tienifr commented Nov 29, 2023

@shubham1206agra Another edge case: If server returned the invited display name with spaces between, we could not render the mention after copy-pasting. I don't think this is possible with the current implementation of mention-user tag. Also this is an edge case, or maybe BE bug, because normally it would return login, I think we should ignore this.

Original:

Screenshot 2023-11-29 at 14 19 55

Copy pasted:

Screenshot 2023-11-29 at 14 22 30

@shubham1206agra
Copy link
Contributor

@shubham1206agra Another edge case: If server returned the invited display name with spaces between, we could not render the mention after copy-pasting. I don't think this is possible with the current implementation of mention-user tag. Also this is an edge case, or maybe BE bug, because normally it would return login, I think we should ignore this.

Original:

Screenshot 2023-11-29 at 14 19 55 Copy pasted: Screenshot 2023-11-29 at 14 22 30

@tienifr This looks weird bug. It should use email (login) here, instead of display name.
Can you put repro steps of this?

@tienifr
Copy link
Contributor Author

tienifr commented Nov 29, 2023

@shubham1206agra I'm not sure about that, the invitation message was one month ago. I tried iniviting the same account again and accounts with display name but it just showed login. I believe this is a BE bug and has already been resolved somewhere.

Comment on lines 350 to 352
let environmentURL: string;
Environment.getEnvironmentURL().then((url: string) => (environmentURL = url));

Copy link
Contributor

Choose a reason for hiding this comment

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

Can you see tryResolveUrlFromApiRoot instead of this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is there any specific reason? Because I took reference from ReportActionsUtils here:

updatedReportAction.message[0].html = reportAction.message[0].html?.replace('%baseURL', environmentURL);

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe above method doesn't work in that case, thats why they have used environmentURL directly.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

tryResolveUrlFromApiRoot requires a pre-defined/existing URL to resolve the base domain. In this case, there's no such URL. It's usually used for attachment link. For report actions, I see that environmentURL is used across the app like here, here, here, etc.

@shubham1206agra
Copy link
Contributor

@tienifr In this, you may want to make link independent of platform cause clicking on room link from production website tries to take me to local link

@shubham1206agra
Copy link
Contributor

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(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 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 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.2023-12-03.at.8.57.46.PM.mov
Android: mWeb Chrome
Screen.Recording.2023-12-04.at.9.07.08.AM.mov
iOS: Native
Screen.Recording.2023-12-03.at.7.47.10.PM.mov
iOS: mWeb Safari
Screen.Recording.2023-12-04.at.9.04.57.AM.mov
MacOS: Chrome / Safari
Screen.Recording.2023-12-04.at.9.02.51.AM.mov
MacOS: Desktop
Screen.Recording.2023-12-03.at.7.43.18.PM.mov

@namhihi237
Copy link
Contributor

namhihi237 commented Dec 4, 2023

Hi @shubham1206agra @tienifr , we have made changes related to the channel log, I think they are related to each other and may cause conflicts. Can the team help check to hold this PR until our PR is merged cc @cubuspl42 @mobilify

@tienifr
Copy link
Contributor Author

tienifr commented Dec 4, 2023

@namhihi237 Can you link the related PR?

@namhihi237
Copy link
Contributor

Ah sorry,I am missing. I updated

@shubham1206agra
Copy link
Contributor

@tienifr Can you see if this problem can be solved in the meantime? #32161 (comment)

@tienifr
Copy link
Contributor Author

tienifr commented Dec 4, 2023

@shubham1206agra Sure! So by that you mean we put this PR on HOLD for #30927, don't you?

@shubham1206agra
Copy link
Contributor

I think we can hold this as the holding PR is near merge state

@cubuspl42
Copy link
Contributor

Yes, please hold. We've had many, many review rounds there. I would be grateful if you applied your solution on top of those changes.

@tienifr tienifr changed the title Turn channel log member message into HTML [HOLD APP PR #30927] Turn channel log member message into HTML Dec 5, 2023
@shubham1206agra
Copy link
Contributor

@tienifr Lets get this OFF HOLD now

@tienifr
Copy link
Contributor Author

tienifr commented Dec 8, 2023

Seems like there was regression and they attempted to fix in #32612. I think we still need HOLD then.

@cubuspl42
Copy link
Contributor

I'll push #32612 forward ASAP

@shubham1206agra
Copy link
Contributor

Lets get it OFF HOLD now as holding PR is now in production

@shubham1206agra
Copy link
Contributor

@tienifr Bump here ^

@tienifr
Copy link
Contributor Author

tienifr commented Dec 19, 2023

Taking a look.

@tienifr tienifr changed the title [HOLD APP PR #30927] Turn channel log member message into HTML Turn channel log member message into HTML Dec 20, 2023
@tienifr
Copy link
Contributor Author

tienifr commented Dec 20, 2023

Discussing with #32612 author about the changes here. I'm close to to finishing this, just some minor details.

@tienifr
Copy link
Contributor Author

tienifr commented Dec 20, 2023

@shubham1206agra We can continue here. #32612 already handled most of the parsing logic for us 🙏.

Copy link
Contributor

@shubham1206agra shubham1206agra left a comment

Choose a reason for hiding this comment

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

LGTM!

@luacmartins luacmartins merged commit 2540a7f into Expensify:main Dec 20, 2023
16 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/luacmartins in version: 1.4.15-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.4.15-5 🚀

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

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.

6 participants