Merge pull request #13600 from Expensify/tgolen-fix-unread-count-on-s…

…ignout

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

src/Expensify.js

@@ -24,6 +24,10 @@ import * as User from './libs/actions/User';
 import NetworkConnection from './libs/NetworkConnection';
 import Navigation from './libs/Navigation/Navigation';
 
+// This lib needs to be imported, but it has nothing to export since all it contains is an Onyx connection
+// eslint-disable-next-line no-unused-vars
+import UnreadIndicatorUpdater from './libs/UnreadIndicatorUpdater';
+
 Onyx.registerLogger(({level, message}) => {
     if (level === 'alert') {
         Log.alert(message);

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';
 import ONYXKEYS from '../../../ONYXKEYS';
 import Timing from '../../actions/Timing';
@@ -101,8 +100,6 @@ class AuthScreens extends React.Component {
             User.subscribeToUserEvents();
         });
 
-        // Listen for report changes and fetch some data we need on initialization
-        UnreadIndicatorUpdater.listenForReportChanges();
         App.openApp();
         App.setUpPoliciesAndNavigate(this.props.session);
         Timing.end(CONST.TIMING.HOMEPAGE_INITIAL_RENDER);

src/libs/Navigation/NavigationRoot.js

@@ -8,7 +8,6 @@ import AppNavigator from './AppNavigator';
 import FullScreenLoadingIndicator from '../../components/FullscreenLoadingIndicator';
 import themeColors from '../../styles/themes/default';
 import styles from '../../styles/styles';
-import UnreadIndicatorUpdater from '../UnreadIndicatorUpdater';
 import Log from '../Log';
 
 // https://reactnavigation.org/docs/themes
@@ -46,7 +45,6 @@ function parseAndLogRoute(state) {
         Log.info('Navigating to route', false, {path: currentPath});
     }
 
-    UnreadIndicatorUpdater.throttledUpdatePageTitleAndUnreadCount();
     Navigation.setIsNavigationReady();
 }
 

src/libs/ReportUtils.js

@@ -1014,6 +1014,10 @@ function buildOptimisticWorkspaceChats(policyID, policyName) {
  * @returns {Boolean}
  */
 function isUnread(report) {
+    if (!report) {
+        return false;
+    }
+
     const lastReadSequenceNumber = report.lastReadSequenceNumber || 0;
     const maxSequenceNumber = report.maxSequenceNumber || 0;
     return lastReadSequenceNumber < maxSequenceNumber;

src/libs/UnreadIndicatorUpdater/index.js

@@ -1,54 +1,14 @@
 import _ from 'underscore';
 import Onyx from 'react-native-onyx';
 import ONYXKEYS from '../../ONYXKEYS';
-import updateUnread from './updateUnread';
+import updateUnread from './updateUnread/index';
 import * as ReportUtils from '../ReportUtils';
 
-const reports = {};
-
-/**
- * Updates the title and favicon of the current browser tab and Mac OS or iOS dock icon with an unread indicator.
- * Note: We are throttling this since listening for report changes can trigger many updates depending on how many reports
- * a user has and how often they are updated.
- */
-const throttledUpdatePageTitleAndUnreadCount = _.throttle(() => {
-    const totalCount = _.filter(reports, ReportUtils.isUnread).length;
-    updateUnread(totalCount);
-}, 100, {leading: false});
-
-let connectionID;
-
-/**
- * Bind to the report collection key and update
- * the title and unread count indicators
- */
-function listenForReportChanges() {
-    connectionID = Onyx.connect({
-        key: ONYXKEYS.COLLECTION.REPORT,
-        callback: (report) => {
-            if (!report || !report.reportID) {
-                return;
-            }
-
-            reports[report.reportID] = report;
-            throttledUpdatePageTitleAndUnreadCount();
-        },
-    });
-}
-
-/**
- * Remove the subscription callback when we no longer need it.
- */
-function stopListeningForReportChanges() {
-    if (!connectionID) {
-        return;
-    }
-
-    Onyx.disconnect(connectionID);
-}
-
-export default {
-    listenForReportChanges,
-    stopListeningForReportChanges,
-    throttledUpdatePageTitleAndUnreadCount,
-};
+Onyx.connect({
+    key: ONYXKEYS.COLLECTION.REPORT,
+    waitForCollectionCallback: true,
+    callback: (reportsFromOnyx) => {
+        const unreadReports = _.filter(reportsFromOnyx, ReportUtils.isUnread);
+        updateUnread(_.size(unreadReports));
+    },
+});

src/libs/UnreadIndicatorUpdater/updateUnread/index.website.js

@@ -11,11 +11,15 @@ import CONFIG from '../../../CONFIG';
 function updateUnread(totalCount) {
     const hasUnread = totalCount !== 0;
 
-    // There is a Chrome browser bug that causes the title to revert back to the previous when we are navigating back. Setting the title to an empty string
-    // seems to improve this issue.
-    document.title = '';
-    document.title = hasUnread ? `(${totalCount}) ${CONFIG.SITE_TITLE}` : CONFIG.SITE_TITLE;
-    document.getElementById('favicon').href = hasUnread ? CONFIG.FAVICON.UNREAD : CONFIG.FAVICON.DEFAULT;
+    // This setTimeout is required because due to how react rendering messes with the DOM, the document title can't be modified synchronously, and we must wait until all JS is done
+    // running before setting the title.
+    setTimeout(() => {
+        // There is a Chrome browser bug that causes the title to revert back to the previous when we are navigating back. Setting the title to an empty string
+        // seems to improve this issue.
+        document.title = '';
+        document.title = hasUnread ? `(${totalCount}) ${CONFIG.SITE_TITLE}` : CONFIG.SITE_TITLE;
+        document.getElementById('favicon').href = hasUnread ? CONFIG.FAVICON.UNREAD : CONFIG.FAVICON.DEFAULT;
+    }, 0);
 }
 
 export default updateUnread;

src/libs/actions/Session/index.js

@@ -9,7 +9,6 @@ import PushNotification from '../../Notification/PushNotification';
 import Timing from '../Timing';
 import CONST from '../../../CONST';
 import * as Localize from '../../Localize';
-import UnreadIndicatorUpdater from '../../UnreadIndicatorUpdater';
 import Timers from '../../Timers';
 import * as Pusher from '../../Pusher/pusher';
 import * as Authentication from '../../Authentication';
@@ -310,8 +309,6 @@ function clearSignInData() {
  * Put any logic that needs to run when we are signed out here. This can be triggered when the current tab or another tab signs out.
  */
 function cleanupSession() {
-    // We got signed out in this tab or another so clean up any subscriptions and timers
-    UnreadIndicatorUpdater.stopListeningForReportChanges();
     PushNotification.deregister();
     PushNotification.clearNotifications();
     Pusher.disconnect();

src/pages/signin/SignInPage.js

@@ -6,7 +6,6 @@ import PropTypes from 'prop-types';
 import {withOnyx} from 'react-native-onyx';
 import ONYXKEYS from '../../ONYXKEYS';
 import styles from '../../styles/styles';
-import updateUnread from '../../libs/UnreadIndicatorUpdater/updateUnread/index';
 import compose from '../../libs/compose';
 import SignInPageLayout from './SignInPageLayout';
 import LoginForm from './LoginForm';
@@ -44,9 +43,6 @@ const defaultProps = {
 
 class SignInPage extends Component {
     componentDidMount() {
-        // Always reset the unread counter to zero on this page
-        // NOTE: We need to wait for the next tick to ensure that the unread indicator is updated
-        setTimeout(() => updateUnread(0), 0);
         Performance.measureTTI();
     }