Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated logic to handle unread messages case #25935

Merged
merged 43 commits into from
Nov 16, 2023

Conversation

gedu
Copy link
Contributor

@gedu gedu commented Aug 25, 2023

Details

Fixed Issues

$ #23171
PROPOSAL: -

Tests

  • Verify that no errors appear in the JS console
  1. have 2 accounts
  2. with user A, mark a message as unread
  3. with user B, start sending many messages
  4. user A should see the unread marker in the same message
  5. user A can send a message and the marker still showing

Offline tests

QA Steps

  • 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 / Chrome
    • iOS / native
    • iOS / 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 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
      • 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 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 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
markingUnread_multiple_messages_chrome.mp4
markingUnread_multiple_messages_safari.mp4
Mobile Web - Chrome
markingUnread_multiple_messages_androidWeb.mp4
Mobile Web - Safari
markingUnread_multiple_messages_iPhoneWeb.mp4
Desktop
markingUnread_multiple_messages_desktop.mp4
iOS
markingUnread_multiple_messages_iPhone.mp4
Android
markingUnread_multiple_messages_android.mp4

Copy link
Contributor

@MonilBhavsar MonilBhavsar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some issues with marker not being displayed when revisiting the chat after marking it as unread. DM'ed Eduardo

@gedu gedu marked this pull request as ready for review September 29, 2023 12:56
@gedu gedu requested a review from a team as a code owner September 29, 2023 12:56
@melvin-bot melvin-bot bot requested review from allroundexperts and removed request for a team September 29, 2023 12:56
@melvin-bot
Copy link

melvin-bot bot commented Sep 29, 2023

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

@MonilBhavsar
Copy link
Contributor

@allroundexperts could you please take a look.
@gedu there are conflicts again 😬

# Conflicts:
#	src/pages/home/report/ReportActionsList.js
@gedu
Copy link
Contributor Author

gedu commented Oct 3, 2023

@MonilBhavsar conflicts solved

@allroundexperts
Copy link
Contributor

@allroundexperts could you please take a look. @gedu there are conflicts again 😬

On it!

@@ -842,6 +842,8 @@ function readNewestAction(reportID) {
*
* @param {String} reportID
* @param {String} reportActionCreated
*
* @returns {String} lastReadTime
Copy link
Contributor

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 lastReadTime from the report.

Copy link
Contributor Author

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

@@ -251,7 +252,8 @@ export default [
shouldShow: (type, reportAction, isArchivedRoom, betas, anchor, isChronosReport, reportID, isPinnedChat, isUnreadChat) =>
type === CONTEXT_MENU_TYPES.REPORT_ACTION || (type === CONTEXT_MENU_TYPES.REPORT && !isUnreadChat),
onPress: (closePopover, {reportAction, reportID}) => {
Report.markCommentAsUnread(reportID, reportAction.created);
const lastReadTime = Report.markCommentAsUnread(reportID, reportAction.created);
DeviceEventEmitter.emit(`unreadAction_${reportID}`, lastReadTime);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can't we inside from inside the action? I think that would be better since we won't be requiring the action to return stuff.

Comment on lines 211 to 214
cacheUnreadMarkers.delete(report.reportID);
lastReadRef.current = newLastReadTime;
setCurrentUnreadMarker(null);
setMessageManuallyMarkedUnread(new Date().getTime());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't seen this event driven pattern used in our app before. Would you mind explaining why this is needed?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was added here point 3.
I just moved the code around because of conflicts. Basically setting a new number produces a rerender, but when is clean, setting 0, and we try to set 0 again, because it is 0 already no rerender event is fired

@gedu
Copy link
Contributor Author

gedu commented Oct 9, 2023

@allroundexperts Conflicts solved + comments

@gedu
Copy link
Contributor Author

gedu commented Nov 15, 2023

I just took a look at it, and the bug wasn't coming from our code, was coming from PusherUtils, but after merging again with main I couldn't reproduce the bug. It is all pushed, if you can give it another round. @MonilBhavsar @shubham1206agra

Screen.Recording.2023-11-15.at.21.07.08.mp4

@shubham1206agra
Copy link
Contributor

Have you pushed the merge commit? @gedu
Cause I can still able to repro this on this PR.

@gedu
Copy link
Contributor Author

gedu commented Nov 16, 2023

@shubham1206agra @MonilBhavsar pushed the merge

@gedu
Copy link
Contributor Author

gedu commented Nov 16, 2023

Checking again, because @MonilBhavsar can reproduce it, and I just could reproduce it again

@shubham1206agra
Copy link
Contributor

shubham1206agra commented Nov 16, 2023

@gedu Can you check the repro on main also?

@MonilBhavsar
Copy link
Contributor

It is not reproducible on main for me

@MonilBhavsar
Copy link
Contributor

Thanks! It works fine for me now. @shubham1206agra could you also please confirm, thanks

@shubham1206agra
Copy link
Contributor

@MonilBhavsar Working fine now

@MonilBhavsar
Copy link
Contributor

Wohoo, thanks for confirming!

Copy link
Contributor

@MonilBhavsar MonilBhavsar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! 🚀
Thanks all!

@Expensify Expensify deleted a comment from allroundexperts Nov 16, 2023
@MonilBhavsar
Copy link
Contributor

Dismissed old PR reviewer checklist.
New one is here #25935 (comment)

@MonilBhavsar MonilBhavsar merged commit d220f6c into Expensify:main Nov 16, 2023
16 checks passed
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@rlinoz
Copy link
Contributor

rlinoz commented Nov 21, 2023

This PR might have caused this regression, generating an adhoc build to check.

@OSBotify
Copy link
Contributor

🧪🧪 Use the links below to test this adhoc build on Android, iOS, Desktop, and Web. Happy testing! 🧪🧪

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.amazonaws.com/android/25935/index.html https://ad-hoc-expensify-cash.s3.amazonaws.com/ios/25935/index.html
Android iOS
Desktop 💻 Web 🕸️
https://ad-hoc-expensify-cash.s3.amazonaws.com/desktop/25935/NewExpensify.dmg https://25935.pr-testing.expensify.com
Desktop Web

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.4.1-13 🚀

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

@cubuspl42
Copy link
Contributor

Is #31617 a regression of this PR?

@rlinoz
Copy link
Contributor

rlinoz commented Nov 27, 2023

From what I tested it potentially is, but I didn't actually revert this PR to check, just tested the Adhoc build.

// of the relevant reportActionID for displaying the green line.
// We need to persist it across reports because there are at least 3 ReportScreen components created so the
// internal states are resetted or recreated.
const cacheUnreadMarkers = new Map();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants