Skip to content

Explain how the scroll controller behaves under tests#50129

Merged
fluttergithubbot merged 3 commits intoflutter:masterfrom
DaveShuckerow:sc-docs
Feb 6, 2020
Merged

Explain how the scroll controller behaves under tests#50129
fluttergithubbot merged 3 commits intoflutter:masterfrom
DaveShuckerow:sc-docs

Conversation

@DaveShuckerow
Copy link
Copy Markdown
Contributor

@DaveShuckerow DaveShuckerow commented Feb 4, 2020 •
edited
Loading

Description

Explain that awaiting ScrollController.animateTo can cause tests to hang.

Tests

This is a documentation update.

Checklist

Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes ([x]). This will ensure a smooth and quick review process.

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I signed the CLA.
  • I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I updated/added relevant documentation (doc comments with ///).
  • All existing and new tests are passing.
  • The analyzer (flutter analyze --flutter-repo) does not report any problems on my PR.
  • I am willing to follow-up on review comments in a timely manner.

Breaking Change

Did any tests fail when you ran them? Please read Handling breaking changes.

  • No, no existing tests failed, so this is not a breaking change.
  • Yes, this is a breaking change.

@fluttergithubbot
Copy link
Copy Markdown
Contributor

fluttergithubbot commented Feb 4, 2020

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.

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

@fluttergithubbot fluttergithubbot added the framework flutter/packages/flutter repository. See also f: labels. label Feb 4, 2020
@DaveShuckerow DaveShuckerow added the d: api docs Issues with https://api.flutter.dev/ label Feb 4, 2020
goderbauer
goderbauer approved these changes Feb 4, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@goderbauer goderbauer left a comment

Choose a reason for hiding this comment

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

LGTM after style comment is addressed.

Comment thread packages/flutter/lib/src/widgets/scroll_controller.dart Outdated
/// The duration must not be zero. To jump to a particular value without an
/// animation, use [jumpTo].
///
/// Note that when calling [animateTo] in widget tests, `await`ing the
Copy link
Copy Markdown
Member

@goderbauer goderbauer Feb 4, 2020

Choose a reason for hiding this comment

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

nit: as per style guide don't use "note that".

Copy link
Copy Markdown
Contributor Author

@DaveShuckerow DaveShuckerow Feb 5, 2020

Choose a reason for hiding this comment

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

Done.

@fluttergithubbot
Copy link
Copy Markdown
Contributor

fluttergithubbot commented Feb 5, 2020

This pull request is not suitable for automatic merging in its current state.

  • The status or check suite framework_tests-misc-macos has failed. Please fix the issues identified (or deflake) before re-applying this label.
  • The status or check suite framework_tests-widgets-linux has failed. Please fix the issues identified (or deflake) before re-applying this label.
  • The status or check suite framework_tests-libraries-linux has failed. Please fix the issues identified (or deflake) before re-applying this label.

@fluttergithubbot
Copy link
Copy Markdown
Contributor

fluttergithubbot commented Feb 5, 2020

This pull request is not suitable for automatic merging in its current state.

  • The status or check suite framework_tests-misc-macos has failed. Please fix the issues identified (or deflake) before re-applying this label.
  • The status or check suite framework_tests-widgets-linux has failed. Please fix the issues identified (or deflake) before re-applying this label.
  • The status or check suite framework_tests-libraries-linux has failed. Please fix the issues identified (or deflake) before re-applying this label.

@Piinks
Copy link
Copy Markdown
Contributor

Piinks commented Feb 6, 2020

It looks like this is experiencing a flake that has been patched. Can you update your branch with changes from master?

@DaveShuckerow
Copy link
Copy Markdown
Contributor Author

DaveShuckerow commented Feb 6, 2020

It looks like this is experiencing a flake that has been patched. Can you update your branch with changes from master?

Done. Tests passing now.

@fluttergithubbot fluttergithubbot merged commit 2032760 into flutter:master Feb 6, 2020
@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Aug 1, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@goderbauer goderbauer goderbauer approved these changes

@HansMuller HansMuller Awaiting requested review from HansMuller

Assignees

No one assigned

Labels

d: api docs Issues with https://api.flutter.dev/ 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.

5 participants

@DaveShuckerow @fluttergithubbot @Piinks @goderbauer @googlebot