Fix last spacer #32843

perunt · 2023-12-11T17:45:46Z

Details

The issue lies in incorrectly constraining the size of non-final spacers in lists that have a structure like:

ITEMS
SPACER
ITEMS

Here, the logic mistakenly applies tail spacer constraints to a middle spacer. This causes problems, especially with maintainVisibleContentPosition, leading to incorrect scrolling and the unintended virtualization of supposed-to-be-visible content. This happens because the logic is designed to prevent rapid scrolling into unmeasured areas, but it fails in lists where spacers aren't at the end.

UPSTREAM: facebook/react-native#41846

Fixed Issues

$ #32634
PROPOSAL:

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

For testing purposes, copy this code into your ReportScreen and click the button. You'll see that the screen position remains unchanged, and an item gets added. Note that this behavior is effective for a single push only.

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

melvin-bot · 2023-12-13T16:49:24Z

@grgia 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

Patch looks good to me

grgia · 2023-12-19T18:07:51Z

@perunt I think you're missing a checkmark in the author checklist

perunt · 2023-12-21T14:34:59Z

It should be good now

patches/react-native-web+0.19.9+005+fixLastSpacer.patch

roryabraham · 2023-12-22T17:14:04Z

@situchan is going to help us out with a C+ review here

roryabraham · 2023-12-22T17:14:53Z

@perunt the author checklist recently changed with a few items added, can you copy the checklist from .github/PULL_REQUEST_TEMPLATE.md and complete the updated checklist?

situchan · 2023-12-22T17:19:23Z

Just to confirm: upstream PR was merged but we're just applying patch here until new RN release given the urgency of comment linking project?

janicduplessis · 2023-12-22T17:20:39Z

@situchan Exactly, we also need a separate patch for RN web since the lists components are vendored and do not use the same version as react-native.

situchan · 2023-12-22T17:58:55Z

@perunt the author checklist recently changed with a few items added, can you copy the checklist from .github/PULL_REQUEST_TEMPLATE.md and complete the updated checklist?

Here's one - #30699

situchan · 2023-12-22T18:55:02Z

For testing purposes, copy this code into your ReportScreen and click the button. You'll see that the screen position remains unchanged, and an item gets added. Note that this behavior is effective for a single push only.

can you provide complete code? i.e. generatePosts function is missing
Otherwise, any easy way to test this?

Also, please complete Screenshots/Videos section

perunt · 2023-12-30T16:01:35Z

can you provide complete code? i.e. generatePosts function is missing
Otherwise, any easy way to test this?
Also, please complete Screenshots/Videos section

The generatePosts function can be found at the bottom of the page at the provided link. Additionally, you can reference the upstream code snippet available here: https://gist.github.com/janicduplessis/b67d1fafc08ef848378263208ab93d4c.

We haven't implemented this in our app yet. Would you like me to use the snipped above to demonstrate how it works?
By the way the upstream pull request has been successfully merged and the changes will be included in the upcoming React Native update

situchan · 2024-01-05T08:55:19Z

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

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

MacOS: Desktop

situchan · 2024-01-05T08:55:56Z

I don't see any difference before and after applying patch

Screen.Recording.2024-01-05.at.2.53.21.PM.mov

Screen.Recording.2024-01-05.at.2.54.52.PM.mov

…ix-last-spacer

situchan · 2024-01-09T07:46:52Z

@perunt any feedback on #32843 (comment)?

perunt · 2024-01-09T08:28:24Z

There should be some mistakes. Let's do all steps from the beginning
Copy this to ReportScreen (I removed comments and made the pagination batch bigger)

import {
  Button,
  StyleSheet,
  Text,
  View,
} from "react-native";
import FlatList from "@components/FlatList/MVCPFlatList";

function ReportScreen() {
  const pageSize = 50;
  const dat = useMemo(() => generatePosts(5000), []);
  const initial = useRef(true);
  const [page, setPage] = useState(0);

  const renderItem = ({ item }) => <Item data={item} />;
  const keyExtractor = (item) => item.id.toString();

  const data = useMemo(() =>  dat.slice(2000 - pageSize * page, 2050), [page]);

  useEffect(() => {
    initial.current = false;
  }, []);

  const onLoadNewerChats = () => {
    setPage((p) => p + 3);
  };

  return (
    <View style={{ flex: 1 }}>
      <FlatList
        data={data}
        inverted
        renderItem={renderItem}
        keyExtractor={keyExtractor}
        onStartReachedThreshold={0.75}
        windowSize={21}
        initialNumToRender={50}
        maintainVisibleContentPosition={{
          minIndexForVisible: 0,
        }}
      />
      <Button title="load newer" onPress={onLoadNewerChats} />
    </View>
  );
}

function Item({ data }) {
  return (
    <View style={[styles.item, { padding: data.padding }]}>
      <Text style={styles.title}>
        {data.id} - {data.title}
      </Text>
    </View>
  );
}

const styles = StyleSheet.create({
  item: {
    backgroundColor: "#f9c2ff",
    marginVertical: 8,
    marginHorizontal: 16,
  },
  title: {
    fontSize: 24,
  },
});

const generatePosts = (count, start = 0) =>
  Array.from({ length: count }, (_, i) => ({
    title: `Title ${start + i + 1}`,
    vote: 10,
    id: start + i,
    padding: 20,
  }));

export default ReportScreen;

you should see the following result
before:

+720.mov

after:

720+.mov

perunt · 2024-01-09T08:44:08Z

@situchan, please ping me if it doesn't work for you

situchan · 2024-01-09T08:50:39Z

I am getting crash after applying your code

perunt · 2024-01-09T09:32:53Z

For mobile you should replace

import FlatList from "@components/FlatList/MVCPFlatList";

to

import FlatList from '@components/FlatList';

as MVCPFlatList is only for web component
@situchan can you check this?

situchan · 2024-01-09T09:34:42Z

as MVCPFlatList is only for web component
@situchan can you check this?

crash happened on web as well

perunt · 2024-01-09T09:41:22Z

Let me run it with a 'clean' flag and recheck it. Meantime please double check if your branch is up to date.

perunt · 2024-01-09T10:08:05Z

@situchan I cleared my cache, and everything is working for me. Did you check if your local branch is up to date with mine?

grgia

waiting on c+ re-review to merge

perunt · 2024-01-10T15:25:29Z

@situchan, please can you check it?

situchan · 2024-01-10T17:26:04Z

I confirmed working on both web and native. Before this PR, there's bug indeed

@grgia let's merge!

OSBotify · 2024-01-10T18:51:33Z

✋ 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-01-11T09:58:40Z

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

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

kavimuru · 2024-01-11T10:01:44Z

@perunt Can you help with the QA steps? What should we be validating after sending the linked code in a chat?

You'll see that the screen position remains unchanged, and an item gets added. Note that this behavior is effective for a single push only.

perunt · 2024-01-11T10:54:42Z

This PR fixes a bug where adding over 50 new messages at once causes issues. It's hard to replicate this in the app right now as we don't have such functionality, but PR #30269 makes it possible to test it

situchan · 2024-01-11T11:04:48Z

I think for now it's [No QA]. It can be fully tested in that comment linking live PR

OSBotify · 2024-01-15T11:40:00Z

🚀 Deployed to production by https://github.com/mountiny in version: 1.4.24-8 🚀

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

perunt added 3 commits December 11, 2023 13:42

fix last spacer

022ac3a

rename

462420c

the second patch

c74d0ef

perunt changed the title ~~Perunt/fix last spacer~~ Fix last spacer Dec 12, 2023

update patch

4659b54

perunt mentioned this pull request Dec 13, 2023

[HOLD for payment 2024-01-22] HIGH: (Comment linking: step 1) 'maintainVisibleContentPosition' doesn't works with the large list #32634

Closed

6 tasks

perunt marked this pull request as ready for review December 13, 2023 16:48

perunt requested a review from a team as a code owner December 13, 2023 16:48

melvin-bot bot requested review from grgia and removed request for a team December 13, 2023 16:49

perunt marked this pull request as draft December 13, 2023 16:58

janicduplessis mentioned this pull request Dec 13, 2023

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

Merged

50 tasks

janicduplessis approved these changes Dec 13, 2023

View reviewed changes

fix patch

f4592cb

roryabraham mentioned this pull request Dec 15, 2023

[$2000] HIGH: Implement Comment Linking #20282

Closed

perunt marked this pull request as ready for review December 16, 2023 13:46

grgia previously approved these changes Dec 19, 2023

View reviewed changes

janicduplessis reviewed Dec 21, 2023

View reviewed changes

patches/react-native-web+0.19.9+005+fixLastSpacer.patch Outdated Show resolved Hide resolved

const replace with var

13dd61c

perunt dismissed grgia’s stale review via 13dd61c December 21, 2023 18:43

roryabraham requested a review from situchan December 22, 2023 17:13

roryabraham self-requested a review January 1, 2024 19:27

Merge branch 'main' of https://github.com/Expensify/App into perunt/f…

0626998

…ix-last-spacer

situchan approved these changes Jan 9, 2024

View reviewed changes

reapply patch after merge

8aca887

grgia approved these changes Jan 9, 2024

View reviewed changes

roryabraham approved these changes Jan 10, 2024

View reviewed changes

roryabraham merged commit ce67e8a into Expensify:main Jan 10, 2024
9 checks passed

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

Deploy Checklist: New Expensify 2024-01-11 #34327

Closed

54 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix last spacer #32843

Fix last spacer #32843

perunt commented Dec 11, 2023 •

edited

Loading

melvin-bot bot commented Dec 13, 2023

janicduplessis left a comment

grgia commented Dec 19, 2023

perunt commented Dec 21, 2023

roryabraham commented Dec 22, 2023

roryabraham commented Dec 22, 2023

situchan commented Dec 22, 2023

janicduplessis commented Dec 22, 2023

situchan commented Dec 22, 2023

situchan commented Dec 22, 2023

perunt commented Dec 30, 2023

situchan commented Jan 5, 2024

situchan commented Jan 5, 2024

situchan commented Jan 9, 2024

perunt commented Jan 9, 2024 •

edited

Loading

perunt commented Jan 9, 2024

situchan commented Jan 9, 2024

perunt commented Jan 9, 2024 •

edited

Loading

situchan commented Jan 9, 2024

perunt commented Jan 9, 2024 •

edited

Loading

perunt commented Jan 9, 2024

grgia left a comment

perunt commented Jan 10, 2024

situchan commented Jan 10, 2024

OSBotify commented Jan 10, 2024

OSBotify commented Jan 11, 2024

kavimuru commented Jan 11, 2024 •

edited

Loading

perunt commented Jan 11, 2024

situchan commented Jan 11, 2024

OSBotify commented Jan 15, 2024

Fix last spacer #32843

Fix last spacer #32843

Conversation

perunt commented Dec 11, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Dec 13, 2023

janicduplessis left a comment

Choose a reason for hiding this comment

grgia commented Dec 19, 2023

perunt commented Dec 21, 2023

roryabraham commented Dec 22, 2023

roryabraham commented Dec 22, 2023

situchan commented Dec 22, 2023

janicduplessis commented Dec 22, 2023

situchan commented Dec 22, 2023

situchan commented Dec 22, 2023

perunt commented Dec 30, 2023

situchan commented Jan 5, 2024

Reviewer Checklist

Screenshots/Videos

situchan commented Jan 5, 2024

situchan commented Jan 9, 2024

perunt commented Jan 9, 2024 • edited Loading

perunt commented Jan 9, 2024

situchan commented Jan 9, 2024

perunt commented Jan 9, 2024 • edited Loading

situchan commented Jan 9, 2024

perunt commented Jan 9, 2024 • edited Loading

perunt commented Jan 9, 2024

grgia left a comment

Choose a reason for hiding this comment

perunt commented Jan 10, 2024

situchan commented Jan 10, 2024

OSBotify commented Jan 10, 2024

OSBotify commented Jan 11, 2024

kavimuru commented Jan 11, 2024 • edited Loading

perunt commented Jan 11, 2024

situchan commented Jan 11, 2024

OSBotify commented Jan 15, 2024

perunt commented Dec 11, 2023 •

edited

Loading

perunt commented Jan 9, 2024 •

edited

Loading

perunt commented Jan 9, 2024 •

edited

Loading

perunt commented Jan 9, 2024 •

edited

Loading

kavimuru commented Jan 11, 2024 •

edited

Loading