flutter_flutter/packages/flutter/test/widgets/scroll_events_test.dart
Kate Lovett 9d96df2364
Modernize framework lints (#179089)
WIP

Commits separated as follows:
- Update lints in analysis_options files
- Run `dart fix --apply`
- Clean up leftover analysis issues 
- Run `dart format .` in the right places.

Local analysis and testing passes. Checking CI now.

Part of https://github.com/flutter/flutter/issues/178827
- Adoption of flutter_lints in examples/api coming in a separate change
(cc @loic-sharma)

## 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].
- [ ] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [ ] All existing and new tests are passing.

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

**Note**: The Flutter team is currently trialing the use of [Gemini Code
Assist for
GitHub](https://developers.google.com/gemini-code-assist/docs/review-github-code).
Comments from the `gemini-code-assist` bot should not be taken as
authoritative feedback from the Flutter team. If you find its comments
useful you can update your code accordingly, but if you are unsure or
disagree with the feedback, please feel free to wait for a Flutter team
member's review for guidance on which automated comments should be
addressed.

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
2025-11-26 01:10:39 +00:00

237 lines
9.2 KiB
Dart

// Copyright 2014 The Flutter Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'dart:async';
import 'package:flutter/widgets.dart';
import 'package:flutter_test/flutter_test.dart';
Widget _buildScroller({required List<String> log}) {
return NotificationListener<ScrollNotification>(
onNotification: (ScrollNotification notification) {
if (notification is ScrollStartNotification) {
log.add('scroll-start');
} else if (notification is ScrollUpdateNotification) {
log.add('scroll-update');
} else if (notification is ScrollEndNotification) {
log.add('scroll-end');
}
return false;
},
child: const SingleChildScrollView(child: SizedBox(width: 1000.0, height: 1000.0)),
);
}
void main() {
Completer<void> animateTo(
WidgetTester tester,
double newScrollOffset, {
required Duration duration,
}) {
final completer = Completer<void>();
final ScrollableState scrollable = tester.state(find.byType(Scrollable));
scrollable.position
.animateTo(newScrollOffset, duration: duration, curve: Curves.linear)
.whenComplete(completer.complete);
return completer;
}
void jumpTo(WidgetTester tester, double newScrollOffset) {
final ScrollableState scrollable = tester.state(find.byType(Scrollable));
scrollable.position.jumpTo(newScrollOffset);
}
testWidgets('Scroll event drag', (WidgetTester tester) async {
final log = <String>[];
await tester.pumpWidget(_buildScroller(log: log));
expect(log, equals(<String>[]));
final TestGesture gesture = await tester.startGesture(const Offset(100.0, 100.0));
expect(log, equals(<String>['scroll-start']));
await tester.pump(const Duration(seconds: 1));
expect(log, equals(<String>['scroll-start']));
await gesture.moveBy(const Offset(-10.0, -10.0));
expect(log, equals(<String>['scroll-start', 'scroll-update']));
await tester.pump(const Duration(seconds: 1));
expect(log, equals(<String>['scroll-start', 'scroll-update']));
await gesture.up();
expect(log, equals(<String>['scroll-start', 'scroll-update', 'scroll-end']));
await tester.pump(const Duration(seconds: 1));
expect(log, equals(<String>['scroll-start', 'scroll-update', 'scroll-end']));
});
testWidgets('Scroll animateTo', (WidgetTester tester) async {
final log = <String>[];
await tester.pumpWidget(_buildScroller(log: log));
expect(log, equals(<String>[]));
final Completer<void> completer = animateTo(
tester,
100.0,
duration: const Duration(seconds: 1),
);
expect(completer.isCompleted, isFalse);
expect(log, equals(<String>['scroll-start']));
await tester.pump(const Duration(milliseconds: 100));
expect(log, equals(<String>['scroll-start']));
await tester.pump(const Duration(milliseconds: 100));
expect(log, equals(<String>['scroll-start', 'scroll-update']));
await tester.pump(const Duration(milliseconds: 1500));
expect(log, equals(<String>['scroll-start', 'scroll-update', 'scroll-update', 'scroll-end']));
expect(completer.isCompleted, isTrue);
});
testWidgets('Scroll jumpTo', (WidgetTester tester) async {
final log = <String>[];
await tester.pumpWidget(_buildScroller(log: log));
expect(log, equals(<String>[]));
jumpTo(tester, 100.0);
expect(log, equals(<String>['scroll-start', 'scroll-update', 'scroll-end']));
await tester.pump();
expect(log, equals(<String>['scroll-start', 'scroll-update', 'scroll-end']));
});
testWidgets('Scroll jumpTo during animation', (WidgetTester tester) async {
final log = <String>[];
await tester.pumpWidget(_buildScroller(log: log));
expect(log, equals(<String>[]));
final Completer<void> completer = animateTo(
tester,
100.0,
duration: const Duration(seconds: 1),
);
expect(completer.isCompleted, isFalse);
expect(log, equals(<String>['scroll-start']));
await tester.pump(const Duration(milliseconds: 100));
expect(log, equals(<String>['scroll-start']));
await tester.pump(const Duration(milliseconds: 100));
expect(log, equals(<String>['scroll-start', 'scroll-update']));
expect(completer.isCompleted, isFalse);
jumpTo(tester, 100.0);
expect(completer.isCompleted, isFalse);
expect(
log,
equals(<String>[
'scroll-start',
'scroll-update',
'scroll-end',
'scroll-start',
'scroll-update',
'scroll-end',
]),
);
await tester.pump(const Duration(milliseconds: 100));
expect(
log,
equals(<String>[
'scroll-start',
'scroll-update',
'scroll-end',
'scroll-start',
'scroll-update',
'scroll-end',
]),
);
expect(completer.isCompleted, isTrue);
await tester.pump(const Duration(milliseconds: 1500));
expect(
log,
equals(<String>[
'scroll-start',
'scroll-update',
'scroll-end',
'scroll-start',
'scroll-update',
'scroll-end',
]),
);
expect(completer.isCompleted, isTrue);
});
testWidgets('Scroll scrollTo during animation', (WidgetTester tester) async {
final log = <String>[];
await tester.pumpWidget(_buildScroller(log: log));
expect(log, equals(<String>[]));
Completer<void> completer = animateTo(tester, 100.0, duration: const Duration(seconds: 1));
expect(completer.isCompleted, isFalse);
expect(log, equals(<String>['scroll-start']));
await tester.pump(const Duration(milliseconds: 100));
expect(log, equals(<String>['scroll-start']));
await tester.pump(const Duration(milliseconds: 100));
expect(log, equals(<String>['scroll-start', 'scroll-update']));
expect(completer.isCompleted, isFalse);
completer = animateTo(tester, 100.0, duration: const Duration(seconds: 1));
expect(completer.isCompleted, isFalse);
expect(log, equals(<String>['scroll-start', 'scroll-update']));
await tester.pump(const Duration(milliseconds: 100));
expect(log, equals(<String>['scroll-start', 'scroll-update']));
await tester.pump(const Duration(milliseconds: 1500));
expect(log, equals(<String>['scroll-start', 'scroll-update', 'scroll-update', 'scroll-end']));
expect(completer.isCompleted, isTrue);
});
testWidgets('fling, fling generates two start/end pairs', (WidgetTester tester) async {
final log = <String>[];
await tester.pumpWidget(_buildScroller(log: log));
// The ideal behavior here would be a single start/end pair, but for
// simplicity of implementation we compromise here and accept two. Should
// you find a way to make this work with just one without complicating the
// API, feel free to change the expectation here.
expect(log, equals(<String>[]));
await tester.flingFrom(const Offset(100.0, 100.0), const Offset(-50.0, -50.0), 500.0);
await tester.pump(const Duration(seconds: 1));
log.removeWhere((String value) => value == 'scroll-update');
expect(log, equals(<String>['scroll-start']));
await tester.flingFrom(const Offset(100.0, 100.0), const Offset(-50.0, -50.0), 500.0);
log.removeWhere((String value) => value == 'scroll-update');
expect(log, equals(<String>['scroll-start', 'scroll-end', 'scroll-start']));
await tester.pump(const Duration(seconds: 1));
await tester.pump(const Duration(seconds: 1));
log.removeWhere((String value) => value == 'scroll-update');
expect(log, equals(<String>['scroll-start', 'scroll-end', 'scroll-start', 'scroll-end']));
});
testWidgets('fling, pause, fling generates two start/end pairs', (WidgetTester tester) async {
final log = <String>[];
await tester.pumpWidget(_buildScroller(log: log));
expect(log, equals(<String>[]));
await tester.flingFrom(const Offset(100.0, 100.0), const Offset(-50.0, -50.0), 500.0);
await tester.pump(const Duration(seconds: 1));
log.removeWhere((String value) => value == 'scroll-update');
expect(log, equals(<String>['scroll-start']));
await tester.pump(const Duration(minutes: 1));
await tester.flingFrom(const Offset(100.0, 100.0), const Offset(-50.0, -50.0), 500.0);
log.removeWhere((String value) => value == 'scroll-update');
expect(log, equals(<String>['scroll-start', 'scroll-end', 'scroll-start']));
await tester.pump(const Duration(seconds: 1));
await tester.pump(const Duration(seconds: 1));
log.removeWhere((String value) => value == 'scroll-update');
expect(log, equals(<String>['scroll-start', 'scroll-end', 'scroll-start', 'scroll-end']));
});
testWidgets('fling up ends', (WidgetTester tester) async {
final log = <String>[];
await tester.pumpWidget(_buildScroller(log: log));
expect(log, equals(<String>[]));
await tester.flingFrom(const Offset(100.0, 100.0), const Offset(50.0, 50.0), 500.0);
await tester.pump(const Duration(seconds: 1));
await tester.pump(const Duration(seconds: 1));
await tester.pump(const Duration(seconds: 1));
expect(log.first, equals('scroll-start'));
expect(log.last, equals('scroll-end'));
log.removeWhere((String value) => value == 'scroll-update');
expect(log.length, equals(2));
expect(tester.state<ScrollableState>(find.byType(Scrollable)).position.pixels, equals(0.0));
});
}