HIGH: (Comment linking: step 2) [23220] WEB maintain visible content position #32098

perunt · 2023-11-28T10:35:59Z

Details

This PR introduces the maintainVisibleContentPosition property to React Native for Web (RNW), aligning it with the recent updates in React Native (RN). The implementation is based on the changes from the following upstream PRs:

RN upstream: facebook/react-native#35993
RNW upstream: necolas/react-native-web#2588

The initial implementation for this feature (Expensify/App#28793) was reverted (Expensify/App#31158) due to a bug (Expensify/App#31143). This PR addresses and resolves that issue.

🎉 Thanks to @janicduplessis, it was found and fixed 🎉

Fixed Issues

$ #23220
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

As an employee, create an IOU with a receipt.
Log in as the workspace admin.
Navigate to the workspace chat with the employee.
Access the request conversation and resolve any errors as the admin.

Testing Goals:
Verify the correctness of the scrolling direction in the chat list.
Ensure the copying process functions as expected.
Confirm that styles are properly applied (with nothing appearing inverted).

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

…rgelo/expensify-app-fork into feat/#Expensify#23220-web-maintainVisibleContentPosition

melvin-bot · 2023-11-28T18:17:45Z

@0xmiroslav 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]

…rgelo/expensify-app-fork into feat/#Expensify#23220-web-maintainVisibleContentPosition

cedarbaum · 2023-11-29T22:38:53Z

Hey all,

I've been following this PR as well as necolas/react-native-web#2588, since I would also like to get maintainVisibleContentPosition working in RNW.

I've got it mostly working, but wanted to point out one thing I noticed in the usage of the MutationObserver. If the subtree of the FlatList has attributes that change frequently, the observe method will get called each time. I specifically saw this happening when some items in my list had repeating animations via React Native Reanimated, which caused nonstop calls to the observer.

I fixed this for my use case by removing observation of attribute changes altogether:

mutationObserver.observe(contentView, {
  childList: true,
  subtree: true,
});

This works for me, since I am only interested in layout changes due to items being prepended to the list. I am not confident that removing this for all cases is safe, but perhaps at least making it configurable or allowing more granular control over which specific attribute changes to look for could avoid these cases.

@janicduplessis FYI, since this could be relevant to the upstream PR.

Happy to provide more details if needed. Also, wanted to say thanks for the work on this issue and for making it open source!

janicduplessis · 2023-11-30T17:07:30Z

I did think about that, but thought it wouldn’t handle cases where items are resized. You do bring up a good point though. Thinking about it more I wonder if it would be possible to use ResizeObserver on the content view instead since we only want to maintain position when the content view size changes.

cedarbaum · 2023-11-30T20:38:01Z

I did think about that, but thought it wouldn’t handle cases where items are resized. You do bring up a good point though. Thinking about it more I wonder if it would be possible to use ResizeObserver on the content view instead since we only want to maintain position when the content view size changes.

I think ResizeObserver could solve the issue I mentioned, though I did find another interesting case. When the content view changes height due to reasons besides items being added to the list (e.g., a cell is expanded), this can also trigger the scroll offset behavior. In such cases, it is more desirable IMO to maintain the scroll offset, since otherwise the expanded cell can shift upwards and be clipped from the top. So my new solution is to only observe the childList change. Using ResizeObserver would solve the original issue I mentioned but would not avoid this case.

However, I am not sure how maintainVisibleContentPosition handles such cases on other platforms. I think ideally this would be configurable in RN (i.e. allow users to specify whether they only want maintainVisibleContentPosition behavior due to item count changes or always).

Sorry if this is a bit off-topic from this PR, but wanted to mention it in case it is relevant.

…pensify#23220-web-maintainVisibleContentPosition

0xmiros · 2023-12-07T15:24:16Z

Confirmed this doesn't cause such issues like #31143, #30947

0xmiros · 2023-12-07T15:35:00Z

Mostly looks good.
One thing I noticed the behavior different from main:
there's scroll animation down to latest message on reload website

this branch:

Screen.Recording.2023-12-07.at.4.32.03.pm.mov

main:

Screen.Recording.2023-12-07.at.4.32.46.pm.mov

roryabraham · 2023-12-07T17:42:13Z

I'm not particularly concerned about that behavior judging by the videos. What happens if there's more than one page of messages in the chat?

0xmiros · 2023-12-07T17:47:45Z

I'm not particularly concerned about that behavior judging by the videos. What happens if there's more than one page of messages in the chat?

Screen.Recording.2023-12-07.at.6.46.24.pm.mov

But the issue is not consistent. Sometimes show last message immediately

roryabraham · 2023-12-07T20:32:05Z

Yeah, looks like we need to fix that

…pensify#23220-web-maintainVisibleContentPosition

perunt · 2024-01-05T15:43:53Z

done
lint is green

perunt · 2024-01-08T08:28:03Z

@0xmiroslav, is it good for you? Can we get it merged?

roryabraham · 2024-01-09T05:35:50Z

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 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(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 form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label 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

Android: mWeb Chrome

android.mov

iOS: Native

iOS: mWeb Safari

web.mov

MacOS: Chrome / Safari

web.mov

MacOS: Desktop

roryabraham · 2024-01-09T05:56:59Z

Note that I was able to reproduce the weird scrolling issue, but only on Android Chrome, which on a dev environment in an emulator was super janky anyways. So I'm not too concerned by that and sort of doubt we'll see it in production. It's not a huge deal even if we do.

roryabraham · 2024-01-09T06:00:32Z

src/components/FlatList/MVCPFlatList.js

@@ -0,0 +1,207 @@
+/* eslint-disable es/no-optional-chaining, es/no-nullish-coalescing-operators, react/prop-types */


Note for posterity: these were disabled to keep this code as similar as possible to the upstream PR it's based on: necolas/react-native-web#2588

Hopefully this component only lives in our codebase relatively temporarily. We probably will want to switch to FlashList soon too for the main chat list.

roryabraham · 2024-01-09T06:02:53Z

Merging through failing reassure per this comment

melvin-bot · 2024-01-09T06:03:02Z

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

OSBotify · 2024-01-09T06:08:15Z

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

0xmiros · 2024-01-09T07:03:05Z

Thanks for finalizing review. I will watch out any regressions QA team is reporting. Hope that would not happen again 🙏

0xmiros · 2024-01-09T12:43:10Z

chat is not scrolled down automatically to see last report action after request money in workspace chat.
Need to confirm if this is caused by this PR

janicduplessis · 2024-01-09T18:22:07Z

Maybe this should not have been removed? https://github.com/Expensify/App/pull/32098/files#diff-b1c8c4fd8072edbd35c63a7cdd71b63ff1701a6f43529ea794f7720a86460df2L18

OSBotify · 2024-01-10T06:20:32Z

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.4.24-0 🚀

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

0xmiros · 2024-01-10T12:21:51Z

chat is not scrolled down automatically to see last report action after request money in workspace chat. Need to confirm if this is caused by this PR

Now this is deploy blocker (not happening on production but staging)

@perunt can you please check?
cc: @roryabraham

0xmiros · 2024-01-10T12:48:23Z

That also happens when send any attachment

Screen.Recording.2024-01-10.at.1.46.07.pm.mov

shubham1206agra · 2024-01-10T15:08:21Z

chat is not scrolled down automatically to see last report action after request money in workspace chat. Need to confirm if this is caused by this PR

useEffect(() => {
        if (previousLastIndex.current !== lastActionIndex && reportActionSize.current > sortedVisibleReportActions.length) {
            reportScrollManager.scrollToBottom();
        }
        previousLastIndex.current = lastActionIndex;
        reportActionSize.current = sortedVisibleReportActions.length;
    }, [lastActionIndex, sortedVisibleReportActions.length, reportScrollManager]);

Maybe update this logic to fix this issue.

perunt · 2024-01-10T15:14:01Z

Going to check this out. Might fix it by going back to https://github.com/Expensify/App/pull/32098/files#diff-b1c8c4fd8072edbd35c63a7cdd71b63ff1701a6f43529ea794f7720a86460df2L18, like @janicduplessis said. But, this could mess up comment linking in the next PR. Still, it's a decent quick fix for staging.

perunt · 2024-01-10T15:34:18Z

Can confirm that bringing it back is fixing that issue
#34244
@0xmiroslav

OSBotify · 2024-01-11T08:52:12Z

🚀 Deployed to production by https://github.com/thienlnam in version: 1.4.24-3 🚀

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

s77rt · 2024-07-07T13:35:29Z

src/components/FlatList/MVCPFlatList.js

+                scrollToOffset(0, true);
+            }
+        }
+    }, [getScrollOffset, scrollToOffset, mvcpMinIndexForVisible, mvcpAutoscrollToTopThreshold, horizontal]);


Having mvcpAutoscrollToTopThreshold as a dependency made this function gets re-evaluated on value change. Which also made the setupMutationObserver function re-evaluated and executed (due to useEffect). That later function will disconnect the old observer and create a new one. This constant observer recreation is found to disrupt the new message detection.

(Coming from #43600)

alitoshmatov · 2024-08-18T13:21:03Z

src/components/FlatList/MVCPFlatList.js

+
+        mutationObserverRef.current?.disconnect();
+
+        const mutationObserver = new MutationObserver(() => {


When list is hidden and reappears, it scrolls down to the bottom. But it should keep its last scroll offset. That is why ignore this callback when list is hidden. Coming from #45434

perunt added 5 commits November 15, 2023 16:30

Merge branch 'main' of https://github.com/Expensify/App

97b0a29

Merge branch 'main' of https://github.com/Expensify/App

a7360c4

create MVCPFlatList

d624dd3

use MVCPFlatList

a34fed2

Merge branch 'perunt/chat-loader-flickering' of https://github.com/ma…

e642647

…rgelo/expensify-app-fork into feat/#Expensify#23220-web-maintainVisibleContentPosition

janicduplessis approved these changes Nov 28, 2023

View reviewed changes

perunt added 2 commits November 28, 2023 16:57

Merge branch 'perunt/chat-loader-flickering' of https://github.com/ma…

7dd2e8f

…rgelo/expensify-app-fork into feat/#Expensify#23220-web-maintainVisibleContentPosition

move scrollToOffset into requestAnimationFrame

5d67d02

perunt marked this pull request as ready for review November 28, 2023 18:17

perunt requested a review from a team as a code owner November 28, 2023 18:17

melvin-bot bot requested review from 0xmiros and removed request for a team November 28, 2023 18:17

Merge branch 'perunt/chat-loader-flickering' of https://github.com/ma…

ace8192

…rgelo/expensify-app-fork into feat/#Expensify#23220-web-maintainVisibleContentPosition

roryabraham self-requested a review December 5, 2023 16:18

Merge branch 'main' of https://github.com/Expensify/App into feat/#Ex…

9f5084d

…pensify#23220-web-maintainVisibleContentPosition

quinthar mentioned this pull request Dec 7, 2023

MEDIUM: Comment linking #32619

Closed

quinthar changed the title ~~[23220] WEB maintain visible content position~~ MEDIUM: (Comment linking: step 2) [23220] WEB maintain visible content position Dec 8, 2023

quinthar changed the title ~~MEDIUM: (Comment linking: step 2) [23220] WEB maintain visible content position~~ HIGH: (Comment linking: step 2) [23220] WEB maintain visible content position Dec 8, 2023

perunt added 3 commits December 11, 2023 12:55

fix scrolling

e9fa5bf

Merge branch 'main' of https://github.com/Expensify/App into feat/#Ex…

731514e

…pensify#23220-web-maintainVisibleContentPosition

remove scrollToOffset

5e6d6f6

roryabraham reviewed Jan 9, 2024

View reviewed changes

roryabraham approved these changes Jan 9, 2024

View reviewed changes

roryabraham merged commit 4e25271 into Expensify:main Jan 9, 2024
17 of 18 checks passed

melvin-bot bot added the Emergency label Jan 9, 2024

roryabraham removed the Emergency label Jan 9, 2024

github-actions bot mentioned this pull request Jan 10, 2024

Deploy Checklist: New Expensify 2024-01-10 #34203

Closed

54 tasks

0xmiros mentioned this pull request Jan 10, 2024

[HOLD for payment 2024-01-22] [HOLD for payment 2024-01-18] IOU - App does not scroll down to show the latest message when editing expense request #34240

Closed

6 tasks

melvin-bot bot mentioned this pull request Jan 11, 2024

[HOLD for payment 2024-01-18] Fix FlatList jumping #23220

Closed

dukenv0307 mentioned this pull request Feb 27, 2024

[CP Staging] Fix/37253: Console log error when opening thread #37261

Merged

50 tasks

s77rt reviewed Jul 7, 2024

View reviewed changes

s77rt mentioned this pull request Jul 7, 2024

[HOLD for payment 2024-07-10] [$250] Chat does not scroll to the last message when a new message received #43600

Closed

6 tasks

alitoshmatov reviewed Aug 18, 2024

View reviewed changes

alitoshmatov mentioned this pull request Aug 18, 2024

[$250] Search - Report always auto scroll down after editing the expense from RHP #45434

Closed

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

HIGH: (Comment linking: step 2) [23220] WEB maintain visible content position #32098

HIGH: (Comment linking: step 2) [23220] WEB maintain visible content position #32098

perunt commented Nov 28, 2023 •

edited

Loading

melvin-bot bot commented Nov 28, 2023

cedarbaum commented Nov 29, 2023

janicduplessis commented Nov 30, 2023

cedarbaum commented Nov 30, 2023 •

edited

Loading

0xmiros commented Dec 7, 2023

0xmiros commented Dec 7, 2023 •

edited

Loading

roryabraham commented Dec 7, 2023

0xmiros commented Dec 7, 2023

roryabraham commented Dec 7, 2023

perunt commented Jan 5, 2024

perunt commented Jan 8, 2024

roryabraham commented Jan 9, 2024 •

edited

Loading

roryabraham commented Jan 9, 2024 •

edited

Loading

roryabraham Jan 9, 2024 •

edited

Loading

roryabraham commented Jan 9, 2024

melvin-bot bot commented Jan 9, 2024

OSBotify commented Jan 9, 2024

0xmiros commented Jan 9, 2024

0xmiros commented Jan 9, 2024

janicduplessis commented Jan 9, 2024

OSBotify commented Jan 10, 2024

0xmiros commented Jan 10, 2024

0xmiros commented Jan 10, 2024

shubham1206agra commented Jan 10, 2024

perunt commented Jan 10, 2024 •

edited

Loading

perunt commented Jan 10, 2024

OSBotify commented Jan 11, 2024

s77rt Jul 7, 2024 •

edited

Loading

alitoshmatov Aug 18, 2024

		@@ -0,0 +1,207 @@
		/* eslint-disable es/no-optional-chaining, es/no-nullish-coalescing-operators, react/prop-types */


		mutationObserverRef.current?.disconnect();

		const mutationObserver = new MutationObserver(() => {

HIGH: (Comment linking: step 2) [23220] WEB maintain visible content position #32098

HIGH: (Comment linking: step 2) [23220] WEB maintain visible content position #32098

Conversation

perunt commented Nov 28, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 28, 2023

cedarbaum commented Nov 29, 2023

janicduplessis commented Nov 30, 2023

cedarbaum commented Nov 30, 2023 • edited Loading

0xmiros commented Dec 7, 2023

0xmiros commented Dec 7, 2023 • edited Loading

roryabraham commented Dec 7, 2023

0xmiros commented Dec 7, 2023

roryabraham commented Dec 7, 2023

perunt commented Jan 5, 2024

perunt commented Jan 8, 2024

roryabraham commented Jan 9, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

roryabraham commented Jan 9, 2024 • edited Loading

roryabraham Jan 9, 2024 • edited Loading

Choose a reason for hiding this comment

roryabraham commented Jan 9, 2024

melvin-bot bot commented Jan 9, 2024

OSBotify commented Jan 9, 2024

0xmiros commented Jan 9, 2024

0xmiros commented Jan 9, 2024

janicduplessis commented Jan 9, 2024

OSBotify commented Jan 10, 2024

0xmiros commented Jan 10, 2024

0xmiros commented Jan 10, 2024

shubham1206agra commented Jan 10, 2024

perunt commented Jan 10, 2024 • edited Loading

perunt commented Jan 10, 2024

OSBotify commented Jan 11, 2024

s77rt Jul 7, 2024 • edited Loading

Choose a reason for hiding this comment

alitoshmatov Aug 18, 2024

Choose a reason for hiding this comment

perunt commented Nov 28, 2023 •

edited

Loading

cedarbaum commented Nov 30, 2023 •

edited

Loading

0xmiros commented Dec 7, 2023 •

edited

Loading

roryabraham commented Jan 9, 2024 •

edited

Loading

roryabraham commented Jan 9, 2024 •

edited

Loading

roryabraham Jan 9, 2024 •

edited

Loading

perunt commented Jan 10, 2024 •

edited

Loading

s77rt Jul 7, 2024 •

edited

Loading