refresh_test.dart 39.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14
// Copyright 2018 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.
import 'dart:async';

import 'package:flutter/cupertino.dart';
import 'package:flutter/foundation.dart';
import 'package:flutter/services.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:mockito/mockito.dart';

void main() {
  MockHelper mockHelper;

15
  /// Completer that holds the future given to the CupertinoSliverRefreshControl.
16 17
  Completer<void> refreshCompleter;

18
  /// The widget that the indicator builder given to the CupertinoSliverRefreshControl
19 20 21
  /// returns.
  Widget refreshIndicator;

22 23 24 25 26 27 28 29 30 31 32
  /// These two Functions are required to avoid tearing off of the MockHelper object,
  /// which is not supported when using Dart 2 runtime semantics.
  final Function builder = (BuildContext context, RefreshIndicatorMode refreshState,
          double pulledExtent,
          double refreshTriggerPullDistance,
          double refreshIndicatorExtent) =>
      mockHelper.builder(context, refreshState, pulledExtent, refreshTriggerPullDistance,
          refreshIndicatorExtent);

  final Function onRefresh = () => mockHelper.refreshTask();

33
  setUp(() {
34 35 36
    mockHelper = MockHelper();
    refreshCompleter = Completer<void>.sync();
    refreshIndicator = Container();
37

38
    when(mockHelper.builder(
39
            any, any, any, any, any))
40 41 42 43 44 45
        .thenAnswer((Invocation i) {
      final RefreshIndicatorMode refreshState = i.positionalArguments[1];
      final double pulledExtent = i.positionalArguments[2];
      final double refreshTriggerPullDistance = i.positionalArguments[3];
      final double refreshIndicatorExtent = i.positionalArguments[4];
      if (refreshState == RefreshIndicatorMode.inactive) {
46
        throw TestFailure(
47 48
          'RefreshControlIndicatorBuilder should never be called with the '
          "inactive state because there's nothing to build in that case"
49
        );
50 51
      }
      if (pulledExtent < 0.0) {
52
        throw TestFailure('The pulledExtent should never be less than 0.0');
53 54
      }
      if (refreshTriggerPullDistance < 0.0) {
55
        throw TestFailure('The refreshTriggerPullDistance should never be less than 0.0');
56 57
      }
      if (refreshIndicatorExtent < 0.0) {
58
        throw TestFailure('The refreshIndicatorExtent should never be less than 0.0');
59 60 61
      }
      return refreshIndicator;
    });
62
    when(mockHelper.refreshTask()).thenAnswer((_) => refreshCompleter.future);
63 64
  });

65
  int testListLength = 10;
66
  SliverList buildAListOfStuff() {
67 68
    return SliverList(
      delegate: SliverChildBuilderDelegate(
69
        (BuildContext context, int index) {
70
          return Container(
71
            height: 200.0,
72
            child: Center(child: Text(index.toString())),
73 74
          );
        },
75
        childCount: testListLength,
76 77 78 79
      ),
    );
  }

80
  final Function uiTestGroup = () {
81 82 83 84
    testWidgets("doesn't invoke anything without user interaction", (WidgetTester tester) async {
      debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

      await tester.pumpWidget(
85
        Directionality(
86
          textDirection: TextDirection.ltr,
87
          child: CustomScrollView(
88
            slivers: <Widget>[
89
              CupertinoSliverRefreshControl(
90
                builder: builder,
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

      verifyNoMoreInteractions(mockHelper);

      expect(
        tester.getTopLeft(find.widgetWithText(Container, '0')),
        const Offset(0.0, 0.0),
      );

      debugDefaultTargetPlatformOverride = null;
    });

    testWidgets('calls the indicator builder when starting to overscroll', (WidgetTester tester) async {
      debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

      await tester.pumpWidget(
112
        Directionality(
113
          textDirection: TextDirection.ltr,
114
          child: CustomScrollView(
115
            slivers: <Widget>[
116
              CupertinoSliverRefreshControl(
117
                builder: builder,
118 119 120 121 122 123 124 125 126 127 128
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

      // Drag down but not enough to trigger the refresh.
      await tester.drag(find.text('0'), const Offset(0.0, 50.0));
      await tester.pump();

129
      // The function is referenced once while passing into CupertinoSliverRefreshControl
130
      // and is called.
131
      verify(mockHelper.builder(
132
        any,
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
        RefreshIndicatorMode.drag,
        50.0,
        100.0, // Default value.
        60.0, // Default value.
      ));
      verifyNoMoreInteractions(mockHelper);

      expect(
        tester.getTopLeft(find.widgetWithText(Container, '0')),
        const Offset(0.0, 50.0),
      );

      debugDefaultTargetPlatformOverride = null;
    });

    testWidgets(
      "don't call the builder if overscroll doesn't move slivers like on Android",
      (WidgetTester tester) async {
        debugDefaultTargetPlatformOverride = TargetPlatform.android;

        await tester.pumpWidget(
154
          Directionality(
155
            textDirection: TextDirection.ltr,
156
            child: CustomScrollView(
157
              slivers: <Widget>[
158
                CupertinoSliverRefreshControl(
159
                  builder: builder,
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

        // Drag down but not enough to trigger the refresh.
        await tester.drag(find.text('0'), const Offset(0.0, 50.0));
        await tester.pump();

        verifyNoMoreInteractions(mockHelper);

        expect(
          tester.getTopLeft(find.widgetWithText(Container, '0')),
          const Offset(0.0, 0.0),
        );

        debugDefaultTargetPlatformOverride = null;
      },
    );

    testWidgets('let the builder update as cancelled drag scrolls away', (WidgetTester tester) async {
      debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

      await tester.pumpWidget(
186
        Directionality(
187
          textDirection: TextDirection.ltr,
188
          child: CustomScrollView(
189
            slivers: <Widget>[
190
              CupertinoSliverRefreshControl(
191
                builder: builder,
192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

      // Drag down but not enough to trigger the refresh.
      await tester.drag(find.text('0'), const Offset(0.0, 50.0));
      await tester.pump();
      await tester.pump(const Duration(milliseconds: 20));
      await tester.pump(const Duration(milliseconds: 20));
      await tester.pump(const Duration(seconds: 3));

      verifyInOrder(<void>[
        mockHelper.builder(
208
          any,
209 210 211 212 213 214
          RefreshIndicatorMode.drag,
          50.0,
          100.0, // Default value.
          60.0, // Default value.
        ),
        mockHelper.builder(
215
          any,
216
          RefreshIndicatorMode.drag,
217
          argThat(moreOrLessEquals(48.36801747187993)),
218 219 220 221
          100.0, // Default value.
          60.0, // Default value.
        ),
        mockHelper.builder(
222
          any,
223
          RefreshIndicatorMode.drag,
224
          argThat(moreOrLessEquals(44.63031931875867)),
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
          100.0, // Default value.
          60.0, // Default value.
        ),
        // The builder isn't called again when the sliver completely goes away.
      ]);
      verifyNoMoreInteractions(mockHelper);

      expect(
        tester.getTopLeft(find.widgetWithText(Container, '0')),
        const Offset(0.0, 0.0),
      );

      debugDefaultTargetPlatformOverride = null;
    });

    testWidgets('drag past threshold triggers refresh task', (WidgetTester tester) async {
      debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

      final List<MethodCall> platformCallLog = <MethodCall>[];

      SystemChannels.platform.setMockMethodCallHandler((MethodCall methodCall) async {
        platformCallLog.add(methodCall);
      });

      await tester.pumpWidget(
250
        Directionality(
251
          textDirection: TextDirection.ltr,
252
          child: CustomScrollView(
253
            slivers: <Widget>[
254
              CupertinoSliverRefreshControl(
255 256
                builder: builder,
                onRefresh: onRefresh,
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

      final TestGesture gesture = await tester.startGesture(const Offset(0.0, 0.0));
      await gesture.moveBy(const Offset(0.0, 99.0));
      await tester.pump();
      await gesture.moveBy(const Offset(0.0, -30.0));
      await tester.pump();
      await gesture.moveBy(const Offset(0.0, 50.0));
      await tester.pump();

      verifyInOrder(<void>[
        mockHelper.builder(
274
          any,
275 276 277 278 279 280
          RefreshIndicatorMode.drag,
          99.0,
          100.0, // Default value.
          60.0, // Default value.
        ),
        mockHelper.builder(
281
          any,
282
          RefreshIndicatorMode.drag,
283
          argThat(moreOrLessEquals(86.78169)),
284 285 286 287
          100.0, // Default value.
          60.0, // Default value.
        ),
        mockHelper.builder(
288
          any,
289
          RefreshIndicatorMode.armed,
290
          argThat(moreOrLessEquals(105.80452021305739)),
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
          100.0, // Default value.
          60.0, // Default value.
        ),
        // The refresh callback is triggered after the frame.
        mockHelper.refreshTask(),
      ]);
      verifyNoMoreInteractions(mockHelper);

      expect(
        platformCallLog.last,
        isMethodCall('HapticFeedback.vibrate', arguments: 'HapticFeedbackType.mediumImpact'),
      );
      debugDefaultTargetPlatformOverride = null;
    });

    testWidgets(
      'refreshing task keeps the sliver expanded forever until done',
      (WidgetTester tester) async {
        debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

        await tester.pumpWidget(
312
          Directionality(
313
            textDirection: TextDirection.ltr,
314
            child: CustomScrollView(
315
              slivers: <Widget>[
316
                CupertinoSliverRefreshControl(
317 318
                  builder: builder,
                  onRefresh: onRefresh,
319 320 321 322 323 324 325 326 327 328 329 330 331 332
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

        await tester.drag(find.text('0'), const Offset(0.0, 150.0));
        await tester.pump();
        // Let it start snapping back.
        await tester.pump(const Duration(milliseconds: 50));

        verifyInOrder(<void>[
          mockHelper.builder(
333
            any,
334 335 336 337 338 339 340
            RefreshIndicatorMode.armed,
            150.0,
            100.0, // Default value.
            60.0, // Default value.
          ),
          mockHelper.refreshTask(),
          mockHelper.builder(
341
            any,
342
            RefreshIndicatorMode.armed,
343
            argThat(moreOrLessEquals(127.10396988577114)),
344 345 346 347 348 349 350 351
            100.0, // Default value.
            60.0, // Default value.
          ),
        ]);

        // Reaches refresh state and sliver's at 60.0 in height after a while.
        await tester.pump(const Duration(seconds: 1));
        verify(mockHelper.builder(
352
          any,
353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
          RefreshIndicatorMode.refresh,
          60.0,
          100.0, // Default value.
          60.0, // Default value.
        ));

        // Stays in that state forever until future completes.
        await tester.pump(const Duration(seconds: 1000));
        verifyNoMoreInteractions(mockHelper);
        expect(
          tester.getTopLeft(find.widgetWithText(Container, '0')),
          const Offset(0.0, 60.0),
        );

        refreshCompleter.complete(null);
        await tester.pump();

        verify(mockHelper.builder(
371
          any,
372 373 374 375 376 377 378 379 380 381 382 383 384 385
          RefreshIndicatorMode.done,
          60.0,
          100.0, // Default value.
          60.0, // Default value.
        ));
        verifyNoMoreInteractions(mockHelper);

        debugDefaultTargetPlatformOverride = null;
      },
    );

    testWidgets('expanded refreshing sliver scrolls normally', (WidgetTester tester) async {
      debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

386
      refreshIndicator = const Center(child: Text('-1'));
387 388

      await tester.pumpWidget(
389
        Directionality(
390
          textDirection: TextDirection.ltr,
391
          child: CustomScrollView(
392
            slivers: <Widget>[
393
              CupertinoSliverRefreshControl(
394 395
                builder: builder,
                onRefresh: onRefresh,
396 397 398 399 400 401 402 403 404 405 406
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

      await tester.drag(find.text('0'), const Offset(0.0, 150.0));
      await tester.pump();

      verify(mockHelper.builder(
407
        any,
408 409 410 411 412 413 414 415 416
        RefreshIndicatorMode.armed,
        150.0,
        100.0, // Default value.
        60.0, // Default value.
      ));

      // Given a box constraint of 150, the Center will occupy all that height.
      expect(
        tester.getRect(find.widgetWithText(Center, '-1')),
417
        Rect.fromLTRB(0.0, 0.0, 800.0, 150.0),
418 419 420 421 422 423 424
      );

      await tester.drag(find.text('0'), const Offset(0.0, -300.0));
      await tester.pump();

      // Refresh indicator still being told to layout the same way.
      verify(mockHelper.builder(
425
        any,
426 427 428 429 430 431 432 433
        RefreshIndicatorMode.refresh,
        60.0,
        100.0, // Default value.
        60.0, // Default value.
      ));

      // Now the sliver is scrolled off screen.
      expect(
434
        tester.getTopLeft(find.widgetWithText(Center, '-1', skipOffstage: false)).dy,
435 436 437
        moreOrLessEquals(-175.38461538461536),
      );
      expect(
438
        tester.getBottomLeft(find.widgetWithText(Center, '-1', skipOffstage: false)).dy,
439 440 441 442 443 444 445 446 447 448 449 450 451 452
        moreOrLessEquals(-115.38461538461536),
      );
      expect(
        tester.getTopLeft(find.widgetWithText(Center, '0')).dy,
        moreOrLessEquals(-115.38461538461536),
      );

      // Scroll the top of the refresh indicator back to overscroll, it will
      // snap to the size of the refresh indicator and stay there.
      await tester.drag(find.text('1'), const Offset(0.0, 200.0));
      await tester.pump();
      await tester.pump(const Duration(seconds: 2));
      expect(
        tester.getRect(find.widgetWithText(Center, '-1')),
453
        Rect.fromLTRB(0.0, 0.0, 800.0, 60.0),
454 455 456
      );
      expect(
        tester.getRect(find.widgetWithText(Center, '0')),
457
        Rect.fromLTRB(0.0, 60.0, 800.0, 260.0),
458 459 460 461 462 463 464 465
      );

      debugDefaultTargetPlatformOverride = null;
    });

    testWidgets('expanded refreshing sliver goes away when done', (WidgetTester tester) async {
      debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

466
      refreshIndicator = const Center(child: Text('-1'));
467 468

      await tester.pumpWidget(
469
        Directionality(
470
          textDirection: TextDirection.ltr,
471
          child: CustomScrollView(
472
            slivers: <Widget>[
473
              CupertinoSliverRefreshControl(
474 475
                builder: builder,
                onRefresh: onRefresh,
476 477 478 479 480 481 482 483 484 485
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

      await tester.drag(find.text('0'), const Offset(0.0, 150.0));
      await tester.pump();
      verify(mockHelper.builder(
486
        any,
487 488 489 490 491 492 493
        RefreshIndicatorMode.armed,
        150.0,
        100.0, // Default value.
        60.0, // Default value.
      ));
      expect(
        tester.getRect(find.widgetWithText(Center, '-1')),
494
        Rect.fromLTRB(0.0, 0.0, 800.0, 150.0),
495 496 497 498 499 500 501 502
      );
      verify(mockHelper.refreshTask());

      // Rebuilds the sliver with a layout extent now.
      await tester.pump();
      // Let it snap back to occupy the indicator's final sliver space only.
      await tester.pump(const Duration(seconds: 2));
      verify(mockHelper.builder(
503
        any,
504 505 506 507 508 509 510
        RefreshIndicatorMode.refresh,
        60.0,
        100.0, // Default value.
        60.0, // Default value.
      ));
      expect(
        tester.getRect(find.widgetWithText(Center, '-1')),
511
        Rect.fromLTRB(0.0, 0.0, 800.0, 60.0),
512 513 514
      );
      expect(
        tester.getRect(find.widgetWithText(Center, '0')),
515
        Rect.fromLTRB(0.0, 60.0, 800.0, 260.0),
516 517 518 519 520
      );

      refreshCompleter.complete(null);
      await tester.pump();
      verify(mockHelper.builder(
521
        any,
522 523 524 525 526 527 528 529 530 531
        RefreshIndicatorMode.done,
        60.0,
        100.0, // Default value.
        60.0, // Default value.
      ));

      await tester.pump(const Duration(seconds: 5));
      expect(find.text('-1'), findsNothing);
      expect(
        tester.getRect(find.widgetWithText(Center, '0')),
532
        Rect.fromLTRB(0.0, 0.0, 800.0, 200.0),
533 534 535 536 537 538 539 540 541 542
      );

      debugDefaultTargetPlatformOverride = null;
    });

    testWidgets(
      'retracting sliver during done cannot be pulled to refresh again until fully retracted',
      (WidgetTester tester) async {
        debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

543
        refreshIndicator = const Center(child: Text('-1'));
544 545

        await tester.pumpWidget(
546
          Directionality(
547
            textDirection: TextDirection.ltr,
548
            child: CustomScrollView(
549
              slivers: <Widget>[
550
                CupertinoSliverRefreshControl(
551 552
                  builder: builder,
                  onRefresh: onRefresh,
553 554 555 556 557 558 559 560 561 562 563 564 565 566
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

        await tester.drag(find.text('0'), const Offset(0.0, 150.0));
        await tester.pump();
        verify(mockHelper.refreshTask());

        refreshCompleter.complete(null);
        await tester.pump();
        verify(mockHelper.builder(
567
          any,
568 569 570 571 572 573 574 575 576 577
          RefreshIndicatorMode.done,
          150.0, // Still overscrolled here.
          100.0, // Default value.
          60.0, // Default value.
        ));

        // Let it start going away but not fully.
        await tester.pump(const Duration(milliseconds: 100));
        // The refresh indicator is still building.
        verify(mockHelper.builder(
578
          any,
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596
          RefreshIndicatorMode.done,
          91.31180913199277,
          100.0, // Default value.
          60.0, // Default value.
        ));
        expect(
          tester.getBottomLeft(find.widgetWithText(Center, '-1')).dy,
          moreOrLessEquals(91.311809131992776),
        );

        // Start another drag by an amount that would have been enough to
        // trigger another refresh if it were in the right state.
        await tester.drag(find.text('0'), const Offset(0.0, 150.0));
        await tester.pump();

        // Instead, it's still in the done state because the sliver never
        // fully retracted.
        verify(mockHelper.builder(
597
          any,
598 599 600 601 602 603 604 605 606 607 608
          RefreshIndicatorMode.done,
          147.3772721631821,
          100.0, // Default value.
          60.0, // Default value.
        ));

        // Now let it fully go away.
        await tester.pump(const Duration(seconds: 5));
        expect(find.text('-1'), findsNothing);
        expect(
          tester.getRect(find.widgetWithText(Center, '0')),
609
          Rect.fromLTRB(0.0, 0.0, 800.0, 200.0),
610 611 612 613 614 615
        );

        // Start another drag. It's now in drag mode.
        await tester.drag(find.text('0'), const Offset(0.0, 40.0));
        await tester.pump();
        verify(mockHelper.builder(
616
          any,
617 618 619 620 621 622 623 624 625 626 627 628 629 630 631
          RefreshIndicatorMode.drag,
          40.0,
          100.0, // Default value.
          60.0, // Default value.
        ));

        debugDefaultTargetPlatformOverride = null;
      },
    );

    testWidgets(
      'sliver held in overscroll when task finishes completes normally',
      (WidgetTester tester) async {
        debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

632
        refreshIndicator = const Center(child: Text('-1'));
633 634

        await tester.pumpWidget(
635
          Directionality(
636
            textDirection: TextDirection.ltr,
637
            child: CustomScrollView(
638
              slivers: <Widget>[
639
                CupertinoSliverRefreshControl(
640 641
                  builder: builder,
                  onRefresh: onRefresh,
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

        final TestGesture gesture = await tester.startGesture(const Offset(0.0, 0.0));
        // Start a refresh.
        await gesture.moveBy(const Offset(0.0, 150.0));
        await tester.pump();
        verify(mockHelper.refreshTask());

        // Complete the task while held down.
        refreshCompleter.complete(null);
        await tester.pump();
        verify(mockHelper.builder(
659
          any,
660 661 662 663 664 665 666
          RefreshIndicatorMode.done,
          150.0, // Still overscrolled here.
          100.0, // Default value.
          60.0, // Default value.
        ));
        expect(
          tester.getRect(find.widgetWithText(Center, '0')),
667
          Rect.fromLTRB(0.0, 150.0, 800.0, 350.0),
668 669 670 671 672 673 674 675
        );

        await gesture.up();
        await tester.pump();
        await tester.pump(const Duration(seconds: 5));
        expect(find.text('-1'), findsNothing);
        expect(
          tester.getRect(find.widgetWithText(Center, '0')),
676
          Rect.fromLTRB(0.0, 0.0, 800.0, 200.0),
677 678 679 680 681 682 683 684 685
        );

        debugDefaultTargetPlatformOverride = null;
      },
    );

    testWidgets(
      'sliver scrolled away when task completes properly removes itself',
      (WidgetTester tester) async {
686 687 688 689 690
        if (testListLength < 4) {
          // This test only makes sense when the list is long enough that
          // the indicator can be scrolled away while refreshing.
          return;
        }
691 692
        debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

693
        refreshIndicator = const Center(child: Text('-1'));
694 695

        await tester.pumpWidget(
696
          Directionality(
697
            textDirection: TextDirection.ltr,
698
            child: CustomScrollView(
699
              slivers: <Widget>[
700
                CupertinoSliverRefreshControl(
701 702
                  builder: builder,
                  onRefresh: onRefresh,
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

        // Start a refresh.
        await tester.drag(find.text('0'), const Offset(0.0, 150.0));
        await tester.pump();
        verify(mockHelper.refreshTask());

        await tester.drag(find.text('0'), const Offset(0.0, -300.0));
        await tester.pump();

        // Refresh indicator still being told to layout the same way.
        verify(mockHelper.builder(
720
          any,
721 722 723 724 725 726 727 728
          RefreshIndicatorMode.refresh,
          60.0,
          100.0, // Default value.
          60.0, // Default value.
        ));

        // Now the sliver is scrolled off screen.
        expect(
729
          tester.getTopLeft(find.widgetWithText(Center, '-1', skipOffstage: false)).dy,
730 731 732
          moreOrLessEquals(-175.38461538461536),
        );
        expect(
733
          tester.getBottomLeft(find.widgetWithText(Center, '-1', skipOffstage: false)).dy,
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754
          moreOrLessEquals(-115.38461538461536),
        );

        // Complete the task while scrolled away.
        refreshCompleter.complete(null);
        // The sliver is instantly gone since there is no overscroll physics
        // simulation.
        await tester.pump();

        // The next item's position is not disturbed.
        expect(
          tester.getTopLeft(find.widgetWithText(Center, '0')).dy,
          moreOrLessEquals(-115.38461538461536),
        );

        // Scrolling past the first item still results in a new overscroll.
        // The layout extent is gone.
        await tester.drag(find.text('1'), const Offset(0.0, 120.0));
        await tester.pump();

        verify(mockHelper.builder(
755
          any,
756 757 758 759 760 761 762 763 764 765 766 767
          RefreshIndicatorMode.drag,
          4.615384615384642,
          100.0, // Default value.
          60.0, // Default value.
        ));

        // Snaps away normally.
        await tester.pump();
        await tester.pump(const Duration(seconds: 2));
        expect(find.text('-1'), findsNothing);
        expect(
          tester.getRect(find.widgetWithText(Center, '0')),
768
          Rect.fromLTRB(0.0, 0.0, 800.0, 200.0),
769 770 771 772 773 774 775 776 777 778 779
        );

        debugDefaultTargetPlatformOverride = null;
      },
    );

    testWidgets(
      "don't do anything unless it can be overscrolled at the start of the list",
      (WidgetTester tester) async {
        debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

780
        refreshIndicator = const Center(child: Text('-1'));
781 782

        await tester.pumpWidget(
783
          Directionality(
784
            textDirection: TextDirection.ltr,
785
            child: CustomScrollView(
786 787
              slivers: <Widget>[
                buildAListOfStuff(),
788
                CupertinoSliverRefreshControl( // it's in the middle now.
789 790
                  builder: builder,
                  onRefresh: onRefresh,
791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

        await tester.fling(find.byType(Container).first, const Offset(0.0, 200.0), 2000.0);

        await tester.fling(find.byType(Container).first, const Offset(0.0, -200.0), 3000.0);

        verifyNoMoreInteractions(mockHelper);

        debugDefaultTargetPlatformOverride = null;
      },
    );

    testWidgets(
      'without an onRefresh, builder is called with arm for one frame then sliver goes away',
      (WidgetTester tester) async {
        debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

813
        refreshIndicator = const Center(child: Text('-1'));
814 815

        await tester.pumpWidget(
816
          Directionality(
817
            textDirection: TextDirection.ltr,
818
            child: CustomScrollView(
819
              slivers: <Widget>[
820
                CupertinoSliverRefreshControl(
821
                  builder: builder,
822 823 824 825 826 827 828 829 830 831
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

        await tester.drag(find.text('0'), const Offset(0.0, 150.0));
        await tester.pump();
        verify(mockHelper.builder(
832
          any,
833 834 835 836 837 838 839 840
          RefreshIndicatorMode.armed,
          150.0,
          100.0, // Default value.
          60.0, // Default value.
        ));

        await tester.pump(const Duration(milliseconds: 10));
        verify(mockHelper.builder(
841
          any,
842 843 844 845 846 847 848 849 850 851
          RefreshIndicatorMode.done, // Goes to done on the next frame.
          148.6463892921364,
          100.0, // Default value.
          60.0, // Default value.
        ));

        await tester.pump(const Duration(seconds: 5));
        expect(find.text('-1'), findsNothing);
        expect(
          tester.getRect(find.widgetWithText(Center, '0')),
852
          Rect.fromLTRB(0.0, 0.0, 800.0, 200.0),
853 854 855 856 857
        );

        debugDefaultTargetPlatformOverride = null;
      }
    );
858
  };
859

860
  final Function stateMachineTestGroup = () {
861 862 863 864
    testWidgets('starts in inactive state', (WidgetTester tester) async {
      debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

      await tester.pumpWidget(
865
        Directionality(
866
          textDirection: TextDirection.ltr,
867
          child: CustomScrollView(
868
            slivers: <Widget>[
869
              CupertinoSliverRefreshControl(
870
                builder: builder,
871 872 873 874 875 876 877 878
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

      expect(
879
        CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder, skipOffstage: false))),
880 881 882 883 884 885 886 887 888 889
        RefreshIndicatorMode.inactive,
      );

      debugDefaultTargetPlatformOverride = null;
    });

    testWidgets('goes to drag and returns to inactive in a small drag', (WidgetTester tester) async {
      debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

      await tester.pumpWidget(
890
        Directionality(
891
          textDirection: TextDirection.ltr,
892
          child: CustomScrollView(
893
            slivers: <Widget>[
894
              CupertinoSliverRefreshControl(
895
                builder: builder,
896 897 898 899 900 901 902 903 904 905 906
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

      await tester.drag(find.text('0'), const Offset(0.0, 20.0));
      await tester.pump();

      expect(
907
        CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
908 909 910 911 912 913
        RefreshIndicatorMode.drag,
      );

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

      expect(
914
        CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder, skipOffstage: false))),
915 916 917 918 919 920 921 922 923 924
        RefreshIndicatorMode.inactive,
      );

      debugDefaultTargetPlatformOverride = null;
    });

    testWidgets('goes to armed the frame it passes the threshold', (WidgetTester tester) async {
      debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

      await tester.pumpWidget(
925
        Directionality(
926
          textDirection: TextDirection.ltr,
927
          child: CustomScrollView(
928
            slivers: <Widget>[
929
              CupertinoSliverRefreshControl(
930
                builder: builder,
931 932 933 934 935 936 937 938 939 940 941 942
                refreshTriggerPullDistance: 80.0,
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

      final TestGesture gesture = await tester.startGesture(const Offset(0.0, 0.0));
      await gesture.moveBy(const Offset(0.0, 79.0));
      await tester.pump();
      expect(
943
        CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
944 945 946 947 948 949
        RefreshIndicatorMode.drag,
      );

      await gesture.moveBy(const Offset(0.0, 3.0)); // Overscrolling, need to move more than 1px.
      await tester.pump();
      expect(
950
        CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
951 952 953 954 955 956 957 958 959 960 961 962
        RefreshIndicatorMode.armed,
      );

      debugDefaultTargetPlatformOverride = null;
    });

    testWidgets(
      'goes to refresh the frame it crossed back the refresh threshold',
      (WidgetTester tester) async {
        debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

        await tester.pumpWidget(
963
          Directionality(
964
            textDirection: TextDirection.ltr,
965
            child: CustomScrollView(
966
              slivers: <Widget>[
967
                CupertinoSliverRefreshControl(
968 969
                  builder: builder,
                  onRefresh: onRefresh,
970 971 972 973 974 975 976 977 978 979 980 981 982
                  refreshTriggerPullDistance: 90.0,
                  refreshIndicatorExtent: 50.0,
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

        final TestGesture gesture = await tester.startGesture(const Offset(0.0, 0.0));
        await gesture.moveBy(const Offset(0.0, 90.0)); // Arm it.
        await tester.pump();
        expect(
983
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
984 985 986 987 988 989 990 991 992 993
          RefreshIndicatorMode.armed,
        );

        await gesture.moveBy(const Offset(0.0, -80.0)); // Overscrolling, need to move more than -40.
        await tester.pump();
        expect(
          tester.getTopLeft(find.widgetWithText(Container, '0')).dy,
          moreOrLessEquals(49.775111111111116), // Below 50 now.
        );
        expect(
994
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
          RefreshIndicatorMode.refresh,
        );

        debugDefaultTargetPlatformOverride = null;
      },
    );

    testWidgets(
      'goes to done internally as soon as the task finishes',
      (WidgetTester tester) async {
        debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

        await tester.pumpWidget(
1008
          Directionality(
1009
            textDirection: TextDirection.ltr,
1010
            child: CustomScrollView(
1011
              slivers: <Widget>[
1012
                CupertinoSliverRefreshControl(
1013 1014
                  builder: builder,
                  onRefresh: onRefresh,
1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

        await tester.drag(find.text('0'), const Offset(0.0, 100.0));
        await tester.pump();
        expect(
1025
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1026 1027 1028 1029 1030 1031 1032
          RefreshIndicatorMode.armed,
        );
        // The sliver scroll offset correction is applied on the next frame.
        await tester.pump();

        await tester.pump(const Duration(seconds: 2));
        expect(
1033
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1034 1035 1036 1037
          RefreshIndicatorMode.refresh,
        );
        expect(
          tester.getRect(find.widgetWithText(Container, '0')),
1038
          Rect.fromLTRB(0.0, 60.0, 800.0, 260.0),
1039 1040 1041 1042 1043 1044 1045
        );

        refreshCompleter.complete(null);
        // The task completed between frames. The internal state goes to done
        // right away even though the sliver gets a new offset correction the
        // next frame.
        expect(
1046
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059
          RefreshIndicatorMode.done,
        );

        debugDefaultTargetPlatformOverride = null;
      },
    );

    testWidgets(
      'goes back to inactive when retracting back past 10% of arming distance',
      (WidgetTester tester) async {
        debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

        await tester.pumpWidget(
1060
          Directionality(
1061
            textDirection: TextDirection.ltr,
1062
            child: CustomScrollView(
1063
              slivers: <Widget>[
1064
                CupertinoSliverRefreshControl(
1065 1066
                  builder: builder,
                  onRefresh: onRefresh,
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

        final TestGesture gesture = await tester.startGesture(const Offset(0.0, 0.0));
        await gesture.moveBy(const Offset(0.0, 150.0));
        await tester.pump();
        expect(
1078
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1079 1080 1081 1082 1083
          RefreshIndicatorMode.armed,
        );

        refreshCompleter.complete(null);
        expect(
1084
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097
          RefreshIndicatorMode.done,
        );
        await tester.pump();

        // Now back in overscroll mode.
        await gesture.moveBy(const Offset(0.0, -200.0));
        await tester.pump();
        expect(
          tester.getTopLeft(find.widgetWithText(Container, '0')).dy,
          moreOrLessEquals(27.944444444444457),
        );
        // Need to bring it to 100 * 0.1 to reset to inactive.
        expect(
1098
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
          RefreshIndicatorMode.done,
        );

        await gesture.moveBy(const Offset(0.0, -35.0));
        await tester.pump();
        expect(
          tester.getTopLeft(find.widgetWithText(Container, '0')).dy,
          moreOrLessEquals(9.313890708161875),
        );
        expect(
1109
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
          RefreshIndicatorMode.inactive,
        );

        debugDefaultTargetPlatformOverride = null;
      },
    );

    testWidgets(
      'goes back to inactive if already scrolled away when task completes',
      (WidgetTester tester) async {
        debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

        await tester.pumpWidget(
1123
          Directionality(
1124
            textDirection: TextDirection.ltr,
1125
            child: CustomScrollView(
1126
              slivers: <Widget>[
1127
                CupertinoSliverRefreshControl(
1128 1129
                  builder: builder,
                  onRefresh: onRefresh,
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

        final TestGesture gesture = await tester.startGesture(const Offset(0.0, 0.0));
        await gesture.moveBy(const Offset(0.0, 150.0));
        await tester.pump();
        expect(
1141
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153
          RefreshIndicatorMode.armed,
        );
        await tester.pump(); // Sliver scroll offset correction is applied one frame later.

        await gesture.moveBy(const Offset(0.0, -300.0));
        await tester.pump();
        // The refresh indicator is offscreen now.
        expect(
          tester.getTopLeft(find.widgetWithText(Container, '0')).dy,
          moreOrLessEquals(-145.0332383665717),
        );
        expect(
1154
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder, skipOffstage: false))),
1155 1156 1157 1158 1159 1160 1161
          RefreshIndicatorMode.refresh,
        );

        refreshCompleter.complete(null);
        // The sliver layout extent is removed on next frame.
        await tester.pump();
        expect(
1162
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder, skipOffstage: false))),
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185
          RefreshIndicatorMode.inactive,
        );
        // Nothing moved.
        expect(
          tester.getTopLeft(find.widgetWithText(Container, '0')).dy,
          moreOrLessEquals(-145.0332383665717),
        );
        await tester.pump(const Duration(seconds: 2));
        // Everything stayed as is.
        expect(
          tester.getTopLeft(find.widgetWithText(Container, '0')).dy,
          moreOrLessEquals(-145.0332383665717),
        );

        debugDefaultTargetPlatformOverride = null;
      },
    );

    testWidgets(
      "don't have to build any indicators or occupy space during refresh",
      (WidgetTester tester) async {
        debugDefaultTargetPlatformOverride = TargetPlatform.iOS;

1186
        refreshIndicator = const Center(child: Text('-1'));
1187 1188

        await tester.pumpWidget(
1189
          Directionality(
1190
            textDirection: TextDirection.ltr,
1191
            child: CustomScrollView(
1192
              slivers: <Widget>[
1193
                CupertinoSliverRefreshControl(
1194
                  builder: null,
1195
                  onRefresh: onRefresh,
1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206
                  refreshIndicatorExtent: 0.0,
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

        await tester.drag(find.text('0'), const Offset(0.0, 150.0));
        await tester.pump();
        expect(
1207
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1208 1209 1210 1211 1212 1213 1214
          RefreshIndicatorMode.armed,
        );

        await tester.pump();
        await tester.pump(const Duration(seconds: 5));
        // In refresh mode but has no UI.
        expect(
1215
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder, skipOffstage: false))),
1216 1217 1218 1219
          RefreshIndicatorMode.refresh,
        );
        expect(
          tester.getRect(find.widgetWithText(Center, '0')),
1220
          Rect.fromLTRB(0.0, 0.0, 800.0, 200.0),
1221 1222 1223 1224 1225 1226 1227
        );
        verify(mockHelper.refreshTask()); // The refresh function still called.

        refreshCompleter.complete(null);
        await tester.pump();
        // Goes to inactive right away since the sliver is already collapsed.
        expect(
1228
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder, skipOffstage: false))),
1229 1230 1231 1232 1233 1234
          RefreshIndicatorMode.inactive,
        );

        debugDefaultTargetPlatformOverride = null;
      }
    );
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250
  };

  group('UI tests long list', uiTestGroup);

  // Test the internal state machine directly to make sure the UI aren't just
  // correct by coincidence.
  group('state machine test long list', stateMachineTestGroup);

  // Retest everything and make sure that it still works when the whole list
  // is smaller than the viewport size.
  testListLength = 2;
  group('UI tests short list', uiTestGroup);

  // Test the internal state machine directly to make sure the UI aren't just
  // correct by coincidence.
  group('state machine test short list', stateMachineTestGroup);
1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262
}

class MockHelper extends Mock {
  Widget builder(
    BuildContext context,
    RefreshIndicatorMode refreshState,
    double pulledExtent,
    double refreshTriggerPullDistance,
    double refreshIndicatorExtent,
  );

  Future<void> refreshTask();
1263
}