dismissible_test.dart 33.7 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
Hixie's avatar
Hixie committed
2 3 4
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

5
import 'package:flutter/gestures.dart' show DragStartBehavior;
6
import 'package:flutter/widgets.dart';
Ian Hickson's avatar
Ian Hickson committed
7
import 'package:flutter_test/flutter_test.dart';
8

9
const double itemExtent = 100.0;
10
Axis scrollDirection = Axis.vertical;
11
DismissDirection dismissDirection = DismissDirection.horizontal;
12
late DismissDirection reportedDismissDirection;
13
List<int> dismissedItems = <int>[];
14
Widget? background;
15
const double crossAxisEndOffset = 0.5;
16

17
Widget buildTest({
18
  double? startToEndThreshold,
19
  TextDirection textDirection = TextDirection.ltr,
20
  Future<bool?> Function(BuildContext context, DismissDirection direction)? confirmDismiss,
21
}) {
22
  return Directionality(
Ian Hickson's avatar
Ian Hickson committed
23
    textDirection: textDirection,
24
    child: StatefulBuilder(
Ian Hickson's avatar
Ian Hickson committed
25 26
      builder: (BuildContext context, StateSetter setState) {
        Widget buildDismissibleItem(int item) {
27
          return Dismissible(
28
            dragStartBehavior: DragStartBehavior.down,
29
            key: ValueKey<int>(item),
Ian Hickson's avatar
Ian Hickson committed
30
            direction: dismissDirection,
31 32 33
            confirmDismiss: confirmDismiss == null ? null : (DismissDirection direction) {
              return confirmDismiss(context, direction);
            },
Ian Hickson's avatar
Ian Hickson committed
34 35 36 37 38 39 40 41
            onDismissed: (DismissDirection direction) {
              setState(() {
                reportedDismissDirection = direction;
                expect(dismissedItems.contains(item), isFalse);
                dismissedItems.add(item);
              });
            },
            onResize: () {
42
              expect(dismissedItems.contains(item), isFalse);
Ian Hickson's avatar
Ian Hickson committed
43 44 45 46 47
            },
            background: background,
            dismissThresholds: startToEndThreshold == null
                ? <DismissDirection, double>{}
                : <DismissDirection, double>{DismissDirection.startToEnd: startToEndThreshold},
48
            crossAxisEndOffset: crossAxisEndOffset,
49
            child: Container(
Ian Hickson's avatar
Ian Hickson committed
50 51
              width: itemExtent,
              height: itemExtent,
52
              child: Text(item.toString()),
Ian Hickson's avatar
Ian Hickson committed
53 54 55 56
            ),
          );
        }

57
        return Container(
Ian Hickson's avatar
Ian Hickson committed
58
          padding: const EdgeInsets.all(10.0),
59
          child: ListView(
60
            dragStartBehavior: DragStartBehavior.down,
Ian Hickson's avatar
Ian Hickson committed
61 62 63 64
            scrollDirection: scrollDirection,
            itemExtent: itemExtent,
            children: <int>[0, 1, 2, 3, 4]
              .where((int i) => !dismissedItems.contains(i))
65
              .map<Widget>(buildDismissibleItem).toList(),
66 67
          ),
        );
Ian Hickson's avatar
Ian Hickson committed
68 69
      },
    ),
70 71 72
  );
}

73
typedef DismissMethod = Future<void> Function(WidgetTester tester, Finder finder, { required AxisDirection gestureDirection });
74

75
Future<void> dismissElement(WidgetTester tester, Finder finder, { required AxisDirection gestureDirection }) async {
76 77
  Offset downLocation;
  Offset upLocation;
78
  switch (gestureDirection) {
Ian Hickson's avatar
Ian Hickson committed
79
    case AxisDirection.left:
80
      // getTopRight() returns a point that's just beyond itemWidget's right
81
      // edge and outside the Dismissible event listener's bounds.
82 83
      downLocation = tester.getTopRight(finder) + const Offset(-0.1, 0.0);
      upLocation = tester.getTopLeft(finder);
84
      break;
Ian Hickson's avatar
Ian Hickson committed
85
    case AxisDirection.right:
86
      // we do the same thing here to keep the test symmetric
87 88
      downLocation = tester.getTopLeft(finder) + const Offset(0.1, 0.0);
      upLocation = tester.getTopRight(finder);
89
      break;
Ian Hickson's avatar
Ian Hickson committed
90
    case AxisDirection.up:
91
      // getBottomLeft() returns a point that's just below itemWidget's bottom
92
      // edge and outside the Dismissible event listener's bounds.
93 94
      downLocation = tester.getBottomLeft(finder) + const Offset(0.0, -0.1);
      upLocation = tester.getTopLeft(finder);
95
      break;
Ian Hickson's avatar
Ian Hickson committed
96
    case AxisDirection.down:
97
      // again with doing the same here for symmetry
98 99
      downLocation = tester.getTopLeft(finder) + const Offset(0.1, 0.0);
      upLocation = tester.getBottomLeft(finder);
100 101 102
      break;
  }

Ian Hickson's avatar
Ian Hickson committed
103
  final TestGesture gesture = await tester.startGesture(downLocation);
104 105
  await gesture.moveTo(upLocation);
  await gesture.up();
Hixie's avatar
Hixie committed
106 107
}

108
Future<void> flingElement(WidgetTester tester, Finder finder, { required AxisDirection gestureDirection, double initialOffsetFactor = 0.0 }) async {
Ian Hickson's avatar
Ian Hickson committed
109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125
  Offset delta;
  switch (gestureDirection) {
    case AxisDirection.left:
      delta = const Offset(-300.0, 0.0);
      break;
    case AxisDirection.right:
      delta = const Offset(300.0, 0.0);
      break;
    case AxisDirection.up:
      delta = const Offset(0.0, -300.0);
      break;
    case AxisDirection.down:
      delta = const Offset(0.0, 300.0);
      break;
  }
  await tester.fling(finder, delta, 1000.0, initialOffset: delta * initialOffsetFactor);
}
Hixie's avatar
Hixie committed
126

127
Future<void> flingElementFromZero(WidgetTester tester, Finder finder, { required AxisDirection gestureDirection }) async {
Ian Hickson's avatar
Ian Hickson committed
128 129
  // This is a special case where we drag in one direction, then fling back so
  // that at the point of release, we're at exactly the point at which we
Josh Soref's avatar
Josh Soref committed
130
  // started, but with velocity. This is needed to check a boundary condition
Ian Hickson's avatar
Ian Hickson committed
131 132 133 134
  // in the flinging behavior.
  await flingElement(tester, finder, gestureDirection: gestureDirection, initialOffsetFactor: -1.0);
}

135 136 137
Future<void> dismissItem(
  WidgetTester tester,
  int item, {
138
  required AxisDirection gestureDirection,
139
  DismissMethod mechanism = dismissElement,
Ian Hickson's avatar
Ian Hickson committed
140 141
}) async {
  assert(gestureDirection != null);
142
  final Finder itemFinder = find.text(item.toString());
143
  expect(itemFinder, findsOneWidget);
Hixie's avatar
Hixie committed
144

Ian Hickson's avatar
Ian Hickson committed
145
  await mechanism(tester, itemFinder, gestureDirection: gestureDirection);
146

147 148 149 150 151
  await tester.pump(); // start the slide
  await tester.pump(const Duration(seconds: 1)); // finish the slide and start shrinking...
  await tester.pump(); // first frame of shrinking animation
  await tester.pump(const Duration(seconds: 1)); // finish the shrinking and call the callback...
  await tester.pump(); // rebuild after the callback removes the entry
152 153
}

154 155 156
Future<void> checkFlingItemBeforeMovementEnd(
  WidgetTester tester,
  int item, {
157
  required AxisDirection gestureDirection,
158
  DismissMethod mechanism = rollbackElement,
159 160 161 162 163 164 165 166 167 168 169
}) async {
  assert(gestureDirection != null);
  final Finder itemFinder = find.text(item.toString());
  expect(itemFinder, findsOneWidget);

  await mechanism(tester, itemFinder, gestureDirection: gestureDirection);

  await tester.pump(); // start the slide
  await tester.pump(const Duration(milliseconds: 100));
}

170 171 172
Future<void> checkFlingItemAfterMovement(
  WidgetTester tester,
  int item, {
173
  required AxisDirection gestureDirection,
174
  DismissMethod mechanism = rollbackElement,
175 176 177 178 179 180 181 182 183 184 185
}) async {
  assert(gestureDirection != null);
  final Finder itemFinder = find.text(item.toString());
  expect(itemFinder, findsOneWidget);

  await mechanism(tester, itemFinder, gestureDirection: gestureDirection);

  await tester.pump(); // start the slide
  await tester.pump(const Duration(milliseconds: 300));
}

186
Future<void> rollbackElement(WidgetTester tester, Finder finder, { required AxisDirection gestureDirection, double initialOffsetFactor = 0.0 }) async {
187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
  Offset delta;
  switch (gestureDirection) {
    case AxisDirection.left:
      delta = const Offset(-30.0, 0.0);
      break;
    case AxisDirection.right:
      delta = const Offset(30.0, 0.0);
      break;
    case AxisDirection.up:
      delta = const Offset(0.0, -30.0);
      break;
    case AxisDirection.down:
      delta = const Offset(0.0, 30.0);
      break;
  }
  await tester.fling(finder, delta, 1000.0, initialOffset: delta * initialOffsetFactor);
}

205
class Test1215DismissibleWidget extends StatelessWidget {
206
  const Test1215DismissibleWidget(this.text, { Key? key }) : super(key: key);
207

Hixie's avatar
Hixie committed
208
  final String text;
209 210

  @override
Hixie's avatar
Hixie committed
211
  Widget build(BuildContext context) {
212
    return Dismissible(
213
      dragStartBehavior: DragStartBehavior.down,
214 215
      key: ObjectKey(text),
      child: AspectRatio(
Hixie's avatar
Hixie committed
216
        aspectRatio: 1.0,
217
        child: Text(text),
218
      ),
Hixie's avatar
Hixie committed
219 220 221 222
    );
  }
}

223
void main() {
224 225 226 227 228
  setUp(() {
    dismissedItems = <int>[];
    background = null;
  });

229
  testWidgets('Horizontal drag triggers dismiss scrollDirection=vertical', (WidgetTester tester) async {
230 231
    scrollDirection = Axis.vertical;
    dismissDirection = DismissDirection.horizontal;
232

233
    await tester.pumpWidget(buildTest());
234
    expect(dismissedItems, isEmpty);
235

Ian Hickson's avatar
Ian Hickson committed
236
    await dismissItem(tester, 0, gestureDirection: AxisDirection.right);
237
    expect(find.text('0'), findsNothing);
238
    expect(dismissedItems, equals(<int>[0]));
239
    expect(reportedDismissDirection, DismissDirection.startToEnd);
240

Ian Hickson's avatar
Ian Hickson committed
241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
    await dismissItem(tester, 1, gestureDirection: AxisDirection.left);
    expect(find.text('1'), findsNothing);
    expect(dismissedItems, equals(<int>[0, 1]));
    expect(reportedDismissDirection, DismissDirection.endToStart);
  });

  testWidgets('Horizontal fling triggers dismiss scrollDirection=vertical', (WidgetTester tester) async {
    scrollDirection = Axis.vertical;
    dismissDirection = DismissDirection.horizontal;

    await tester.pumpWidget(buildTest());
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, gestureDirection: AxisDirection.right, mechanism: flingElement);
    expect(find.text('0'), findsNothing);
    expect(dismissedItems, equals(<int>[0]));
    expect(reportedDismissDirection, DismissDirection.startToEnd);

    await dismissItem(tester, 1, gestureDirection: AxisDirection.left, mechanism: flingElement);
    expect(find.text('1'), findsNothing);
    expect(dismissedItems, equals(<int>[0, 1]));
    expect(reportedDismissDirection, DismissDirection.endToStart);
  });

  testWidgets('Horizontal fling does not trigger at zero offset, but does otherwise', (WidgetTester tester) async {
    scrollDirection = Axis.vertical;
    dismissDirection = DismissDirection.horizontal;

    await tester.pumpWidget(buildTest(startToEndThreshold: 0.95));
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, gestureDirection: AxisDirection.right, mechanism: flingElementFromZero);
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, equals(<int>[]));

    await dismissItem(tester, 0, gestureDirection: AxisDirection.left, mechanism: flingElementFromZero);
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, equals(<int>[]));

    await dismissItem(tester, 0, gestureDirection: AxisDirection.right, mechanism: flingElement);
    expect(find.text('0'), findsNothing);
    expect(dismissedItems, equals(<int>[0]));
    expect(reportedDismissDirection, DismissDirection.startToEnd);

    await dismissItem(tester, 1, gestureDirection: AxisDirection.left, mechanism: flingElement);
286
    expect(find.text('1'), findsNothing);
287
    expect(dismissedItems, equals(<int>[0, 1]));
288
    expect(reportedDismissDirection, DismissDirection.endToStart);
289 290
  });

291
  testWidgets('Vertical drag triggers dismiss scrollDirection=horizontal', (WidgetTester tester) async {
292 293
    scrollDirection = Axis.horizontal;
    dismissDirection = DismissDirection.vertical;
294

295
    await tester.pumpWidget(buildTest());
296
    expect(dismissedItems, isEmpty);
297

Ian Hickson's avatar
Ian Hickson committed
298
    await dismissItem(tester, 0, gestureDirection: AxisDirection.up);
299
    expect(find.text('0'), findsNothing);
300
    expect(dismissedItems, equals(<int>[0]));
301
    expect(reportedDismissDirection, DismissDirection.up);
302

Ian Hickson's avatar
Ian Hickson committed
303
    await dismissItem(tester, 1, gestureDirection: AxisDirection.down);
304
    expect(find.text('1'), findsNothing);
305
    expect(dismissedItems, equals(<int>[0, 1]));
306
    expect(reportedDismissDirection, DismissDirection.down);
307 308
  });

Ian Hickson's avatar
Ian Hickson committed
309
  testWidgets('drag-left with DismissDirection.endToStart triggers dismiss (LTR)', (WidgetTester tester) async {
310 311
    scrollDirection = Axis.vertical;
    dismissDirection = DismissDirection.endToStart;
312

313
    await tester.pumpWidget(buildTest());
314
    expect(dismissedItems, isEmpty);
315

Ian Hickson's avatar
Ian Hickson committed
316
    await dismissItem(tester, 0, gestureDirection: AxisDirection.right);
317 318
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);
Ian Hickson's avatar
Ian Hickson committed
319
    await dismissItem(tester, 1, gestureDirection: AxisDirection.right);
320

Ian Hickson's avatar
Ian Hickson committed
321
    await dismissItem(tester, 0, gestureDirection: AxisDirection.left);
322
    expect(find.text('0'), findsNothing);
323
    expect(dismissedItems, equals(<int>[0]));
Ian Hickson's avatar
Ian Hickson committed
324
    await dismissItem(tester, 1, gestureDirection: AxisDirection.left);
325 326
  });

Ian Hickson's avatar
Ian Hickson committed
327
  testWidgets('drag-right with DismissDirection.startToEnd triggers dismiss (LTR)', (WidgetTester tester) async {
328 329
    scrollDirection = Axis.vertical;
    dismissDirection = DismissDirection.startToEnd;
330

331
    await tester.pumpWidget(buildTest());
332
    expect(dismissedItems, isEmpty);
333

Ian Hickson's avatar
Ian Hickson committed
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366
    await dismissItem(tester, 0, gestureDirection: AxisDirection.left);
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, gestureDirection: AxisDirection.right);
    expect(find.text('0'), findsNothing);
    expect(dismissedItems, equals(<int>[0]));
  });

  testWidgets('drag-right with DismissDirection.endToStart triggers dismiss (RTL)', (WidgetTester tester) async {
    scrollDirection = Axis.vertical;
    dismissDirection = DismissDirection.endToStart;

    await tester.pumpWidget(buildTest(textDirection: TextDirection.rtl));
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, gestureDirection: AxisDirection.left);
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, gestureDirection: AxisDirection.right);
    expect(find.text('0'), findsNothing);
    expect(dismissedItems, equals(<int>[0]));
  });

  testWidgets('drag-left with DismissDirection.startToEnd triggers dismiss (RTL)', (WidgetTester tester) async {
    scrollDirection = Axis.vertical;
    dismissDirection = DismissDirection.startToEnd;

    await tester.pumpWidget(buildTest(textDirection: TextDirection.rtl));
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, gestureDirection: AxisDirection.right);
367 368
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);
Ian Hickson's avatar
Ian Hickson committed
369
    await dismissItem(tester, 1, gestureDirection: AxisDirection.right);
370

Ian Hickson's avatar
Ian Hickson committed
371
    await dismissItem(tester, 0, gestureDirection: AxisDirection.left);
372
    expect(find.text('0'), findsNothing);
373
    expect(dismissedItems, equals(<int>[0]));
Ian Hickson's avatar
Ian Hickson committed
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
    await dismissItem(tester, 1, gestureDirection: AxisDirection.left);
  });

  testWidgets('fling-left with DismissDirection.endToStart triggers dismiss (LTR)', (WidgetTester tester) async {
    scrollDirection = Axis.vertical;
    dismissDirection = DismissDirection.endToStart;

    await tester.pumpWidget(buildTest());
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, gestureDirection: AxisDirection.right);
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);
    await dismissItem(tester, 1, gestureDirection: AxisDirection.right);

    await dismissItem(tester, 0, gestureDirection: AxisDirection.left);
    expect(find.text('0'), findsNothing);
    expect(dismissedItems, equals(<int>[0]));
    await dismissItem(tester, 1, gestureDirection: AxisDirection.left);
  });

  testWidgets('fling-right with DismissDirection.startToEnd triggers dismiss (LTR)', (WidgetTester tester) async {
    scrollDirection = Axis.vertical;
    dismissDirection = DismissDirection.startToEnd;

    await tester.pumpWidget(buildTest());
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, mechanism: flingElement, gestureDirection: AxisDirection.left);
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, mechanism: flingElement, gestureDirection: AxisDirection.right);
    expect(find.text('0'), findsNothing);
    expect(dismissedItems, equals(<int>[0]));
  });

  testWidgets('fling-right with DismissDirection.endToStart triggers dismiss (RTL)', (WidgetTester tester) async {
    scrollDirection = Axis.vertical;
    dismissDirection = DismissDirection.endToStart;

    await tester.pumpWidget(buildTest(textDirection: TextDirection.rtl));
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, mechanism: flingElement, gestureDirection: AxisDirection.left);
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, mechanism: flingElement, gestureDirection: AxisDirection.right);
    expect(find.text('0'), findsNothing);
    expect(dismissedItems, equals(<int>[0]));
  });

  testWidgets('fling-left with DismissDirection.startToEnd triggers dismiss (RTL)', (WidgetTester tester) async {
    scrollDirection = Axis.vertical;
    dismissDirection = DismissDirection.startToEnd;

    await tester.pumpWidget(buildTest(textDirection: TextDirection.rtl));
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, mechanism: flingElement, gestureDirection: AxisDirection.right);
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);
    await dismissItem(tester, 1, mechanism: flingElement, gestureDirection: AxisDirection.right);

    await dismissItem(tester, 0, mechanism: flingElement, gestureDirection: AxisDirection.left);
    expect(find.text('0'), findsNothing);
    expect(dismissedItems, equals(<int>[0]));
    await dismissItem(tester, 1, mechanism: flingElement, gestureDirection: AxisDirection.left);
443 444
  });

445
  testWidgets('drag-up with DismissDirection.up triggers dismiss', (WidgetTester tester) async {
446 447
    scrollDirection = Axis.horizontal;
    dismissDirection = DismissDirection.up;
448

449
    await tester.pumpWidget(buildTest());
450
    expect(dismissedItems, isEmpty);
451

Ian Hickson's avatar
Ian Hickson committed
452
    await dismissItem(tester, 0, gestureDirection: AxisDirection.down);
453 454
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);
455

Ian Hickson's avatar
Ian Hickson committed
456
    await dismissItem(tester, 0, gestureDirection: AxisDirection.up);
457
    expect(find.text('0'), findsNothing);
458
    expect(dismissedItems, equals(<int>[0]));
459 460
  });

461
  testWidgets('drag-down with DismissDirection.down triggers dismiss', (WidgetTester tester) async {
462 463
    scrollDirection = Axis.horizontal;
    dismissDirection = DismissDirection.down;
464

465
    await tester.pumpWidget(buildTest());
466
    expect(dismissedItems, isEmpty);
467

Ian Hickson's avatar
Ian Hickson committed
468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500
    await dismissItem(tester, 0, gestureDirection: AxisDirection.up);
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, gestureDirection: AxisDirection.down);
    expect(find.text('0'), findsNothing);
    expect(dismissedItems, equals(<int>[0]));
  });

  testWidgets('fling-up with DismissDirection.up triggers dismiss', (WidgetTester tester) async {
    scrollDirection = Axis.horizontal;
    dismissDirection = DismissDirection.up;

    await tester.pumpWidget(buildTest());
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, mechanism: flingElement, gestureDirection: AxisDirection.down);
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, mechanism: flingElement, gestureDirection: AxisDirection.up);
    expect(find.text('0'), findsNothing);
    expect(dismissedItems, equals(<int>[0]));
  });

  testWidgets('fling-down with DismissDirection.down triggers dismiss', (WidgetTester tester) async {
    scrollDirection = Axis.horizontal;
    dismissDirection = DismissDirection.down;

    await tester.pumpWidget(buildTest());
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, mechanism: flingElement, gestureDirection: AxisDirection.up);
501 502
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);
503

Ian Hickson's avatar
Ian Hickson committed
504
    await dismissItem(tester, 0, mechanism: flingElement, gestureDirection: AxisDirection.down);
505
    expect(find.text('0'), findsNothing);
506
    expect(dismissedItems, equals(<int>[0]));
507
  });
508

509
  testWidgets('drag-left has no effect on dismissible with a high dismiss threshold', (WidgetTester tester) async {
510 511 512 513 514 515
    scrollDirection = Axis.vertical;
    dismissDirection = DismissDirection.horizontal;

    await tester.pumpWidget(buildTest(startToEndThreshold: 1.0));
    expect(dismissedItems, isEmpty);

Ian Hickson's avatar
Ian Hickson committed
516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532
    await dismissItem(tester, 0, gestureDirection: AxisDirection.right);
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, gestureDirection: AxisDirection.left);
    expect(find.text('0'), findsNothing);
    expect(dismissedItems, equals(<int>[0]));
  });

  testWidgets('fling-left has no effect on dismissible with a high dismiss threshold', (WidgetTester tester) async {
    scrollDirection = Axis.vertical;
    dismissDirection = DismissDirection.horizontal;

    await tester.pumpWidget(buildTest(startToEndThreshold: 1.0));
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, mechanism: flingElement, gestureDirection: AxisDirection.right);
533 534 535
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);

Ian Hickson's avatar
Ian Hickson committed
536
    await dismissItem(tester, 0, mechanism: flingElement, gestureDirection: AxisDirection.left);
537 538 539 540
    expect(find.text('0'), findsNothing);
    expect(dismissedItems, equals(<int>[0]));
  });

541 542 543 544 545 546
  // This is a regression test for an fn2 bug where dragging a card caused an
  // assert "'!_disqualifiedFromEverAppearingAgain' is not true". The old URL
  // was https://github.com/domokit/sky_engine/issues/1068 but that issue is 404
  // now since we migrated to the new repo. The bug was fixed by
  // https://github.com/flutter/engine/pull/1134 at the time, and later made
  // irrelevant by fn3, but just in case...
547
  testWidgets('Verify that drag-move events do not assert', (WidgetTester tester) async {
548 549 550
    scrollDirection = Axis.horizontal;
    dismissDirection = DismissDirection.down;

551
    await tester.pumpWidget(buildTest());
552
    final Offset location = tester.getTopLeft(find.text('0'));
553
    const Offset offset = Offset(0.0, 5.0);
554
    final TestGesture gesture = await tester.startGesture(location, pointer: 5);
555
    await gesture.moveBy(offset);
556
    await tester.pumpWidget(buildTest());
557
    await gesture.moveBy(offset);
558
    await tester.pumpWidget(buildTest());
559
    await gesture.moveBy(offset);
560
    await tester.pumpWidget(buildTest());
561
    await gesture.moveBy(offset);
562
    await tester.pumpWidget(buildTest());
563
    await gesture.up();
564
  });
Hixie's avatar
Hixie committed
565

566
  // This one is for a case where dismissing a widget above a previously
567
  // dismissed widget threw an exception, which was documented at the
568 569 570
  // now-obsolete URL https://github.com/flutter/engine/issues/1215 (the URL
  // died in the migration to the new repo). Don't copy this test; it doesn't
  // actually remove the dismissed widget, which is a violation of the
571
  // Dismissible contract. This is not an example of good practice.
572
  testWidgets('dismissing bottom then top (smoketest)', (WidgetTester tester) async {
Ian Hickson's avatar
Ian Hickson committed
573
    await tester.pumpWidget(
574
      Directionality(
Ian Hickson's avatar
Ian Hickson committed
575
        textDirection: TextDirection.ltr,
576 577
        child: Center(
          child: Container(
Ian Hickson's avatar
Ian Hickson committed
578 579
            width: 100.0,
            height: 1000.0,
580
            child: Column(
581
              children: const <Widget>[
582 583
                Test1215DismissibleWidget('1'),
                Test1215DismissibleWidget('2'),
Ian Hickson's avatar
Ian Hickson committed
584 585 586
              ],
            ),
          ),
587 588
        ),
      ),
Ian Hickson's avatar
Ian Hickson committed
589
    );
590 591
    expect(find.text('1'), findsOneWidget);
    expect(find.text('2'), findsOneWidget);
Ian Hickson's avatar
Ian Hickson committed
592
    await dismissElement(tester, find.text('2'), gestureDirection: AxisDirection.right);
593
    await tester.pump(); // start the slide away
594
    await tester.pump(const Duration(seconds: 1)); // finish the slide away
595 596
    expect(find.text('1'), findsOneWidget);
    expect(find.text('2'), findsNothing);
Ian Hickson's avatar
Ian Hickson committed
597
    await dismissElement(tester, find.text('1'), gestureDirection: AxisDirection.right);
598
    await tester.pump(); // start the slide away
599
    await tester.pump(const Duration(seconds: 1)); // finish the slide away (at which point the child is no longer included in the tree)
600 601
    expect(find.text('1'), findsNothing);
    expect(find.text('2'), findsNothing);
Hixie's avatar
Hixie committed
602
  });
603

604
  testWidgets('Dismissible starts from the full size when collapsing', (WidgetTester tester) async {
605 606
    scrollDirection = Axis.vertical;
    dismissDirection = DismissDirection.horizontal;
607
    background = const Text('background');
608

609
    await tester.pumpWidget(buildTest());
610
    expect(dismissedItems, isEmpty);
611

612
    final Finder itemFinder = find.text('0');
613
    expect(itemFinder, findsOneWidget);
Ian Hickson's avatar
Ian Hickson committed
614
    await dismissElement(tester, itemFinder, gestureDirection: AxisDirection.right);
615
    await tester.pump();
616

617
    expect(find.text('background'), findsOneWidget); // The other four have been culled.
618
    final RenderBox backgroundBox = tester.firstRenderObject(find.text('background'));
619
    expect(backgroundBox.size.height, equals(100.0));
620
  });
621 622 623 624 625 626 627 628 629 630 631 632

  testWidgets('Checking fling item before movementDuration completes', (WidgetTester tester) async {
    await tester.pumpWidget(buildTest());
    expect(dismissedItems, isEmpty);

    await checkFlingItemBeforeMovementEnd(tester, 0, gestureDirection: AxisDirection.left, mechanism: flingElement);
    expect(find.text('0'), findsOneWidget);

    await checkFlingItemBeforeMovementEnd(tester, 1, gestureDirection: AxisDirection.right, mechanism: flingElement);
    expect(find.text('1'), findsOneWidget);
  });

633
  testWidgets('Checking fling item after movementDuration', (WidgetTester tester) async {
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
    await tester.pumpWidget(buildTest());
    expect(dismissedItems, isEmpty);

    await checkFlingItemAfterMovement(tester, 1, gestureDirection: AxisDirection.left, mechanism: flingElement);
    expect(find.text('1'), findsNothing);

    await checkFlingItemAfterMovement(tester, 0, gestureDirection: AxisDirection.right, mechanism: flingElement);
    expect(find.text('0'), findsNothing);
  });

  testWidgets('Horizontal fling less than threshold', (WidgetTester tester) async {
    scrollDirection = Axis.horizontal;
    await tester.pumpWidget(buildTest());
    expect(dismissedItems, isEmpty);

    await checkFlingItemAfterMovement(tester, 0, gestureDirection: AxisDirection.left, mechanism: rollbackElement);
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);

    await checkFlingItemAfterMovement(tester, 1, gestureDirection: AxisDirection.right, mechanism: rollbackElement);
    expect(find.text('1'), findsOneWidget);
    expect(dismissedItems, isEmpty);
  });

  testWidgets('Vertical fling less than threshold', (WidgetTester tester) async {
    scrollDirection = Axis.vertical;
    await tester.pumpWidget(buildTest());
    expect(dismissedItems, isEmpty);

    await checkFlingItemAfterMovement(tester, 0, gestureDirection: AxisDirection.left, mechanism: rollbackElement);
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);

    await checkFlingItemAfterMovement(tester, 1, gestureDirection: AxisDirection.right, mechanism: rollbackElement);
    expect(find.text('1'), findsOneWidget);
    expect(dismissedItems, isEmpty);
  });
671 672 673 674

  testWidgets('confirmDismiss returns values: true, false, null', (WidgetTester tester) async {
    scrollDirection = Axis.vertical;
    dismissDirection = DismissDirection.horizontal;
675
    late DismissDirection confirmDismissDirection;
676

677
    Widget buildFrame(bool? confirmDismissValue) {
678 679 680
      return buildTest(
        confirmDismiss: (BuildContext context, DismissDirection dismissDirection) {
          confirmDismissDirection = dismissDirection;
681
          return Future<bool?>.value(confirmDismissValue);
682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729
        }
      );
    }

    // Dismiss is confirmed IFF confirmDismiss() returns true.
    await tester.pumpWidget(buildFrame(true));
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, gestureDirection: AxisDirection.right, mechanism: flingElement);
    expect(find.text('0'), findsNothing);
    expect(dismissedItems, equals(<int>[0]));
    expect(reportedDismissDirection, DismissDirection.startToEnd);
    expect(confirmDismissDirection, DismissDirection.startToEnd);

    await dismissItem(tester, 1, gestureDirection: AxisDirection.left, mechanism: flingElement);
    expect(find.text('1'), findsNothing);
    expect(dismissedItems, equals(<int>[0, 1]));
    expect(reportedDismissDirection, DismissDirection.endToStart);
    expect(confirmDismissDirection, DismissDirection.endToStart);

    // Dismiss is not confirmed if confirmDismiss() returns false
    dismissedItems = <int>[];
    await tester.pumpWidget(buildFrame(false));

    await dismissItem(tester, 0, gestureDirection: AxisDirection.right, mechanism: flingElement);
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);
    expect(confirmDismissDirection, DismissDirection.startToEnd);

    await dismissItem(tester, 1, gestureDirection: AxisDirection.left, mechanism: flingElement);
    expect(find.text('1'), findsOneWidget);
    expect(dismissedItems, isEmpty);
    expect(confirmDismissDirection, DismissDirection.endToStart);

    // Dismiss is not confirmed if confirmDismiss() returns null
    dismissedItems = <int>[];
    await tester.pumpWidget(buildFrame(null));

    await dismissItem(tester, 0, gestureDirection: AxisDirection.right, mechanism: flingElement);
    expect(find.text('0'), findsOneWidget);
    expect(dismissedItems, isEmpty);
    expect(confirmDismissDirection, DismissDirection.startToEnd);

    await dismissItem(tester, 1, gestureDirection: AxisDirection.left, mechanism: flingElement);
    expect(find.text('1'), findsOneWidget);
    expect(dismissedItems, isEmpty);
    expect(confirmDismissDirection, DismissDirection.endToStart);
  });
730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774

  testWidgets('setState that does not remove the Dismissible from tree should throws Error', (WidgetTester tester) async {
    scrollDirection = Axis.vertical;
    dismissDirection = DismissDirection.horizontal;

    await tester.pumpWidget(Directionality(
      textDirection: TextDirection.ltr,
      child: StatefulBuilder(
        builder: (BuildContext context, StateSetter setState) {
          return ListView(
            dragStartBehavior: DragStartBehavior.down,
            scrollDirection: scrollDirection,
            itemExtent: itemExtent,
            children: <Widget>[
              Dismissible(
                dragStartBehavior: DragStartBehavior.down,
                key: const ValueKey<int>(1),
                direction: dismissDirection,
                onDismissed: (DismissDirection direction) {
                  setState(() {
                    reportedDismissDirection = direction;
                    expect(dismissedItems.contains(1), isFalse);
                    dismissedItems.add(1);
                  });
                },
                background: background,
                dismissThresholds: const <DismissDirection, double>{},
                crossAxisEndOffset: crossAxisEndOffset,
                child: Container(
                  width: itemExtent,
                  height: itemExtent,
                  child: Text(1.toString()),
                ),
              ),
            ]
          );
        },
      ),
    ));
    expect(dismissedItems, isEmpty);
    await dismissItem(tester, 1, gestureDirection: AxisDirection.right);
    expect(dismissedItems, equals(<int>[1]));
    final dynamic exception =  tester.takeException();
    expect(exception, isNotNull);
    expect(exception, isFlutterError);
775
    final FlutterError error = exception as FlutterError;
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
    expect(error.diagnostics.last.level, DiagnosticLevel.hint);
    expect(
      error.diagnostics.last.toStringDeep(),
      equalsIgnoringHashCodes(
        'Make sure to implement the onDismissed handler and to immediately\n'
        'remove the Dismissible widget from the application once that\n'
        'handler has fired.\n',
      ),
    );
    expect(
      error.toStringDeep(),
      'FlutterError\n'
      '   A dismissed Dismissible widget is still part of the tree.\n'
      '   Make sure to implement the onDismissed handler and to immediately\n'
      '   remove the Dismissible widget from the application once that\n'
      '   handler has fired.\n',
    );
  });
794 795 796 797

  testWidgets('Dismissible.behavior should behave correctly during hit testing', (WidgetTester tester) async {
    bool didReceivePointerDown = false;

798
    Widget buildStack({required Widget child}) {
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862
      return Directionality(
        textDirection: TextDirection.ltr,
        child: Stack(
          children: <Widget>[
            Listener(
              onPointerDown: (_) {
                didReceivePointerDown = true;
              },
              child: Container(
                width: 100.0,
                height: 100.0,
                color: const Color(0xFF00FF00),
              ),
            ),
            child,
          ],
        ),
      );
    }

    await tester.pumpWidget(
      buildStack(
        child: const Dismissible(
          key: ValueKey<int>(1),
          child: SizedBox(
            width: 100.0,
            height: 100.0,
          ),
        ),
      ),
    );
    await tester.tapAt(const Offset(10.0, 10.0));
    expect(didReceivePointerDown, isFalse);

    Future<void> pumpWidgetTree(HitTestBehavior behavior) {
      return tester.pumpWidget(
        buildStack(
          child: Dismissible(
            key: const ValueKey<int>(1),
            behavior: behavior,
            child: const SizedBox(
              width: 100.0,
              height: 100.0,
            ),
          ),
        ),
      );
    }

    didReceivePointerDown = false;
    await pumpWidgetTree(HitTestBehavior.deferToChild);
    await tester.tapAt(const Offset(10.0, 10.0));
    expect(didReceivePointerDown, isTrue);

    didReceivePointerDown = false;
    await pumpWidgetTree(HitTestBehavior.opaque);
    await tester.tapAt(const Offset(10.0, 10.0));
    expect(didReceivePointerDown, isFalse);

    didReceivePointerDown = false;
    await pumpWidgetTree(HitTestBehavior.translucent);
    await tester.tapAt(const Offset(10.0, 10.0));
    expect(didReceivePointerDown, isTrue);
  });
863 864 865 866 867 868 869 870 871 872 873 874 875

  testWidgets('DismissDirection.none does not trigger dismiss', (WidgetTester tester) async {
    dismissDirection = DismissDirection.none;

    await tester.pumpWidget(buildTest());
    expect(dismissedItems, isEmpty);

    await dismissItem(tester, 0, gestureDirection: AxisDirection.left);
    await dismissItem(tester, 0, gestureDirection: AxisDirection.right);
    await dismissItem(tester, 0, gestureDirection: AxisDirection.up);
    await dismissItem(tester, 0, gestureDirection: AxisDirection.down);
    expect(find.text('0'), findsOneWidget);
  });
876
}