Fix - Mark the chat as "read" immediately upon switching to the tab #34537

FitseTLT · 2024-01-15T21:54:29Z

Details

Fixed Issues

$ #33680
PROPOSAL: #33680 (comment)

Tests

Login with User B and open a chat with User A and change to another tab on web
Now Send a message as User A to User B
Wait until the message arrives at User B and now as User B switch back to the tab you were chatting in (1)
Check that the LHN is not bold
verify that unread marker indicates on the new message you sent in (2)

Verify that no errors appear in the JS console

Offline tests

same

QA Steps

same

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(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 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

2024-01-22_23-59-11.mp4

iOS: Native

ios.native.1.mp4

iOS: mWeb Safari

ios.web.1.mp4

MacOS: Chrome / Safari

web.mp4

MacOS: Desktop

desk1.mp4

melvin-bot · 2024-01-15T21:54:34Z

@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

@FitseTLT I tested on web and the changes are working fine. I found some inconsistent issues, but I don't think its related to this PR. Anyways I will be testing in all platforms tomorrow and approve if no issues there as well.

Meanwhile kindly fix the minor comment i mentioned below.

src/pages/home/report/ReportActionsList.js

FitseTLT · 2024-01-18T14:18:56Z

@abdulrahuman5196 there are minor things I will update before U test. Give a min, I will notify U.

FitseTLT · 2024-01-18T16:42:16Z

Finished on Updating. @abdulrahuman5196 U're good to go 👍
But as U said There are odd buggy behaviours with current codebase and it is not directly related with this issue. So may be we can handle it in a separate issue or if the price can be boosted we can extend on the tasks of these issue and deal with it here.
Here are some of the problems:

When you are already on the chat while there is the current unread marker and u receive a message it is not auto read (LHN bold) but marker is reset.
When u receive again it will not auto read.
But when u receive again for the second time it will auto read. Its totally random!
When u set a message manually marked as read and receive a new message it will be auto-read and the marker reset 😕 IT'S REALLY REALLY Odd

src/pages/home/report/ReportActionsList.js

FitseTLT · 2024-01-19T17:17:37Z

Please note that currently receiving message will reset manuallyMarkedMarker similarly moving to other tab and coming back to the chat tab will reset manuallyMarkedMarker. @abdulrahuman5196

abdulrahuman5196 · 2024-01-19T17:29:27Z

I don't understand this @FitseTLT . Could you provide more information on the same.

Please note that currently receiving message will reset manuallyMarkedMarker similarly moving to other tab and coming back to the chat tab will reset manuallyMarkedMarker.

FitseTLT · 2024-01-19T17:35:18Z

I mean on latest main if U manually mark a message and then receive a new message it resets the marker. doesn't it ??

Similarly on this pr manually marked messages are reset on visibility change (changing from other browser tab to the chat (expensify) tab). That's what I meant.

abdulrahuman5196 · 2024-01-19T18:39:56Z

Got it. Working on review now.

abdulrahuman5196 · 2024-01-19T19:12:39Z

@FitseTLT Could you kindly test and add videos for other platforms as well? Even though this change is most likely to have effect only on web. We should test others platforms to see if there is no breakage and add the video on the same.

abdulrahuman5196 · 2024-01-19T19:29:17Z

@FitseTLT I see an issue related to this change. Without receiving any new messages.
If I mark my message as 'Mark as Unread' and switch tab and come back, both unread marker and bold LHN is gone.
If I mark the other chat person message as 'Mark as Unread' and switch tab and come back, only bold LHN is gone and the unread marker is still present. And the same should be applicable when I mark my message as well. Could you kindly check and fix it?

Same is not happening in staging.

Screen.Recording.2024-01-20.at.12.55.02.AM.mov

FitseTLT · 2024-01-21T21:16:29Z

@abdulrahuman5196 I have updated the code so that our new effect (the one that runs when we switch back tabs) to be only run when a user has received a new message after they have switched away from the tab, I think that's more aligned with the requirements of the issue. Of course now manually marked messages will not be reset by our new effect and it's more logical.

abdulrahuman5196 · 2024-01-22T11:25:59Z

I have updated the code so that our new effect (the one that runs when we switch back tabs) to be only run when a user has received a new message after they have switched away from the tab, I think that's more aligned with the requirements of the issue. Of course now manually marked messages will not be reset by our new effect and it's more logical.

Is this change to solve this issue #34537 (comment)?

Anyways will go through with the testing again.

abdulrahuman5196 · 2024-01-22T19:44:45Z

The Bug previously mentioned is still reproducible. @FitseTLT is working on the fix for the same.

Screen.Recording.2024-01-23.at.1.00.02.AM.mov

FitseTLT · 2024-01-22T20:01:25Z

@abdulrahuman5196 Fixed 👍

abdulrahuman5196 · 2024-01-23T16:38:23Z

@FitseTLT Could you kindly test and add videos for other platforms as well? Even though this change is most likely to have effect only on web. We should test others platforms to see if there is no breakage and add the video on the same.

Can you check on this @FitseTLT

FitseTLT · 2024-01-23T16:42:33Z

Done @abdulrahuman5196 but android native is failing I will upload as soon as I finish 👍

abdulrahuman5196 · 2024-01-23T18:53:25Z

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-24.at.12.19.16.AM.mov

Android: mWeb Chrome

Screen.Recording.2024-01-24.at.12.15.38.AM.mov

iOS: Native

Screen.Recording.2024-01-23.at.11.29.24.PM.mov

iOS: mWeb Safari

Screen.Recording.2024-01-23.at.11.32.33.PM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-01-23.at.9.08.56.PM.mov

MacOS: Desktop

Screen.Recording.2024-01-23.at.10.04.40.PM.mov

abdulrahuman5196

Changes looks good and works well. Reviewers checklist is also complete.

All yours. @hayata-suenaga

🎀 👀 🎀
C+ Reviewed

hayata-suenaga

👍

jeremy-croff · 2024-01-24T17:57:38Z

My PR will also address this issue, but instead relies on the focus change event to recheck if it needs to mark as read.
#35004
This will mark it as read on tab return.

OSBotify · 2024-01-24T18:04:06Z

✋ 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 · 2024-01-25T09:07:16Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.4.32-0 🚀

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

…isibility-change" This reverts commit 77814e5, reversing changes made to b0e2a92.

[CP Staging] Revert "Merge pull request #34537 from FitseTLT/fix-mark-as-read-on-v…

[CP Staging] Revert "Merge pull request #34537 from FitseTLT/fix-mark-as-read-on-v… (cherry picked from commit b2e1e21)

OSBotify · 2024-01-29T19:07:01Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.32-5 🚀

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

OSBotify · 2024-01-29T19:24:12Z

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.4.33-0 🚀

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

OSBotify · 2024-01-31T02:31:03Z

🚀 Deployed to production by https://github.com/francoisl in version: 1.4.33-5 🚀

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

FitseTLT added 2 commits January 15, 2024 00:10

set unread marker and read the report on visibility change

5afbe63

updated to consider manual mark as read case

09dadf4

FitseTLT requested a review from a team as a code owner January 15, 2024 21:54

melvin-bot bot removed the request for review from a team January 15, 2024 21:54

melvin-bot bot requested a review from abdulrahuman5196 January 15, 2024 21:54

abdulrahuman5196 suggested changes Jan 17, 2024

View reviewed changes

src/pages/home/report/ReportActionsList.js Outdated Show resolved Hide resolved

implemented useCallback Ref

9194fd1

FitseTLT requested a review from abdulrahuman5196 January 18, 2024 16:42

abdulrahuman5196 reviewed Jan 18, 2024

View reviewed changes

src/pages/home/report/ReportActionsList.js Outdated Show resolved Hide resolved

FitseTLT added 3 commits January 18, 2024 20:37

Merge branch 'main' into fix-mark-as-read-on-visibility-change

e938d62

minor fix

10b518f

minor change

d49c487

FitseTLT added 2 commits January 21, 2024 23:48

updated to run our effect only when there is new message received

7faf409

refined logic

1a022da

Merge branch 'main' into fix-mark-as-read-on-visibility-change

bd613b8

abdulrahuman5196 mentioned this pull request Jan 22, 2024

[HOLD for payment 2024-03-14] [HOLD for payment 2024-02-07] [$500] HIGH: Mark the chat as "read" immediately upon switching to the tab #33680

Closed

fixed unread marker inconsistency

44d8298

fix condition to consider usage on different device

9f56657

abdulrahuman5196 approved these changes Jan 23, 2024

View reviewed changes

melvin-bot bot requested a review from hayata-suenaga January 23, 2024 18:56

jeremy-croff mentioned this pull request Jan 24, 2024

fix: use focus listeners for message read status #35004

Closed

50 tasks

hayata-suenaga approved these changes Jan 24, 2024

View reviewed changes

Merge branch 'main' into fix-mark-as-read-on-visibility-change

6738d1d

hayata-suenaga merged commit 77814e5 into Expensify:main Jan 24, 2024
27 checks passed

github-actions bot mentioned this pull request Jan 25, 2024

Deploy Checklist: New Expensify 2024-01-25 #35138

Closed

48 tasks

bernhardoj mentioned this pull request Jan 26, 2024

[HOLD for payment 2024-02-07] [HOLD for payment 2024-02-05] [$500] Desktop - Unread chat becomes unbolded in LHN without opening unread messages #35254

Closed

6 tasks

arosiclair mentioned this pull request Jan 26, 2024

[HOLD for payment 2024-02-07] [HOLD for payment 2024-02-05] Desktop - Unread marker remains after opening chat with new messages #35251

Closed

6 tasks

mountiny added a commit that referenced this pull request Jan 29, 2024

Revert "Merge pull request #34537 from FitseTLT/fix-mark-as-read-on-v…

c472590

…isibility-change" This reverts commit 77814e5, reversing changes made to b0e2a92.

mountiny mentioned this pull request Jan 29, 2024

[CP Staging] Revert "Merge pull request #34537 from FitseTLT/fix-mark-as-read-on-v… #35308

Merged

50 tasks

pecanoro added a commit that referenced this pull request Jan 29, 2024

Merge pull request #35308 from Expensify/vit-revert34537

b2e1e21

[CP Staging] Revert "Merge pull request #34537 from FitseTLT/fix-mark-as-read-on-v…

OSBotify pushed a commit that referenced this pull request Jan 29, 2024

Merge pull request #35308 from Expensify/vit-revert34537

6fc4a5e

[CP Staging] Revert "Merge pull request #34537 from FitseTLT/fix-mark-as-read-on-v… (cherry picked from commit b2e1e21)

github-actions bot mentioned this pull request Jan 29, 2024

Deploy Checklist: New Expensify 2024-01-29 #35328

Closed

jeremy-croff mentioned this pull request Mar 14, 2024

[Hold for #35004][$500] Android - LNH - Chat stays unread after opening notification #34698

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix - Mark the chat as "read" immediately upon switching to the tab #34537

Fix - Mark the chat as "read" immediately upon switching to the tab #34537

FitseTLT commented Jan 15, 2024 •

edited

Loading

melvin-bot bot commented Jan 15, 2024

abdulrahuman5196 left a comment

FitseTLT commented Jan 18, 2024

FitseTLT commented Jan 18, 2024 •

edited

Loading

FitseTLT commented Jan 19, 2024

abdulrahuman5196 commented Jan 19, 2024

FitseTLT commented Jan 19, 2024

abdulrahuman5196 commented Jan 19, 2024

abdulrahuman5196 commented Jan 19, 2024

abdulrahuman5196 commented Jan 19, 2024 •

edited

Loading

FitseTLT commented Jan 21, 2024

abdulrahuman5196 commented Jan 22, 2024

abdulrahuman5196 commented Jan 22, 2024

FitseTLT commented Jan 22, 2024

abdulrahuman5196 commented Jan 23, 2024

FitseTLT commented Jan 23, 2024

abdulrahuman5196 commented Jan 23, 2024 •

edited

Loading

abdulrahuman5196 left a comment

hayata-suenaga left a comment

jeremy-croff commented Jan 24, 2024

OSBotify commented Jan 24, 2024

OSBotify commented Jan 25, 2024

OSBotify commented Jan 29, 2024

OSBotify commented Jan 29, 2024

OSBotify commented Jan 31, 2024

Fix - Mark the chat as "read" immediately upon switching to the tab #34537

Fix - Mark the chat as "read" immediately upon switching to the tab #34537

Conversation

FitseTLT commented Jan 15, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Jan 15, 2024

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

FitseTLT commented Jan 18, 2024

FitseTLT commented Jan 18, 2024 • edited Loading

FitseTLT commented Jan 19, 2024

abdulrahuman5196 commented Jan 19, 2024

FitseTLT commented Jan 19, 2024

abdulrahuman5196 commented Jan 19, 2024

abdulrahuman5196 commented Jan 19, 2024

abdulrahuman5196 commented Jan 19, 2024 • edited Loading

FitseTLT commented Jan 21, 2024

abdulrahuman5196 commented Jan 22, 2024

abdulrahuman5196 commented Jan 22, 2024

FitseTLT commented Jan 22, 2024

abdulrahuman5196 commented Jan 23, 2024

FitseTLT commented Jan 23, 2024

abdulrahuman5196 commented Jan 23, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

abdulrahuman5196 left a comment

Choose a reason for hiding this comment

hayata-suenaga left a comment

Choose a reason for hiding this comment

jeremy-croff commented Jan 24, 2024

OSBotify commented Jan 24, 2024

OSBotify commented Jan 25, 2024

OSBotify commented Jan 29, 2024

OSBotify commented Jan 29, 2024

OSBotify commented Jan 31, 2024

FitseTLT commented Jan 15, 2024 •

edited

Loading

FitseTLT commented Jan 18, 2024 •

edited

Loading

abdulrahuman5196 commented Jan 19, 2024 •

edited

Loading

abdulrahuman5196 commented Jan 23, 2024 •

edited

Loading