[WIP] Update Yellow Highlight Dismissal Behavior

[brunovjk]

Details

This update modifies the behavior of the yellow highlight for linked report actions to dismiss under various conditions.

Fixed Issues

$ #42165
PROPOSAL: #42165 (comment)

Tests

1. Click into a thread
2. Click back into the main conversation by clicking the the room title in the top left of the thread window
3. Observe that the thread is highlighted in yellow after you exit it
4. The yellow highlight should fade after:
   1. Clicking out of the chat into another chat
   2. Clicking into another thread
   3. Refreshing the page
   4. Sending a new comment in the same chat (but not receiving a comment from another user)
   5. Taking any action from the + menu while in the chat

• Verify that no errors appear in the JS console

Offline tests

Same as Tests

QA Steps

Same as Tests

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

43581_android-native.mov

Android: mWeb Chrome

43581_android-web.mov

iOS: Native

43581_ios_native.mov

iOS: mWeb Safari

43581_ios_web.mov

MacOS: Chrome / Safari

43581_web.mov

MacOS: Desktop

43581_desktop.mov

[melvin-bot]

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

[brunovjk]

Hello @sobitneupane, I need some help.

So far our "Yellow Highlight Dismissal Behavior" works as expected for the following scenarios:

• Clicking out of the chat into another chat
• Clicking into another thread
• Refreshing the page
• Sending a new comment in the same chat (but not receiving a comment from another user)
• Taking any action from the + menu while in the chat

However, I’m having trouble with dismissing the highlight after refreshing the page. I've tried using window/performance detection, useState/useEffect logic, and the beforeunload event, but nothing seems to work perfectly.

Could you give me some suggestions on how can we achieve this? Thank you very much.

[sobitneupane]

Sorry for the delay @brunovjk. I running quite busy. I will try to get to it asap.

[brunovjk]

Okay, I think I found a safe way, I'm testing it and I'll let you know. Thanks for your patience.

[brunovjk]

@sobitneupane PR, finally, ready for review. Looking forward to hearing your thoughts on the hook I created.

[sobitneupane]

Taking any action from the + menu while in the chat

@brunovjk Should we remove the yellow highlight as soon as we begin taking any action (such as Submit expense), or after the action is complete? I am inclined towards the former.

Raised it in issue: #42165 (comment)

[brunovjk]

@sobitneupane now available for review. Thank you very much.

[sobitneupane]

@brunovjk I can still reproduce this issue.

Screen.Recording.2024-08-16.at.14.00.30.mov

[brunovjk]

Thank you, Im on it

[brunovjk]

Screen.Recording.2024-08-16.at.14.00.30.mov

@sobitneupane Thank you for clarifying. Before I misunderstood your point about "removing as soon as we start taking any action." It's more accurate now. However, when cleaning the reportActionID (which also clears the yellow highlight) by starting an action in a chat with many messages, the highlighted item, which might be well above the visible area, causes the view to scroll to the bottom:

Screen.Recording.2024-08-19.at.16.09.01.mov

What do you think? Should we keep the current behavior of scrolling to the bottom, or should we only remove the highlight while keeping the reportActionItem visible? Thanks :D

[sobitneupane]

What do you think? Should we keep the current behavior of scrolling to the bottom, or should we only remove the highlight while keeping the reportActionItem visible?

@brunovjk I think we should only remove the highlight.

[sobitneupane]

@brunovjk Any update? Let's try to get this merged asap.

[brunovjk]

Making good progress here, I need to do some more testing to make sure everything is ok and no regressions, and we'll have it for review soon.

[brunovjk]

Misclicked above.

[brunovjk]

Hey @sobitneupane :D could you please take a look at the changes I made (review the PR actually)? Everything looks good to me now. Thank you.

Edit: I'm investigating the Reassure Performance Tests fail, do you have any idea what might be causing it?

[sobitneupane]

Edit: I'm investigating the Reassure Performance Tests fail, do you have any idea what might be causing it?

I am not sure. @brunovjk Is it related to this PR? Which part of the code do you think is causing the issue?

[brunovjk]

Edit: I'm investigating the Reassure Performance Tests fail, do you have any idea what might be causing it?

I am not sure. @brunovjk Is it related to this PR? Which part of the code do you think is causing the issue?

Not sure. I'll go deep into this today

[brunovjk]

@sobitneupane could you take a look at the changes now? I tested it and everything seems to work fine, but I'm still a little unsure about the names of the variables and functions we created.

[sobitneupane]

Thanks for the update @brunovjk

[sobitneupane]

Refreshing the page

@brunovjk I can still reproduce the issue. The highlight doesn't fade after refreshing the page.

Screen.Recording.2024-09-20.at.14.29.24.mov

[brunovjk]

Update: Working on fixing/updating the hook to a more robust approach, I'll update again by the end of the week.

[github-actions]

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.

---

I have read the CLA Document and I hereby sign the CLA

---

Bruno seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You can retrigger this bot by commenting recheck in this Pull Request}