Revert "Reland 2: Make LiveTestWidgetsFlutterBinding work with setSurfaceSize and live tests (#86912)" (#87233)
This reverts commit b50991d6833e6551bef6e06c48ff959b9d1c5d07.
diff --git a/packages/flutter/test/animation/live_binding_test.dart b/packages/flutter/test/animation/live_binding_test.dart
index 4a44833..6397527 100644
--- a/packages/flutter/test/animation/live_binding_test.dart
+++ b/packages/flutter/test/animation/live_binding_test.dart
@@ -11,12 +11,11 @@
* because [matchesGoldenFile] does not use Skia Gold in its native package.
*/
- LiveTestWidgetsFlutterBinding().framePolicy = LiveTestWidgetsFlutterBindingFramePolicy.onlyPumps;
+ LiveTestWidgetsFlutterBinding();
testWidgets('Should show event indicator for pointer events', (WidgetTester tester) async {
final AnimationSheetBuilder animationSheet = AnimationSheetBuilder(frameSize: const Size(200, 200), allLayers: true);
- int taps = 0;
- Widget target({bool recording = true}) => Container(
+ final Widget target = Container(
padding: const EdgeInsets.fromLTRB(20, 10, 25, 20),
child: animationSheet.record(
MaterialApp(
@@ -26,103 +25,37 @@
border: Border.all(color: const Color.fromARGB(255, 0, 0, 0)),
),
child: Center(
- child: Container(
- width: 40,
- height: 40,
- color: Colors.black,
- child: GestureDetector(
- onTapDown: (_) {
- taps += 1;
- },
- ),
+ child: GestureDetector(
+ onTap: () {},
+ child: const Text('Test'),
),
),
),
),
- recording: recording,
),
);
- await tester.pumpWidget(target(recording: false));
+ await tester.pumpWidget(target);
- await tester.pumpFrames(target(), const Duration(milliseconds: 50));
+ await tester.pumpFrames(target, const Duration(milliseconds: 50));
- final TestGesture gesture1 = await tester.createGesture(pointer: 1);
- await gesture1.down(tester.getCenter(find.byType(GestureDetector)) + const Offset(10, 10));
- expect(taps, 1);
+ final TestGesture gesture1 = await tester.createGesture();
+ await gesture1.down(tester.getCenter(find.byType(Text)) + const Offset(10, 10));
- await tester.pumpFrames(target(), const Duration(milliseconds: 100));
+ await tester.pumpFrames(target, const Duration(milliseconds: 100));
- final TestGesture gesture2 = await tester.createGesture(pointer: 2);
- await gesture2.down(tester.getTopLeft(find.byType(GestureDetector)) + const Offset(30, -10));
+ final TestGesture gesture2 = await tester.createGesture();
+ await gesture2.down(tester.getTopLeft(find.byType(Text)) + const Offset(30, -10));
await gesture1.moveBy(const Offset(50, 50));
- await tester.pumpFrames(target(), const Duration(milliseconds: 100));
+ await tester.pumpFrames(target, const Duration(milliseconds: 100));
await gesture1.up();
await gesture2.up();
- await tester.pumpFrames(target(), const Duration(milliseconds: 50));
- expect(taps, 1);
+ await tester.pumpFrames(target, const Duration(milliseconds: 50));
await expectLater(
animationSheet.collate(6),
matchesGoldenFile('LiveBinding.press.animation.png'),
);
- }, skip: isBrowser); // https://github.com/flutter/flutter/issues/42767
-
- testWidgets('Should show event indicator for pointer events with setSurfaceSize', (WidgetTester tester) async {
- int taps = 0;
- final AnimationSheetBuilder animationSheet = AnimationSheetBuilder(frameSize: const Size(200, 200), allLayers: true);
- Widget target({bool recording = true}) => Container(
- padding: const EdgeInsets.fromLTRB(20, 10, 25, 20),
- child: animationSheet.record(
- MaterialApp(
- home: Container(
- decoration: BoxDecoration(
- color: const Color.fromARGB(255, 128, 128, 128),
- border: Border.all(color: const Color.fromARGB(255, 0, 0, 0)),
- ),
- child: Center(
- child: Container(
- width: 40,
- height: 40,
- color: Colors.black,
- child: GestureDetector(
- onTapDown: (_) {
- taps += 1;
- },
- ),
- ),
- ),
- ),
- ),
- recording: recording,
- ),
- );
-
- await tester.binding.setSurfaceSize(const Size(300, 300));
- await tester.pumpWidget(target(recording: false));
-
- await tester.pumpFrames(target(), const Duration(milliseconds: 50));
-
- final TestGesture gesture1 = await tester.createGesture(pointer: 1);
- await gesture1.down(tester.getCenter(find.byType(GestureDetector)) + const Offset(10, 10));
- expect(taps, 1);
-
- await tester.pumpFrames(target(), const Duration(milliseconds: 100));
-
- final TestGesture gesture2 = await tester.createGesture(pointer: 2);
- await gesture2.down(tester.getTopLeft(find.byType(GestureDetector)) + const Offset(30, -10));
- await gesture1.moveBy(const Offset(50, 50));
-
- await tester.pumpFrames(target(), const Duration(milliseconds: 100));
- await gesture1.up();
- await gesture2.up();
- await tester.pumpFrames(target(), const Duration(milliseconds: 50));
- expect(taps, 1);
-
- await expectLater(
- animationSheet.collate(6),
- matchesGoldenFile('LiveBinding.press.animation.2.png'),
- );
}, skip: isBrowser); // https://github.com/flutter/flutter/issues/56001
}
diff --git a/packages/flutter_test/lib/src/animation_sheet.dart b/packages/flutter_test/lib/src/animation_sheet.dart
index b7417d5..d7c5810 100644
--- a/packages/flutter_test/lib/src/animation_sheet.dart
+++ b/packages/flutter_test/lib/src/animation_sheet.dart
@@ -134,11 +134,11 @@
/// The returned widget wraps `child` in a box with a fixed size specified by
/// [frameSize]. The `key` is also applied to the returned widget.
///
- /// The frame is only recorded if the `recording` argument is true, or during
- /// a procedure that is wrapped within [recording]. In either case, the
- /// painted result of each frame will be stored and later available for
- /// [display]. If neither condition is met, the frames are not recorded, which
- /// is useful during setup phases.
+ /// The `recording` defaults to true, which means the painted result of each
+ /// frame will be stored and later available for [display]. If `recording` is
+ /// false, then frames are not recorded. This is useful during the setup phase
+ /// that shouldn't be recorded; if the target widget isn't wrapped in [record]
+ /// during the setup phase, the states will be lost when it starts recording.
///
/// The `child` must not be null.
///
@@ -274,10 +274,7 @@
///
/// An example of using this method can be found at [AnimationSheetBuilder].
Future<ui.Image> collate(int cellsPerRow) async {
- final List<ui.Image> frames = await _frames;
- assert(frames.isNotEmpty,
- 'No frames are collected. Have you forgot to set `recording` to true?');
- return _collateFrames(frames, frameSize, cellsPerRow);
+ return _collateFrames(await _frames, frameSize, cellsPerRow);
}
/// Returns the smallest size that can contain all recorded frames.
diff --git a/packages/flutter_test/lib/src/binding.dart b/packages/flutter_test/lib/src/binding.dart
index 8f2c4856..8c34a61 100644
--- a/packages/flutter_test/lib/src/binding.dart
+++ b/packages/flutter_test/lib/src/binding.dart
@@ -119,20 +119,6 @@
/// that actually needs to make a network call should provide its own
/// `HttpClient` to the code making the call, so that it can appropriately mock
/// or fake responses.
-///
-/// ### Coordinate spaces
-///
-/// [TestWidgetsFlutterBinding] might be run on devices of different screen
-/// sizes, while the testing widget is still told the same size to ensure
-/// consistent results. Consequently, code that deals with positions (such as
-/// pointer events or painting) must distinguish between two coordinate spaces:
-///
-/// * The _local coordinate space_ is the one used by the testing widget
-/// (typically an 800 by 600 window, but can be altered by [setSurfaceSize]).
-/// * The _global coordinate space_ is the one used by the device.
-///
-/// Positions can be transformed between coordinate spaces with [localToGlobal]
-/// and [globalToLocal].
abstract class TestWidgetsFlutterBinding extends BindingBase
with SchedulerBinding,
ServicesBinding,
@@ -461,16 +447,14 @@
});
}
- /// Convert the given point from the global coordinate space to the local
- /// one.
- ///
- /// For definitions for coordinate spaces, see [TestWidgetsFlutterBinding].
+ /// Convert the given point from the global coordinate system (as used by
+ /// pointer events from the device) to the coordinate system used by the
+ /// tests (an 800 by 600 window).
Offset globalToLocal(Offset point) => point;
- /// Convert the given point from the local coordinate space to the global
- /// one.
- ///
- /// For definitions for coordinate spaces, see [TestWidgetsFlutterBinding].
+ /// Convert the given point from the coordinate system used by the tests (an
+ /// 800 by 600 window) to the global coordinate system (as used by pointer
+ /// events from the device).
Offset localToGlobal(Offset point) => point;
/// The source of the current pointer event.
@@ -478,34 +462,15 @@
/// The [pointerEventSource] is set as the `source` parameter of
/// [handlePointerEventForSource] and can be used in the immediate enclosing
/// [dispatchEvent].
- ///
- /// When [handlePointerEvent] is called directly, [pointerEventSource]
- /// is [TestBindingEventSource.device].
TestBindingEventSource get pointerEventSource => _pointerEventSource;
TestBindingEventSource _pointerEventSource = TestBindingEventSource.device;
/// Dispatch an event to the targets found by a hit test on its position,
/// and remember its source as [pointerEventSource].
///
- /// This method sets [pointerEventSource] to `source`, forwards the call to
+ /// This method sets [pointerEventSource] to `source`, runs
/// [handlePointerEvent], then resets [pointerEventSource] to the previous
/// value.
- ///
- /// If `source` is [TestBindingEventSource.device], then the `event` is based
- /// in the global coordinate space (for definitions for coordinate spaces,
- /// see [TestWidgetsFlutterBinding]) and the event is likely triggered by the
- /// user physically interacting with the screen during a live test on a real
- /// device (see [LiveTestWidgetsFlutterBinding]).
- ///
- /// If `source` is [TestBindingEventSource.test], then the `event` is based
- /// in the local coordinate space and the event is likely triggered by
- /// programatically simulated pointer events, such as:
- ///
- /// * [WidgetController.tap] and alike methods, as well as directly using
- /// [TestGesture]. They are usually used in
- /// [AutomatedTestWidgetsFlutterBinding] but sometimes in live tests too.
- /// * [WidgetController.timedDrag] and alike methods. They are usually used
- /// in macrobenchmarks.
void handlePointerEventForSource(
PointerEvent event, {
TestBindingEventSource source = TestBindingEventSource.device,
@@ -517,7 +482,7 @@
/// to the previous value.
@protected
void withPointerEventSource(TestBindingEventSource source, VoidCallback task) {
- final TestBindingEventSource previousSource = _pointerEventSource;
+ final TestBindingEventSource previousSource = source;
_pointerEventSource = source;
try {
task();
@@ -1532,15 +1497,11 @@
/// Events dispatched by [TestGesture] are not affected by this.
HitTestDispatcher? deviceEventDispatcher;
+
/// Dispatch an event to the targets found by a hit test on its position.
///
- /// If the [pointerEventSource] is [TestBindingEventSource.test], then
- /// the event is forwarded to [GestureBinding.dispatchEvent] as usual;
- /// additionally, down pointers are painted on the screen.
- ///
- /// If the [pointerEventSource] is [TestBindingEventSource.device], then
- /// the event, after being transformed to the local coordinate system, is
- /// forwarded to [deviceEventDispatcher].
+ /// Apart from forwarding the event to [GestureBinding.dispatchEvent],
+ /// This also paint all events that's down on the screen.
@override
void handlePointerEvent(PointerEvent event) {
switch (pointerEventSource) {
@@ -1562,12 +1523,8 @@
break;
case TestBindingEventSource.device:
if (deviceEventDispatcher != null) {
- // The pointer events received with this source has a global position
- // (see [handlePointerEventForSource]). Transform it to the local
- // coordinate space used by the testing widgets.
- final PointerEvent localEvent = event.copyWith(position: globalToLocal(event.position));
withPointerEventSource(TestBindingEventSource.device,
- () => super.handlePointerEvent(localEvent)
+ () => super.handlePointerEvent(event)
);
}
break;
@@ -1581,10 +1538,9 @@
super.dispatchEvent(event, hitTestResult);
break;
case TestBindingEventSource.device:
- assert(hitTestResult != null || event is PointerAddedEvent || event is PointerRemovedEvent);
+ assert(hitTestResult != null);
assert(deviceEventDispatcher != null);
- if (hitTestResult != null)
- deviceEventDispatcher!.dispatchEvent(event, hitTestResult);
+ deviceEventDispatcher!.dispatchEvent(event, hitTestResult!);
break;
}
}
@@ -1820,6 +1776,15 @@
}
@override
+ bool hitTest(HitTestResult result, { required Offset position }) {
+ final Matrix4 transform = configuration.toHitTestMatrix();
+ final double det = transform.invert();
+ assert(det != 0.0);
+ position = MatrixUtils.transformPoint(transform, position);
+ return super.hitTest(result, position: position);
+ }
+
+ @override
void paint(PaintingContext context, Offset offset) {
assert(offset == Offset.zero);
super.paint(context, offset);
diff --git a/packages/flutter_test/lib/src/widget_tester.dart b/packages/flutter_test/lib/src/widget_tester.dart
index 63b50f9..9651fda 100644
--- a/packages/flutter_test/lib/src/widget_tester.dart
+++ b/packages/flutter_test/lib/src/widget_tester.dart
@@ -59,21 +59,6 @@
/// Signature for callback to [testWidgets] and [benchmarkWidgets].
typedef WidgetTesterCallback = Future<void> Function(WidgetTester widgetTester);
-// Return the last element that satisifes `test`, or return null if not found.
-E? _lastWhereOrNull<E>(Iterable<E> list, bool Function(E) test) {
- late E result;
- bool foundMatching = false;
- for (final E element in list) {
- if (test(element)) {
- result = element;
- foundMatching = true;
- }
- }
- if (foundMatching)
- return result;
- return null;
-}
-
/// Runs the [callback] inside the Flutter test environment.
///
/// Use this function for testing custom [StatelessWidget]s and
@@ -844,12 +829,15 @@
.map((HitTestEntry candidate) => candidate.target)
.whereType<RenderObject>()
.first;
- final Element? innerTargetElement = _lastWhereOrNull(
- collectAllElementsFrom(binding.renderViewElement!, skipOffstage: true),
- (Element element) => element.renderObject == innerTarget,
+ final Element? innerTargetElement = collectAllElementsFrom(
+ binding.renderViewElement!,
+ skipOffstage: true,
+ ).cast<Element?>().lastWhere(
+ (Element? element) => element!.renderObject == innerTarget,
+ orElse: () => null,
);
if (innerTargetElement == null) {
- printToConsole('No widgets found at ${event.position}.');
+ printToConsole('No widgets found at ${binding.globalToLocal(event.position)}.');
return;
}
final List<Element> candidates = <Element>[];
@@ -862,7 +850,7 @@
int numberOfWithTexts = 0;
int numberOfTypes = 0;
int totalNumber = 0;
- printToConsole('Some possible finders for the widgets at ${event.position}:');
+ printToConsole('Some possible finders for the widgets at ${binding.globalToLocal(event.position)}:');
for (final Element element in candidates) {
if (totalNumber > 13) // an arbitrary number of finders that feels useful without being overwhelming
break;
diff --git a/packages/flutter_test/test/widget_tester_live_device_test.dart b/packages/flutter_test/test/widget_tester_live_device_test.dart
index 34db4e3..be60b62 100644
--- a/packages/flutter_test/test/widget_tester_live_device_test.dart
+++ b/packages/flutter_test/test/widget_tester_live_device_test.dart
@@ -6,13 +6,6 @@
import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';
-// Only check the initial lines of the message, since the message walks the
-// entire widget tree back, and any changes to the widget tree break these
-// tests if we check the entire message.
-void _expectStartsWith(List<String?> actual, List<String?> matcher) {
- expect(actual.sublist(0, matcher.length), equals(matcher));
-}
-
void main() {
final _MockLiveTestWidgetsFlutterBinding binding = _MockLiveTestWidgetsFlutterBinding();
@@ -21,9 +14,8 @@
int invocations = 0;
await tester.pumpWidget(
- Directionality(
- textDirection: TextDirection.ltr,
- child: Center(
+ MaterialApp(
+ home: Center(
child: GestureDetector(
onTap: () {
invocations++;
@@ -50,87 +42,39 @@
await tester.pump();
expect(invocations, 0);
- _expectStartsWith(printedMessages, '''
+ expect(printedMessages, equals('''
Some possible finders for the widgets at Offset(400.0, 300.0):
find.text('Test')
-'''.trim().split('\n'));
+ find.widgetWithText(RawGestureDetector, 'Test')
+ find.byType(GestureDetector)
+ find.byType(Center)
+ find.widgetWithText(IgnorePointer, 'Test')
+ find.byType(FadeTransition)
+ find.byType(FractionalTranslation)
+ find.byType(SlideTransition)
+ find.widgetWithText(FocusTrap, 'Test')
+ find.widgetWithText(PrimaryScrollController, 'Test')
+ find.widgetWithText(PageStorage, 'Test')
+'''.trim().split('\n')));
printedMessages.clear();
await binding.collectDebugPrints(printedMessages, () async {
await tester.tapAt(const Offset(1, 1));
});
expect(printedMessages, equals('''
-No widgets found at Offset(1.0, 1.0).
+Some possible finders for the widgets at Offset(1.0, 1.0):
+ find.byType(MouseRegion)
+ find.byType(ExcludeSemantics)
+ find.byType(BlockSemantics)
+ find.byType(ModalBarrier)
+ find.byType(Overlay)
'''.trim().split('\n')));
});
-
- testWidgets('Should print message on pointer events with setSurfaceSize', (WidgetTester tester) async {
- final List<String?> printedMessages = <String?>[];
-
- int invocations = 0;
- await tester.pumpWidget(
- Directionality(
- textDirection: TextDirection.ltr,
- child: Center(
- child:GestureDetector(
- onTap: () {
- invocations++;
- },
- child: const Text('Test'),
- ),
- ),
- ),
- );
-
- final Size originalSize = tester.binding.createViewConfiguration().size;
- await tester.binding.setSurfaceSize(const Size(2000, 1800));
- try {
- await tester.pump();
-
- final Offset widgetCenter = tester.getRect(find.byType(Text)).center;
- expect(widgetCenter.dx, 1000);
- expect(widgetCenter.dy, 900);
-
- await binding.collectDebugPrints(printedMessages, () async {
- await tester.tap(find.byType(Text));
- });
- await tester.pump();
- expect(invocations, 0);
-
- _expectStartsWith(printedMessages, '''
-Some possible finders for the widgets at Offset(1000.0, 900.0):
- find.text('Test')
-'''.trim().split('\n'));
- printedMessages.clear();
-
- await binding.collectDebugPrints(printedMessages, () async {
- await tester.tapAt(const Offset(1, 1));
- });
- expect(printedMessages, equals('''
-No widgets found at Offset(1.0, 1.0).
-'''.trim().split('\n')));
- } finally {
- await tester.binding.setSurfaceSize(originalSize);
- }
- });
}
class _MockLiveTestWidgetsFlutterBinding extends LiveTestWidgetsFlutterBinding {
@override
- void handlePointerEventForSource(
- PointerEvent event, {
- TestBindingEventSource source = TestBindingEventSource.device,
- }) {
- // In this test we use `WidgetTester.tap` to simulate real device touches.
- // `WidgetTester.tap` sends events in the local coordinate system, while
- // real devices touches sends event in the global coordinate system.
- // See the documentation of [handlePointerEventForSource] for details.
- if (source == TestBindingEventSource.test) {
- final PointerEvent globalEvent = event.copyWith(position: localToGlobal(event.position));
- return super.handlePointerEventForSource(globalEvent, source: TestBindingEventSource.device);
- }
- return super.handlePointerEventForSource(event, source: source);
- }
+ TestBindingEventSource get pointerEventSource => TestBindingEventSource.device;
List<String?>? _storeDebugPrints;
