tap_test.dart 10.7 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1 2 3 4
// Copyright 2015 The Chromium Authors. All rights reserved.
// 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 8
import 'package:test/test.dart';

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
Ian Hickson's avatar
Ian Hickson committed
23
  const PointerDownEvent down1 = const PointerDownEvent(
24
    pointer: 1,
25
    position: const Offset(10.0, 10.0)
26 27
  );

Ian Hickson's avatar
Ian Hickson committed
28
  const PointerUpEvent up1 = const PointerUpEvent(
29
    pointer: 1,
30
    position: const Offset(11.0, 9.0)
31 32 33
  );

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

Ian Hickson's avatar
Ian Hickson committed
39
  const PointerUpEvent up2 = const PointerUpEvent(
40
    pointer: 2,
41
    position: const Offset(31.0, 29.0)
42 43
  );

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

Ian Hickson's avatar
Ian Hickson committed
50
  const PointerMoveEvent move3 = const PointerMoveEvent(
51
    pointer: 3,
52
    position: const Offset(25.0, 25.0)
53 54
  );

Ian Hickson's avatar
Ian Hickson committed
55
  const PointerUpEvent up3 = const PointerUpEvent(
56
    pointer: 3,
57
    position: const Offset(25.0, 25.0)
58 59
  );

60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
  // Down/move/up sequence 4: intervening motion, less than kTouchSlop. (~17px)
  const PointerDownEvent down4 = const PointerDownEvent(
    pointer: 4,
    position: const Offset(10.0, 10.0)
  );

  const PointerMoveEvent move4 = const PointerMoveEvent(
    pointer: 4,
    position: const Offset(22.0, 22.0)
  );

  const PointerUpEvent up4 = const PointerUpEvent(
    pointer: 4,
    position: const Offset(22.0, 22.0)
  );

76
  testGesture('Should recognize tap', (GestureTester tester) {
77
    final TapGestureRecognizer tap = new TapGestureRecognizer();
78 79 80 81 82 83

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

84
    tap.addPointer(down1);
85
    tester.closeArena(1);
86
    expect(tapRecognized, isFalse);
87
    tester.route(down1);
88 89
    expect(tapRecognized, isFalse);

90
    tester.route(up1);
91
    expect(tapRecognized, isTrue);
92
    GestureBinding.instance.gestureArena.sweep(1);
93 94 95 96 97
    expect(tapRecognized, isTrue);

    tap.dispose();
  });

98
  testGesture('No duplicate tap events', (GestureTester tester) {
99
    final TapGestureRecognizer tap = new TapGestureRecognizer();
100 101 102 103 104 105 106

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

    tap.addPointer(down1);
107
    tester.closeArena(1);
108
    expect(tapsRecognized, 0);
109
    tester.route(down1);
110 111
    expect(tapsRecognized, 0);

112
    tester.route(up1);
113
    expect(tapsRecognized, 1);
114
    GestureBinding.instance.gestureArena.sweep(1);
115 116 117
    expect(tapsRecognized, 1);

    tap.addPointer(down1);
118
    tester.closeArena(1);
119
    expect(tapsRecognized, 1);
120
    tester.route(down1);
121 122
    expect(tapsRecognized, 1);

123
    tester.route(up1);
124
    expect(tapsRecognized, 2);
125
    GestureBinding.instance.gestureArena.sweep(1);
126 127 128 129 130
    expect(tapsRecognized, 2);

    tap.dispose();
  });

131
  testGesture('Should not recognize two overlapping taps', (GestureTester tester) {
132
    final TapGestureRecognizer tap = new TapGestureRecognizer();
133 134 135 136 137

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

139
    tap.addPointer(down1);
140
    tester.closeArena(1);
141
    expect(tapsRecognized, 0);
142
    tester.route(down1);
143 144 145
    expect(tapsRecognized, 0);

    tap.addPointer(down2);
146
    tester.closeArena(2);
147
    expect(tapsRecognized, 0);
148
    tester.route(down1);
149 150 151
    expect(tapsRecognized, 0);


152
    tester.route(up1);
153
    expect(tapsRecognized, 1);
154
    GestureBinding.instance.gestureArena.sweep(1);
155 156
    expect(tapsRecognized, 1);

157
    tester.route(up2);
158
    expect(tapsRecognized, 1);
159
    GestureBinding.instance.gestureArena.sweep(2);
160
    expect(tapsRecognized, 1);
161 162 163 164

    tap.dispose();
  });

165
  testGesture('Distance cancels tap', (GestureTester tester) {
166
    final TapGestureRecognizer tap = new TapGestureRecognizer();
167 168 169 170 171

    bool tapRecognized = false;
    tap.onTap = () {
      tapRecognized = true;
    };
Ian Hickson's avatar
Ian Hickson committed
172 173 174 175
    bool tapCanceled = false;
    tap.onTapCancel = () {
      tapCanceled = true;
    };
176 177

    tap.addPointer(down3);
178
    tester.closeArena(3);
179
    expect(tapRecognized, isFalse);
Ian Hickson's avatar
Ian Hickson committed
180
    expect(tapCanceled, isFalse);
181
    tester.route(down3);
182
    expect(tapRecognized, isFalse);
Ian Hickson's avatar
Ian Hickson committed
183
    expect(tapCanceled, isFalse);
184

185
    tester.route(move3);
186
    expect(tapRecognized, isFalse);
Ian Hickson's avatar
Ian Hickson committed
187
    expect(tapCanceled, isTrue);
188
    tester.route(up3);
189
    expect(tapRecognized, isFalse);
Ian Hickson's avatar
Ian Hickson committed
190
    expect(tapCanceled, isTrue);
191
    GestureBinding.instance.gestureArena.sweep(3);
192
    expect(tapRecognized, isFalse);
Ian Hickson's avatar
Ian Hickson committed
193
    expect(tapCanceled, isTrue);
194

195 196 197
    tap.dispose();
  });

198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
  testGesture('Short distance does not cancel tap', (GestureTester tester) {
    final TapGestureRecognizer tap = new TapGestureRecognizer();

    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);
    GestureBinding.instance.gestureArena.sweep(4);
    expect(tapRecognized, isTrue);
    expect(tapCanceled, isFalse);

    tap.dispose();
  });

231
  testGesture('Timeout does not cancel tap', (GestureTester tester) {
232
    final TapGestureRecognizer tap = new TapGestureRecognizer();
233 234 235 236 237 238

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

239 240 241 242 243 244
    tap.addPointer(down1);
    tester.closeArena(1);
    expect(tapRecognized, isFalse);
    tester.route(down1);
    expect(tapRecognized, isFalse);

245
    tester.async.elapse(const Duration(milliseconds: 500));
246 247 248 249 250
    expect(tapRecognized, isFalse);
    tester.route(up1);
    expect(tapRecognized, isTrue);
    GestureBinding.instance.gestureArena.sweep(1);
    expect(tapRecognized, isTrue);
251 252 253 254

    tap.dispose();
  });

255
  testGesture('Should yield to other arena members', (GestureTester tester) {
256
    final TapGestureRecognizer tap = new TapGestureRecognizer();
257 258 259 260 261 262 263

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

    tap.addPointer(down1);
264 265
    final TestGestureArenaMember member = new TestGestureArenaMember();
    final GestureArenaEntry entry = GestureBinding.instance.gestureArena.add(1, member);
266
    GestureBinding.instance.gestureArena.hold(1);
267
    tester.closeArena(1);
268
    expect(tapRecognized, isFalse);
269
    tester.route(down1);
270 271
    expect(tapRecognized, isFalse);

272
    tester.route(up1);
273
    expect(tapRecognized, isFalse);
274
    GestureBinding.instance.gestureArena.sweep(1);
275 276 277 278 279 280 281 282
    expect(tapRecognized, isFalse);

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

    tap.dispose();
  });

283
  testGesture('Should trigger on release of held arena', (GestureTester tester) {
284
    final TapGestureRecognizer tap = new TapGestureRecognizer();
285 286 287 288 289 290 291

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

    tap.addPointer(down1);
292 293
    final TestGestureArenaMember member = new TestGestureArenaMember();
    final GestureArenaEntry entry = GestureBinding.instance.gestureArena.add(1, member);
294
    GestureBinding.instance.gestureArena.hold(1);
295
    tester.closeArena(1);
296
    expect(tapRecognized, isFalse);
297
    tester.route(down1);
298 299
    expect(tapRecognized, isFalse);

300
    tester.route(up1);
301
    expect(tapRecognized, isFalse);
302
    GestureBinding.instance.gestureArena.sweep(1);
303 304 305
    expect(tapRecognized, isFalse);

    entry.resolve(GestureDisposition.rejected);
306
    tester.async.flushMicrotasks();
307 308 309 310
    expect(tapRecognized, isTrue);

    tap.dispose();
  });
311

312
  testGesture('Should log exceptions from callbacks', (GestureTester tester) {
313
    final TapGestureRecognizer tap = new TapGestureRecognizer();
314 315 316 317 318

    tap.onTap = () {
      throw new Exception(test);
    };

319
    final FlutterExceptionHandler previousErrorHandler = FlutterError.onError;
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335
    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();
  });
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 367 368 369 370 371 372 373 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

  testGesture('No duplicate tap events', (GestureTester tester) {
    final TapGestureRecognizer tapA = new TapGestureRecognizer();
    final TapGestureRecognizer tapB = new TapGestureRecognizer();

    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');
    GestureBinding.instance.gestureArena.sweep(1);
    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');
    GestureBinding.instance.gestureArena.sweep(2);
    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',
      'tapB onTapCancel',
      'swept 1',
      'down 2 to A',
      'down 2 to B',
      'closed 2',
      'routed 2 down',
      'routed 2 up',
      'tapA onTapDown',
      'tapA onTapUp',
      'tapA onTap',
      'tapB onTapCancel',
      'swept 2',
      'disposed A',
      'disposed B',
    ]);
  });
407
}