fix: 11584 web jump to unread message #12124

tienifr · 2022-10-25T16:40:19Z

Details

Currently, the logic scroll to unread message is using scrollToBottom function.
Function ReportScrollManager.scrollToIndex isn't work correctly in web because it has different behavior scroll from native.
This PR fixes behavior scroll on web.

Fixed Issues

$ #11584

Tests

Go to any chat
Click at Mark as Unread
Click on New Messages button
Clicking "new messages" should jump directly to the message marked as Unread

Verify that no errors appear in the JS console

PR Review Checklist

PR Author Checklist

QA Steps

Go to any chat
Click at Mark as Unread
Click on New Messages button
Clicking "new messages" should jump directly to the message marked as Unread

Verify that no errors appear in the JS console

PR Reviewer Checklist

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

QA Steps

Verify that no errors appear in the JS console

Screenshots

Web

afterUpdate.mp4

Mobile Web - Chrome

jumpChrome.mp4

Mobile Web - Safari

jumpSafari.mp4

Desktop

jumpDesktop.mp4

iOS

jump.mp4

Android

jumpMobile.mp4

mountiny · 2022-10-26T13:26:33Z

Same here $ https://github.com/Expensify/App/issues/11584

eVoloshchak · 2022-10-26T14:42:21Z

src/libs/ReportScrollManager/index.js

-    flatListRef.current.scrollToIndex(index);
+    const sizeMap = flatListRef.current.props.sizeMap;
+    const clientHeight = flatListRef.current.getScrollableNode().clientHeight;
+    const paddingTop = parseFloat(flatListRef.current.getScrollableNode().childNodes[0].style.paddingTop || '0px');


We should access nested properties using lodashGet
More details in STYLING.md

eVoloshchak · 2022-10-26T14:43:50Z

src/libs/ReportScrollManager/index.js

+    const clientHeight = flatListRef.current.getScrollableNode().clientHeight;
+    const paddingTop = parseFloat(flatListRef.current.getScrollableNode().childNodes[0].style.paddingTop || '0px');
+    const sizeArray = _.map(_.values(sizeMap), s => s.length);
+    const sumNum = _.reduce(sizeArray.slice(0, (index.index)), (acc, val) => acc + val);


Please give variables a bit more readable names, could we rename sumNum to something like a currentOffset?

eVoloshchak · 2022-10-26T14:48:47Z

src/libs/ReportScrollManager/index.js

+    const sumNum = _.reduce(sizeArray.slice(0, (index.index)), (acc, val) => acc + val);
+    flatListRef.current.scrollToOffset({
+        animated: index.animated,
+        offset: (sumNum + paddingTop + (index.viewOffset || 0)) - (clientHeight * (index.viewPosition || 0)),


I think we should have offset as a separate variable for the ease of reading and debugging

comst offset = sumNum + paddingTop + (index.viewOffset || 0)) - (clientHeight * (index.viewPosition || 0); flatListRef.current.scrollToOffset({animated: index.animated, offset});

tienifr · 2022-10-26T17:28:52Z

@eVoloshchak Thanks for noting, I just fixed your comment, Could you help to check again?

eVoloshchak · 2022-10-27T15:17:21Z

Screenshots

Web

Screen.Recording.2022-10-27.at.18.07.06.mov

Mobile Web - Chrome

22-10-27-18-12-31.mp4

Mobile Web - Safari

Screen.Recording.2022-10-27.at.18.07.48.mov

Desktop

Screen.Recording.2022-10-27.at.18.14.09.mov

iOS

Screen.Recording.2022-10-27.at.18.08.50.mov

Android

22-10-27-18-13-24.mp4

PR 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:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 was added in all src/languages/* files
- 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

srikarparsi

lgtm!

srikarparsi · 2022-10-28T08:31:56Z

The reviewer will copy/paste it into a new comment and complete it after the author checklist is completed

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 verified tests pass on all platforms & I tested again on:
- iOS / native
- Android / native
- iOS / Safari
- Android / Chrome
- MacOS / Chrome
- 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 was added in all src/languages/* files
- I verified any copy / text that was added to the app is correct English and approved by marketing by tagging the marketing team 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 */
- Any functional components have the displayName property
- 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 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.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

melvin-bot · 2022-10-28T08:40:45Z

@srikarparsi looks like this was merged without the checklist test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

srikarparsi · 2022-10-28T08:41:07Z

checklist is finished

OSBotify · 2022-10-28T09:56:13Z

🚀 Deployed to staging by @srikarparsi in version: 1.2.21-4 🚀

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

OSBotify · 2022-10-31T18:03:59Z

🚀 Deployed to production by @Julesssss in version: 1.2.21-4 🚀

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

fix: rebase

50d8e9c

tienifr requested a review from a team as a code owner October 25, 2022 16:40

tienifr changed the title ~~fix: rebase~~ fix: 11584 web jump to unread message Oct 25, 2022

tienifr mentioned this pull request Oct 25, 2022

fix/11584 web jump to unread message tienifr/App#7

Merged

93 tasks

mountiny requested review from a team and removed request for a team October 26, 2022 13:26

melvin-bot bot requested review from eVoloshchak and srikarparsi and removed request for a team October 26, 2022 13:26

eVoloshchak suggested changes Oct 26, 2022

View reviewed changes

fix: refactor code in report scroll manager

498c05b

srikarparsi approved these changes Oct 28, 2022

View reviewed changes

srikarparsi merged commit dbfcb0e into Expensify:main Oct 28, 2022

melvin-bot bot added the Emergency label Oct 28, 2022

srikarparsi removed the Emergency label Oct 28, 2022

OSBotify mentioned this pull request Oct 28, 2022

Deploy Checklist: New Expensify 2022-10-28 #12223

Closed

20 tasks

kbecciv mentioned this pull request Oct 28, 2022

[HOLD for #35011][$250] Chat- "New messages" doesn't jump directly to the message marked as Unread for second time #12249

Open

melvin-bot bot mentioned this pull request Oct 31, 2022

[Regression in PR][$250] Clicking on "New Messages" jumps to newest messages, skipping over any messages marked unread report by @chauchausoup #11584

Closed

This was referenced Nov 28, 2022

[HOLD] Prevent negative indexes in scrollToUnreadMsgAndMarkReportAsRead #13089

Closed

Deploy Checklist: New Expensify 2022-11-25 #13059

Closed

srikarparsi mentioned this pull request Dec 1, 2022

Revert "fix: 11584 web jump to unread message" #13230

Merged

47 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: 11584 web jump to unread message #12124

fix: 11584 web jump to unread message #12124

tienifr commented Oct 25, 2022 •

edited by srikarparsi

Loading

mountiny commented Oct 26, 2022

eVoloshchak Oct 26, 2022

eVoloshchak Oct 26, 2022

eVoloshchak Oct 26, 2022

tienifr commented Oct 26, 2022

eVoloshchak commented Oct 27, 2022

Screenshots

PR Reviewer Checklist

srikarparsi left a comment

srikarparsi commented Oct 28, 2022 •

edited

Loading

melvin-bot bot commented Oct 28, 2022

srikarparsi commented Oct 28, 2022

OSBotify commented Oct 28, 2022

OSBotify commented Oct 31, 2022

fix: 11584 web jump to unread message #12124

fix: 11584 web jump to unread message #12124

Conversation

tienifr commented Oct 25, 2022 • edited by srikarparsi Loading

Details

Fixed Issues

Tests

PR Review Checklist

PR Author Checklist

QA Steps

PR Reviewer Checklist

QA Steps

Screenshots

Web

Mobile Web - Chrome

Mobile Web - Safari

Desktop

iOS

Android

mountiny commented Oct 26, 2022

eVoloshchak Oct 26, 2022

Choose a reason for hiding this comment

eVoloshchak Oct 26, 2022

Choose a reason for hiding this comment

eVoloshchak Oct 26, 2022

Choose a reason for hiding this comment

tienifr commented Oct 26, 2022

eVoloshchak commented Oct 27, 2022

Screenshots

PR Reviewer Checklist

srikarparsi left a comment

Choose a reason for hiding this comment

srikarparsi commented Oct 28, 2022 • edited Loading

melvin-bot bot commented Oct 28, 2022

srikarparsi commented Oct 28, 2022

OSBotify commented Oct 28, 2022

OSBotify commented Oct 31, 2022

tienifr commented Oct 25, 2022 •

edited by srikarparsi

Loading

srikarparsi commented Oct 28, 2022 •

edited

Loading