tap_test.dart 29.4 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
Ian Hickson's avatar
Ian Hickson 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/foundation.dart';
6
import 'package:flutter/gestures.dart';
7
import 'package:flutter_test/flutter_test.dart';
8

9 10
import 'gesture_tester.dart';

11
class TestGestureArenaMember extends GestureArenaMember {
12
  @override
13
  void acceptGesture(int key) { }
14 15

  @override
16
  void rejectGesture(int key) { }
17 18
}

19
void main() {
20
  setUp(ensureGestureBinding);
21 22

  // Down/up pair 1: normal tap sequence
23
  const PointerDownEvent down1 = PointerDownEvent(
24
    pointer: 1,
25
    position: Offset(10.0, 10.0),
26 27
  );

28
  const PointerUpEvent up1 = PointerUpEvent(
29
    pointer: 1,
30
    position: Offset(11.0, 9.0),
31 32 33
  );

  // Down/up pair 2: normal tap sequence far away from pair 1
34
  const PointerDownEvent down2 = PointerDownEvent(
35
    pointer: 2,
36
    position: Offset(30.0, 30.0),
37 38
  );

39
  const PointerUpEvent up2 = PointerUpEvent(
40
    pointer: 2,
41
    position: Offset(31.0, 29.0),
42 43
  );

44
  // Down/move/up sequence 3: intervening motion, more than kTouchSlop. (~21px)
45
  const PointerDownEvent down3 = PointerDownEvent(
46
    pointer: 3,
47
    position: Offset(10.0, 10.0),
48 49
  );

50
  const PointerMoveEvent move3 = PointerMoveEvent(
51
    pointer: 3,
52
    position: Offset(25.0, 25.0),
53 54
  );

55
  const PointerUpEvent up3 = PointerUpEvent(
56
    pointer: 3,
57
    position: Offset(25.0, 25.0),
58 59
  );

60
  // Down/move/up sequence 4: intervening motion, less than kTouchSlop. (~17px)
61
  const PointerDownEvent down4 = PointerDownEvent(
62
    pointer: 4,
63
    position: Offset(10.0, 10.0),
64 65
  );

66
  const PointerMoveEvent move4 = PointerMoveEvent(
67
    pointer: 4,
68
    position: Offset(22.0, 22.0),
69 70
  );

71
  const PointerUpEvent up4 = PointerUpEvent(
72
    pointer: 4,
73
    position: Offset(22.0, 22.0),
74 75
  );

76 77 78 79 80 81 82 83 84 85 86 87
  // Down/up sequence 5: tap sequence with secondary button
  const PointerDownEvent down5 = PointerDownEvent(
    pointer: 5,
    position: Offset(20.0, 20.0),
    buttons: kSecondaryButton,
  );

  const PointerUpEvent up5 = PointerUpEvent(
    pointer: 5,
    position: Offset(20.0, 20.0),
  );

88 89 90 91 92 93 94 95 96 97 98 99
  // Down/up sequence 6: tap sequence with tertiary button
  const PointerDownEvent down6 = PointerDownEvent(
    pointer: 6,
    position: Offset(20.0, 20.0),
    buttons: kTertiaryButton,
  );

  const PointerUpEvent up6 = PointerUpEvent(
    pointer: 6,
    position: Offset(20.0, 20.0),
  );

100
  testGesture('Should recognize tap', (GestureTester tester) {
101
    final TapGestureRecognizer tap = TapGestureRecognizer();
102 103 104 105 106 107

    bool tapRecognized = false;
    tap.onTap = () {
      tapRecognized = true;
    };

108
    tap.addPointer(down1);
109
    tester.closeArena(1);
110
    expect(tapRecognized, isFalse);
111
    tester.route(down1);
112 113
    expect(tapRecognized, isFalse);

114
    tester.route(up1);
115
    expect(tapRecognized, isTrue);
116
    GestureBinding.instance!.gestureArena.sweep(1);
117 118 119 120 121
    expect(tapRecognized, isTrue);

    tap.dispose();
  });

122 123 124
  testGesture('Details contain the correct device kind', (GestureTester tester) {
    final TapGestureRecognizer tap = TapGestureRecognizer();

125 126
    TapDownDetails? lastDownDetails;
    TapUpDetails? lastUpDetails;
127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142

    tap.onTapDown = (TapDownDetails details) {
      lastDownDetails = details;
    };
    tap.onTapUp = (TapUpDetails details) {
      lastUpDetails = details;
    };

    const PointerDownEvent mouseDown =
        PointerDownEvent(pointer: 1, kind: PointerDeviceKind.mouse);
    const PointerUpEvent mouseUp =
        PointerUpEvent(pointer: 1, kind: PointerDeviceKind.mouse);

    tap.addPointer(mouseDown);
    tester.closeArena(1);
    tester.route(mouseDown);
143
    expect(lastDownDetails?.kind, PointerDeviceKind.mouse);
144 145

    tester.route(mouseUp);
146
    expect(lastUpDetails?.kind, PointerDeviceKind.mouse);
147 148 149 150

    tap.dispose();
  });

151
  testGesture('No duplicate tap events', (GestureTester tester) {
152
    final TapGestureRecognizer tap = TapGestureRecognizer();
153 154 155 156 157 158 159

    int tapsRecognized = 0;
    tap.onTap = () {
      tapsRecognized++;
    };

    tap.addPointer(down1);
160
    tester.closeArena(1);
161
    expect(tapsRecognized, 0);
162
    tester.route(down1);
163 164
    expect(tapsRecognized, 0);

165
    tester.route(up1);
166
    expect(tapsRecognized, 1);
167
    GestureBinding.instance!.gestureArena.sweep(1);
168 169 170
    expect(tapsRecognized, 1);

    tap.addPointer(down1);
171
    tester.closeArena(1);
172
    expect(tapsRecognized, 1);
173
    tester.route(down1);
174 175
    expect(tapsRecognized, 1);

176
    tester.route(up1);
177
    expect(tapsRecognized, 2);
178
    GestureBinding.instance!.gestureArena.sweep(1);
179 180 181 182 183
    expect(tapsRecognized, 2);

    tap.dispose();
  });

184
  testGesture('Should not recognize two overlapping taps (FIFO)', (GestureTester tester) {
185
    final TapGestureRecognizer tap = TapGestureRecognizer();
186 187 188 189 190

    int tapsRecognized = 0;
    tap.onTap = () {
      tapsRecognized++;
    };
191

192
    tap.addPointer(down1);
193
    tester.closeArena(1);
194
    expect(tapsRecognized, 0);
195
    tester.route(down1);
196 197 198
    expect(tapsRecognized, 0);

    tap.addPointer(down2);
199
    tester.closeArena(2);
200
    expect(tapsRecognized, 0);
201
    tester.route(down1);
202 203 204
    expect(tapsRecognized, 0);


205
    tester.route(up1);
206
    expect(tapsRecognized, 1);
207
    GestureBinding.instance!.gestureArena.sweep(1);
208 209
    expect(tapsRecognized, 1);

210
    tester.route(up2);
211
    expect(tapsRecognized, 1);
212
    GestureBinding.instance!.gestureArena.sweep(2);
213
    expect(tapsRecognized, 1);
214 215 216 217

    tap.dispose();
  });

218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240
  testGesture('Should not recognize two overlapping taps (FILO)', (GestureTester tester) {
    final TapGestureRecognizer tap = TapGestureRecognizer();

    int tapsRecognized = 0;
    tap.onTap = () {
      tapsRecognized++;
    };

    tap.addPointer(down1);
    tester.closeArena(1);
    expect(tapsRecognized, 0);
    tester.route(down1);
    expect(tapsRecognized, 0);

    tap.addPointer(down2);
    tester.closeArena(2);
    expect(tapsRecognized, 0);
    tester.route(down1);
    expect(tapsRecognized, 0);


    tester.route(up2);
    expect(tapsRecognized, 0);
241
    GestureBinding.instance!.gestureArena.sweep(2);
242 243 244 245
    expect(tapsRecognized, 0);

    tester.route(up1);
    expect(tapsRecognized, 1);
246
    GestureBinding.instance!.gestureArena.sweep(1);
247 248 249 250 251
    expect(tapsRecognized, 1);

    tap.dispose();
  });

252
  testGesture('Distance cancels tap', (GestureTester tester) {
253
    final TapGestureRecognizer tap = TapGestureRecognizer();
254 255 256 257 258

    bool tapRecognized = false;
    tap.onTap = () {
      tapRecognized = true;
    };
Ian Hickson's avatar
Ian Hickson committed
259 260 261 262
    bool tapCanceled = false;
    tap.onTapCancel = () {
      tapCanceled = true;
    };
263 264

    tap.addPointer(down3);
265
    tester.closeArena(3);
266
    expect(tapRecognized, isFalse);
Ian Hickson's avatar
Ian Hickson committed
267
    expect(tapCanceled, isFalse);
268
    tester.route(down3);
269
    expect(tapRecognized, isFalse);
Ian Hickson's avatar
Ian Hickson committed
270
    expect(tapCanceled, isFalse);
271

272
    tester.route(move3);
273
    expect(tapRecognized, isFalse);
Ian Hickson's avatar
Ian Hickson committed
274
    expect(tapCanceled, isTrue);
275
    tester.route(up3);
276
    expect(tapRecognized, isFalse);
Ian Hickson's avatar
Ian Hickson committed
277
    expect(tapCanceled, isTrue);
278
    GestureBinding.instance!.gestureArena.sweep(3);
279
    expect(tapRecognized, isFalse);
Ian Hickson's avatar
Ian Hickson committed
280
    expect(tapCanceled, isTrue);
281

282 283 284
    tap.dispose();
  });

285
  testGesture('Short distance does not cancel tap', (GestureTester tester) {
286
    final TapGestureRecognizer tap = TapGestureRecognizer();
287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310

    bool tapRecognized = false;
    tap.onTap = () {
      tapRecognized = true;
    };
    bool tapCanceled = false;
    tap.onTapCancel = () {
      tapCanceled = true;
    };

    tap.addPointer(down4);
    tester.closeArena(4);
    expect(tapRecognized, isFalse);
    expect(tapCanceled, isFalse);
    tester.route(down4);
    expect(tapRecognized, isFalse);
    expect(tapCanceled, isFalse);

    tester.route(move4);
    expect(tapRecognized, isFalse);
    expect(tapCanceled, isFalse);
    tester.route(up4);
    expect(tapRecognized, isTrue);
    expect(tapCanceled, isFalse);
311
    GestureBinding.instance!.gestureArena.sweep(4);
312 313 314 315 316 317
    expect(tapRecognized, isTrue);
    expect(tapCanceled, isFalse);

    tap.dispose();
  });

318
  testGesture('Timeout does not cancel tap', (GestureTester tester) {
319
    final TapGestureRecognizer tap = TapGestureRecognizer();
320 321 322 323 324 325

    bool tapRecognized = false;
    tap.onTap = () {
      tapRecognized = true;
    };

326 327 328 329 330 331
    tap.addPointer(down1);
    tester.closeArena(1);
    expect(tapRecognized, isFalse);
    tester.route(down1);
    expect(tapRecognized, isFalse);

332
    tester.async.elapse(const Duration(milliseconds: 500));
333 334 335
    expect(tapRecognized, isFalse);
    tester.route(up1);
    expect(tapRecognized, isTrue);
336
    GestureBinding.instance!.gestureArena.sweep(1);
337
    expect(tapRecognized, isTrue);
338 339 340 341

    tap.dispose();
  });

342
  testGesture('Should yield to other arena members', (GestureTester tester) {
343
    final TapGestureRecognizer tap = TapGestureRecognizer();
344 345 346 347 348 349 350

    bool tapRecognized = false;
    tap.onTap = () {
      tapRecognized = true;
    };

    tap.addPointer(down1);
351
    final TestGestureArenaMember member = TestGestureArenaMember();
352 353
    final GestureArenaEntry entry = GestureBinding.instance!.gestureArena.add(1, member);
    GestureBinding.instance!.gestureArena.hold(1);
354
    tester.closeArena(1);
355
    expect(tapRecognized, isFalse);
356
    tester.route(down1);
357 358
    expect(tapRecognized, isFalse);

359
    tester.route(up1);
360
    expect(tapRecognized, isFalse);
361
    GestureBinding.instance!.gestureArena.sweep(1);
362 363 364 365 366 367 368 369
    expect(tapRecognized, isFalse);

    entry.resolve(GestureDisposition.accepted);
    expect(tapRecognized, isFalse);

    tap.dispose();
  });

370
  testGesture('Should trigger on release of held arena', (GestureTester tester) {
371
    final TapGestureRecognizer tap = TapGestureRecognizer();
372 373 374 375 376 377 378

    bool tapRecognized = false;
    tap.onTap = () {
      tapRecognized = true;
    };

    tap.addPointer(down1);
379
    final TestGestureArenaMember member = TestGestureArenaMember();
380 381
    final GestureArenaEntry entry = GestureBinding.instance!.gestureArena.add(1, member);
    GestureBinding.instance!.gestureArena.hold(1);
382
    tester.closeArena(1);
383
    expect(tapRecognized, isFalse);
384
    tester.route(down1);
385 386
    expect(tapRecognized, isFalse);

387
    tester.route(up1);
388
    expect(tapRecognized, isFalse);
389
    GestureBinding.instance!.gestureArena.sweep(1);
390 391 392
    expect(tapRecognized, isFalse);

    entry.resolve(GestureDisposition.rejected);
393
    tester.async.flushMicrotasks();
394 395 396 397
    expect(tapRecognized, isTrue);

    tap.dispose();
  });
398

399
  testGesture('Should log exceptions from callbacks', (GestureTester tester) {
400
    final TapGestureRecognizer tap = TapGestureRecognizer();
401 402

    tap.onTap = () {
403
      throw Exception(test);
404 405
    };

406
    final FlutterExceptionHandler? previousErrorHandler = FlutterError.onError;
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
    bool gotError = false;
    FlutterError.onError = (FlutterErrorDetails details) {
      gotError = true;
    };

    tap.addPointer(down1);
    tester.closeArena(1);
    tester.route(down1);
    expect(gotError, isFalse);

    tester.route(up1);
    expect(gotError, isTrue);

    FlutterError.onError = previousErrorHandler;
    tap.dispose();
  });
423

424 425 426 427 428 429 430
  testGesture('onTapCancel should show reason in the proper format', (GestureTester tester) {
    final TapGestureRecognizer tap = TapGestureRecognizer();

    tap.onTapCancel = () {
      throw Exception(test);
    };

431
    final FlutterExceptionHandler? previousErrorHandler = FlutterError.onError;
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449
    bool gotError = false;
    FlutterError.onError = (FlutterErrorDetails details) {
      expect(details.toString().contains('"spontaneous onTapCancel"') , isTrue);
      gotError = true;
    };

    const int pointer = 1;
    tap.addPointer(const PointerDownEvent(pointer: pointer));
    tester.closeArena(pointer);
    tester.async.elapse(const Duration(milliseconds: 500));
    tester.route(const PointerCancelEvent(pointer: pointer));

    expect(gotError, isTrue);

    FlutterError.onError = previousErrorHandler;
    tap.dispose();
  });

450
  testGesture('No duplicate tap events', (GestureTester tester) {
451 452
    final TapGestureRecognizer tapA = TapGestureRecognizer();
    final TapGestureRecognizer tapB = TapGestureRecognizer();
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474

    final List<String> log = <String>[];
    tapA.onTapDown = (TapDownDetails details) { log.add('tapA onTapDown'); };
    tapA.onTapUp = (TapUpDetails details) { log.add('tapA onTapUp'); };
    tapA.onTap = () { log.add('tapA onTap'); };
    tapA.onTapCancel = () { log.add('tapA onTapCancel'); };
    tapB.onTapDown = (TapDownDetails details) { log.add('tapB onTapDown'); };
    tapB.onTapUp = (TapUpDetails details) { log.add('tapB onTapUp'); };
    tapB.onTap = () { log.add('tapB onTap'); };
    tapB.onTapCancel = () { log.add('tapB onTapCancel'); };

    log.add('start');
    tapA.addPointer(down1);
    log.add('added 1 to A');
    tapB.addPointer(down1);
    log.add('added 1 to B');
    tester.closeArena(1);
    log.add('closed 1');
    tester.route(down1);
    log.add('routed 1 down');
    tester.route(up1);
    log.add('routed 1 up');
475
    GestureBinding.instance!.gestureArena.sweep(1);
476 477 478 479 480 481 482 483 484 485 486
    log.add('swept 1');
    tapA.addPointer(down2);
    log.add('down 2 to A');
    tapB.addPointer(down2);
    log.add('down 2 to B');
    tester.closeArena(2);
    log.add('closed 2');
    tester.route(down2);
    log.add('routed 2 down');
    tester.route(up2);
    log.add('routed 2 up');
487
    GestureBinding.instance!.gestureArena.sweep(2);
488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517
    log.add('swept 2');
    tapA.dispose();
    log.add('disposed A');
    tapB.dispose();
    log.add('disposed B');

    expect(log, <String>[
      'start',
      'added 1 to A',
      'added 1 to B',
      'closed 1',
      'routed 1 down',
      'routed 1 up',
      'tapA onTapDown',
      'tapA onTapUp',
      'tapA onTap',
      'swept 1',
      'down 2 to A',
      'down 2 to B',
      'closed 2',
      'routed 2 down',
      'routed 2 up',
      'tapA onTapDown',
      'tapA onTapUp',
      'tapA onTap',
      'swept 2',
      'disposed A',
      'disposed B',
    ]);
  });
518 519 520 521

  testGesture('PointerCancelEvent cancels tap', (GestureTester tester) {
    const PointerDownEvent down = PointerDownEvent(
        pointer: 5,
522
        position: Offset(10.0, 10.0),
523 524 525
    );
    const PointerCancelEvent cancel = PointerCancelEvent(
        pointer: 5,
526
        position: Offset(10.0, 10.0),
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
    );

    final TapGestureRecognizer tap = TapGestureRecognizer();

    final List<String> recognized = <String>[];
    tap.onTapDown = (_) {
      recognized.add('down');
    };
    tap.onTapUp = (_) {
      recognized.add('up');
    };
    tap.onTap = () {
      recognized.add('tap');
    };
    tap.onTapCancel = () {
      recognized.add('cancel');
    };

    tap.addPointer(down);
    tester.closeArena(5);
    tester.async.elapse(const Duration(milliseconds: 5000));
    expect(recognized, <String>['down']);
    tester.route(cancel);
    expect(recognized, <String>['down', 'cancel']);

    tap.dispose();
  });

555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
  testGesture('PointerCancelEvent after exceeding deadline cancels tap', (GestureTester tester) {
    const PointerDownEvent down = PointerDownEvent(
        pointer: 5,
        position: Offset(10.0, 10.0),
    );
    const PointerCancelEvent cancel = PointerCancelEvent(
        pointer: 5,
        position: Offset(10.0, 10.0),
    );

    final TapGestureRecognizer tap = TapGestureRecognizer();
    final HorizontalDragGestureRecognizer drag = HorizontalDragGestureRecognizer()
      ..onStart = (_) {}; // Need a callback to compete

    final List<String> recognized = <String>[];
    tap.onTapDown = (_) {
      recognized.add('down');
    };
    tap.onTapUp = (_) {
      recognized.add('up');
    };
    tap.onTap = () {
      recognized.add('tap');
    };
    tap.onTapCancel = () {
      recognized.add('cancel');
    };

    tap.addPointer(down);
    drag.addPointer(down);
    tester.closeArena(5);
    tester.route(down);
    expect(recognized, <String>[]);
    tester.async.elapse(const Duration(milliseconds: 1000));
    expect(recognized, <String>['down']);
    tester.route(cancel);
    expect(recognized, <String>['down', 'cancel']);

    tap.dispose();
    drag.dispose();
  });

597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
  testGesture('losing tap gesture recognizer does not send onTapCancel', (GestureTester tester) {
    final TapGestureRecognizer tap = TapGestureRecognizer();
    final HorizontalDragGestureRecognizer drag = HorizontalDragGestureRecognizer();

    final List<String> recognized = <String>[];
    tap.onTapDown = (_) {
      recognized.add('down');
    };
    tap.onTapUp = (_) {
      recognized.add('up');
    };
    tap.onTap = () {
      recognized.add('tap');
    };
    tap.onTapCancel = () {
      recognized.add('cancel');
    };

    tap.addPointer(down3);
    drag.addPointer(down3);
    tester.closeArena(3);
    tester.route(move3);
619
    GestureBinding.instance!.gestureArena.sweep(3);
620 621 622 623 624
    expect(recognized, isEmpty);

    tap.dispose();
    drag.dispose();
  });
625

626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655
  testGesture('non-primary pointers does not trigger timeout', (GestureTester tester) {
    // Regression test for https://github.com/flutter/flutter/issues/43310
    // Pointer1 down, pointer2 down, then pointer 1 up, all within the timeout.
    // In this way, `BaseTapGestureRecognizer.didExceedDeadline` can be triggered
    // after its `_reset`.
    final TapGestureRecognizer tap = TapGestureRecognizer();

    final List<String> recognized = <String>[];
    tap.onTapDown = (_) {
      recognized.add('down');
    };
    tap.onTapUp = (_) {
      recognized.add('up');
    };
    tap.onTap = () {
      recognized.add('tap');
    };
    tap.onTapCancel = () {
      recognized.add('cancel');
    };

    tap.addPointer(down1);
    tester.closeArena(down1.pointer);

    tap.addPointer(down2);
    tester.closeArena(down2.pointer);

    expect(recognized, isEmpty);

    tester.route(up1);
656
    GestureBinding.instance!.gestureArena.sweep(down1.pointer);
657 658 659 660 661 662 663 664
    expect(recognized, <String>['down', 'up', 'tap']);
    recognized.clear();

    // If regression happens, the following step will throw error
    tester.async.elapse(const Duration(milliseconds: 200));
    expect(recognized, isEmpty);

    tester.route(up2);
665
    GestureBinding.instance!.gestureArena.sweep(down2.pointer);
666 667 668 669 670
    expect(recognized, isEmpty);

    tap.dispose();
  });

671 672 673 674 675 676 677 678 679 680 681 682 683 684
  group('Enforce consistent-button restriction:', () {
    // Change buttons during down-up sequence 1
    const PointerMoveEvent move1lr = PointerMoveEvent(
      pointer: 1,
      position: Offset(10.0, 10.0),
      buttons: kPrimaryMouseButton | kSecondaryMouseButton,
    );
    const PointerMoveEvent move1r = PointerMoveEvent(
      pointer: 1,
      position: Offset(10.0, 10.0),
      buttons: kSecondaryMouseButton,
    );

    final List<String> recognized = <String>[];
685
    late TapGestureRecognizer tap;
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 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
    setUp(() {
      tap = TapGestureRecognizer()
        ..onTapDown = (TapDownDetails details) {
          recognized.add('down');
        }
        ..onTapUp = (TapUpDetails details) {
          recognized.add('up');
        }
        ..onTapCancel = () {
          recognized.add('cancel');
        };
    });

    tearDown(() {
      tap.dispose();
      recognized.clear();
    });

    testGesture('changing buttons before TapDown should cancel gesture without sending cancel', (GestureTester tester) {
      tap.addPointer(down1);
      tester.closeArena(1);
      expect(recognized, <String>[]);

      tester.route(move1lr);
      expect(recognized, <String>[]);

      tester.route(move1r);
      expect(recognized, <String>[]);

      tester.route(up1);
      expect(recognized, <String>[]);

      tap.dispose();
    });

    testGesture('changing buttons before TapDown should not prevent the next tap', (GestureTester tester) {
      tap.addPointer(down1);
      tester.closeArena(1);

      tester.route(move1lr);
      tester.route(move1r);
      tester.route(up1);
      expect(recognized, <String>[]);

      tap.addPointer(down2);
      tester.closeArena(2);
      tester.async.elapse(const Duration(milliseconds: 1000));
      tester.route(up2);
      expect(recognized, <String>['down', 'up']);

      tap.dispose();
    });

    testGesture('changing buttons after TapDown should cancel gesture and send cancel', (GestureTester tester) {
      tap.addPointer(down1);
      tester.closeArena(1);
      expect(recognized, <String>[]);
      tester.async.elapse(const Duration(milliseconds: 1000));
      expect(recognized, <String>['down']);

      tester.route(move1lr);
      expect(recognized, <String>['down', 'cancel']);

      tester.route(move1r);
      expect(recognized, <String>['down', 'cancel']);

      tester.route(up1);
      expect(recognized, <String>['down', 'cancel']);

      tap.dispose();
    });

    testGesture('changing buttons after TapDown should not prevent the next tap', (GestureTester tester) {
      tap.addPointer(down1);
      tester.closeArena(1);
      tester.async.elapse(const Duration(milliseconds: 1000));

      tester.route(move1lr);
      tester.route(move1r);
      tester.route(up1);
766
      GestureBinding.instance!.gestureArena.sweep(1);
767 768 769 770 771 772
      expect(recognized, <String>['down', 'cancel']);

      tap.addPointer(down2);
      tester.closeArena(2);
      tester.async.elapse(const Duration(milliseconds: 1000));
      tester.route(up2);
773
      GestureBinding.instance!.gestureArena.sweep(2);
774 775 776 777 778 779 780 781 782 783 784 785 786
      expect(recognized, <String>['down', 'cancel', 'down', 'up']);

      tap.dispose();
    });
  });

  group('Recognizers listening on different buttons do not form competition:', () {
    // If a tap gesture has no competitors, a pointer down event triggers
    // onTapDown immediately; if there are competitors, onTapDown is triggered
    // after a timeout. The following tests make sure that tap recognizers
    // listening on different buttons do not form competition.

    final List<String> recognized = <String>[];
787 788 789 790
    late TapGestureRecognizer primary;
    late TapGestureRecognizer primary2;
    late TapGestureRecognizer secondary;
    late TapGestureRecognizer tertiary;
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
    setUp(() {
      primary = TapGestureRecognizer()
        ..onTapDown = (TapDownDetails details) {
          recognized.add('primaryDown');
        }
        ..onTapUp = (TapUpDetails details) {
          recognized.add('primaryUp');
        }
        ..onTapCancel = () {
          recognized.add('primaryCancel');
        };
      primary2 = TapGestureRecognizer()
        ..onTapDown = (TapDownDetails details) {
          recognized.add('primary2Down');
        }
        ..onTapUp = (TapUpDetails details) {
          recognized.add('primary2Up');
        }
        ..onTapCancel = () {
          recognized.add('primary2Cancel');
        };
      secondary = TapGestureRecognizer()
        ..onSecondaryTapDown = (TapDownDetails details) {
          recognized.add('secondaryDown');
        }
        ..onSecondaryTapUp = (TapUpDetails details) {
          recognized.add('secondaryUp');
        }
        ..onSecondaryTapCancel = () {
          recognized.add('secondaryCancel');
        };
822 823 824 825 826 827 828 829 830 831
      tertiary = TapGestureRecognizer()
        ..onTertiaryTapDown = (TapDownDetails details) {
          recognized.add('tertiaryDown');
        }
        ..onTertiaryTapUp = (TapUpDetails details) {
          recognized.add('tertiaryUp');
        }
        ..onTertiaryTapCancel = () {
          recognized.add('tertiaryCancel');
        };
832 833 834 835 836 837 838
    });

    tearDown(() {
      recognized.clear();
      primary.dispose();
      primary2.dispose();
      secondary.dispose();
839
      tertiary.dispose();
840 841
    });

Chris Bracken's avatar
Chris Bracken committed
842
    testGesture('A primary tap recognizer does not form competition with a secondary tap recognizer', (GestureTester tester) {
843 844 845 846 847 848 849 850 851 852 853 854
      primary.addPointer(down1);
      secondary.addPointer(down1);
      tester.closeArena(1);

      tester.route(down1);
      expect(recognized, <String>['primaryDown']);
      recognized.clear();

      tester.route(up1);
      expect(recognized, <String>['primaryUp']);
    });

855 856 857 858 859 860 861 862 863 864 865 866 867
    testGesture('A primary tap recognizer does not form competition with a tertiary tap recognizer', (GestureTester tester) {
      primary.addPointer(down1);
      tertiary.addPointer(down1);
      tester.closeArena(1);

      tester.route(down1);
      expect(recognized, <String>['primaryDown']);
      recognized.clear();

      tester.route(up1);
      expect(recognized, <String>['primaryUp']);
    });

Chris Bracken's avatar
Chris Bracken committed
868
    testGesture('A primary tap recognizer forms competition with another primary tap recognizer', (GestureTester tester) {
869 870 871 872 873 874 875 876 877 878 879 880 881 882
      primary.addPointer(down1);
      primary2.addPointer(down1);
      tester.closeArena(1);

      tester.route(down1);
      expect(recognized, <String>[]);

      tester.async.elapse(const Duration(milliseconds: 500));
      expect(recognized, <String>['primaryDown', 'primary2Down']);
    });
  });

  group('Gestures of different buttons trigger correct callbacks:', () {
    final List<String> recognized = <String>[];
883
    late TapGestureRecognizer tap;
884 885 886 887 888 889
    const PointerCancelEvent cancel1 = PointerCancelEvent(
      pointer: 1,
    );
    const PointerCancelEvent cancel5 = PointerCancelEvent(
      pointer: 5,
    );
890 891 892
    const PointerCancelEvent cancel6 = PointerCancelEvent(
      pointer: 6,
    );
893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915

    setUp(() {
      tap = TapGestureRecognizer()
        ..onTapDown = (TapDownDetails details) {
          recognized.add('primaryDown');
        }
        ..onTap = () {
          recognized.add('primary');
        }
        ..onTapUp = (TapUpDetails details) {
          recognized.add('primaryUp');
        }
        ..onTapCancel = () {
          recognized.add('primaryCancel');
        }
        ..onSecondaryTapDown = (TapDownDetails details) {
          recognized.add('secondaryDown');
        }
        ..onSecondaryTapUp = (TapUpDetails details) {
          recognized.add('secondaryUp');
        }
        ..onSecondaryTapCancel = () {
          recognized.add('secondaryCancel');
916 917 918 919 920 921 922 923 924
        }
        ..onTertiaryTapDown = (TapDownDetails details) {
          recognized.add('tertiaryDown');
        }
        ..onTertiaryTapUp = (TapUpDetails details) {
          recognized.add('tertiaryUp');
        }
        ..onTertiaryTapCancel = () {
          recognized.add('tertiaryCancel');
925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
        };
    });

    tearDown(() {
      recognized.clear();
      tap.dispose();
    });

    testGesture('A primary tap should trigger primary callbacks', (GestureTester tester) {
      tap.addPointer(down1);
      tester.closeArena(down1.pointer);
      expect(recognized, <String>[]);
      tester.async.elapse(const Duration(milliseconds: 500));
      expect(recognized, <String>['primaryDown']);
      recognized.clear();

      tester.route(up1);
      expect(recognized, <String>['primaryUp', 'primary']);
943
      GestureBinding.instance!.gestureArena.sweep(down1.pointer);
944 945 946 947 948 949 950 951 952 953 954 955
    });

    testGesture('A primary tap cancel trigger primary callbacks', (GestureTester tester) {
      tap.addPointer(down1);
      tester.closeArena(down1.pointer);
      expect(recognized, <String>[]);
      tester.async.elapse(const Duration(milliseconds: 500));
      expect(recognized, <String>['primaryDown']);
      recognized.clear();

      tester.route(cancel1);
      expect(recognized, <String>['primaryCancel']);
956
      GestureBinding.instance!.gestureArena.sweep(down1.pointer);
957 958 959 960 961 962 963 964 965 966 967
    });

    testGesture('A secondary tap should trigger secondary callbacks', (GestureTester tester) {
      tap.addPointer(down5);
      tester.closeArena(down5.pointer);
      expect(recognized, <String>[]);
      tester.async.elapse(const Duration(milliseconds: 500));
      expect(recognized, <String>['secondaryDown']);
      recognized.clear();

      tester.route(up5);
968
      GestureBinding.instance!.gestureArena.sweep(down5.pointer);
969 970 971
      expect(recognized, <String>['secondaryUp']);
    });

972 973 974 975 976 977 978 979 980
    testGesture('A tertiary tap should trigger tertiary callbacks', (GestureTester tester) {
      tap.addPointer(down6);
      tester.closeArena(down6.pointer);
      expect(recognized, <String>[]);
      tester.async.elapse(const Duration(milliseconds: 500));
      expect(recognized, <String>['tertiaryDown']);
      recognized.clear();

      tester.route(up6);
981
      GestureBinding.instance!.gestureArena.sweep(down6.pointer);
982 983 984
      expect(recognized, <String>['tertiaryUp']);
    });

985 986 987 988 989 990 991 992 993
    testGesture('A secondary tap cancel should trigger secondary callbacks', (GestureTester tester) {
      tap.addPointer(down5);
      tester.closeArena(down5.pointer);
      expect(recognized, <String>[]);
      tester.async.elapse(const Duration(milliseconds: 500));
      expect(recognized, <String>['secondaryDown']);
      recognized.clear();

      tester.route(cancel5);
994
      GestureBinding.instance!.gestureArena.sweep(down5.pointer);
995
      expect(recognized, <String>['secondaryCancel']);
996 997 998 999 1000 1001 1002 1003 1004 1005 1006
    });

    testGesture('A tertiary tap cancel should trigger tertiary callbacks', (GestureTester tester) {
      tap.addPointer(down6);
      tester.closeArena(down6.pointer);
      expect(recognized, <String>[]);
      tester.async.elapse(const Duration(milliseconds: 500));
      expect(recognized, <String>['tertiaryDown']);
      recognized.clear();

      tester.route(cancel6);
1007
      GestureBinding.instance!.gestureArena.sweep(down6.pointer);
1008
      expect(recognized, <String>['tertiaryCancel']);
1009 1010
    });
  });
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044

  testGesture('A second tap after rejection is ignored', (GestureTester tester) {
    bool didTap = false;

    final TapGestureRecognizer tap = TapGestureRecognizer()
      ..onTap = () {
        didTap = true;
      };
    // Add drag recognizer for competition
    final HorizontalDragGestureRecognizer drag = HorizontalDragGestureRecognizer()
      ..onStart = (_) {};

    final TestPointer pointer1 = TestPointer(1);

    final PointerDownEvent down = pointer1.down(const Offset(0.0, 0.0));
    drag.addPointer(down);
    tap.addPointer(down);

    tester.closeArena(1);

    // One-finger moves, canceling the tap
    tester.route(down);
    tester.route(pointer1.move(const Offset(50.0, 0)));

    // Add another finger
    final TestPointer pointer2 = TestPointer(2);
    final PointerDownEvent down2 = pointer2.down(const Offset(10.0, 20.0));
    drag.addPointer(down2);
    tap.addPointer(down2);
    tester.closeArena(2);
    tester.route(down2);

    expect(didTap, isFalse);
  });
1045
}