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 messages don't get shown as unread #23683

Conversation

rayane-d
Copy link
Contributor

@rayane-d rayane-d commented Jul 26, 2023

Details

Fixed Issues

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

Tests

  1. Open the app in two sessions and login with two accounts.
  2. From User A, open a chat with user B.
  3. From User A navigate from the current chat to another one.
  4. From User B, send a message to user A.
  5. From User A, Verify if the new message is marked as unread.
  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Same as tests above.

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

Screenshots/Videos

Web
2023-07-26.22-19-56.mp4
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
video.mp4
Android

@rayane-d rayane-d requested a review from a team as a code owner July 26, 2023 19:35
@melvin-bot melvin-bot bot requested review from arosiclair and removed request for a team July 26, 2023 19:35
@melvin-bot
Copy link

melvin-bot bot commented Jul 26, 2023

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

Copy link
Contributor

@situchan situchan left a comment

Choose a reason for hiding this comment

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

@rayane-d
Copy link
Contributor Author

@situchan could you review this please.
I tested the solution on web and iOS, and it worked well. However, when I tested it on desktop, it didn't work.

desk.mp4

@allroundexperts
Copy link
Contributor

  • From User B, send a message to user B.

@rayane-djouah This needs to be send a message to user A?

@allroundexperts
Copy link
Contributor

allroundexperts commented Jul 26, 2023

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

Web
Screen.Recording.2023-07-27.at.3.43.52.AM.mov
Screen.Recording.2023-07-27.at.3.47.58.AM.mov
Mobile Web - Chrome
Mobile Web - Safari
Desktop
iOS
Android

@allroundexperts
Copy link
Contributor

allroundexperts commented Jul 26, 2023

On mweb, the chat scrolls halfway when a new message is received but on web, it never scrolls to the bottom.

Screen.Recording.2023-07-27.at.4.06.00.AM.mov

Also notice that the green dot does not appear in the LHN for new messages.

@allroundexperts
Copy link
Contributor

allroundexperts commented Jul 26, 2023

Similar results on mweb Android. The message is getting un-bolded automatically after ~1-2s in the LHN. Auto scrolling seems broken as well.

Screen.Recording.2023-07-27.at.4.13.16.AM.mov

@rayane-d
Copy link
Contributor Author

rayane-d commented Jul 26, 2023

@rayane-djouah This needs to be send a message to user A?

yes, edited.

@rayane-d
Copy link
Contributor Author

rayane-d commented Jul 26, 2023

On mweb, the chat scrolls halfway when a new message is received but on web, it never scrolls to the bottom.

Auto scrolling was working fine before, I don't know where is the problem with it

@allroundexperts
Copy link
Contributor

On mweb, the chat scrolls halfway when a new message is received but on web, it never scrolls to the bottom.

Auto scrolling was working fine before, I don't know where is the problem with it

@rayane-djouah Can you reproduce the behaviour I mentioned though?

@situchan Can you please confirm this as well?

@rayane-d
Copy link
Contributor Author

rayane-d commented Jul 26, 2023

On mweb, the chat scrolls halfway when a new message is received but on web, it never scrolls to the bottom.

Auto scrolling was working fine before, I don't know where is the problem with it

@rayane-djouah Can you reproduce the behaviour I mentioned though?

@situchan Can you please confirm this as well?

@allroundexperts the behaviour you mentioned is also occuring on main so it's not introduced by this PR

Video for reproduction on main:

Nouvelle.video.mp4

@allroundexperts
Copy link
Contributor

@rayane-djouah What about android web? There is no new message showing up on it!

@rayane-d
Copy link
Contributor Author

I also retested the sollution on Desktop but it's not working there.
@allroundexperts could you test on Desktop please?

@allroundexperts
Copy link
Contributor

I also retested the sollution on Desktop but it's not working there. @allroundexperts could you test on Desktop please?

I already did and uploaded the video in the checklist above.

@rayane-d
Copy link
Contributor Author

I also retested the sollution on Desktop but it's not working there. @allroundexperts could you test on Desktop please?

I already did and uploaded the video in the checklist above.

I can't find it in the checklist

@allroundexperts
Copy link
Contributor

I can't find it in the checklist

Might have missed the upload. Checking again and uploading now. Meanwhile, can you check android web?

@rayane-d
Copy link
Contributor Author

rayane-d commented Jul 27, 2023

@allroundexperts it works fine for me on android web

2023-07-27.01-16-48.mp4

@situchan
Copy link
Contributor

I don't think the fix is going in right direction.
Not always work for me, even on web.

Screen.Recording.2023-07-27.at.6.17.25.AM.mov

And on desktop, it marked as unread and then immediately marked as read. And it's not consistent. Sometimes works, sometimes not work.

Screen.Recording.2023-07-27.at.6.18.52.AM.mov

@allroundexperts
Copy link
Contributor

I don't think the fix is going in right direction. Not always work for me, even on web.

Screen.Recording.2023-07-27.at.6.17.25.AM.mov
And on desktop, it marked as unread and then immediately marked as read. And it's not consistent. Sometimes works, sometimes not work.

Screen.Recording.2023-07-27.at.6.18.52.AM.mov

Agreed. Something seems off here.

Comment on lines +68 to +71
const scrollToBottom = useCallback(() => {
reportScrollManager.scrollToBottom();
}, [reportScrollManager]);

Copy link
Contributor

@hannojg hannojg Jul 27, 2023

Choose a reason for hiding this comment

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

This isn't doing anything. This scrollToBottom function will be recreated on each re-render of the component.
Why? Because reportScrollManager isn't stable. It will be a new object on every re-render.
Thus the useCallback has to be applied inside the reportScrollManager module!

Copy link
Contributor

Choose a reason for hiding this comment

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

I do think that this might cause some of the issues we are seeing at the minute

@hannojg
Copy link
Contributor

hannojg commented Jul 27, 2023

This PR is superseded by this PR:

@mountiny
Copy link
Contributor

Thanks for the effort everyone, Hanno has been able to follow up with a fix #23729 but there is still issue with mobile so we can look into that next

@mountiny mountiny closed this Jul 27, 2023
@rayane-d rayane-d deleted the fixing-new-messages-don't-get-shown-as-unread branch September 4, 2023 12:33
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