Skip to content

Re-add the ability to return null in ListView.builder#108706

Merged
auto-submit[bot] merged 16 commits intoflutter:masterfrom
rrousselGit:null-item-builder
Sep 20, 2022
Merged

Re-add the ability to return null in ListView.builder#108706
auto-submit[bot] merged 16 commits intoflutter:masterfrom
rrousselGit:null-item-builder

Conversation

@rrousselGit
Copy link
Contributor

@rrousselGit rrousselGit commented Jul 31, 2022

Fixes a possible regression during NNBD migration that removed the ability to return null in ListView.builder's itemBuilder

fixes #108705

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.

@flutter-dashboard flutter-dashboard bot added f: scrolling Viewports, list views, slivers, etc. framework flutter/packages/flutter repository. See also f: labels. labels Jul 31, 2022
@goderbauer
Copy link
Member

goderbauer commented Aug 2, 2022

(from triage): Looks like some tests are failing on this, could you take a look and fix those up?

@goderbauer goderbauer requested a review from Piinks August 2, 2022 22:15
Piinks
Piinks reviewed Aug 2, 2022
View reviewed changes
@rrousselGit
Copy link
Contributor Author

rrousselGit commented Aug 8, 2022

(from triage): Looks like some tests are failing on this, could you take a look and fix those up?

I'd happily try to fix the CI, but the error messages are unreadable

Example:

��������������������������������������������������������

Any thought on how I could get a readable explanation of the problem? Otherwise I'll have a hard time fixing the issue.

@goderbauer
Copy link
Member

goderbauer commented Aug 8, 2022

The failure appears pretty clearly in the log [1]:

03:48 +2804 ~52: /tmp/flutter sdk/packages/flutter/test/widgets/scroll_view_test.dart: ListView.separated supports null items in itemBuilder                                                           
══╡ EXCEPTION CAUGHT BY FLUTTER TEST FRAMEWORK ╞════════════════════════════════════════════════════
The following TestFailure was thrown running a test:
Expected: exactly 4 matching nodes in the widget tree
  Actual: _TextFinder:<5 widgets with text "separator" (ignoring offstage widgets):
Text("separator", dependencies: [DefaultSelectionStyle, DefaultTextStyle, MediaQuery]),
Text("separator", dependencies: [DefaultSelectionStyle, DefaultTextStyle, MediaQuery]),
Text("separator", dependencies: [DefaultSelectionStyle, DefaultTextStyle, MediaQuery]), ...>
   Which: is too many
When the exception was thrown, this was the stack:
#4      main.<anonymous closure> (file:///tmp/flutter%20sdk/packages/flutter/test/widgets/scroll_view_test.dart:179:5)
<asynchronous suspension>
<asynchronous suspension>
(elided one frame from package:stack_trace)
This was caught by the test expectation on the following line:
  file:///tmp/flutter%20sdk/packages/flutter/test/widgets/scroll_view_test.dart line 179
The test description was:
  ListView.separated supports null items in itemBuilder
════════════════════════════════════════════════════════════════════════════════════════════════════

[1] https://cirrus-ci.com/task/6670346764943360?logs=main#L801

@rrousselGit
Copy link
Contributor Author

rrousselGit commented Aug 9, 2022

Thanks! Weird that Github action doesn't render them clearly. I'll look into it

@goderbauer goderbauer requested a review from Piinks August 16, 2022 22:13
Piinks
Piinks reviewed Aug 16, 2022
View reviewed changes
Copy link
Contributor

@Piinks Piinks left a comment

Choose a reason for hiding this comment

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

Thanks for the updates. So we have updated PageView, ListView, and GridView here, and it looks like AnimatedList, ReorderableList are confirmed not relevant.
It also looks like CupertinoTabScaffold specifies in the docs that tabBuilder cannot be null.

For the three cases that are changing to NullableIndexedWidgetBuilder can you add a templated doc that clarifies the behavior when using null to indicate the end of the list? The max scroll extent will not be accurate unless you are at the end of the list for example. This has caused confusion for a lot of folks in the past, so reintroducing this gives us a better chance to document it. :)

@rrousselGit
Copy link
Contributor Author

rrousselGit commented Aug 24, 2022

Sorry, I missed your message!

I'll update the docs after the Flutter Vikings (1st of September).

@goderbauer
Copy link
Member

goderbauer commented Sep 13, 2022

(triage): @rrousselGit Do you have another chance to look at this now that Vikings is over?

@rrousselGit
Copy link
Contributor Author

rrousselGit commented Sep 14, 2022

Oops, sorry for the delay. Done

Piinks
Piinks reviewed Sep 14, 2022
View reviewed changes
Copy link
Contributor

@Piinks Piinks left a comment

Choose a reason for hiding this comment

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

This LGTM with nits, but it looks like CI is unhappy. Can you rebase with master to see if it resolves the failures?

Piinks
Piinks reviewed Sep 16, 2022
View reviewed changes
Copy link
Contributor

@Piinks Piinks left a comment

Choose a reason for hiding this comment

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

Thanks for the updates! The docs test looks unhappy, but I've noted where the issues are below.

packages/flutter/lib/src/widgets/scroll_view.dart
/// [ListView] itself is created, it is more efficient to use the [ListView]
/// constructor. Even more efficient, however, is to create the instances on
/// demand using this constructor's `itemBuilder` callback.
///
Copy link
Contributor

@Piinks Piinks Sep 16, 2022

Choose a reason for hiding this comment

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

This needs an /// {@endtemplate}

Copy link
Contributor Author

@rrousselGit rrousselGit Sep 17, 2022

Choose a reason for hiding this comment

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

There is one, it is in the paragraph above

This paragraph isn't part of the @template

@rrousselGit
Copy link
Contributor Author

rrousselGit commented Sep 17, 2022

Oh, my bad. Let me fix that

@Piinks
Copy link
Contributor

Piinks commented Sep 19, 2022

Oh, my bad. Let me fix that

No worries, appeasing the CI gods can feel a bit tedious at times. Thanks for sticking with it!

Piinks
Piinks approved these changes Sep 19, 2022
View reviewed changes
Copy link
Contributor

@Piinks Piinks left a comment

Choose a reason for hiding this comment

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

Flutter_LGTM

@Piinks Piinks added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 19, 2022
@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Sep 19, 2022
@auto-submit
Copy link
Contributor

auto-submit bot commented Sep 19, 2022

auto label is removed for flutter/flutter, pr: 108706, due to - Please get at least one approved review if you are already a member or two member reviews if you are not a member before re-applying this label. Reviewers: If you left a comment approving, please use the "approve" review action instead.

@auto-submit
Copy link
Contributor

auto-submit bot commented Sep 19, 2022

auto label is removed for flutter/flutter, pr: 108706, due to Validations Fail.

@Piinks
Copy link
Contributor

Piinks commented Sep 19, 2022

Ah we need a second reviewer, I'll seek one.

justinmc
justinmc approved these changes Sep 19, 2022
View reviewed changes
Copy link
Contributor

@justinmc justinmc left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@Piinks Piinks added autosubmit Merge PR when tree becomes green via auto submit App and removed autosubmit Merge PR when tree becomes green via auto submit App labels Sep 20, 2022
@Piinks Piinks added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 20, 2022
@auto-submit auto-submit bot merged commit 6f3168c into flutter:master Sep 20, 2022
@rrousselGit rrousselGit deleted the null-item-builder branch September 20, 2022 19:03
This was referenced Sep 21, 2022
Merged
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 21, 2022
@engine-flutter-autoroll
6f3168c Re-add the ability to return null in ListView.builder (flutte…
b0c969c 
…r/flutter#108706)
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Sep 21, 2022
@engine-flutter-autoroll
6f3168c Re-add the ability to return null in ListView.builder (flutte…
63e0370 
…r/flutter#108706)
galiperkin
galiperkin reviewed Jan 30, 2023
View reviewed changes
Copy link

@galiperkin galiperkin left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Changes are reviewed. LGTM.

@HansMuller HansMuller mentioned this pull request Feb 28, 2024
Closed
@laiiihz laiiihz mentioned this pull request Nov 13, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Piinks Piinks Piinks approved these changes

@justinmc justinmc justinmc approved these changes

+1 more reviewer

@galiperkin galiperkin galiperkin left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

autosubmit Merge PR when tree becomes green via auto submit App f: scrolling Viewports, list views, slivers, etc. framework flutter/packages/flutter repository. See also f: labels.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Regression: ListView.builder's itemBuilder can no-longer return null since NNBD migration

5 participants

@rrousselGit @goderbauer @Piinks @justinmc @galiperkin