[CP Staging] Fix/regression unread messages #23729

hannojg · 2023-07-27T11:25:41Z

Details

We noticed a regression where new messages wouldn't show up as unread.
The main issues I found were the followings:

We were wrapping the component with withNavigationFocus, which reported incorrect values. Instead we are using the useIsFocused hook directly (this is also more inline with the function component styles in general to use hooks directly)
The useEffect hook subscribing to the new actions didn't had any dependencies. However the variables used in the callback of the subscription did change in the outer scope (such as isFocused, which lead to the buggy behaviour, as the subscription function was always running with the variable still being true). However, the use effect wouldn't recreate the subscription with the changed values. Thus they needed to be added to the dependency array (note: this is also cleaner in terms of function component usage)
On web, when we show the LHN and the report screen at the same time opening a new report doesn't unmount the previous report screen (like its happening when using the stack navigator on a small screen). This isn't per se problematic, however, when we reopen the same report again a new screen gets created as well (not reused). This causes a second subscription, next to the previous one, to get initialised. The previous one takes precedence over the new one, and thus there are conflicts.

Fixed Issues

$ #23446
PROPOSAL: https://expensify.slack.com/archives/C01GTK53T8Q/p1690394092631009

Tests

Test 1

Open the app in two sessions and login with two accounts. Important: The browser window needs to be wide enough to show the sidebar and report screen at the same time
From User A, open a chat with user B.
From User A navigate from the current chat to another one.
From User B, send a message to user A.
From User A, Verify if the new message is marked as unread.

Test 2

Same setup as in test 1
User A: Make sure that when the app loads, the chat with user B is open at first
User A: Navigate to another chat
User A: Come back to chat with user B
User B: Write message into chat
User A: Verify that the chat message from user B immediately gets marked as read

Test 3

Same setup as in test 1
User A: Make sure that when the app loads, the chat with user B is open at first
User A: Navigate to another chat
User A: Come back to chat with user B
User A: Scroll the chat up
User B: send a message
User A: make sure the "New message" info shows up at the top of the chat
User A: make sure the message is still shown as unread in the LHN

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Web

Screen.Recording.2023-07-27.at.13.40.47.mov

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

src/pages/home/report/ReportActionsView.js

allroundexperts · 2023-07-27T11:39:57Z

src/hooks/useReportScrollManager/index.js

        if (!flatListRef.current) {
            return;
        }

        flatListRef.current.scrollToOffset({animated: false, offset: 0});
-    };
+    }, [flatListRef]);


flatListRef would never change. So we can just add [].

As flatlist ref comes from the outside eslint doesn't know it's a ref. Thus it will warn us that we need to add it to the dependency array
Then I'd need to add a eslint-ignore line. When it comes to just adding it which is technically correct, or to suppress a warning I'd choose the former.

Also technically it's not correct. Although right now we don't, the flatlistRef could technically change. In this case we need this function to be recreated.

melvin-bot · 2023-07-27T11:51:24Z

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

hannojg · 2023-07-27T12:10:07Z

One second, I think its still broken on mobile

mountiny · 2023-07-27T12:27:13Z

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 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
- 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 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 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 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 reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Adding video of web and mweb tested

Web

web23729.mp4

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

mountiny · 2023-07-27T12:30:22Z

waiting for Hanno, I think that part can be logged as an issue to be investigated later.

hannojg · 2023-07-27T12:43:56Z

Yes, let's do a follow up for mobile! @mountiny

mountiny

Thanks, tested well with hanno in DM as well so with urgency I will go ahead and merge

OSBotify · 2023-07-27T13:13:26Z

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

[CP Staging] Fix/regression unread messages (cherry picked from commit 0cccb4e)

mountiny · 2023-07-27T13:34:39Z

Here is the follow up #23733

OSBotify · 2023-07-27T13:58:06Z

🚀 Deployed to staging by https://github.com/mountiny in version: 1.3.46-1 🚀

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

OSBotify · 2023-07-27T22:38:23Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.46-2 🚀

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

hannojg added 4 commits July 27, 2023 09:26

memoize scrollToBottom function

d7ee57c

add dependencies to useEffect

39a6e6a

fix isFocused

5917a4f

fix issue with conflicting subscriptions

df2fc05

mountiny assigned hannojg Jul 27, 2023

hannojg mentioned this pull request Jul 27, 2023

Fix: new messages don't get shown as unread #23683

Closed

58 tasks

mountiny reviewed Jul 27, 2023

View reviewed changes

src/pages/home/report/ReportActionsView.js Outdated Show resolved Hide resolved

src/pages/home/report/ReportActionsView.js Outdated Show resolved Hide resolved

allroundexperts reviewed Jul 27, 2023

View reviewed changes

hannojg marked this pull request as ready for review July 27, 2023 11:51

hannojg requested a review from a team as a code owner July 27, 2023 11:51

melvin-bot bot requested review from eVoloshchak and removed request for a team July 27, 2023 11:51

hannojg added 4 commits July 27, 2023 13:54

fix comment

3cbc752

remove reportId from deps

6ad9a83

fix comment

890c01d

fix comment

5a2656c

remove debug code

8967d16

mountiny changed the title ~~Fix/regression unread messages~~ [CP Staging] Fix/regression unread messages Jul 27, 2023

mountiny approved these changes Jul 27, 2023

View reviewed changes

mountiny merged commit 0cccb4e into Expensify:main Jul 27, 2023

OSBotify pushed a commit that referenced this pull request Jul 27, 2023

Merge pull request #23729 from margelo/fix/regression-unread-messages

74eca59

[CP Staging] Fix/regression unread messages (cherry picked from commit 0cccb4e)

mountiny mentioned this pull request Jul 27, 2023

[$1000] Chat is not marked as read when receiving messages while in the report #23733

Closed

6 tasks

OSBotify mentioned this pull request Jul 27, 2023

Deploy Checklist: New Expensify 2023-07-27 #23765

Closed

79 tasks

melvin-bot bot mentioned this pull request Jul 27, 2023

[HOLD for payment 2023-08-07] [HOLD for payment 2023-08-03] Unread not working on the LHN #23446

Closed

6 tasks

Pujan92 mentioned this pull request Jul 31, 2023

[HOLD for payment 2023-08-17] [$1000] iOS/iPad - Chat - Message “User is typing” is not showing #23874

Closed

6 tasks

roryabraham mentioned this pull request Jul 31, 2023

[HOLD for payment 2023-09-20] [HOLD for payment 2023-09-18] Manually CPed App PR did not update the checklist #21763

Closed

Pujan92 mentioned this pull request Aug 18, 2023

" user is typing ... " doesn't appear after opening and closing the RHP #25486

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CP Staging] Fix/regression unread messages #23729

[CP Staging] Fix/regression unread messages #23729

hannojg commented Jul 27, 2023 •

edited

Loading

allroundexperts Jul 27, 2023

hannojg Jul 27, 2023 •

edited

Loading

melvin-bot bot commented Jul 27, 2023

hannojg commented Jul 27, 2023

mountiny commented Jul 27, 2023 •

edited

Loading

mountiny commented Jul 27, 2023

hannojg commented Jul 27, 2023

mountiny left a comment

OSBotify commented Jul 27, 2023

mountiny commented Jul 27, 2023

OSBotify commented Jul 27, 2023

OSBotify commented Jul 27, 2023

[CP Staging] Fix/regression unread messages #23729

[CP Staging] Fix/regression unread messages #23729

Conversation

hannojg commented Jul 27, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

allroundexperts Jul 27, 2023

Choose a reason for hiding this comment

hannojg Jul 27, 2023 • edited Loading

Choose a reason for hiding this comment

melvin-bot bot commented Jul 27, 2023

hannojg commented Jul 27, 2023

mountiny commented Jul 27, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

mountiny commented Jul 27, 2023

hannojg commented Jul 27, 2023

mountiny left a comment

Choose a reason for hiding this comment

OSBotify commented Jul 27, 2023

mountiny commented Jul 27, 2023

OSBotify commented Jul 27, 2023

OSBotify commented Jul 27, 2023

hannojg commented Jul 27, 2023 •

edited

Loading

hannojg Jul 27, 2023 •

edited

Loading

mountiny commented Jul 27, 2023 •

edited

Loading