Highlight linked comment

[perunt]

Details

This PR is part of the Comment Linking project. Specifically, this task allows users to see which message they referred to by changing the background color of the linked message. WARNING: it doesn't scroll to that message; it merely changes the background color. This background color remains until the user navigates back, so it will be there permanently as long as it remains in the route.

Fixed Issues

$ #23230
PROPOSAL:

Tests

• Verify that no errors appear in the JS console

Offline tests

QA Steps

Enable the beta flag named 'commentLinking'.

• Open a chat.

• Copy the link to the desired message.

• Navigate to another chat.

• Paste the copied link into this chat.

• Click on the pasted link. You were navigated to the separate chat

• Scroll to the linked message if it's not immediately visible.

• Verify that the background color of the linked message has been changed.

• 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
  • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web

Untitled.mov

Mobile Web - Chrome

telegram-cloud-document-2-5188386215157578478.mp4

Mobile Web - Safari

Simulator.Screen.Recording.-.iPhone.14.Pro.-.2023-09-12.at.13.42.04.mp4

Desktop

Untitled.2.mov

iOS

Simulator.Screen.Recording.-.iPhone.14.Pro.-.2023-09-12.at.13.36.51.mp4

Android

telegram-cloud-document-2-5188386215157578449.mp4

[melvin-bot]

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

[perunt]

@situchan, could you take a look at this? It's a part of the comment-linking feature, and it is a big priority. Thanks!

[situchan]

reviewing now. can you please fix conflict?

[perunt]

@situchan can you take a look at this?

[perunt]

@situchan is it good for you now?

[situchan]

yes good, will checklist in a few hrs

[situchan]

Server is down - https://expensify.slack.com/archives/C01GTK53T8Q/p1695314249132269
Will checklist once it's back

[perunt]

Sure, thanks for keeping it up to date!

[perunt]

@situchan, just a friendly reminder. As we need to deliver the whole that features by the end of the month

[situchan]

Thanks for the reminder. Reviewing now

[situchan]

Please pull main

[situchan]

Once I click message deep link, no way to remove highlight unless browser url is changed.
Is this out of scope for this PR?

Screen.Recording.2023-09-22.at.9.38.31.PM.mov

[situchan]

It's odd to me that money request preview is not highlighted while message is highlighted

Shouldn't this be consistent with hover effect?

[situchan]

Given this is priority project, I'd like to consider above concerns out of scope here

[situchan]

It would be good to change message deep link back to report link when click active report in LHN

i.e. /r/8594040674715855/3686280274134926037 to /r/8594040674715855

Screen.Recording.2023-09-22.at.9.47.17.PM.mov

[perunt]

@situchan Yes, I have been addressing those comments. Also, I had a weird test error that was not related to this PR. Now it should be good.

[Gonals]

All good here? @situchan, do we need to retest?

[situchan]

I will review shortly

[Gonals]

I will review shortly

Sounds good. Let me know when you are done, @situchan

[Gonals]

@perunt, seems like we now have some conflicts

[perunt]

@Gonals done

[situchan]

For performance, I think it's better useRoute only once in parent view (report screen.)
And pass only flag to ReportActionItem.
It's not performant to subscribe route change on every item.

[Gonals]

@perunt ⬆️

[perunt]

In that case, we will rerender all messages if we want to highlight a message already on the screen.
I'll make changes in a moment.

[perunt]

done

[perunt]

@Gonals @situchan, is it good now?

[situchan]

Some known issues:

• double slash on copy from native
  i.e. https://new.expensify.com//r/1273261174467626/1467080164206627159

• composer is blurred when click same chat on LHN

Screen.Recording.2023-10-02.at.12.49.17.AM.mov

[OSBotify]

✋ 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]

🚀 Deployed to staging by https://github.com/Gonals in version: 1.3.76-0 🚀

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

[kavimuru]

@Gonals @situchan How do we enable

beta flag named 'commentLinking'.

[situchan]

@Gonals @situchan How do we enable

beta flag named 'commentLinking'.

I am not sure. Thought QA team's test accounts have all beta enabled.

@kavimuru are you able see this option in your account?

[kavimuru]

@situchan yes we do. Thanks

[OSBotify]

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.76-6 🚀

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

[OSBotify]

🚀 Deployed to staging by https://github.com/Gonals in version: 1.3.77-0 🚀

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

[OSBotify]

🚀 Deployed to production by https://github.com/mountiny in version: 1.3.77-7 🚀

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