Fix the unread count not going away when you've signed out #13600

tgolen · 2022-12-14T20:51:42Z

Fixed Issues

Tests

For web, desktop, and mobile web:

Sign in and have another account send you a message
Verify that the unread counter goes up (either page title or icon badge). For mobile web, you need to open the browser window which shows the open tabs in order to verify the page titles.
Access the unread chat
Verify that the unread counter goes down
Make sure you have at least 1 unread chat showing on the counter and sign out
Verify that the unread counter goes away completely

For native devices:
The badge counters don't work in local environment, so they can't really be tested. Just generally do some regression testing to ensure that the unread stuff works like it should

Sign in and have another account send you a message
Verify that the LHN appears with the unread chat
Go into the chat
Go back to the LHN and verify the chat is no longer marked as unread

Verify that no errors appear in the JS console

Offline tests

Be signed into the app with an unread chat
Sign out
Verify that the counter goes away

web offline test video

2022-12-14_13-42-55.mp4

QA Steps

Sign in and have another account send you a message
Verify that the unread counter goes up (either page title or icon badge). For mobile web, you need to open the browser window which shows the open tabs in order to verify the page titles.
Access the unread chat
Verify that the unread counter goes down
Make sure you have at least 1 unread chat showing on the counter and sign out
Verify that the unread counter goes away completely

PR Author Checklist

Screenshots/Videos

Web

2022-12-14_13-19-25.mp4

Mobile Web - Chrome

2022-12-14_13-46-21.mp4

Mobile Web - Safari

2022-12-14_13-47-05.mp4

Desktop

2022-12-14_13-20-32.mp4

iOS

2022-12-14_13-26-38.mp4

Android

2022-12-14_13-32-16.mp4

melvin-bot · 2022-12-14T20:55:48Z

@puneetlath @sobitneupane One of you needs to 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]

puneetlath · 2022-12-14T21:44:54Z

@tgolen lint check is failing.

puneetlath · 2022-12-14T21:47:09Z

@sobitneupane if you're able to get to this soon, then I'll let you take the first crack at it.

tgolen · 2022-12-14T22:34:34Z

Fixed the lint errors 👍

sobitneupane · 2022-12-15T06:09:33Z

@tgolen I didn't get the expected output. I tried sending some messages. But unread indicator did not update.

Screen.Recording.2022-12-15.at.11.44.12.mov

fedirjh · 2022-12-15T15:09:55Z

@tgolen I didn't get the expected output. I tried sending some messages. But unread indicator did not update.

@sobitneupane i think that the subscription isn't imported anywhere in the App

tgolen · 2022-12-15T15:38:40Z

src/libs/Navigation/AppNavigator/AuthScreens.js

@@ -10,7 +10,6 @@ import compose from '../../compose';
 import * as PersonalDetails from '../../actions/PersonalDetails';
 import * as Pusher from '../../Pusher/pusher';
 import PusherConnectionManager from '../../PusherConnectionManager';
-import UnreadIndicatorUpdater from '../../UnreadIndicatorUpdater';
 import ROUTES from '../../../ROUTES';


OK, sorry. I think I might have broken this when I just fixed the linter tests via the GitHub web interface. Sorry about that! Let me do this properly and test it out again.

changes looks good

tgolen · 2022-12-15T15:54:01Z

OK, I fixed the lib import and retested it to make sure it's working again.

fedirjh · 2022-12-15T17:45:25Z

src/libs/Navigation/AppNavigator/AuthScreens.js

@@ -10,7 +10,6 @@ import compose from '../../compose';
 import * as PersonalDetails from '../../actions/PersonalDetails';
 import * as Pusher from '../../Pusher/pusher';
 import PusherConnectionManager from '../../PusherConnectionManager';
-import UnreadIndicatorUpdater from '../../UnreadIndicatorUpdater';
 import ROUTES from '../../../ROUTES';


changes looks good

puneetlath

It looks good to me, but @tgolen it looks like you have some unit tests failing.

@sobitneupane will you be able to review/test this PR in the next day?

tgolen · 2022-12-15T20:58:44Z

OK, I'll look into those unit tests.

sobitneupane · 2022-12-17T05:13:43Z

Screenshots/Videos

Web

Screen.Recording.2022-12-16.at.18.14.54.mov

Mobile Web - Chrome

Screen.Recording.2022-12-17.at.10.32.44.mov

Mobile Web - Safari

Screen.Recording.2022-12-17.at.10.26.22.mov

Desktop

Screen.Recording.2022-12-17.at.10.21.19.mov

iOS

Screen.Recording.2022-12-16.at.18.22.05.mov

Android

Screen.Recording.2022-12-16.at.18.57.03.mov

tgolen · 2022-12-19T17:48:03Z

@tgolen I am getting following console error.

OK, I'm not sure how that can happen, but I've added a check for a null report object now which should prevent that from happening.

puneetlath · 2022-12-19T22:41:33Z

@sobitneupane are you able to test again?

sobitneupane · 2022-12-20T07:27:48Z

@tgolen With the latest change, when we reload the page after sign out (or close the tab and reopen expensify on new tab after signout), the unread count reappears.

Tested with the following account:
email: applausetester+0901abb@applause.expensifail.com
Password: Feya86Katya

I was able to reproduce the issue on chrome only (not on firefox, safari and chrome incognito).

tgolen · 2022-12-20T18:02:00Z

OK, thanks for reporting that. Let me look into that. That's really strange.

tgolen · 2022-12-20T18:25:32Z

I tried to reproduce it, and I couldn't reproduce it in Chrome on either MacOS or Android mobile web. This is what I did:

Sign into an account that has an unread chat
Verify the title shows there is an unread chat
Sign out
Verify the title shows 0 unread chats
Refresh
Verify the title still shows 0 unread chats

I'm going to remerge main into this branch just to see if that helps you. Please make sure to do a fresh npm i before testing it again.

sobitneupane · 2022-12-20T18:53:09Z

I was able to reproduce similar issue in staging as well.

When I log out from one account and login to another account, reports from logged out account also appears in the newly logged in account.

For example, in the following picture reports in LHN with red capsule do not belong to currently logged in user.

So, I think #13600 (comment) bug is also caused by the same issue.

tgolen · 2022-12-20T18:57:01Z

I don't think I'm following you. The changes in this PR can't affect anything on staging, so the changes here should only improve any problems you saw on staging.

sobitneupane · 2022-12-20T19:01:18Z

I mean to say #13600 (comment) and #13600 (comment) bug might be caused by same issue. And might not be related to this PR. I will report it in expensify-bug channel to see if any other user has seen the similar bug.

sobitneupane · 2022-12-20T19:28:46Z

Screen.Recording.2022-12-21.at.01.04.57.mov

puneetlath · 2022-12-20T19:32:46Z

@sobitneupane so are you still seeing issues with this PR or no?

I just tried testing on Chrome and wasn't able to reproduce the issue.

sobitneupane · 2022-12-20T19:38:27Z

@puneetlath Yes, I am still reproduce #13600 (comment) issue. Interestingly, I can only reproduce it on chrome non-incognito.

tgolen · 2022-12-20T21:43:03Z

Hm, I was definitely also testing it in chrom non-icognito. When I first tried to reproduce it, I thought it happened, but then I had some errors in the JS console about missing libs, and that's when I ended up remerging main into the branch and restarting webpack. That made the errors go away and I could no longer reproduce it at all.

fedirjh · 2022-12-20T22:05:39Z

@tgolen I haven't tested these changes yet , but what I see in @sobitneupane video I can see where the bug is . i can tell that this is related to both onyx clear logic which delay clearing and the fact that you have imported the subscriber in the whole App . The subsriber should be imported in AuthScreen . Because when he refresh before onyx finish , the data that wasn't cleared will be used by onyx and the subscriber will be triggered again (we have data and subscriber is imported) a fix for this will be to import subscriber on AuthScreen and/or to close the subscriber connection after logout

import subscriber on AuthScreen instead of globally import

Edit: I think this is enough to fix the issue

fedirjh · 2022-12-21T12:37:21Z

@tgolen as yo can see here the subscriber callback is called on guest screen when Onyx have data (unfinished clearing)

Screen.Recording.2022-12-21.at.1.27.24.PM.mov

tgolen · 2022-12-28T16:36:22Z

@fedirjh Thanks for those comments! I think it's perfectly fine to have the subscriber where it is. Shouldn't we be more concerned with why there is still report data in Onyx after signing out? That seems to be the root of the issue.

tgolen · 2022-12-28T16:40:58Z

Today I tried to reproduce the issue with a large account. I've got an account with 4000 reports and 4000 users, and I wasn't able to reproduce the issue of Onyx not clearing out all the data. I think we need to try and zero-in on how exactly to reproduce that and treat it as a separate issue. Though, I also saw that we are reverting some of the changes to Onyx.clear(), so we might want to hold off on doing anything until we know what the final state of Onyx.clear() will be.

For this PR, I think the changes are good and will remain good regardless of what happens to fix Onyx.clear().

sobitneupane · 2022-12-30T05:20:29Z

We have new issue to handle issues like this. I think we can move forward this this PR.

@puneetlath Overall change looks good to me.

sobitneupane

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 / Chrome
- iOS / native
- iOS / 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 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 correct English and 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

OSBotify · 2022-12-30T17:10:47Z

✋ 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 · 2023-01-02T18:27:29Z

🚀 Deployed to staging by @puneetlath in version: 1.2.47-0 🚀

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

OSBotify · 2023-01-04T02:56:09Z

🚀 Deployed to production by @roryabraham in version: 1.2.47-0 🚀

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

tgolen added 5 commits December 13, 2022 13:56

Remove unnecessary method

13a7b96

WIP on cleaning up unread report counter

8083313

Update version of Onyx

38d81be

Update page title after JS is done running

069c338

Update podfile lock too

dedbdb2

tgolen self-assigned this Dec 14, 2022

Remove some debug code

f23efa1

tgolen marked this pull request as ready for review December 14, 2022 20:55

tgolen requested a review from a team as a code owner December 14, 2022 20:55

melvin-bot bot requested review from puneetlath and sobitneupane and removed request for a team December 14, 2022 20:55

tgolen added 4 commits December 14, 2022 14:49

Remove unused imports

d68cd57

Remove unused import

22a942b

Remove unused import

1091618

Remove unused import

e43d8af

fedirjh suggested changes Dec 15, 2022

View reviewed changes

Import the lib for updating the unread count

99f7c57

fedirjh previously approved these changes Dec 15, 2022

View reviewed changes

puneetlath previously approved these changes Dec 15, 2022

View reviewed changes

tgolen added 2 commits December 15, 2022 13:58

Merge branch 'main' into tgolen-fix-unread-count-on-signout

c6039ff

Fix failing tests

dff42c6

Protect against null reports

4f7ea06

tgolen dismissed puneetlath’s stale review via 4f7ea06 December 19, 2022 17:47

puneetlath approved these changes Dec 19, 2022

View reviewed changes

Merge branch 'main' into tgolen-fix-unread-count-on-signout

06bf8f4

tgolen mentioned this pull request Dec 29, 2022

[$2000] BUG: unread indicator count is not reset after logout reported by @parasharrajat #11671

Closed

sobitneupane approved these changes Dec 30, 2022

View reviewed changes

puneetlath merged commit 1e539c9 into main Dec 30, 2022

puneetlath deleted the tgolen-fix-unread-count-on-signout branch December 30, 2022 17:06

OSBotify mentioned this pull request Jan 2, 2023

Deploy Checklist: New Expensify 2023-01-02 #13933

Closed

10 tasks

Fix the unread count not going away when you've signed out #13600

Fix the unread count not going away when you've signed out #13600

Conversation

tgolen commented Dec 14, 2022

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 14, 2022

puneetlath commented Dec 14, 2022

puneetlath commented Dec 14, 2022

tgolen commented Dec 14, 2022

sobitneupane commented Dec 15, 2022

fedirjh commented Dec 15, 2022

This comment was marked as resolved.

tgolen Dec 15, 2022

Choose a reason for hiding this comment

fedirjh Dec 15, 2022

Choose a reason for hiding this comment

tgolen commented Dec 15, 2022

fedirjh Dec 15, 2022

Choose a reason for hiding this comment

puneetlath left a comment

Choose a reason for hiding this comment

tgolen commented Dec 15, 2022

sobitneupane commented Dec 17, 2022

Screenshots/Videos

tgolen commented Dec 19, 2022

puneetlath commented Dec 19, 2022

sobitneupane commented Dec 20, 2022

tgolen commented Dec 20, 2022

tgolen commented Dec 20, 2022

sobitneupane commented Dec 20, 2022 • edited Loading

tgolen commented Dec 20, 2022

sobitneupane commented Dec 20, 2022

sobitneupane commented Dec 20, 2022

puneetlath commented Dec 20, 2022

sobitneupane commented Dec 20, 2022

tgolen commented Dec 20, 2022

fedirjh commented Dec 20, 2022 • edited Loading

fedirjh commented Dec 21, 2022

tgolen commented Dec 28, 2022

tgolen commented Dec 28, 2022

sobitneupane commented Dec 30, 2022

sobitneupane left a comment

Choose a reason for hiding this comment

Reviewer Checklist

OSBotify commented Dec 30, 2022

OSBotify commented Jan 2, 2023

OSBotify commented Jan 4, 2023

sobitneupane commented Dec 20, 2022 •

edited

Loading

fedirjh commented Dec 20, 2022 •

edited

Loading