Updated logic to handle unread messages case #25935
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,27 +2,28 @@ import PropTypes from 'prop-types'; | |
| import React, {useCallback, useEffect, useMemo, useRef, useState} from 'react'; | ||
| import Animated, {useAnimatedStyle, useSharedValue, withTiming} from 'react-native-reanimated'; | ||
| import _ from 'underscore'; | ||
| import {DeviceEventEmitter} from 'react-native'; | ||
| import {useRoute} from '@react-navigation/native'; | ||
| import lodashGet from 'lodash/get'; | ||
| import compose from '../../../libs/compose'; | ||
| import styles from '../../../styles/styles'; | ||
| import * as ReportUtils from '../../../libs/ReportUtils'; | ||
| import * as Report from '../../../libs/actions/Report'; | ||
| import withWindowDimensions, {windowDimensionsPropTypes} from '../../../components/withWindowDimensions'; | ||
| import withCurrentUserPersonalDetails, {withCurrentUserPersonalDetailsPropTypes, withCurrentUserPersonalDetailsDefaultProps} from '../../../components/withCurrentUserPersonalDetails'; | ||
| import CONST from '../../../CONST'; | ||
| import InvertedFlatList from '../../../components/InvertedFlatList'; | ||
| import {withPersonalDetails} from '../../../components/OnyxProvider'; | ||
| import ReportActionsSkeletonView from '../../../components/ReportActionsSkeletonView'; | ||
| import variables from '../../../styles/variables'; | ||
| import reportActionPropTypes from './reportActionPropTypes'; | ||
| import useLocalize from '../../../hooks/useLocalize'; | ||
| import useNetwork from '../../../hooks/useNetwork'; | ||
| import useReportScrollManager from '../../../hooks/useReportScrollManager'; | ||
| import DateUtils from '../../../libs/DateUtils'; | ||
| import reportPropTypes from '../../reportPropTypes'; | ||
| import FloatingMessageCounter from './FloatingMessageCounter'; | ||
| import ReportActionsListItemRenderer from './ReportActionsListItemRenderer'; | ||
|
|
||
| const propTypes = { | ||
| /** The report currently being looked at */ | ||
|
|
@@ -74,16 +75,15 @@ const defaultProps = { | |
| const VERTICAL_OFFSET_THRESHOLD = 200; | ||
| const MSG_VISIBLE_THRESHOLD = 250; | ||
|
|
||
| // In the component we are subscribing to the arrival of new actions. | ||
| // As there is the possibility that there are multiple instances of a ReportScreen | ||
| // for the same report, we only ever want one subscription to be active, as | ||
| // the subscriptions could otherwise be conflicting. | ||
| const newActionUnsubscribeMap = {}; | ||
|
|
||
| // We cache the unread markers for each report, because the unread marker isn't | ||
| // kept between reports. | ||
| const cacheUnreadMarkers = new Map(); | ||
|
There was a problem hiding this comment. @gedu @MonilBhavsar Hey I'm working on a bug related to unread markers and I'm having trouble wrapping my head around this cache. What problem/scenario does it fix specifically? Like is there a scenario where when we switch away from a report and then navigate back, we want the unread marker to persist? |
||
| /** | ||
| * Create a unique key for each action in the FlatList. | ||
| * We use the reportActionID that is a string representation of a random 64-bit int, which should be | ||
|
|
@@ -122,10 +122,19 @@ function ReportActionsList({ | |
| const route = useRoute(); | ||
| const opacity = useSharedValue(0); | ||
| const userActiveSince = useRef(null); | ||
| const prevReportID = useRef(null); | ||
| const unreadActionSubscription = useRef(null); | ||
| const markerInit = () => { | ||
| if (!cacheUnreadMarkers.has(report.reportID)) { | ||
| return null; | ||
| } | ||
| return cacheUnreadMarkers.get(report.reportID); | ||
| }; | ||
| const [currentUnreadMarker, setCurrentUnreadMarker] = useState(markerInit); | ||
| const scrollingVerticalOffset = useRef(0); | ||
| const readActionSkipped = useRef(false); | ||
| const reportActionSize = useRef(sortedReportActions.length); | ||
| const lastReadRef = useRef(report.lastReadTime); | ||
MonilBhavsar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| const firstRenderRef = useRef(true); | ||
| const linkedReportActionID = lodashGet(route, 'params.reportActionID', ''); | ||
|
|
||
|
|
@@ -145,16 +154,16 @@ function ReportActionsList({ | |
| // If the reportID changes, we reset the userActiveSince to null, we need to do it because | ||
| // the parent component is sending the previous reportID even when the user isn't active | ||
| // on the report | ||
| if (userActiveSince.current && prevReportID.current && prevReportID.current !== report.reportID) { | ||
| userActiveSince.current = null; | ||
| } else { | ||
| userActiveSince.current = DateUtils.getDBTime(); | ||
| } | ||
| prevReportID.current = report.reportID; | ||
| }, [report.reportID]); | ||
|
|
||
| useEffect(() => { | ||
| if (!userActiveSince.current || report.reportID !== prevReportID.current) { | ||
| return; | ||
| } | ||
|
|
||
|
|
@@ -170,25 +179,41 @@ function ReportActionsList({ | |
| return; | ||
| } | ||
|
|
||
| cacheUnreadMarkers.delete(report.reportID); | ||
| reportActionSize.current = sortedReportActions.length; | ||
| setCurrentUnreadMarker(null); | ||
| // eslint-disable-next-line react-hooks/exhaustive-deps | ||
| }, [sortedReportActions.length, report.reportID]); | ||
|
|
||
| useEffect(() => { | ||
| if (!userActiveSince.current || report.reportID !== prevReportID.current) { | ||
| return; | ||
| } | ||
| if (!messageManuallyMarkedUnread && lastReadRef.current && lastReadRef.current < report.lastReadTime) { | ||
MonilBhavsar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| cacheUnreadMarkers.delete(report.reportID); | ||
| } | ||
| lastReadRef.current = report.lastReadTime; | ||
| setMessageManuallyMarkedUnread(0); | ||
|
|
||
| // eslint-disable-next-line react-hooks/exhaustive-deps | ||
| }, [report.lastReadTime, report.reportID]); | ||
|
|
||
| useEffect(() => { | ||
| // If the reportID changes, we reset the userActiveSince to null, we need to do it because | ||
| // this component doesn't unmount when the reportID changes | ||
| if (unreadActionSubscription.current) { | ||
| unreadActionSubscription.current.remove(); | ||
| unreadActionSubscription.current = null; | ||
| } | ||
|
|
||
| // Need to listen for the specific reportID, otherwise we could be listening to all the reports | ||
MonilBhavsar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| unreadActionSubscription.current = DeviceEventEmitter.addListener(`unreadAction_${report.reportID}`, (newLastReadTime) => { | ||
| cacheUnreadMarkers.delete(report.reportID); | ||
| lastReadRef.current = newLastReadTime; | ||
| setCurrentUnreadMarker(null); | ||
| setMessageManuallyMarkedUnread(new Date().getTime()); | ||
|
There was a problem hiding this comment. I haven't seen this event driven pattern used in our app before. Would you mind explaining why this is needed? There was a problem hiding this comment. Was added here point 3. |
||
| }); | ||
| }, [report.reportID]); | ||
|
|
||
| useEffect(() => { | ||
| // Why are we doing this, when in the cleanup of the useEffect we are already calling the unsubscribe function? | ||
|
|
@@ -285,19 +310,23 @@ function ReportActionsList({ | |
| const renderItem = useCallback( | ||
| ({item: reportAction, index}) => { | ||
| let shouldDisplayNewMarker = false; | ||
| if (!currentUnreadMarker) { | ||
| const nextMessage = sortedReportActions[index + 1]; | ||
| const isCurrentMessageUnread = isMessageUnread(reportAction, lastReadRef.current); | ||
| let canDisplayNewMarker = isCurrentMessageUnread && !isMessageUnread(nextMessage, lastReadRef.current); | ||
|
|
||
MonilBhavsar marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if (!messageManuallyMarkedUnread) { | ||
| canDisplayNewMarker = canDisplayNewMarker && reportAction.actorAccountID !== Report.getCurrentUserAccountID(); | ||
| } | ||
|
|
||
| let isMessageInScope = scrollingVerticalOffset.current < MSG_VISIBLE_THRESHOLD ? reportAction.created < userActiveSince.current : true; | ||
| if (messageManuallyMarkedUnread) { | ||
| isMessageInScope = true; | ||
| } | ||
| if (!currentUnreadMarker && canDisplayNewMarker && isMessageInScope) { | ||
| cacheUnreadMarkers.set(report.reportID, reportAction.reportActionID); | ||
| setCurrentUnreadMarker(reportAction.reportActionID); | ||
| shouldDisplayNewMarker = true; | ||
| } | ||
| } else { | ||
| shouldDisplayNewMarker = reportAction.reportActionID === currentUnreadMarker; | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is weird. I'm not sure if we're returning unrelated parameters from an action elsewhere. A better way would be to just use onyx to get
lastReadTimefrom the report.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it was for emitting the even, but I will move the emitting into the function, so it won't need to return it