Fix maintainVisibleContentPosition in Safari #47193

janicduplessis · 2024-08-10T16:56:19Z

Details

The maintainVisibleContentPosition implementation currently doesn't work properly. This fixes it.

I noticed some cases that caused some jumping:

Sometimes the first visible view will be removed from the DOM and it would cause an incorrect adjustment. To fix this we can detect in the mutation observer that the node removed is the first visible view, and calculate a new one when it happens. Also reduce the pagination size to reduce cases where the first visible view could be removed.
We do the adjustment in a requestAnimationFrame, but this gives time for a scroll event to happen before we get to adjust the scroll position and we lose the proper positioning. It seemed to be needed in chrome, but I found a better way, we can instead use the last scroll position from the previous scroll event instead and it works fine without the need of requestAnimationFrame on both chrome and safari.
Add some hacks to mobile safari since adjusting scroll position during momentum scroll does not work.

Before:

Screen.Recording.2024-08-15.at.21.52.09.mov

After:

Screen.Recording.2024-08-15.at.21.49.13.mov

Fixed Issues

$ #47518
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console
Check that scrolling down is smooth after comment linking using the following steps
In a chat with many messages copy the link to a message and send it
Click on the message link from the first step
Scroll down

PR Author Checklist

Screenshots/Videos

Android: Native

N/A

Android: mWeb Chrome

Screen.Recording.2024-08-15.at.22.15.06.mov

iOS: Native

N/A

iOS: mWeb Safari

Screen.Recording.2024-08-17.at.15.52.22.mov

MacOS: Chrome / Safari

Safari

Screen.Recording.2024-08-15.at.21.46.15.mov

Chrome

Screen.Recording.2024-08-15.at.21.54.31.mov

MacOS: Desktop

Screen.Recording.2024-08-17.at.15.43.57.mov

janicduplessis · 2024-08-16T02:20:28Z

After doing more testing it seems like Safari on iOS is still problematic, this only fixes desktop. Investigating.

janicduplessis · 2024-08-16T20:20:03Z

The issue on mobile safari seems to be very hard to fix, I have tried many things but I haven't been able to get safari to change the scroll position while a momentum scroll is happening.

The only workaround I found is to disable scrolling then update the scroll position then re-enable scrolling, but this will cause the momentum scroll to stop which makes scrolling not smooth, but in my opinion a pretty good improvement over a giant jump like it does currently.

I will try to investigate some other websites that have bidirectional scroll to see if they handle mobile safari better than this.

janicduplessis · 2024-08-17T16:56:48Z

I tested slack on iOS safari and they seem to use a similar workaround, the scroll down after linking to a message is a bit jumpy and momentum scroll keeps stopping.

RPReplay_Final1723913579.mov

melvin-bot · 2024-08-17T19:57:07Z

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

janicduplessis · 2024-08-17T19:57:27Z

@ishpaul777 This is ready if you wanna have a look!

ishpaul777 · 2024-08-17T20:00:51Z

For sure, i'll start tomorrow.

@ahmedGaber93 you can ignore this one

ishpaul777 · 2024-08-17T20:03:36Z

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: mWeb Chrome
- iOS: Native
- iOS: mWeb 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 either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- 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(theme.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 the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
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

Android: Native

Screen.Recording.2024-08-31.at.2.10.11.AM.mov

Android: mWeb Chrome

Screen.Recording.2024-08-31.at.2.17.58.AM.mov

iOS: Native

Screen.Recording.2024-08-31.at.1.46.44.AM.mov

iOS: mWeb Safari

Screen.Recording.2024-08-31.at.1.42.40.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-08-31.at.1.32.22.AM.mov

Screen.Recording.2024-08-31.at.1.13.58.AM-1.mov

MacOS: Desktop

Screen.Recording.2024-08-31.at.2.14.46.AM-1.mov

ishpaul777 · 2024-08-20T11:44:57Z

FI, i plan to review this today, was OOO past few days

ishpaul777 · 2024-08-20T14:09:49Z

Sadly i am still seeing some content jumping in desktop safari and few times after linking to first message new message do not load when scrolling down

Screen.Recording.2024-08-20.at.7.27.46.PM-1.mov

janicduplessis · 2024-08-20T15:06:35Z

@ishpaul777 Can you try again to see if the scroll still gets stuck sometimes, I just merged main which has the fixes from #46315.

ishpaul777 · 2024-08-20T15:53:16Z

pulling latest commit cause some weird janky scrolling in opposite direction and also some white screen and some content jumping is still present

Screen.Recording.2024-08-20.at.9.21.02.PM.mov

janicduplessis · 2024-08-22T19:47:54Z

I cannot currently reproduce the blanking issue, but I did find one more problem that I would like to address before merging this.

It seems like adjusting the scroll position is not reliable on the web across browsers. We might need to use a different virtualization strategy if we want to have perfectly smooth bidirectional pagination.

If I link to the first message, then scroll back all the way to the bottom of the chat back to where the links are, then link to the first message again the scroll position is wrong.

janicduplessis · 2024-08-22T23:12:09Z

Added one more fix for the case

If I link to the first message, then scroll back all the way to the bottom of the chat back to where the links are, then link to the first message again the scroll position is wrong.

3fc7859

The problem was that 2 important values ended up being updated at different time and the list would render with old data which would mess up the scroll positioning.

listID which causes a new list to be re-mounted would update first (in useMemo), but currentReportActionID still has its previous value since it is updated in a useLayoutEffect. Instead I call the state update in the useMemo so the state is updated immediately and there is no more render where we have an old currentReportActionID.

ishpaul777 · 2024-08-27T13:57:12Z

Oh god! This PR got off my radar since i am not assigned to this, will priortize for today.

ishpaul777 · 2024-08-27T13:58:34Z

src/CONST.ts

Comment so this shows on my K2 extension

ishpaul777 · 2024-08-30T20:03:31Z

Finishing this few minutes, Sorry for delay

ishpaul777

Looks good! just one comment

ishpaul777 · 2024-08-30T20:56:54Z

src/CONST.ts

@@ -4483,7 +4483,7 @@ const CONST = {
    REPORT_FIELD_TITLE_FIELD_ID: 'text_title',

    MOBILE_PAGINATION_SIZE: 15,
-    WEB_PAGINATION_SIZE: 50,
+    WEB_PAGINATION_SIZE: 30,


Could you explain the reason please

This seemed to help reduce jumping, when loading more messages I noticed that often the first visible view that we use in the maintainVisibleContentPosition implementation would be removed. When reducing this it stopped happening.

I do not see any downsides here, so sounds good 👍 Thanks for clarifying!

melvin-bot · 2024-08-30T20:57:34Z

We did not find an internal engineer to review this PR, trying to assign a random engineer to #47518 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

stitesExpensify · 2024-09-03T10:04:36Z

@janicduplessis would you mind taking one more look here as well?

janicduplessis · 2024-09-03T16:54:34Z

@stitesExpensify Sorry I am not sure what you mean here

stitesExpensify · 2024-09-03T18:47:43Z

@janicduplessis so sorry, I didn't have my head on straight this morning. I thought that you were a reviewer not the author 🤦

OSBotify · 2024-09-03T21:18:17Z

✋ 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 · 2024-09-03T23:42:39Z

🚀 Deployed to staging by https://github.com/stitesExpensify in version: 9.0.29-0 🚀

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

OSBotify · 2024-09-05T19:16:38Z

🚀 Deployed to production by https://github.com/roryabraham in version: 9.0.29-12 🚀

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

Fix maintainVisibleContentPosition in Safari

cd5b1fb

janicduplessis force-pushed the @janic/mvcp-safari-fix branch from ac80158 to cd5b1fb Compare August 15, 2024 17:48

Tentative mobile safari fix

fa4dcf0

janicduplessis added 3 commits August 17, 2024 14:48

Add commments

ae54131

Support horizontal

316e144

Last fixes

f70dce7

janicduplessis marked this pull request as ready for review August 17, 2024 19:57

janicduplessis requested a review from a team as a code owner August 17, 2024 19:57

melvin-bot bot requested a review from ahmedGaber93 August 17, 2024 19:57

melvin-bot bot removed the request for review from a team August 17, 2024 19:57

Merge remote-tracking branch 'upstream/main' into @janic/mvcp-safari-fix

55b316d

ishpaul777 mentioned this pull request Aug 21, 2024

[PAY 9/12] Content jumps on Safari when scrolling down after comment linking #47518

Closed

6 tasks

Fix comment linking after scrolling back down

3fc7859

Fix lint

cc6f50a

ishpaul777 reviewed Aug 27, 2024

View reviewed changes

src/CONST.ts

Copy link

Contributor

ishpaul777 Aug 27, 2024

Choose a reason for hiding this comment

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

Comment so this shows on my K2 extension

ishpaul777 approved these changes Aug 30, 2024

View reviewed changes

ishpaul777 approved these changes Sep 2, 2024

View reviewed changes

melvin-bot bot requested a review from stitesExpensify September 2, 2024 23:14

stitesExpensify approved these changes Sep 3, 2024

View reviewed changes

stitesExpensify merged commit 9067ea8 into Expensify:main Sep 3, 2024
20 of 21 checks passed

github-actions bot mentioned this pull request Sep 3, 2024

Deploy Checklist: New Expensify 2024-09-03 #48515

Closed

68 tasks

janicduplessis deleted the @janic/mvcp-safari-fix branch September 4, 2024 05:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix maintainVisibleContentPosition in Safari #47193

Fix maintainVisibleContentPosition in Safari #47193

janicduplessis commented Aug 10, 2024 •

edited

Loading

janicduplessis commented Aug 16, 2024

janicduplessis commented Aug 16, 2024

janicduplessis commented Aug 17, 2024 •

edited

Loading

melvin-bot bot commented Aug 17, 2024

janicduplessis commented Aug 17, 2024

ishpaul777 commented Aug 17, 2024

ishpaul777 commented Aug 17, 2024 •

edited

Loading

ishpaul777 commented Aug 20, 2024

ishpaul777 commented Aug 20, 2024

janicduplessis commented Aug 20, 2024

ishpaul777 commented Aug 20, 2024

janicduplessis commented Aug 22, 2024 •

edited

Loading

janicduplessis commented Aug 22, 2024 •

edited

Loading

ishpaul777 commented Aug 27, 2024

ishpaul777 Aug 27, 2024

ishpaul777 commented Aug 30, 2024

ishpaul777 left a comment

ishpaul777 Aug 30, 2024

janicduplessis Sep 2, 2024 •

edited

Loading

ishpaul777 Sep 2, 2024 •

edited

Loading

melvin-bot bot commented Aug 30, 2024

stitesExpensify commented Sep 3, 2024

janicduplessis commented Sep 3, 2024

stitesExpensify commented Sep 3, 2024

OSBotify commented Sep 3, 2024

OSBotify commented Sep 3, 2024

OSBotify commented Sep 5, 2024

Fix maintainVisibleContentPosition in Safari #47193

Fix maintainVisibleContentPosition in Safari #47193

Conversation

janicduplessis commented Aug 10, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

janicduplessis commented Aug 16, 2024

janicduplessis commented Aug 16, 2024

janicduplessis commented Aug 17, 2024 • edited Loading

melvin-bot bot commented Aug 17, 2024

janicduplessis commented Aug 17, 2024

ishpaul777 commented Aug 17, 2024

ishpaul777 commented Aug 17, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ishpaul777 commented Aug 20, 2024

ishpaul777 commented Aug 20, 2024

janicduplessis commented Aug 20, 2024

ishpaul777 commented Aug 20, 2024

janicduplessis commented Aug 22, 2024 • edited Loading

janicduplessis commented Aug 22, 2024 • edited Loading

ishpaul777 commented Aug 27, 2024

ishpaul777 Aug 27, 2024

Choose a reason for hiding this comment

ishpaul777 commented Aug 30, 2024

ishpaul777 left a comment

Choose a reason for hiding this comment

ishpaul777 Aug 30, 2024

Choose a reason for hiding this comment

janicduplessis Sep 2, 2024 • edited Loading

Choose a reason for hiding this comment

ishpaul777 Sep 2, 2024 • edited Loading

Choose a reason for hiding this comment

melvin-bot bot commented Aug 30, 2024

stitesExpensify commented Sep 3, 2024

janicduplessis commented Sep 3, 2024

stitesExpensify commented Sep 3, 2024

OSBotify commented Sep 3, 2024

OSBotify commented Sep 3, 2024

OSBotify commented Sep 5, 2024

janicduplessis commented Aug 10, 2024 •

edited

Loading

janicduplessis commented Aug 17, 2024 •

edited

Loading

ishpaul777 commented Aug 17, 2024 •

edited

Loading

janicduplessis commented Aug 22, 2024 •

edited

Loading

janicduplessis commented Aug 22, 2024 •

edited

Loading

janicduplessis Sep 2, 2024 •

edited

Loading

ishpaul777 Sep 2, 2024 •

edited

Loading