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 inverted flat list #44168

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

kosmydel
Copy link

@kosmydel kosmydel commented Apr 19, 2024

Summary:

This PR solves this issue.
Inverted FlatList doesn't work (elements cannot be clicked) when the list is scrolled.

Changelog:

[GENERAL] [FIXED] - Fix clicking items on the inverted FlatList on the new architecture

Test Plan:

  1. Use this reproducer: https://github.com/WoLewicki/reproducer-react-native/tree/%40wolewicki/flatlist-inverted
  2. Apply changes from this PR & build the app.
  3. Scroll a bit the list, so it changes the position.
  4. The onPress should be fired when the button is clicked.
  5. Do the following tests:
  6. Add a horizontal prop to the FlatList - verify everything works.
  7. Remove a inverted prop - verify everything works.
  8. Remove a inverted prop and add a horizontal prop - verify everything works.
  9. Test different combinations of transforms of the FlatList, example:
      <FlatList
        inverted
        horizontal
        style={{
          transform: [
            {scaleY: -1},
            {scaleY: -2},
            {scaleY: -0.5},
            {translateY: 20},
            {translateY: -10},
            {skewX: '10deg'},
            {rotateX: '10deg'},
          ],
        }}
      />
Reproducrer
react-native-flat-list.mov
RN tester
android-rn-tester.mov

@facebook-github-bot
Copy link
Contributor

Hi @kosmydel!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@cipolleschi
Copy link
Contributor

/rebase - this comment rebase the PR on top of main automatically

Copy link
Contributor

@cipolleschi cipolleschi left a comment

Choose a reason for hiding this comment

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

The code looks good to me. I assume that inverting the list actually apply a transformation that is not applied to the content origin offset, right?

I wonder how many other instance of similar issues we have sprinkled around. 🤔

@github-actions github-actions bot force-pushed the @kosmydel/fix-inverted-flat-list branch from 4e59e0e to 8fc31f6 Compare April 19, 2024 16:38
@kosmydel
Copy link
Author

The code looks good to me. I assume that inverting the list actually apply a transformation that is not applied to the content origin offset, right?

That's right.

I still need to test it before opening it for review, as for now I tested it only in the @WoLewicki reproducer.

Copy link

@roryabraham roryabraham left a comment

Choose a reason for hiding this comment

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

We tested this in a release build of the Expensify app and verified that it solves the problem for us 👍🏼

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Apr 19, 2024
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@cipolleschi
Copy link
Contributor

/rebase - this comment rebase the PR on top of main automatically

@github-actions github-actions bot force-pushed the @kosmydel/fix-inverted-flat-list branch from 8fc31f6 to 520ddb4 Compare April 20, 2024 15:51
Copy link
Contributor

@cipolleschi cipolleschi left a comment

Choose a reason for hiding this comment

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

CI is red with an invalid operation. I suspect that this is usually a warning, but we have a "treat warnings as errors" build flag, so it fails in CI.

Copy link
Contributor

@NickGerleman NickGerleman left a comment

Choose a reason for hiding this comment

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

See above

@kosmydel
Copy link
Author

I've addressed the review and solved the mentioned issues

@analysis-bot
Copy link

analysis-bot commented Apr 22, 2024

Platform Engine Arch Size (bytes) Diff
android hermes arm64-v8a 19,410,748 -84,614
android hermes armeabi-v7a n/a --
android hermes x86 n/a --
android hermes x86_64 n/a --
android jsc arm64-v8a 22,784,277 -83,299
android jsc armeabi-v7a n/a --
android jsc x86 n/a --
android jsc x86_64 n/a --

Base commit: 4290ef5
Branch: main

@kosmydel kosmydel marked this pull request as ready for review April 22, 2024 11:51
@facebook-github-bot facebook-github-bot added the Shared with Meta Applied via automation to indicate that an Issue or Pull Request has been shared with the team. label Apr 22, 2024
@NickGerleman
Copy link
Contributor

NickGerleman commented Apr 22, 2024

I think this maybe should be adjusted for transformOrigin now that we have that (@intergalacticspacehighway do you know the math we should be doing here?) Otherwise this lgtm

This might end up interacting with #43192 more broadly I think, since we need to after resolve transforms relative to view size.

return {-contentOffset.x, -contentOffset.y + stateData.scrollAwayPaddingTop};

const auto& props = getConcreteProps();
auto result = props.transform * Vector{-contentOffset.x, -contentOffset.y, 0, 1};
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
auto result = props.transform * Vector{-contentOffset.x, -contentOffset.y, 0, 1};
auto result = props.resolveTransform(layoutMetrics_) * Vector{-contentOffset.x, -contentOffset.y, 0, 1};

cc - @NickGerleman this should take the transformOrigin into consideration

@intergalacticspacehighway
Copy link
Contributor

This might end up interacting with #43192 more broadly I think, since we need to after resolve transforms relative to view size.

I think as long as we use resolveTransform and layout metrics are correct, we should be good.

@facebook-github-bot
Copy link
Contributor

@NickGerleman has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator.

Copy link
Contributor

@NickGerleman NickGerleman left a comment

Choose a reason for hiding this comment

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

I took a closer look at the function where we are doing this, and found a couple more potential issues:

  1. Making getContentOriginOffset() return transformed offset breaks the contract assumed by DOM code
  2. This is called by getRelativeLayoutMetrics() which can be configured whether or not to use a transform. So we can't assume all callers there want a transform either

I.e. we're doing this transform at the wrong layer I think

@kosmydel
Copy link
Author

Hey, today I won't have time to investigate it.

we're doing this transform at the wrong layer I think

Could you provide more details on where the change should be made? This would be helpful.

@NickGerleman
Copy link
Contributor

How did we find this function as the original culprit? I.e. how do we call it for hit testing in the issue case? That would be a clue.

@WoLewicki
Copy link
Contributor

How do we call it for hit testing in the issue case:

We call it when adding offset for elements that are inside the ScrollView:

resultFrame.origin += currentShadowNode->getContentOriginOffset();

@NickGerleman
Copy link
Contributor

@sammy-SC wrote this code it looks like, but I can see that calculateTransformedFrames() already has some logic for transforming origin based on transform (though, seems special cased instead of using the matrix)? So it seems like there is an assumption there as well, that the returned origin is not yet transformed, but that caller should transform it.

We could maybe pass through policy for whether to include transform to this API, like some others. Because some code calling this (e.g. scroll offset) which rely on it not being transformed, but some other code calling it which already seems to try to apply transforms (and it sounds like one case, where we are forgetting to do this).

@NickGerleman
Copy link
Contributor

NickGerleman commented Apr 23, 2024

I also went to experiment on DOM behavior of scrollTop API the above is using, by adding a translation to scrollable content. Note that this transform is applied to the content inside of the scrolling container.

image

The expectation is that the offset is really just how much has been scrolled, in the coordinate space of the scrolling layer. This means that e.g. translating the origin of the content down would not effect reported scrollTop start, but that content transforms can still indirectly effect scrollTop etc when they create more scrollable area.

Transforms against scrollview outer view, like in test plan, do not effect returned results.

@WoLewicki
Copy link
Contributor

@NickGerleman so what would be the next proper actions for this one?

@NickGerleman
Copy link
Contributor

@NickGerleman so what would be the next proper actions for this one?

Digging into the code calling this, to understand where the fix should be, so that it doesn’t break other usages.

@kosmydel
Copy link
Author

Hello, I made changes last week and applied a transform only where necessary. I would appreciate it if someone could review and confirm that these changes are what we want. Thank you.

@NickGerleman
Copy link
Contributor

@realsoelynn you were digging into this, right? Could you take a look at current revision?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. Shared with Meta Applied via automation to indicate that an Issue or Pull Request has been shared with the team.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

8 participants