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.

Sign up for GitHub

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

Jump to bottom

Fix update drag error that made NestedScrollView un-scrollable #127718

Merged

auto-submit merged 10 commits into flutter:master from Piinks:fixNestedDrag

Jun 5, 2023

Contributor

Piinks commented May 26, 2023 •

edited

(plus some more docs)

Fixes #76760
Fixes #82391
Fixes #45619
Fixes #117316
Fixes #110956
Fixes #127282
Fixes #32563
Fixes #46089
Fixes #79077
Part of fixing #62833

This fixes (a bunch of) issues that have been reported differently over the years, but all have the same root cause. Sometimes the NestedScrollView would incorrectly calculate whether or not there is enough content to allow scrolling. This would only apply to drag scrolling (not mouse wheel scrolling for example). This did not relate to how the extent of the NestedScrollView is computed, but just the logic that enabled the actual drag gestures. This fixes that. :)

Pre-launch Checklist

I read the Contributor Guide and followed the process outlined there for submitting PRs.
I read the Tree Hygiene wiki page, which explains my responsibilities.
I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Piinks added 2 commits

May 26, 2023 14:19

++

a273197

Fix

076d967

flutter-dashboard bot added f: scrolling framework labels

flutter-dashboard bot commented May 26, 2023

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat (don't just cc him here, he won't see it! He's on Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

github-actions bot removed f: scrolling framework labels

Contributor Author

Piinks commented May 26, 2023

Still scanning issues to see if there are other test cases here, it looks like this has been reported a lot of different ways over the years. @nt4f04uNd and @xu-baolin might like to see this, no worries if you are unavailable to check it out, but if you can I'd be interested to see what you think. :)

Piinks added framework f: scrolling a: quality labels

xu-baolin self-requested a review

May 29, 2023 12:37

xu-baolin reviewed

View reviewed changes

packages/flutter/lib/src/widgets/nested_scroll_view.dart Outdated

+                    || totalInnerExtent > (viewportDimension - maxScrollExtent)
+                    // There is no outer extent. The inner extent was computed based on the
+                    // full viewport dimension and is accurate for the whole NestedScrollView.
+                    || (maxScrollExtent == 0 && totalInnerExtent > 0);

Member

xu-baolin May 29, 2023

I think I need time to check if this change works for all the problem cases 😄

Will feedback in the next few days.

xu-baolin reviewed

View reviewed changes

packages/flutter/lib/src/widgets/nested_scroll_view.dart Outdated

		@@ -855,7 +855,10 @@ class _NestedScrollCoordinator implements ScrollActivityDelegate, ScrollHoldCont
		position.maxScrollExtent - position.minScrollExtent,

Member

xu-baolin May 30, 2023

In fact, maxInnerExtent is not the total extension of the inner scrollable, but the maximum scrolling space inside, right?

xu-baolin reviewed

View reviewed changes

packages/flutter/lib/src/widgets/nested_scroll_view.dart Outdated

+                  final double maxScrollExtent = this.maxScrollExtent + overlapExtent;
+                  final bool extentAllows =
+                    // There is already room to scroll in the outer scroll view.
+                    minScrollExtent != maxScrollExtent

Member

xu-baolin May 30, 2023

This should be this.minScrollExtent != this.maxScrollExtent.
Thinking of this case, the overlapExtent > 0(just pinned the sliver bar) and the inner scrollable has a little extent that can not scrolling, we should not set this can drag, right?

xu-baolin reviewed

View reviewed changes

packages/flutter/lib/src/widgets/nested_scroll_view.dart Outdated

+                    minScrollExtent != maxScrollExtent
+                    // The inner extent exceeds the bounds of the viewport, accounting for the
+                    // outer extent.
+                    || totalInnerExtent > (viewportDimension - maxScrollExtent)

Member

xu-baolin May 30, 2023

If this is right, we just should change extentAllows to

final bool extentAllows = this.minScrollExtent != this.maxScrollExtent || totalInnerExtent > 0

Contributor Author

Piinks Jun 2, 2023

So I realized this is not accounting for the physics at all! Which reminded me of #82391... so I changed it to what i think it should really be. Even if the extent is not enough to scroll, I don't want to completely ignore AlwaysScrollableScrollPhysics, which should always scroll even if it is not long enough.

nt4f04uNd reviewed

View reviewed changes

packages/flutter/lib/src/widgets/nested_scroll_view.dart Outdated

+                  // app bar should not have to consume scrolling before the inner body of the
+                  // NestedScrollView scrolls. However, when calculating the drag here, 0
+                  // could result in scrolling being disabled unexpectedly if the inner scroll
+                  // view by itself were not long enough to allow scrolling on its own.

Member

nt4f04uNd May 30, 2023

Great comment!
I have to admit that this was pretty tricky for me to wrap my head around this ;-)

I am not very familiar with the internals of NestedScrollView, so I'll leave this to @xu-baolin to review

Contributor Author

Piinks Jun 2, 2023

I was actually able to make it even simpler. :)

Piinks mentioned this pull request

RefreshIndicator syncs scrollposition across tabs when using TabbarView with AutomaticKeepAliveClientMixin inside NestedScrollView #62833

Closed


          Tweaking with something different...

3d0a111

This was referenced Jun 1, 2023

Add error message when sliver overlap absorber is missing #128075

Merged

ScrollableState.setCanDrag should not contradict with scroll physics #82391

Closed


          Stopping to debug test

53e21a3

auto-submit bot pushed a commit that referenced this pull request


          Add error message when sliver overlap absorber is missing (#128075)

acf5a25

Adds an error message where we previously would crash without any help.
Came across this while working on #127718
Fixes #128074

Piinks changed the title ~~WIP - Fix nested computation of drag in NestedScrollView~~ Fix update drag error that made NestedScrollView un-scrollable

Piinks added the f: gestures label


          Update

f9cc9df

github-actions bot removed the f: gestures label

Piinks added 3 commits

June 2, 2023 14:54


          Save conflict?

99403c3


          Merge branch 'master' of github.com:flutter/flutter into fixNestedDrag

509c995


          Self review

c17237b


          Review feedback

2af5e7f

Piinks added the autosubmit label

auto-submit bot removed the autosubmit label

Contributor

auto-submit bot commented Jun 3, 2023

auto label is removed for flutter/flutter, pr: 127718, due to - The status or check suite Google testing has failed. Please fix the issues identified (or deflake) before re-applying this label.


          Merge branch 'master' into fixNestedDrag

222a434

Piinks added the autosubmit label

auto-submit bot merged commit 9a26346 into flutter:master

72 checks passed

engine-flutter-autoroll mentioned this pull request

Roll Flutter from 0b7415356e07 to 24e411f49b9e (16 revisions) flutter/packages#4146

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          9a263466a Fix update drag error that made NestedScrollView un-scrolla…

…ble (flutter/flutter#127718)

engine-flutter-autoroll mentioned this pull request

Roll Flutter from 0b7415356e07 to d095f10b443c (17 revisions) flutter/packages#4148

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          9a263466a Fix update drag error that made NestedScrollView un-scrolla…

c54efb2

…ble (flutter/flutter#127718)

engine-flutter-autoroll mentioned this pull request

Roll Flutter from 0b7415356e07 to ffab83e6f3b7 (19 revisions) flutter/packages#4149

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          9a263466a Fix update drag error that made NestedScrollView un-scrolla…

fe1dab8

…ble (flutter/flutter#127718)

engine-flutter-autoroll mentioned this pull request

Roll Flutter from 0b7415356e07 to 4c5db40ff57e (20 revisions) flutter/packages#4150

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          9a263466a Fix update drag error that made NestedScrollView un-scrolla…

e057ba7

…ble (flutter/flutter#127718)

engine-flutter-autoroll mentioned this pull request

Roll Flutter from 0b7415356e07 to 42cf3e371a27 (21 revisions) flutter/packages#4151

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          9a263466a Fix update drag error that made NestedScrollView un-scrolla…

43e6f78

…ble (flutter/flutter#127718)

engine-flutter-autoroll mentioned this pull request

Roll Flutter from 0b7415356e07 to 6848110ff3a9 (44 revisions) flutter/packages#4156

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          9a263466a Fix update drag error that made NestedScrollView un-scrolla…

1f28efd

…ble (flutter/flutter#127718)

engine-flutter-autoroll mentioned this pull request

Roll Flutter from 0b7415356e07 to 2830f0734d6c (45 revisions) flutter/packages#4158

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          9a263466a Fix update drag error that made NestedScrollView un-scrolla…

ff87a25

…ble (flutter/flutter#127718)

engine-flutter-autoroll mentioned this pull request

Roll Flutter from 0b7415356e07 to 8a5c22e282db (46 revisions) flutter/packages#4160

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          9a263466a Fix update drag error that made NestedScrollView un-scrolla…

…ble (flutter/flutter#127718)

auto-submit bot pushed a commit to flutter/packages that referenced this pull request


          Roll Flutter from 0b7415356e07 to 8a5c22e282db (46 revisions) (#4160)

e584280

Roll Flutter from 0b7415356e07 to 8a5c22e282db (46 revisions)

flutter/flutter@0b74153...8a5c22e

2023-06-07 5236035+fzyzcjy@users.noreply.github.com Super tiny MediaQuery doc update (flutter/flutter#127904)
2023-06-07 jacksongardner@google.com Revert "Make inspector weakly referencing the inspected objects." (flutter/flutter#128436)
2023-06-07 leigha.jarett@gmail.com Update menu API docs to help developers migrate to m3 (flutter/flutter#128351)
2023-06-07 andrewrkolos@gmail.com [tools] allow explicitly specifying the JDK to use via a new config setting (flutter/flutter#128264)
2023-06-07 engine-flutter-autoroll@skia.org Roll Flutter Engine from 6f9df0f988c1 to 59d5444cf06c (3 revisions) (flutter/flutter#128376)
2023-06-07 andrewrkolos@gmail.com Do not try to load main/default asset image if only higher-res variants exist (flutter/flutter#128143)
2023-06-07 92602467+99spark@users.noreply.github.com Addressed Ambiguity in transform.scale constructor docs (flutter/flutter#128182)
2023-06-07 5236035+fzyzcjy@users.noreply.github.com Super tiny fix of dead link (flutter/flutter#128160)
2023-06-07 goderbauer@google.com Refactor tests (flutter/flutter#128371)
2023-06-07 polinach@google.com Make inspector weakly referencing the inspected objects. (flutter/flutter#128095)
2023-06-07 goderbauer@google.com Add viewId to PointerEvents (flutter/flutter#128287)
2023-06-07 5236035+fzyzcjy@users.noreply.github.com Show error message in release mode when box is not laid out without losing performance (flutter/flutter#126302)
2023-06-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from ca499463ec2e to 6f9df0f988c1 (1 revision) (flutter/flutter#128363)
2023-06-06 khanhnwin@gmail.com Update Draggable YouTube video link (flutter/flutter#128078)
2023-06-06 31859944+LongCatIsLooong@users.noreply.github.com Remove more rounding hacks from TextPainter (flutter/flutter#127826)
2023-06-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from 4571695f9e76 to ca499463ec2e (1 revision) (flutter/flutter#128356)
2023-06-06 43054281+camsim99@users.noreply.github.com [Android] Update plugin and module templates to use Flutter constant for `compileSdkVersion` (flutter/flutter#128073)
2023-06-06 rmolivares@renzo-olivares.dev handleSelectWord in MultiSelectableSelectionContainerDelegate should handle rects inside of rects (flutter/flutter#127478)
2023-06-06 christopherfujino@gmail.com [flutter_tools] never tree shake 0x20 (space) font codepoints on web (flutter/flutter#128302)
2023-06-06 31859944+LongCatIsLooong@users.noreply.github.com Remove `textScaleFactor` dependent logic from `AppBar` (flutter/flutter#128112)
2023-06-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from b6d37f8f74ad to 4571695f9e76 (6 revisions) (flutter/flutter#128350)
2023-06-06 5236035+fzyzcjy@users.noreply.github.com Fix `Null check operator used on a null value` on TextField with contextMenuBuilder (flutter/flutter#128114)
2023-06-06 engine-flutter-autoroll@skia.org Roll Packages from db4e5c2 to da72219 (10 revisions) (flutter/flutter#128348)
2023-06-06 91688203+yusuf-goog@users.noreply.github.com Updating cirrus docker image to ubuntu focal. (flutter/flutter#128291)
2023-06-06 leigha.jarett@gmail.com Adding example for migrating to navigation drawer (flutter/flutter#128295)
2023-06-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from 722aad83e5fe to b6d37f8f74ad (2 revisions) (flutter/flutter#128341)
2023-06-06 goderbauer@google.com Clean-up viewId casts in flutter_test (flutter/flutter#128256)
2023-06-06 kevinjchisholm@google.com Update cherry-pick issue template to more uniform labels. (flutter/flutter#128333)
2023-06-06 hans.muller@gmail.com Use Material3 in the 2D viewport tests (flutter/flutter#128155)
2023-06-06 nbosch@google.com Use a `show` over a `hide` for `test_api` exports (flutter/flutter#128298)
2023-06-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from aaa7574375a6 to 722aad83e5fe (1 revision) (flutter/flutter#128307)
2023-06-06 leigha.jarett@gmail.com Migration guide for moving from BottomNavigationBar to NavigationBar (flutter/flutter#128263)
2023-06-06 mdebbar@google.com [web] Use 'Uri' instead of 'dart:html' to extract pathname (flutter/flutter#127983)
2023-06-06 engine-flutter-autoroll@skia.org Roll Flutter Engine from 2b353ae90731 to aaa7574375a6 (4 revisions) (flutter/flutter#128301)
2023-06-05 engine-flutter-autoroll@skia.org Roll Flutter Engine from 220ece4d9faa to 2b353ae90731 (1 revision) (flutter/flutter#128293)
2023-06-05 49699333+dependabot[bot]@users.noreply.github.com Bump actions/labeler from 4.0.4 to 4.1.0 (flutter/flutter#128290)
2023-06-05 engine-flutter-autoroll@skia.org Roll Flutter Engine from 7f12e3497428 to 220ece4d9faa (6 revisions) (flutter/flutter#128282)
2023-06-05 jonahwilliams@google.com [framework] attempt non-key solution (flutter/flutter#128273)
2023-06-05 chillers@google.com [labeler] Fix adding labels when name is directory (flutter/flutter#128243)
2023-06-05 katelovett@google.com Remove scrollbar deprecations isAlwaysShown and hoverThickness (flutter/flutter#127351)
2023-06-05 katelovett@google.com Fix update drag error that made NestedScrollView un-scrollable (flutter/flutter#127718)
2023-06-05 engine-flutter-autoroll@skia.org Roll Flutter Engine from f9f72388a4da to 7f12e3497428 (4 revisions) (flutter/flutter#128271)
2023-06-05 goderbauer@google.com Migrate SemanticsBinding to onSemanticsActionEvent (flutter/flutter#128254)
2023-06-05 engine-flutter-autoroll@skia.org Roll Flutter Engine from c838a1b05924 to f9f72388a4da (19 revisions) (flutter/flutter#128252)
2023-06-05 jonahwilliams@google.com [framework] force flexible space background to rebuild. (flutter/flutter#128138)
2023-06-05 engine-flutter-autoroll@skia.org Roll Packages from 75085ed to db4e5c2 (4 revisions) (flutter/flutter#128246)
...

HansMuller mentioned this pull request

Flutter Framework Team: Notable Commits #121415

Open

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          9a263466a Fix update drag error that made NestedScrollView un-scrolla…

0b6e4ca

…ble (flutter/flutter#127718)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          9a263466a Fix update drag error that made NestedScrollView un-scrolla…

94696f3

…ble (flutter/flutter#127718)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          9a263466a Fix update drag error that made NestedScrollView un-scrolla…

6abdfab

…ble (flutter/flutter#127718)

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request


          9a263466a Fix update drag error that made NestedScrollView un-scrolla…

c378890

…ble (flutter/flutter#127718)

Piinks mentioned this pull request

NestedScrollView allows dragging when there is not enough content to scroll #136069

Open

2 tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment