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

import 'package:flutter/material.dart';
6
import 'package:flutter/cupertino.dart' show CupertinoPageRoute;
7
import 'package:flutter/rendering.dart';
8
import 'package:flutter_test/flutter_test.dart';
9 10

import '../rendering/mock_canvas.dart';
11 12

void main() {
Dan Field's avatar
Dan Field committed
13
  testWidgets('test page transition', (WidgetTester tester) async {
14
    await tester.pumpWidget(
15
      MaterialApp(
16
        home: const Material(child: Text('Page 1')),
17 18
        routes: <String, WidgetBuilder>{
          '/next': (BuildContext context) {
19
            return const Material(child: Text('Page 2'));
20
          },
21
        },
22
      ),
23 24
    );

25
    final Offset widget1TopLeft = tester.getTopLeft(find.text('Page 1'));
26 27 28 29 30

    tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/next');
    await tester.pump();
    await tester.pump(const Duration(milliseconds: 1));

31
    FadeTransition widget2Opacity =
32
        tester.element(find.text('Page 2')).findAncestorWidgetOfExactType<FadeTransition>()!;
33
    Offset widget2TopLeft = tester.getTopLeft(find.text('Page 2'));
34 35
    final Size widget2Size = tester.getSize(find.text('Page 2'));

36
    // Android transition is vertical only.
37
    expect(widget1TopLeft.dx == widget2TopLeft.dx, true);
38
    // Page 1 is above page 2 mid-transition.
39
    expect(widget1TopLeft.dy < widget2TopLeft.dy, true);
40 41 42
    // Animation begins 3/4 of the way up the page.
    expect(widget2TopLeft.dy < widget2Size.height / 4.0, true);
    // Animation starts with page 2 being near transparent.
43
    expect(widget2Opacity.opacity.value < 0.01, true);
44

45
    await tester.pump(const Duration(milliseconds: 300));
46 47 48 49 50 51 52 53 54

    // Page 2 covers page 1.
    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    tester.state<NavigatorState>(find.byType(Navigator)).pop();
    await tester.pump();
    await tester.pump(const Duration(milliseconds: 1));

55
    widget2Opacity =
56
        tester.element(find.text('Page 2')).findAncestorWidgetOfExactType<FadeTransition>()!;
57 58 59
    widget2TopLeft = tester.getTopLeft(find.text('Page 2'));

    // Page 2 starts to move down.
60
    expect(widget1TopLeft.dy < widget2TopLeft.dy, true);
61
    // Page 2 starts to lose opacity.
62
    expect(widget2Opacity.opacity.value < 1.0, true);
63

64
    await tester.pump(const Duration(milliseconds: 300));
65 66 67

    expect(find.text('Page 1'), isOnstage);
    expect(find.text('Page 2'), findsNothing);
Dan Field's avatar
Dan Field committed
68
  }, variant: TargetPlatformVariant.only(TargetPlatform.android));
69

Dan Field's avatar
Dan Field committed
70
  testWidgets('test page transition', (WidgetTester tester) async {
71
    final Key page2Key = UniqueKey();
72
    await tester.pumpWidget(
73
      MaterialApp(
74
        home: const Material(child: Text('Page 1')),
75 76
        routes: <String, WidgetBuilder>{
          '/next': (BuildContext context) {
77
            return Material(
78 79 80
              key: page2Key,
              child: const Text('Page 2'),
            );
81
          },
82
        },
83
      ),
84 85
    );

86
    final Offset widget1InitialTopLeft = tester.getTopLeft(find.text('Page 1'));
87 88

    tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/next');
89

90
    await tester.pump();
91
    await tester.pump(const Duration(milliseconds: 150));
92

93 94
    Offset widget1TransientTopLeft = tester.getTopLeft(find.text('Page 1'));
    Offset widget2TopLeft = tester.getTopLeft(find.text('Page 2'));
95
    final RenderDecoratedBox box = tester.element(find.byKey(page2Key))
96
        .findAncestorRenderObjectOfType<RenderDecoratedBox>()!;
97

98
    // Page 1 is moving to the left.
99
    expect(widget1TransientTopLeft.dx < widget1InitialTopLeft.dx, true);
100
    // Page 1 isn't moving vertically.
101
    expect(widget1TransientTopLeft.dy == widget1InitialTopLeft.dy, true);
102
    // iOS transition is horizontal only.
103
    expect(widget1InitialTopLeft.dy == widget2TopLeft.dy, true);
104
    // Page 2 is coming in from the right.
105
    expect(widget2TopLeft.dx > widget1InitialTopLeft.dx, true);
106 107 108 109 110 111 112 113 114 115 116
    // As explained in _CupertinoEdgeShadowPainter.paint the shadow is drawn
    // as a bunch of rects. The rects are covering an area to the left of
    // where the page 2 box is and a width of 5% of the page 2 box width.
    // `paints` tests relative to the painter's given canvas
    // rather than relative to the screen so assert that the shadow starts at
    // offset.dx = 0.
    final PaintPattern paintsShadow = paints;
    for (int i = 0; i < 0.05 * 800; i += 1) {
      paintsShadow.rect(rect: Rect.fromLTWH(-i.toDouble() - 1.0 , 0.0, 1.0, 600));
    }
    expect(box, paintsShadow);
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131

    await tester.pumpAndSettle();

    // Page 2 covers page 1.
    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    tester.state<NavigatorState>(find.byType(Navigator)).pop();
    await tester.pump();
    await tester.pump(const Duration(milliseconds: 100));

    widget1TransientTopLeft = tester.getTopLeft(find.text('Page 1'));
    widget2TopLeft = tester.getTopLeft(find.text('Page 2'));

    // Page 1 is coming back from the left.
132
    expect(widget1TransientTopLeft.dx < widget1InitialTopLeft.dx, true);
133
    // Page 1 isn't moving vertically.
134
    expect(widget1TransientTopLeft.dy == widget1InitialTopLeft.dy, true);
135
    // iOS transition is horizontal only.
136
    expect(widget1InitialTopLeft.dy == widget2TopLeft.dy, true);
137
    // Page 2 is leaving towards the right.
138
    expect(widget2TopLeft.dx > widget1InitialTopLeft.dx, true);
139 140 141 142 143 144 145 146 147 148

    await tester.pumpAndSettle();

    expect(find.text('Page 1'), isOnstage);
    expect(find.text('Page 2'), findsNothing);

    widget1TransientTopLeft = tester.getTopLeft(find.text('Page 1'));

    // Page 1 is back where it started.
    expect(widget1InitialTopLeft == widget1TransientTopLeft, true);
Dan Field's avatar
Dan Field committed
149
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS, TargetPlatform.macOS }));
150

Dan Field's avatar
Dan Field committed
151
  testWidgets('test fullscreen dialog transition', (WidgetTester tester) async {
152
    await tester.pumpWidget(
Dan Field's avatar
Dan Field committed
153 154
      const MaterialApp(
        home: Material(child: Text('Page 1')),
155
      ),
156 157
    );

158
    final Offset widget1InitialTopLeft = tester.getTopLeft(find.text('Page 1'));
159

160
    tester.state<NavigatorState>(find.byType(Navigator)).push(MaterialPageRoute<void>(
161
      builder: (BuildContext context) {
162
        return const Material(child: Text('Page 2'));
163 164 165 166 167 168 169
      },
      fullscreenDialog: true,
    ));

    await tester.pump();
    await tester.pump(const Duration(milliseconds: 100));

170 171
    Offset widget1TransientTopLeft = tester.getTopLeft(find.text('Page 1'));
    Offset widget2TopLeft = tester.getTopLeft(find.text('Page 2'));
172 173 174 175

    // Page 1 doesn't move.
    expect(widget1TransientTopLeft == widget1InitialTopLeft, true);
    // Fullscreen dialogs transitions vertically only.
176
    expect(widget1InitialTopLeft.dx == widget2TopLeft.dx, true);
177
    // Page 2 is coming in from the bottom.
178
    expect(widget2TopLeft.dy > widget1InitialTopLeft.dy, true);
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195

    await tester.pumpAndSettle();

    // Page 2 covers page 1.
    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    tester.state<NavigatorState>(find.byType(Navigator)).pop();
    await tester.pump();
    await tester.pump(const Duration(milliseconds: 100));

    widget1TransientTopLeft = tester.getTopLeft(find.text('Page 1'));
    widget2TopLeft = tester.getTopLeft(find.text('Page 2'));

    // Page 1 doesn't move.
    expect(widget1TransientTopLeft == widget1InitialTopLeft, true);
    // Fullscreen dialogs transitions vertically only.
196
    expect(widget1InitialTopLeft.dx == widget2TopLeft.dx, true);
197
    // Page 2 is leaving towards the bottom.
198
    expect(widget2TopLeft.dy > widget1InitialTopLeft.dy, true);
199 200 201 202 203 204 205 206 207 208

    await tester.pumpAndSettle();

    expect(find.text('Page 1'), isOnstage);
    expect(find.text('Page 2'), findsNothing);

    widget1TransientTopLeft = tester.getTopLeft(find.text('Page 1'));

    // Page 1 is back where it started.
    expect(widget1InitialTopLeft == widget1TransientTopLeft, true);
Dan Field's avatar
Dan Field committed
209
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS, TargetPlatform.macOS }));
210 211 212

  testWidgets('test no back gesture on Android', (WidgetTester tester) async {
    await tester.pumpWidget(
213
      MaterialApp(
214
        home: const Scaffold(body: Text('Page 1')),
215 216
        routes: <String, WidgetBuilder>{
          '/next': (BuildContext context) {
217
            return const Scaffold(body: Text('Page 2'));
218 219
          },
        },
220
      ),
221 222 223 224 225 226 227 228 229
    );

    tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/next');
    await tester.pumpAndSettle();

    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    // Drag from left edge to invoke the gesture.
230
    final TestGesture gesture = await tester.startGesture(const Offset(5.0, 100.0));
231
    await gesture.moveBy(const Offset(400.0, 0.0));
232
    await tester.pump();
233 234 235 236 237

    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    // Page 2 didn't move
238
    expect(tester.getTopLeft(find.text('Page 2')), Offset.zero);
Dan Field's avatar
Dan Field committed
239
  }, variant: TargetPlatformVariant.only(TargetPlatform.android));
240

Dan Field's avatar
Dan Field committed
241
  testWidgets('test back gesture', (WidgetTester tester) async {
242
    await tester.pumpWidget(
243
      MaterialApp(
244
        home: const Scaffold(body: Text('Page 1')),
245 246
        routes: <String, WidgetBuilder>{
          '/next': (BuildContext context) {
247
            return const Scaffold(body: Text('Page 2'));
248 249
          },
        },
250
      ),
251 252 253 254 255 256 257 258 259
    );

    tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/next');
    await tester.pumpAndSettle();

    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    // Drag from left edge to invoke the gesture.
260
    final TestGesture gesture = await tester.startGesture(const Offset(5.0, 100.0));
261
    await gesture.moveBy(const Offset(400.0, 0.0));
262
    await tester.pump();
263 264 265 266

    // Page 1 is now visible.
    expect(find.text('Page 1'), isOnstage);
    expect(find.text('Page 2'), isOnstage);
267 268

    // The route widget position needs to track the finger position very exactly.
269
    expect(tester.getTopLeft(find.text('Page 2')), const Offset(400.0, 0.0));
270 271 272 273

    await gesture.moveBy(const Offset(-200.0, 0.0));
    await tester.pump();

274
    expect(tester.getTopLeft(find.text('Page 2')), const Offset(200.0, 0.0));
275 276 277 278

    await gesture.moveBy(const Offset(-100.0, 200.0));
    await tester.pump();

279
    expect(tester.getTopLeft(find.text('Page 2')), const Offset(100.0, 0.0));
Dan Field's avatar
Dan Field committed
280
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS, TargetPlatform.macOS }));
281

282 283
  testWidgets('back gesture while OS changes', (WidgetTester tester) async {
    final Map<String, WidgetBuilder> routes = <String, WidgetBuilder>{
284
      '/': (BuildContext context) => Material(
285
        child: TextButton(
286
          child: const Text('PUSH'),
287
          onPressed: () { Navigator.of(context).pushNamed('/b'); },
288 289
        ),
      ),
290
      '/b': (BuildContext context) => const Text('HELLO'),
291 292
    };
    await tester.pumpWidget(
293 294
      MaterialApp(
        theme: ThemeData(platform: TargetPlatform.iOS),
295 296 297 298
        routes: routes,
      ),
    );
    await tester.tap(find.text('PUSH'));
299
    expect(await tester.pumpAndSettle(const Duration(minutes: 1)), 2);
300 301 302 303 304 305 306 307 308 309 310 311 312 313
    expect(find.text('PUSH'), findsNothing);
    expect(find.text('HELLO'), findsOneWidget);
    final Offset helloPosition1 = tester.getCenter(find.text('HELLO'));
    final TestGesture gesture = await tester.startGesture(const Offset(2.5, 300.0));
    await tester.pump(const Duration(milliseconds: 20));
    await gesture.moveBy(const Offset(100.0, 0.0));
    expect(find.text('PUSH'), findsNothing);
    expect(find.text('HELLO'), findsOneWidget);
    await tester.pump(const Duration(milliseconds: 20));
    expect(find.text('PUSH'), findsOneWidget);
    expect(find.text('HELLO'), findsOneWidget);
    final Offset helloPosition2 = tester.getCenter(find.text('HELLO'));
    expect(helloPosition1.dx, lessThan(helloPosition2.dx));
    expect(helloPosition1.dy, helloPosition2.dy);
314
    expect(Theme.of(tester.element(find.text('HELLO'))).platform, TargetPlatform.iOS);
315
    await tester.pumpWidget(
316 317
      MaterialApp(
        theme: ThemeData(platform: TargetPlatform.android),
318 319 320 321 322 323 324 325 326 327 328 329
        routes: routes,
      ),
    );
    // Now we have to let the theme animation run through.
    // This takes three frames (including the first one above):
    //  1. Start the Theme animation. It's at t=0 so everything else is identical.
    //  2. Start any animations that are informed by the Theme, for example, the
    //     DefaultTextStyle, on the first frame that the theme is not at t=0. In
    //     this case, it's at t=1.0 of the theme animation, so this is also the
    //     frame in which the theme animation ends.
    //  3. End all the other animations.
    expect(await tester.pumpAndSettle(const Duration(minutes: 1)), 2);
330
    expect(Theme.of(tester.element(find.text('HELLO'))).platform, TargetPlatform.android);
331 332 333 334 335 336 337 338 339 340 341 342 343
    final Offset helloPosition3 = tester.getCenter(find.text('HELLO'));
    expect(helloPosition3, helloPosition2);
    expect(find.text('PUSH'), findsOneWidget);
    expect(find.text('HELLO'), findsOneWidget);
    await gesture.moveBy(const Offset(100.0, 0.0));
    await tester.pump(const Duration(milliseconds: 20));
    expect(find.text('PUSH'), findsOneWidget);
    expect(find.text('HELLO'), findsOneWidget);
    final Offset helloPosition4 = tester.getCenter(find.text('HELLO'));
    expect(helloPosition3.dx, lessThan(helloPosition4.dx));
    expect(helloPosition3.dy, helloPosition4.dy);
    await gesture.moveBy(const Offset(500.0, 0.0));
    await gesture.up();
344
    expect(await tester.pumpAndSettle(const Duration(minutes: 1)), 3);
345 346
    expect(find.text('PUSH'), findsOneWidget);
    expect(find.text('HELLO'), findsNothing);
347 348

    await tester.pumpWidget(
349
      MaterialApp(
Dan Field's avatar
Dan Field committed
350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
        theme: ThemeData(platform: TargetPlatform.macOS),
        routes: routes,
      ),
    );
    await tester.tap(find.text('PUSH'));
    expect(await tester.pumpAndSettle(const Duration(minutes: 1)), 2);
    expect(find.text('PUSH'), findsNothing);
    expect(find.text('HELLO'), findsOneWidget);
    final Offset helloPosition5 = tester.getCenter(find.text('HELLO'));
    await gesture.down(const Offset(2.5, 300.0));
    await tester.pump(const Duration(milliseconds: 20));
    await gesture.moveBy(const Offset(100.0, 0.0));
    expect(find.text('PUSH'), findsNothing);
    expect(find.text('HELLO'), findsOneWidget);
    await tester.pump(const Duration(milliseconds: 20));
    expect(find.text('PUSH'), findsOneWidget);
    expect(find.text('HELLO'), findsOneWidget);
    final Offset helloPosition6 = tester.getCenter(find.text('HELLO'));
    expect(helloPosition5.dx, lessThan(helloPosition6.dx));
    expect(helloPosition5.dy, helloPosition6.dy);
370
    expect(Theme.of(tester.element(find.text('HELLO'))).platform, TargetPlatform.macOS);
Dan Field's avatar
Dan Field committed
371 372 373 374 375 376
  });

  testWidgets('test no back gesture on fullscreen dialogs', (WidgetTester tester) async {
    await tester.pumpWidget(
      const MaterialApp(
        home: Scaffold(body: Text('Page 1')),
377
      ),
378 379
    );

380
    tester.state<NavigatorState>(find.byType(Navigator)).push(MaterialPageRoute<void>(
381
      builder: (BuildContext context) {
382
        return const Scaffold(body: Text('Page 2'));
383 384 385 386 387 388 389 390 391
      },
      fullscreenDialog: true,
    ));
    await tester.pumpAndSettle();

    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    // Drag from left edge to invoke the gesture.
392
    final TestGesture gesture = await tester.startGesture(const Offset(5.0, 100.0));
393
    await gesture.moveBy(const Offset(400.0, 0.0));
394
    await tester.pump();
395 396 397 398 399

    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    // Page 2 didn't move
400
    expect(tester.getTopLeft(find.text('Page 2')), Offset.zero);
Dan Field's avatar
Dan Field committed
401
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
402 403 404

  testWidgets('test adaptable transitions switch during execution', (WidgetTester tester) async {
    await tester.pumpWidget(
405
      MaterialApp(
406 407 408 409 410 411 412 413
        theme: ThemeData(
          platform: TargetPlatform.android,
          pageTransitionsTheme: const PageTransitionsTheme(
            builders: <TargetPlatform, PageTransitionsBuilder>{
              TargetPlatform.android: FadeUpwardsPageTransitionsBuilder(),
            },
          ),
        ),
414
        home: const Material(child: Text('Page 1')),
415 416
        routes: <String, WidgetBuilder>{
          '/next': (BuildContext context) {
417
            return const Material(child: Text('Page 2'));
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 443 444 445 446
    );

    final Offset widget1InitialTopLeft = tester.getTopLeft(find.text('Page 1'));

    tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/next');
    await tester.pump();
    await tester.pump(const Duration(milliseconds: 100));

    Offset widget2TopLeft = tester.getTopLeft(find.text('Page 2'));
    final Size widget2Size = tester.getSize(find.text('Page 2'));

    // Android transition is vertical only.
    expect(widget1InitialTopLeft.dx == widget2TopLeft.dx, true);
    // Page 1 is above page 2 mid-transition.
    expect(widget1InitialTopLeft.dy < widget2TopLeft.dy, true);
    // Animation begins from the top of the page.
    expect(widget2TopLeft.dy < widget2Size.height, true);

    await tester.pump(const Duration(milliseconds: 300));

    // Page 2 covers page 1.
    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    // Re-pump the same app but with iOS instead of Android.
    await tester.pumpWidget(
447
      MaterialApp(
448
        home: const Material(child: Text('Page 1')),
449 450
        routes: <String, WidgetBuilder>{
          '/next': (BuildContext context) {
451
            return const Material(child: Text('Page 2'));
452 453
          },
        },
454
      ),
455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
    );

    tester.state<NavigatorState>(find.byType(Navigator)).pop();
    await tester.pump();
    await tester.pump(const Duration(milliseconds: 100));

    Offset widget1TransientTopLeft = tester.getTopLeft(find.text('Page 1'));
    widget2TopLeft = tester.getTopLeft(find.text('Page 2'));

    // Page 1 is coming back from the left.
    expect(widget1TransientTopLeft.dx < widget1InitialTopLeft.dx, true);
    // Page 1 isn't moving vertically.
    expect(widget1TransientTopLeft.dy == widget1InitialTopLeft.dy, true);
    // iOS transition is horizontal only.
    expect(widget1InitialTopLeft.dy == widget2TopLeft.dy, true);
    // Page 2 is leaving towards the right.
    expect(widget2TopLeft.dx > widget1InitialTopLeft.dx, true);

    await tester.pump(const Duration(milliseconds: 300));

    expect(find.text('Page 1'), isOnstage);
    expect(find.text('Page 2'), findsNothing);

    widget1TransientTopLeft = tester.getTopLeft(find.text('Page 1'));

    // Page 1 is back where it started.
    expect(widget1InitialTopLeft == widget1TransientTopLeft, true);
Dan Field's avatar
Dan Field committed
482
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
483

Dan Field's avatar
Dan Field committed
484
  testWidgets('test edge swipe then drop back at starting point works', (WidgetTester tester) async {
485 486 487 488 489 490 491 492
    await tester.pumpWidget(
      MaterialApp(
        onGenerateRoute: (RouteSettings settings) {
          return MaterialPageRoute<void>(
            settings: settings,
            builder: (BuildContext context) {
              final String pageNumber = settings.name == '/' ? '1' : '2';
              return Center(child: Text('Page $pageNumber'));
493
            },
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516
          );
        },
      ),
    );

    tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/next');

    await tester.pump();
    await tester.pump(const Duration(seconds: 1));

    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    final TestGesture gesture = await tester.startGesture(const Offset(5, 200));
    await gesture.moveBy(const Offset(300, 0));
    await tester.pump();
    // Bring it exactly back such that there's nothing to animate when releasing.
    await gesture.moveBy(const Offset(-300, 0));
    await gesture.up();
    await tester.pump();

    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);
Dan Field's avatar
Dan Field committed
517
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
518

Dan Field's avatar
Dan Field committed
519
  testWidgets('test edge swipe then drop back at ending point works', (WidgetTester tester) async {
520 521 522 523 524 525 526 527
    await tester.pumpWidget(
      MaterialApp(
        onGenerateRoute: (RouteSettings settings) {
          return MaterialPageRoute<void>(
            settings: settings,
            builder: (BuildContext context) {
              final String pageNumber = settings.name == '/' ? '1' : '2';
              return Center(child: Text('Page $pageNumber'));
528
            },
529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549
          );
        },
      ),
    );

    tester.state<NavigatorState>(find.byType(Navigator)).pushNamed('/next');

    await tester.pump();
    await tester.pump(const Duration(seconds: 1));

    expect(find.text('Page 1'), findsNothing);
    expect(find.text('Page 2'), isOnstage);

    final TestGesture gesture = await tester.startGesture(const Offset(5, 200));
    // The width of the page.
    await gesture.moveBy(const Offset(800, 0));
    await gesture.up();
    await tester.pump();

    expect(find.text('Page 1'), isOnstage);
    expect(find.text('Page 2'), findsNothing);
Dan Field's avatar
Dan Field committed
550
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
551 552 553 554 555 556 557 558 559 560

  testWidgets('Back swipe dismiss interrupted by route push', (WidgetTester tester) async {
    // Regression test for https://github.com/flutter/flutter/issues/28728
    final GlobalKey scaffoldKey = GlobalKey();

    await tester.pumpWidget(
      MaterialApp(
        home: Scaffold(
          key: scaffoldKey,
          body: Center(
561
            child: ElevatedButton(
562
              onPressed: () {
563
                Navigator.push<void>(scaffoldKey.currentContext!, MaterialPageRoute<void>(
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 597 598 599 600 601 602 603 604 605 606
                  builder: (BuildContext context) {
                    return const Scaffold(
                      body: Center(child: Text('route')),
                    );
                  },
                ));
              },
              child: const Text('push'),
            ),
          ),
        ),
      ),
    );

    // Check the basic iOS back-swipe dismiss transition. Dragging the pushed
    // route halfway across the screen will trigger the iOS dismiss animation

    await tester.tap(find.text('push'));
    await tester.pumpAndSettle();
    expect(find.text('route'), findsOneWidget);
    expect(find.text('push'), findsNothing);

    TestGesture gesture = await tester.startGesture(const Offset(5, 300));
    await gesture.moveBy(const Offset(400, 0));
    await gesture.up();
    await tester.pump();
    expect( // The 'route' route has been dragged to the right, halfway across the screen
      tester.getTopLeft(find.ancestor(of: find.text('route'), matching: find.byType(Scaffold))),
      const Offset(400, 0),
    );
    expect( // The 'push' route is sliding in from the left.
      tester.getTopLeft(find.ancestor(of: find.text('push'), matching: find.byType(Scaffold))).dx,
      lessThan(0),
    );
    await tester.pumpAndSettle();
    expect(find.text('push'), findsOneWidget);
    expect(
      tester.getTopLeft(find.ancestor(of: find.text('push'), matching: find.byType(Scaffold))),
      Offset.zero,
    );
    expect(find.text('route'), findsNothing);


607 608 609
    // Run the dismiss animation 60%, which exposes the route "push" button,
    // and then press the button. A drag dropped animation is 400ms when dropped
    // exactly halfway. It follows a curve that is very steep initially.
610 611 612 613 614 615 616

    await tester.tap(find.text('push'));
    await tester.pumpAndSettle();
    expect(find.text('route'), findsOneWidget);
    expect(find.text('push'), findsNothing);

    gesture = await tester.startGesture(const Offset(5, 300));
617
    await gesture.moveBy(const Offset(400, 0)); // Drag halfway.
618
    await gesture.up();
619 620 621 622 623 624 625 626 627 628 629
    await tester.pump(); // Trigger the dropped snapping animation.
    expect(
      tester.getTopLeft(find.ancestor(of: find.text('route'), matching: find.byType(Scaffold))),
      const Offset(400, 0),
    );
    // Let the dismissing snapping animation go 60%.
    await tester.pump(const Duration(milliseconds: 240));
    expect(
      tester.getTopLeft(find.ancestor(of: find.text('route'), matching: find.byType(Scaffold))).dx,
      moreOrLessEquals(798, epsilon: 1),
    );
630 631 632 633

    // Use the navigator to push a route instead of tapping the 'push' button.
    // The topmost route (the one that's animating away), ignores input while
    // the pop is underway because route.navigator.userGestureInProgress.
634
    Navigator.push<void>(scaffoldKey.currentContext!, MaterialPageRoute<void>(
635 636 637 638 639 640 641
      builder: (BuildContext context) {
        return const Scaffold(
          body: Center(child: Text('route')),
        );
      },
    ));

642 643 644
    await tester.pumpAndSettle();
    expect(find.text('route'), findsOneWidget);
    expect(find.text('push'), findsNothing);
Dan Field's avatar
Dan Field committed
645
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
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 671

  testWidgets('During back swipe the route ignores input', (WidgetTester tester) async {
    // Regression test for https://github.com/flutter/flutter/issues/39989

    final GlobalKey homeScaffoldKey = GlobalKey();
    final GlobalKey pageScaffoldKey = GlobalKey();
    int homeTapCount = 0;
    int pageTapCount = 0;

    await tester.pumpWidget(
      MaterialApp(
        home: Scaffold(
          key: homeScaffoldKey,
          body: GestureDetector(
            onTap: () {
              homeTapCount += 1;
            }
          ),
        ),
      ),
    );

    await tester.tap(find.byKey(homeScaffoldKey));
    expect(homeTapCount, 1);
    expect(pageTapCount, 0);

672
    Navigator.push<void>(homeScaffoldKey.currentContext!, MaterialPageRoute<void>(
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
      builder: (BuildContext context) {
        return Scaffold(
          key: pageScaffoldKey,
          appBar: AppBar(title: const Text('Page')),
          body: Padding(
            padding: const EdgeInsets.all(16),
            child: GestureDetector(
              onTap: () {
                pageTapCount += 1;
              }
            ),
          ),
        );
      },
    ));

    await tester.pumpAndSettle();
    await tester.tap(find.byKey(pageScaffoldKey));
    expect(homeTapCount, 1);
    expect(pageTapCount, 1);

    // Start the basic iOS back-swipe dismiss transition. Drag the pushed
    // "page" route halfway across the screen. The underlying "home" will
    // start sliding in from the left.

    final TestGesture gesture = await tester.startGesture(const Offset(5, 300));
    await gesture.moveBy(const Offset(400, 0));
    await tester.pump();
    expect(tester.getTopLeft(find.byKey(pageScaffoldKey)), const Offset(400, 0));
    expect(tester.getTopLeft(find.byKey(homeScaffoldKey)).dx, lessThan(0));

    // Tapping on the "page" route doesn't trigger the GestureDetector because
    // it's being dragged.
706
    await tester.tap(find.byKey(pageScaffoldKey), warnIfMissed: false);
707 708 709 710
    expect(homeTapCount, 1);
    expect(pageTapCount, 1);

    // Tapping the "page" route's back button doesn't do anything either.
711
    await tester.tap(find.byTooltip('Back'), warnIfMissed: false);
712 713 714
    await tester.pumpAndSettle();
    expect(tester.getTopLeft(find.byKey(pageScaffoldKey)), const Offset(400, 0));
    expect(tester.getTopLeft(find.byKey(homeScaffoldKey)).dx, lessThan(0));
Dan Field's avatar
Dan Field committed
715
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
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

  testWidgets('After a pop caused by a back-swipe, input reaches the exposed route', (WidgetTester tester) async {
    // Regression test for https://github.com/flutter/flutter/issues/41024

    final GlobalKey homeScaffoldKey = GlobalKey();
    final GlobalKey pageScaffoldKey = GlobalKey();
    int homeTapCount = 0;
    int pageTapCount = 0;

    await tester.pumpWidget(
      MaterialApp(
        home: Scaffold(
          key: homeScaffoldKey,
          body: GestureDetector(
            onTap: () {
              homeTapCount += 1;
            }
          ),
        ),
      ),
    );

    await tester.tap(find.byKey(homeScaffoldKey));
    expect(homeTapCount, 1);
    expect(pageTapCount, 0);

742
    final ValueNotifier<bool> notifier = Navigator.of(homeScaffoldKey.currentContext!).userGestureInProgressNotifier;
743 744
    expect(notifier.value, false);

745
    Navigator.push<void>(homeScaffoldKey.currentContext!, MaterialPageRoute<void>(
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 775 776 777 778 779 780 781 782 783 784 785
      builder: (BuildContext context) {
        return Scaffold(
          key: pageScaffoldKey,
          appBar: AppBar(title: const Text('Page')),
          body: Padding(
            padding: const EdgeInsets.all(16),
            child: GestureDetector(
              onTap: () {
                pageTapCount += 1;
              }
            ),
          ),
        );
      },
    ));

    await tester.pumpAndSettle();
    await tester.tap(find.byKey(pageScaffoldKey));
    expect(homeTapCount, 1);
    expect(pageTapCount, 1);

    // Trigger the basic iOS back-swipe dismiss transition. Drag the pushed
    // "page" route more than halfway across the screen and then release it.

    final TestGesture gesture = await tester.startGesture(const Offset(5, 300));
    await gesture.moveBy(const Offset(500, 0));
    await tester.pump();
    expect(tester.getTopLeft(find.byKey(pageScaffoldKey)), const Offset(500, 0));
    expect(tester.getTopLeft(find.byKey(homeScaffoldKey)).dx, lessThan(0));
    expect(notifier.value, true);
    await gesture.up();
    await tester.pumpAndSettle();
    expect(notifier.value, false);
    expect(find.byKey(pageScaffoldKey), findsNothing);

    // The back-swipe dismiss pop transition has finished and input on the
    // home page still works.
    await tester.tap(find.byKey(homeScaffoldKey));
    expect(homeTapCount, 2);
    expect(pageTapCount, 1);
Dan Field's avatar
Dan Field committed
786
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
787

Dan Field's avatar
Dan Field committed
788
  testWidgets('A MaterialPageRoute should slide out with CupertinoPageTransition when a compatible PageRoute is pushed on top of it', (WidgetTester tester) async {
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813
    // Regression test for https://github.com/flutter/flutter/issues/44864.

    await tester.pumpWidget(
      MaterialApp(
        theme: ThemeData(platform: TargetPlatform.iOS),
        home: Scaffold(
          appBar: AppBar(title: const Text('Title')),
        ),
      ),
    );

    final Offset titleInitialTopLeft = tester.getTopLeft(find.text('Title'));

    tester.state<NavigatorState>(find.byType(Navigator)).push<void>(
      CupertinoPageRoute<void>(builder: (BuildContext context) => const Placeholder()),
    );

    await tester.pump();
    await tester.pump(const Duration(milliseconds: 150));

    final Offset titleTransientTopLeft = tester.getTopLeft(find.text('Title'));

    // Title of the first route slides to the left.
    expect(titleInitialTopLeft.dy, equals(titleTransientTopLeft.dy));
    expect(titleInitialTopLeft.dx, greaterThan(titleTransientTopLeft.dx));
Dan Field's avatar
Dan Field committed
814
  }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
815 816 817 818 819

  testWidgets('MaterialPage works', (WidgetTester tester) async {
    final LocalKey pageKey = UniqueKey();
    final TransitionDetector detector = TransitionDetector();
    List<Page<void>> myPages = <Page<void>>[
820
      MaterialPage<void>(key: pageKey, child: const Text('first')),
821 822 823 824
    ];
    await tester.pumpWidget(
      buildNavigator(
        pages: myPages,
825 826 827 828
        onPopPage: (Route<dynamic> route, dynamic result) {
          assert(false); // The test should never execute this.
          return true;
        },
829 830 831 832 833 834 835 836
        transitionDelegate: detector,
      )
    );

    expect(detector.hasTransition, isFalse);
    expect(find.text('first'), findsOneWidget);

    myPages = <Page<void>>[
837
      MaterialPage<void>(key: pageKey, child: const Text('second')),
838 839 840 841 842
    ];

    await tester.pumpWidget(
      buildNavigator(
        pages: myPages,
843 844 845 846
        onPopPage: (Route<dynamic> route, dynamic result) {
          assert(false); // The test should never execute this.
          return true;
        },
847 848 849 850 851 852 853 854 855 856 857 858 859 860 861
        transitionDelegate: detector,
      )
    );
    // There should be no transition because the page has the same key.
    expect(detector.hasTransition, isFalse);
    // The content does update.
    expect(find.text('first'), findsNothing);
    expect(find.text('second'), findsOneWidget);
  });

  testWidgets('MaterialPage can toggle MaintainState', (WidgetTester tester) async {
    final LocalKey pageKeyOne = UniqueKey();
    final LocalKey pageKeyTwo = UniqueKey();
    final TransitionDetector detector = TransitionDetector();
    List<Page<void>> myPages = <Page<void>>[
862 863
      MaterialPage<void>(key: pageKeyOne, maintainState: false, child: const Text('first')),
      MaterialPage<void>(key: pageKeyTwo, child: const Text('second')),
864 865 866 867
    ];
    await tester.pumpWidget(
      buildNavigator(
        pages: myPages,
868 869 870 871
        onPopPage: (Route<dynamic> route, dynamic result) {
          assert(false); // The test should never execute this.
          return true;
        },
872 873 874 875 876 877 878 879 880 881
        transitionDelegate: detector,
      )
    );

    expect(detector.hasTransition, isFalse);
    // Page one does not maintain state.
    expect(find.text('first', skipOffstage: false), findsNothing);
    expect(find.text('second'), findsOneWidget);

    myPages = <Page<void>>[
882 883
      MaterialPage<void>(key: pageKeyOne, maintainState: true, child: const Text('first')),
      MaterialPage<void>(key: pageKeyTwo, child: const Text('second')),
884 885 886 887 888
    ];

    await tester.pumpWidget(
      buildNavigator(
        pages: myPages,
889 890 891 892
        onPopPage: (Route<dynamic> route, dynamic result) {
          assert(false); // The test should never execute this.
          return true;
        },
893 894 895 896 897 898 899 900 901 902
        transitionDelegate: detector,
      )
    );
    // There should be no transition because the page has the same key.
    expect(detector.hasTransition, isFalse);
    // Page one sets the maintain state to be true, its widget tree should be
    // built.
    expect(find.text('first', skipOffstage: false), findsOneWidget);
    expect(find.text('second'), findsOneWidget);
  });
903 904 905 906 907 908 909

  testWidgets('MaterialPage does not lose its state when transitioning out', (WidgetTester tester) async {
    final GlobalKey<NavigatorState> navigator = GlobalKey<NavigatorState>();
    await tester.pumpWidget(KeepsStateTestWidget(navigatorKey: navigator));
    expect(find.text('subpage'), findsOneWidget);
    expect(find.text('home'), findsNothing);

910
    navigator.currentState!.pop();
911 912 913 914 915
    await tester.pump();

    expect(find.text('subpage'), findsOneWidget);
    expect(find.text('home'), findsOneWidget);
  });
916 917 918 919 920 921
}

class TransitionDetector extends DefaultTransitionDelegate<void> {
  bool hasTransition = false;
  @override
  Iterable<RouteTransitionRecord> resolve({
922 923 924
    required List<RouteTransitionRecord> newPageRouteHistory,
    required Map<RouteTransitionRecord?, RouteTransitionRecord> locationToExitingPageRoute,
    required Map<RouteTransitionRecord?, List<RouteTransitionRecord>> pageRouteToPagelessRoutes
925 926 927 928 929 930 931 932 933 934 935
  }) {
    hasTransition = true;
    return super.resolve(
      newPageRouteHistory: newPageRouteHistory,
      locationToExitingPageRoute: locationToExitingPageRoute,
      pageRouteToPagelessRoutes: pageRouteToPagelessRoutes
    );
  }
}

Widget buildNavigator({
936 937 938 939
  required List<Page<dynamic>> pages,
  required PopPageCallback onPopPage,
  GlobalKey<NavigatorState>? key,
  TransitionDelegate<dynamic>? transitionDelegate
940 941
}) {
  return MediaQuery(
942
    data: MediaQueryData.fromWindow(WidgetsBinding.instance!.window),
943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959
    child: Localizations(
      locale: const Locale('en', 'US'),
      delegates: const <LocalizationsDelegate<dynamic>>[
        DefaultMaterialLocalizations.delegate,
        DefaultWidgetsLocalizations.delegate
      ],
      child: Directionality(
        textDirection: TextDirection.ltr,
        child: Navigator(
          key: key,
          pages: pages,
          onPopPage: onPopPage,
          transitionDelegate: transitionDelegate ?? const DefaultTransitionDelegate<dynamic>(),
        ),
      ),
    ),
  );
960
}
961 962

class KeepsStateTestWidget extends StatefulWidget {
963
  const KeepsStateTestWidget({Key? key, this.navigatorKey}) : super(key: key);
964

965
  final Key? navigatorKey;
966 967 968 969 970 971

  @override
  State<KeepsStateTestWidget> createState() => _KeepsStateTestWidgetState();
}

class _KeepsStateTestWidgetState extends State<KeepsStateTestWidget> {
972
  String? _subpage = 'subpage';
973 974 975 976 977 978 979 980

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Navigator(
        key: widget.navigatorKey,
        pages: <Page<void>>[
          const MaterialPage<void>(child: Text('home')),
981
          if (_subpage != null) MaterialPage<void>(child: Text(_subpage!)),
982 983 984 985 986 987 988 989 990 991 992 993 994 995
        ],
        onPopPage: (Route<dynamic> route, dynamic result) {
          if (!route.didPop(result)) {
            return false;
          }
          setState(() {
            _subpage = null;
          });
          return true;
        },
      ),
    );
  }
}