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

Fix new IOU and Split Bill chats not being unread #15052

Merged
merged 8 commits into from
Mar 19, 2023
Merged

Fix new IOU and Split Bill chats not being unread #15052

merged 8 commits into from
Mar 19, 2023

Conversation

puneetlath
Copy link
Contributor

@puneetlath puneetlath commented Feb 10, 2023

Details

Previously, when you send an IOU or split bill request to a person/group you've never chatted with before the chat was not showing as unread for the recipients. This fixes that.

Fixed Issues

$ #13913

Tests

  1. In separate windows/apps sign into accountA and accountB who have never chatted
  2. While both accounts are open, send an IOU request from accountB to accountA
  3. The chat with the IOU request should show up in the LHN for accountA as unread
  4. Sign into accountC that has never chatted with A or B (while A or B is still open in another window/app)
  5. Send a split bill request to A and B
  6. The split bill group chat should show up in the LHN for account A and B as unread
  • Verify that no errors appear in the JS console

Offline tests

Not applicable. You need to be online to receive the request from the other user.

QA Steps

  1. In separate windows/apps sign into accountA and accountB who have never chatted
  2. While both accounts are open, send an IOU request from accountB to accountA
  3. The chat with the IOU request should show up in the LHN for accountA as unread
  4. Sign into accountC that has never chatted with A or B (while A or B is still open in another window/app)
  5. Send a split bill request to A and B
  6. The split bill group chat should show up in the LHN for account A and B as unread
  • 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 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 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 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
    • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web image
Mobile Web - Chrome Screenshot 2023-02-10 at 3 03 35 PM
Mobile Web - Safari Screenshot 2023-02-10 at 3 09 02 PM
Desktop Screenshot 2023-02-10 at 2 51 29 PM
iOS Screenshot 2023-02-10 at 3 11 06 PM
Android Screenshot 2023-02-10 at 3 02 16 PM

@puneetlath puneetlath self-assigned this Feb 10, 2023
@puneetlath puneetlath marked this pull request as ready for review February 10, 2023 20:12
@puneetlath puneetlath requested a review from a team as a code owner February 10, 2023 20:12
@melvin-bot melvin-bot bot requested review from aldo-expensify and parasharrajat and removed request for a team February 10, 2023 20:12
@MelvinBot
Copy link

@parasharrajat @aldo-expensify 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
Copy link
Contributor Author

Wait. Not quite ready for review. Got a failing Jest test.

@puneetlath
Copy link
Contributor Author

Ok @parasharrajat @aldo-expensify we should be good to go now!

@@ -660,7 +661,7 @@ function handleReportChanged(report) {
// A report can be missing a name if a comment is received via pusher event
// and the report does not yet exist in Onyx (eg. a new DM created with the logged in person)
if (report.reportID && report.reportName === undefined) {
openReport(report.reportID);
reconnectToReport(report.reportID);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@parasharrajat this is the change that solves the issue. When the IOU transaction comes in from pusher, we were previously calling openReport, even though the user wasn't actually opening the report, which would mark the report as read.

I instead updated that to call reconnectToReport which fetches the report data without marking it as read.

Copy link
Member

Choose a reason for hiding this comment

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

Yeah, I noticed after adding the comment. But wanted to know your expected scope for this change. I will test it.

@puneetlath
Copy link
Contributor Author

@parasharrajat @aldo-expensify ready for another review.

@puneetlath
Copy link
Contributor Author

Bump @parasharrajat

Copy link
Contributor

@aldo-expensify aldo-expensify 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 to me!

@puneetlath
Copy link
Contributor Author

@parasharrajat bump on review please!

@parasharrajat
Copy link
Member

I will test it in a few minutes.

@parasharrajat
Copy link
Member

parasharrajat commented Feb 15, 2023

Reviewing now.

It seems the openReport call was added in #12157. Basically, we wanted to move to the open API. The old logic was fetching the report data from the backend. But not marking it as read.

So it seems the changes here are correct.

It seems we added this handleReportChanged handler as fall-safe based on the design that always considers report data incomplete on the client side.

Now, I need to make sure that there is no user action that used to depend on this logic to fetch the correct report data including marking the report read.

It could be opening a report directly but we already have tons of checks to mark the report read, like the report becomes visible, the page comes to focus, and the report changed.

@puneetlath
Copy link
Contributor Author

That makes sense @parasharrajat. What did you find when testing? Does everything work as expected?

@parasharrajat
Copy link
Member

parasharrajat commented Feb 16, 2023

Still testing a few things. I will complete it today itself and we can merge it if no bugs.

@parasharrajat
Copy link
Member

It seems to not work for me. Any thought?

screen-2023-02-17_04.50.38.mp4

@aldo-expensify
Copy link
Contributor

It seems to not work for me. Any thought?

:( this is a pain in the ass to test. I tested on web, and it worked for me, not sure why it may not be working there... maybe the behaviour is not consistent and I was just lucky

@puneetlath
Copy link
Contributor Author

That seems to be the case at least on dev. I'll test against the staging API as well.

Screenshot 2023-02-16 at 7 16 16 PM

Screenshot 2023-02-16 at 7 15 47 PM

@parasharrajat
Copy link
Member

Test cases

  1. Open the newly created report directly via URL in a new browser session after creating it from another device.
  2. Open two browser sessions at a time affixed together. Do not focus on the receiver window. Send an IOU message from the first focused window to a new chat.
  3. Try for requests, split bills, and send money.
  4. Try with normal messages.
  5. Keep the app open on Android|iOS with a new account. Send a message from another device. Notice unread messages on android|iOS.
  6. Try shrinking the browser window width to mobile view, or from mobile view to desktop view,
  7. Blur a window session and send a new chat message to the blurred window. Focus it.
  8. Switch tabs on the same browser.
  9. Try Offline for all above.

@puneetlath
Copy link
Contributor Author

Merged the Auth PR. So this should be ready for testing again soon.

@aldo-expensify aldo-expensify self-requested a review March 8, 2023 21:31
@puneetlath
Copy link
Contributor Author

Ok the Auth PR has been deployed and I've merged main. Thanks for your patience here.

@parasharrajat can you please re-review/re-test?

@parasharrajat
Copy link
Member

Sure.

@puneetlath
Copy link
Contributor Author

@parasharrajat just wanted to get a sense of when you think you'll be able to review/test this one.

@parasharrajat
Copy link
Member

Oops, I missed it. I will review this today

Copy link
Contributor

@aldo-expensify aldo-expensify left a comment

Choose a reason for hiding this comment

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

LGTM

Split bill / request money

Screen.Recording.2023-03-14.at.10.28.54.AM.mov

Send normal message

Screen.Recording.2023-03-14.at.10.32.05.AM.mov

@parasharrajat
Copy link
Member

Still testing but it will be completed today.

@puneetlath
Copy link
Contributor Author

@parasharrajat how is the testing going?

@parasharrajat
Copy link
Member

Just started for today...It will be completed in 2 hours with the checklist.

@parasharrajat
Copy link
Member

parasharrajat commented Mar 16, 2023

Screenshots

🔲 iOS / native

screen-2023-03-17_04.00.08.mp4

🔲 MacOS / Chrome

screen-2023-03-17_01.46.37.mp4
screen-2023-03-17_02.43.38.mp4

🔲 Android / Chrome

screen-2023-03-17_02.46.54.mp4

@aldo-expensify

This comment was marked as resolved.

@parasharrajat
Copy link
Member

parasharrajat commented Mar 16, 2023

No, it is working this time. Just posting screenshots.

@aldo-expensify
Copy link
Contributor

No, it is working this time. Just posting screenshots.

Oh, sorry, I saw poorly your video hehe, now I see it shows bolded (unread) 🎉

Copy link
Member

@parasharrajat parasharrajat left a comment

Choose a reason for hiding this comment

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

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.

cc: @aldo-expensify

🎀 👀 🎀 C+ reviewed

@parasharrajat
Copy link
Member

parasharrajat commented Mar 16, 2023

I found one issue where displayName is not correct the first time when the report is created. It is the email of the user but that user has a custom displayName.

Check this video https://user-images.githubusercontent.com/24370807/225768184-d9f1a38e-864f-4811-9efa-28766d2162c8.mp4

Ignore the first money request as I used the wrong email thus report was not shown on iOS App.

@puneetlath
Copy link
Contributor Author

Hmm, yes you're right. I just tried on main and that also seems to be a problem there. So I'm going to go ahead and merge this. Could you report that as a separate issue in #expensify-bugs please? Thanks!

@puneetlath puneetlath merged commit 382d167 into main Mar 19, 2023
@puneetlath puneetlath deleted the iou-unread branch March 19, 2023 21:33
@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.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.2.88-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/puneetlath in version: 1.2.88-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.2.88-2 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 1.2.88-2 🚀

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

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

Successfully merging this pull request may close these issues.

5 participants