Update KeepAlive.debugTypicalAncestorWidgetClass #133498

Piinks · 2023-08-28T20:34:34Z

This fixes an oversight from #131641

Since KeepAlive is now supported in 2D scrolling, the debugTypicalAncestorWidgetClass was incorrect - this changes it to RenderAbstractViewport, which is true in both 1D and 2D scrolling. This is used to generate error messages when the ParentDataWidget is improperly used.

Also added some docs for KeepAlive that mention the 2D scrolling classes as supported.

Fixes #133497

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.

chunhtai · 2023-08-28T20:41:27Z

packages/flutter/lib/src/widgets/sliver.dart

@@ -1364,7 +1367,7 @@ class KeepAlive extends ParentDataWidget<KeepAliveParentDataMixin> {
  bool debugCanApplyOutOfTurn() => keepAlive;

  @override
-  Type get debugTypicalAncestorWidgetClass => SliverWithKeepAliveWidget;
+  Type get debugTypicalAncestorWidgetClass => RenderAbstractViewport;


This is a render object. If we really want to point out Render object, we should also update the error message, now it would show

(typically placed directly inside a RenderAbstractViewport widget)

Yeah, I was wondering if that would be less than ideal. I wonder if I can get away with changing the value to a String instead of Type. Let me see if that's not a breaking change...

chunhtai · 2023-08-28T22:32:19Z

packages/flutter/lib/src/widgets/framework.dart

  /// ```
  ///
  /// If the "typical" parent is generic (`Foo<T>`), consider specifying either
  /// a typical type argument (e.g. `Foo<int>` if `int` is typically how the
  /// type is specialized), or specifying the upper bound (e.g. `Foo<Object?>`).
-  Type get debugTypicalAncestorWidgetClass;
+  String get debugTypicalAncestorWidgetClass;


The issue still exist, this string will be plug in to line 1635 which will always be ... xxx widgets)

Oh right, thanks for checking that.

chunhtai · 2023-08-28T22:33:47Z

packages/flutter/lib/src/widgets/sliver.dart

@@ -1364,7 +1367,7 @@ class KeepAlive extends ParentDataWidget<KeepAliveParentDataMixin> {
  bool debugCanApplyOutOfTurn() => keepAlive;

  @override
-  Type get debugTypicalAncestorWidgetClass => SliverWithKeepAliveWidget;
+  String get debugTypicalAncestorWidgetClass => 'RenderAbstractViewport widget';


This sentence is still a bit confusing. Maybe Widgets that create RenderAbstractViewport

SGTM! Thank you!

So I tweaked this to be explicit instead. Originally I was trying to refer to the viewport as a common ancestor between 1D and 2D scrolling. But after working on another parent data change, it's really not the right error message to give someone for 1D scrolling since the viewport does not apply or use that parent data, the SliverWithKeepAliveWidget does.

navaronbracke · 2023-08-29T06:28:08Z

packages/flutter/lib/src/cupertino/dialog.dart

@@ -1561,8 +1561,7 @@ class _ActionButtonParentDataWidget
  }

  @override
-  Type get debugTypicalAncestorWidgetClass =>
-      _CupertinoDialogActionsRenderWidget;
+  String get debugTypicalAncestorWidgetClass => '_CupertinoDialogActionsRenderWidget';


You could use '$SomeClass' instead for all these usages?

Could do! I don't know if that would be reliably followed going forward since the type is just a String

chunhtai

LGTM

auto-submit · 2023-08-29T23:01:59Z

auto label is removed for flutter/flutter/133498, due to - The status or check suite Linux analyze has failed. Please fix the issues identified (or deflake) before re-applying this label.

auto-submit · 2023-08-30T05:43:15Z

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

Piinks · 2023-08-30T16:30:00Z

Ah unlucky, making it a String is breaking. I'll deprecate and add a dart fix in favor of a new property. 🙃 Simple change are always the trickiest.

chunhtai · 2023-08-30T17:02:35Z

if you don't want to make it breaking you can do something like

Type get debugTypicalAncestorWidgetClass;

String get debugTypicalAncestorWidgetClassMessage => '$debugTypicalAncestorWidgetClass widget';

Piinks · 2023-08-30T18:06:29Z

Good idea! I will experiment with that and look at the usages in g3 a bit more. Thank you!

packages/flutter/lib/src/widgets/framework.dart

chunhtai

LGTM

auto-submit · 2023-09-13T22:59:11Z

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

auto-submit · 2023-09-13T23:13:03Z

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

Piinks · 2023-09-13T23:16:01Z

I manually set the google testing check to green, and it undid itself for some reason. Merging manually since the autosubmit bot won't play nice.

…lutter#133498)

flutter/flutter@61b890b...58ba6c2 2023-09-14 engine-flutter-autoroll@skia.org Roll Packages from 06cd9e9 to 275b76c (1 revision) (flutter/flutter#134734) 2023-09-14 dacoharkes@google.com Update plugin_ffi generated file to match FFIgen 9.0.0 (flutter/flutter#134614) 2023-09-14 jmccandless@google.com LinkedText (Linkify) (flutter/flutter#125927) 2023-09-14 polinach@google.com _DayPicker should build days using separate stetefull widget _Day. (flutter/flutter#134607) 2023-09-13 31859944+LongCatIsLooong@users.noreply.github.com Remove `Path.combine` call from `CupertionoTextSelectionToolbar` (flutter/flutter#134369) 2023-09-13 katelovett@google.com Update KeepAlive.debugTypicalAncestorWidgetClass (flutter/flutter#133498) 2023-09-13 84124091+opxdelwin@users.noreply.github.com Fix null check crash by ReorderableList (flutter/flutter#132153) 2023-09-13 engine-flutter-autoroll@skia.org Roll Flutter Engine from 154d6fd601a3 to cd90cc8469fb (3 revisions) (flutter/flutter#134691) 2023-09-13 49699333+dependabot[bot]@users.noreply.github.com Bump github/codeql-action from 2.21.5 to 2.21.6 (flutter/flutter#134692) 2023-09-13 engine-flutter-autoroll@skia.org Roll Flutter Engine from b71b366e3de3 to 154d6fd601a3 (6 revisions) (flutter/flutter#134683) 2023-09-13 christopherfujino@gmail.com [flutter_tools] Run ShutdownHooks when handling signals (flutter/flutter#134590) 2023-09-13 jhy03261997@gmail.com Dispose routes in navigator when throwing exception (flutter/flutter#134596) 2023-09-13 jonahwilliams@google.com [framework] reduce ink sparkle uniform count. (flutter/flutter#133897) 2023-09-13 engine-flutter-autoroll@skia.org Roll Flutter Engine from 5e671d5c90f9 to b71b366e3de3 (4 revisions) (flutter/flutter#134676) 2023-09-13 15619084+vashworth@users.noreply.github.com Set the CONFIGURATION_BUILD_DIR in generated xcconfig when debugging core device (flutter/flutter#134493) 2023-09-13 zanderso@users.noreply.github.com Bump gradle heap size limit in *everywhere* (flutter/flutter#134665) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC camillesimon@google.com,rmistry@google.com,stuartmorgan@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Packages: https://github.com/flutter/flutter/issues/new/choose To report a problem with the AutoRoller itself, please file a bug: https://bugs.chromium.org/p/skia/issues/entry?template=Autoroller+Bug Documentation for the AutoRoller is here: https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md

…lutter#133498)

Piinks added framework flutter/packages/flutter repository. See also f: labels. f: scrolling Viewports, list views, slivers, etc. d: api docs Issues with https://api.flutter.dev/ a: error message Error messages from the Flutter framework labels Aug 28, 2023

Piinks requested a review from chunhtai August 28, 2023 20:34

Piinks changed the title ~~Update KeepAlive~~ Update KeepAlive.debugTypicalAncestorWidgetClass Aug 28, 2023

chunhtai reviewed Aug 28, 2023

View reviewed changes

github-actions bot added the f: cupertino flutter/packages/flutter/cupertino repository label Aug 28, 2023

Piinks requested a review from chunhtai August 28, 2023 21:22

chunhtai reviewed Aug 28, 2023

View reviewed changes

navaronbracke reviewed Aug 29, 2023

View reviewed changes

github-actions bot added the d: examples Sample code and demos label Aug 29, 2023

Piinks requested a review from chunhtai August 29, 2023 22:53

chunhtai approved these changes Aug 29, 2023

View reviewed changes

Piinks added the autosubmit Merge PR when tree becomes green via auto submit App label Aug 29, 2023

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Aug 29, 2023

Piinks added the autosubmit Merge PR when tree becomes green via auto submit App label Aug 29, 2023

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Aug 30, 2023

Piinks commented Sep 13, 2023

View reviewed changes

packages/flutter/lib/src/widgets/framework.dart Show resolved Hide resolved

Piinks requested a review from chunhtai September 13, 2023 16:58

chunhtai approved these changes Sep 13, 2023

View reviewed changes

Piinks added 4 commits September 13, 2023 15:45

Update KeepAlive

268dbd3

Nits

7169e29

Try rework Type to String

aa447dc

Review feedback

6cb6197

Piinks added 2 commits September 13, 2023 15:45

Snippet fix

415f1fb

Non breaking rework

6730861

Piinks force-pushed the ancestorDebug branch from 2c77f80 to 6730861 Compare September 13, 2023 22:46

Piinks added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 13, 2023

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Sep 13, 2023

Piinks added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 13, 2023

auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Sep 13, 2023

Piinks merged commit 2ea9edc into flutter:master Sep 13, 2023
64 of 67 checks passed

engine-flutter-autoroll mentioned this pull request Sep 14, 2023

Roll Flutter from 61b890bfcbc1 to 58ba6c295d8c (16 revisions) flutter/packages#4928

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 14, 2023

2ea9edc1a Update KeepAlive.debugTypicalAncestorWidgetClass (flutter/f…

d978dfc

…lutter#133498)

Mairramer pushed a commit to Mairramer/flutter that referenced this pull request Oct 10, 2023

Update KeepAlive.debugTypicalAncestorWidgetClass (flutter#133498)

44f0fd1

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Nov 15, 2023

2ea9edc1a Update KeepAlive.debugTypicalAncestorWidgetClass (flutter/f…

3fe33bd

…lutter#133498)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update KeepAlive.debugTypicalAncestorWidgetClass #133498

Update KeepAlive.debugTypicalAncestorWidgetClass #133498

Piinks commented Aug 28, 2023

chunhtai Aug 28, 2023

Piinks Aug 28, 2023

chunhtai Aug 28, 2023 •

edited

Piinks Aug 28, 2023

chunhtai Aug 28, 2023

Piinks Aug 28, 2023

Piinks Aug 29, 2023

navaronbracke Aug 29, 2023

Piinks Aug 29, 2023

chunhtai left a comment

auto-submit bot commented Aug 29, 2023

auto-submit bot commented Aug 30, 2023

Piinks commented Aug 30, 2023

chunhtai commented Aug 30, 2023 •

edited

Piinks commented Aug 30, 2023

chunhtai left a comment

auto-submit bot commented Sep 13, 2023

auto-submit bot commented Sep 13, 2023

Piinks commented Sep 13, 2023

Update KeepAlive.debugTypicalAncestorWidgetClass #133498

Update KeepAlive.debugTypicalAncestorWidgetClass #133498

Conversation

Piinks commented Aug 28, 2023

Pre-launch Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chunhtai Aug 28, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chunhtai left a comment

Choose a reason for hiding this comment

auto-submit bot commented Aug 29, 2023

auto-submit bot commented Aug 30, 2023

Piinks commented Aug 30, 2023

chunhtai commented Aug 30, 2023 • edited

Piinks commented Aug 30, 2023

chunhtai left a comment

Choose a reason for hiding this comment

auto-submit bot commented Sep 13, 2023

auto-submit bot commented Sep 13, 2023

Piinks commented Sep 13, 2023

chunhtai Aug 28, 2023 •

edited

chunhtai commented Aug 30, 2023 •

edited