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

5
@TestOn('!chrome')
6 7 8
import 'dart:async';

import 'package:flutter/cupertino.dart';
9
import 'package:flutter/foundation.dart';
10 11 12 13
import 'package:flutter/services.dart';
import 'package:flutter_test/flutter_test.dart';

void main() {
14
  late FakeBuilder mockHelper;
15

16
  setUp(() {
17
    mockHelper = FakeBuilder();
18 19
  });

20
  int testListLength = 10;
21
  SliverList buildAListOfStuff() {
22 23
    return SliverList(
      delegate: SliverChildBuilderDelegate(
24
        (BuildContext context, int index) {
25
          return SizedBox(
26
            height: 200.0,
27
            child: Center(child: Text(index.toString())),
28 29
          );
        },
30
        childCount: testListLength,
31 32 33 34
      ),
    );
  }

35
  void uiTestGroup() {
36 37
    testWidgets("doesn't invoke anything without user interaction", (WidgetTester tester) async {
      await tester.pumpWidget(
38 39
        CupertinoApp(
          home: CustomScrollView(
40
            slivers: <Widget>[
41
              CupertinoSliverRefreshControl(
42
                builder: mockHelper.builder,
43 44 45 46 47 48 49
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

50
      expect(mockHelper.invocations, isEmpty);
51 52

      expect(
53
        tester.getTopLeft(find.widgetWithText(SizedBox, '0')),
54
        Offset.zero,
55
      );
Dan Field's avatar
Dan Field committed
56
    }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
57 58 59

    testWidgets('calls the indicator builder when starting to overscroll', (WidgetTester tester) async {
      await tester.pumpWidget(
60 61
        CupertinoApp(
          home: CustomScrollView(
62
            slivers: <Widget>[
63
              CupertinoSliverRefreshControl(
64
                builder: mockHelper.builder,
65 66 67 68 69 70 71 72
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

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

76
      // The function is referenced once while passing into CupertinoSliverRefreshControl
77
      // and is called.
78 79 80 81 82
      expect(mockHelper.invocations.first, matchesBuilder(
        refreshState: RefreshIndicatorMode.drag,
        pulledExtent: 50,
        refreshTriggerPullDistance: 100,  // default value.
        refreshIndicatorExtent: 60,  // default value.
83
      ));
84
      expect(mockHelper.invocations, hasLength(1));
85 86

      expect(
87
        tester.getTopLeft(find.widgetWithText(SizedBox, '0')),
88 89
        const Offset(0.0, 50.0),
      );
Dan Field's avatar
Dan Field committed
90
    }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
91 92 93 94 95

    testWidgets(
      "don't call the builder if overscroll doesn't move slivers like on Android",
      (WidgetTester tester) async {
        await tester.pumpWidget(
96
          Directionality(
97
            textDirection: TextDirection.ltr,
98 99 100 101 102 103 104 105 106 107
            child: MediaQuery(
              data: const MediaQueryData(),
              child: CustomScrollView(
                slivers: <Widget>[
                  CupertinoSliverRefreshControl(
                    builder: mockHelper.builder,
                  ),
                  buildAListOfStuff(),
                ],
              ),
108 109 110 111 112 113 114 115
            ),
          ),
        );

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

116
        expect(mockHelper.invocations, isEmpty);
117 118

        expect(
119
          tester.getTopLeft(find.widgetWithText(SizedBox, '0')),
120
          Offset.zero,
121
        );
122 123 124
      },
      variant: TargetPlatformVariant.only(TargetPlatform.android),
    );
125

126
    testWidgets('let the builder update as canceled drag scrolls away', (WidgetTester tester) async {
127
      await tester.pumpWidget(
128 129
        CupertinoApp(
          home: CustomScrollView(
130
            slivers: <Widget>[
131
              CupertinoSliverRefreshControl(
132
                builder: mockHelper.builder,
133 134 135 136 137 138 139 140
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

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

147 148 149 150 151 152
      expect(mockHelper.invocations, containsAllInOrder(<void>[
        matchesBuilder(
          refreshState: RefreshIndicatorMode.drag,
          pulledExtent: 50,
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
153
        ),
154 155 156 157 158 159 160
        if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) matchesBuilder(
          refreshState: RefreshIndicatorMode.drag,
          pulledExtent: moreOrLessEquals(48.07979523362715),
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
        )
        else matchesBuilder(
161 162 163 164
          refreshState: RefreshIndicatorMode.drag,
          pulledExtent: moreOrLessEquals(48.36801747187993),
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
165
        ),
166 167 168 169 170 171 172
        if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) matchesBuilder(
          refreshState: RefreshIndicatorMode.drag,
          pulledExtent: moreOrLessEquals(43.98499220391114),
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
        )
        else matchesBuilder(
173 174 175 176
          refreshState: RefreshIndicatorMode.drag,
          pulledExtent: moreOrLessEquals(44.63031931875867),
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
177
        ),
178 179 180
      ]));
      // The builder isn't called again when the sliver completely goes away.
      expect(mockHelper.invocations, hasLength(3));
181 182

      expect(
183
        tester.getTopLeft(find.widgetWithText(SizedBox, '0')),
184
        Offset.zero,
185
      );
Dan Field's avatar
Dan Field committed
186
    }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
187 188 189 190

    testWidgets('drag past threshold triggers refresh task', (WidgetTester tester) async {
      final List<MethodCall> platformCallLog = <MethodCall>[];

191
      tester.binding.defaultBinaryMessenger.setMockMethodCallHandler(SystemChannels.platform, (MethodCall methodCall) async {
192
        platformCallLog.add(methodCall);
193
        return null;
194 195 196
      });

      await tester.pumpWidget(
197 198
        CupertinoApp(
          home: CustomScrollView(
199
            slivers: <Widget>[
200
              CupertinoSliverRefreshControl(
201 202
                builder: mockHelper.builder,
                onRefresh: mockHelper.refreshTask,
203 204 205 206 207 208 209
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

210
      final TestGesture gesture = await tester.startGesture(Offset.zero);
211 212 213 214
      await gesture.moveBy(const Offset(0.0, 99.0));
      await tester.pump();
      await gesture.moveBy(const Offset(0.0, -30.0));
      await tester.pump();
215 216 217 218 219 220
      if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) {
        await gesture.moveBy(const Offset(0.0, 70.0));
      }
      else {
        await gesture.moveBy(const Offset(0.0, 50.0));
      }
221 222
      await tester.pump();

223 224 225 226 227 228
      expect(mockHelper.invocations, containsAllInOrder(<void>[
        matchesBuilder(
          refreshState: RefreshIndicatorMode.drag,
          pulledExtent: 99,
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
229
        ),
230 231 232 233 234 235 236
        if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) matchesBuilder(
          refreshState: RefreshIndicatorMode.drag,
          pulledExtent: moreOrLessEquals(97.3552275),
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
        )
        else matchesBuilder(
237 238 239 240
          refreshState: RefreshIndicatorMode.drag,
          pulledExtent: moreOrLessEquals(86.78169),
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
241
        ),
242 243 244 245 246 247 248
        if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) matchesBuilder(
          refreshState: RefreshIndicatorMode.armed,
          pulledExtent: moreOrLessEquals(100.79409877743257),
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
        )
        else matchesBuilder(
249 250 251 252
          refreshState: RefreshIndicatorMode.armed,
          pulledExtent: moreOrLessEquals(105.80452021305739),
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
253
        ),
254 255 256 257
      ]));
      // The refresh callback is triggered after the frame.
      expect(mockHelper.invocations.last, const RefreshTaskInvocation());
      expect(mockHelper.invocations, hasLength(4));
258 259 260 261 262

      expect(
        platformCallLog.last,
        isMethodCall('HapticFeedback.vibrate', arguments: 'HapticFeedbackType.mediumImpact'),
      );
Dan Field's avatar
Dan Field committed
263
    }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
264 265 266 267 268

    testWidgets(
      'refreshing task keeps the sliver expanded forever until done',
      (WidgetTester tester) async {
        await tester.pumpWidget(
269 270
          CupertinoApp(
            home: CustomScrollView(
271
              slivers: <Widget>[
272
                CupertinoSliverRefreshControl(
273 274
                  builder: mockHelper.builder,
                  onRefresh: mockHelper.refreshTask,
275 276 277 278 279 280 281
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

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

287 288 289 290 291 292
        expect(mockHelper.invocations, containsAllInOrder(<Matcher>[
          matchesBuilder(
            refreshState: RefreshIndicatorMode.armed,
            pulledExtent: 150,
            refreshTriggerPullDistance: 100, // Default value.
            refreshIndicatorExtent: 60, // Default value.
293
          ),
294
          equals(const RefreshTaskInvocation()),
295 296 297 298 299 300 301
          if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) matchesBuilder(
            refreshState: RefreshIndicatorMode.armed,
            pulledExtent: moreOrLessEquals(124.87933920045268),
            refreshTriggerPullDistance: 100, // Default value.
            refreshIndicatorExtent: 60, // Default value.
          )
          else matchesBuilder(
302 303 304 305
            refreshState: RefreshIndicatorMode.armed,
            pulledExtent: moreOrLessEquals(127.10396988577114),
            refreshTriggerPullDistance: 100, // Default value.
            refreshIndicatorExtent: 60, // Default value.
306
          ),
307
        ]));
308 309 310

        // Reaches refresh state and sliver's at 60.0 in height after a while.
        await tester.pump(const Duration(seconds: 1));
311 312 313 314 315 316 317

        expect(mockHelper.invocations, contains(matchesBuilder(
          refreshState: RefreshIndicatorMode.refresh,
          pulledExtent: 60,
          refreshIndicatorExtent: 60, // Default value.
          refreshTriggerPullDistance: 100, // Default value.
        )));
318 319 320 321

        // Stays in that state forever until future completes.
        await tester.pump(const Duration(seconds: 1000));
        expect(
322
          tester.getTopLeft(find.widgetWithText(SizedBox, '0')),
323 324 325
          const Offset(0.0, 60.0),
        );

326
        mockHelper.refreshCompleter.complete(null);
327 328
        await tester.pump();

329 330 331 332 333 334 335
        expect(mockHelper.invocations, contains(matchesBuilder(
          refreshState: RefreshIndicatorMode.done,
          pulledExtent: 60,
          refreshIndicatorExtent: 60, // Default value.
          refreshTriggerPullDistance: 100, // Default value.
        )));
        expect(mockHelper.invocations, hasLength(5));
336 337 338
      },
      variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }),
    );
339

340 341 342 343 344
    testWidgets(
      'refreshing task keeps the sliver expanded forever until completes with error',
      (WidgetTester tester) async {
        final FlutterError error = FlutterError('Oops');
        double errorCount = 0;
345
        final TargetPlatform? platform = debugDefaultTargetPlatformOverride; // Will not be correct within the zone.
346

347
        runZonedGuarded(
348
          () async {
349
            mockHelper.refreshCompleter = Completer<void>.sync();
350
            await tester.pumpWidget(
351 352
              CupertinoApp(
                home: CustomScrollView(
353 354
                  slivers: <Widget>[
                    CupertinoSliverRefreshControl(
355 356
                      builder: mockHelper.builder,
                      onRefresh: mockHelper.refreshTask,
357 358 359 360
                    ),
                    buildAListOfStuff(),
                  ],
                ),
361
              ),
362 363 364 365 366 367 368
            );

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

369 370 371 372 373 374
            expect(mockHelper.invocations, containsAllInOrder(<Matcher>[
             matchesBuilder(
                refreshState: RefreshIndicatorMode.armed,
                pulledExtent: 150,
                refreshIndicatorExtent: 60, // Default value.
                refreshTriggerPullDistance: 100, // Default value.
375
              ),
376
              equals(const RefreshTaskInvocation()),
377 378 379 380 381 382 383
              if (platform == TargetPlatform.macOS) matchesBuilder(
                refreshState: RefreshIndicatorMode.armed,
                pulledExtent: moreOrLessEquals(124.87933920045268),
                refreshTriggerPullDistance: 100, // Default value.
                refreshIndicatorExtent: 60, // Default value.
              )
              else matchesBuilder(
384 385 386 387
                refreshState: RefreshIndicatorMode.armed,
                pulledExtent: moreOrLessEquals(127.10396988577114),
                refreshIndicatorExtent: 60, // Default value.
                refreshTriggerPullDistance: 100, // Default value.
388
              ),
389
            ]));
390

391 392
            // Reaches refresh state and sliver's at 60.0 in height after a while.
            await tester.pump(const Duration(seconds: 1));
393 394 395 396 397 398
            expect(mockHelper.invocations, contains(matchesBuilder(
              refreshState: RefreshIndicatorMode.refresh,
              pulledExtent: 60,
              refreshIndicatorExtent: 60, // Default value.
              refreshTriggerPullDistance: 100, // Default value.
            )));
399

400 401 402
            // Stays in that state forever until future completes.
            await tester.pump(const Duration(seconds: 1000));
            expect(
403
              tester.getTopLeft(find.widgetWithText(SizedBox, '0')),
404 405
              const Offset(0.0, 60.0),
            );
406

407
            mockHelper.refreshCompleter.completeError(error);
408
            await tester.pump();
409

410 411 412 413 414 415 416
            expect(mockHelper.invocations, contains(matchesBuilder(
              refreshState: RefreshIndicatorMode.done,
              pulledExtent: 60,
              refreshIndicatorExtent: 60, // Default value.
              refreshTriggerPullDistance: 100, // Default value.
            )));
            expect(mockHelper.invocations, hasLength(5));
417
          },
418
          (Object e, StackTrace stack) {
419 420 421 422 423
            expect(e, error);
            expect(errorCount, 0);
            errorCount++;
          },
        );
424 425 426
      },
      variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }),
    );
427

428
    testWidgets('expanded refreshing sliver scrolls normally', (WidgetTester tester) async {
429
      mockHelper.refreshIndicator = const Center(child: Text('-1'));
430 431

      await tester.pumpWidget(
432 433
        CupertinoApp(
          home: CustomScrollView(
434
            slivers: <Widget>[
435
              CupertinoSliverRefreshControl(
436 437
                builder: mockHelper.builder,
                onRefresh: mockHelper.refreshTask,
438 439 440 441 442 443 444
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

445
      await tester.drag(find.text('0'), const Offset(0.0, 150.0), touchSlopY: 0);
446 447
      await tester.pump();

448 449 450 451 452 453
      expect(mockHelper.invocations, contains(matchesBuilder(
        refreshState: RefreshIndicatorMode.armed,
        pulledExtent: 150,
        refreshIndicatorExtent: 60, // Default value.
        refreshTriggerPullDistance: 100, // Default value.
      )));
454 455 456 457

      // Given a box constraint of 150, the Center will occupy all that height.
      expect(
        tester.getRect(find.widgetWithText(Center, '-1')),
Dan Field's avatar
Dan Field committed
458
        const Rect.fromLTRB(0.0, 0.0, 800.0, 150.0),
459 460
      );

461 462 463 464 465 466
      if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) {
        await tester.drag(find.text('0'), const Offset(0.0, -600.0), touchSlopY: 0, warnIfMissed: false); // hits the list
      }
      else {
        await tester.drag(find.text('0'), const Offset(0.0, -300.0), touchSlopY: 0, warnIfMissed: false); // hits the list
      }
467 468 469
      await tester.pump();

      // Refresh indicator still being told to layout the same way.
470 471 472 473 474 475
      expect(mockHelper.invocations, contains(matchesBuilder(
        refreshState: RefreshIndicatorMode.refresh,
        pulledExtent: 60,
        refreshIndicatorExtent: 60, // Default value.
        refreshTriggerPullDistance: 100, // Default value.
      )));
476 477

      // Now the sliver is scrolled off screen.
478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
      if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) {
        expect(
          tester.getTopLeft(find.widgetWithText(Center, '-1', skipOffstage: false)).dy,
          moreOrLessEquals(-38.625),
        );
        expect(
          tester.getBottomLeft(find.widgetWithText(Center, '-1', skipOffstage: false)).dy,
          moreOrLessEquals(21.375),
        );
        expect(
          tester.getTopLeft(find.widgetWithText(Center, '0')).dy,
          moreOrLessEquals(21.375),
        );
      }
      else {
        expect(
          tester.getTopLeft(find.widgetWithText(Center, '-1', skipOffstage: false)).dy,
          moreOrLessEquals(-175.38461538461536),
        );
        expect(
          tester.getBottomLeft(find.widgetWithText(Center, '-1', skipOffstage: false)).dy,
          moreOrLessEquals(-115.38461538461536),
        );
        expect(
          tester.getTopLeft(find.widgetWithText(Center, '0')).dy,
          moreOrLessEquals(-115.38461538461536),
        );
      }
506 507 508

      // Scroll the top of the refresh indicator back to overscroll, it will
      // snap to the size of the refresh indicator and stay there.
509
      await tester.drag(find.text('1'), const Offset(0.0, 200.0), warnIfMissed: false); // hits the list
510 511 512 513
      await tester.pump();
      await tester.pump(const Duration(seconds: 2));
      expect(
        tester.getRect(find.widgetWithText(Center, '-1')),
Dan Field's avatar
Dan Field committed
514
        const Rect.fromLTRB(0.0, 0.0, 800.0, 60.0),
515 516 517
      );
      expect(
        tester.getRect(find.widgetWithText(Center, '0')),
Dan Field's avatar
Dan Field committed
518
        const Rect.fromLTRB(0.0, 60.0, 800.0, 260.0),
519
      );
Dan Field's avatar
Dan Field committed
520
    }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
521 522

    testWidgets('expanded refreshing sliver goes away when done', (WidgetTester tester) async {
523
      mockHelper.refreshIndicator = const Center(child: Text('-1'));
524 525

      await tester.pumpWidget(
526 527
        CupertinoApp(
          home: CustomScrollView(
528
            slivers: <Widget>[
529
              CupertinoSliverRefreshControl(
530 531
                builder: mockHelper.builder,
                onRefresh: mockHelper.refreshTask,
532 533 534 535 536 537 538
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

539
      await tester.drag(find.text('0'), const Offset(0.0, 150.0), touchSlopY: 0);
540
      await tester.pump();
541 542 543 544 545 546
      expect(mockHelper.invocations, contains(matchesBuilder(
        refreshState: RefreshIndicatorMode.armed,
        pulledExtent: 150,
        refreshIndicatorExtent: 60, // Default value.
        refreshTriggerPullDistance: 100, // Default value.
      )));
547 548
      expect(
        tester.getRect(find.widgetWithText(Center, '-1')),
Dan Field's avatar
Dan Field committed
549
        const Rect.fromLTRB(0.0, 0.0, 800.0, 150.0),
550
      );
551
      expect(mockHelper.invocations, contains(const RefreshTaskInvocation()));
552 553 554 555 556

      // 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));
557 558 559 560 561 562 563

      expect(mockHelper.invocations, contains(matchesBuilder(
        refreshState: RefreshIndicatorMode.refresh,
        pulledExtent: 60,
        refreshIndicatorExtent: 60, // Default value.
        refreshTriggerPullDistance: 100, // Default value.
      )));
564 565
      expect(
        tester.getRect(find.widgetWithText(Center, '-1')),
Dan Field's avatar
Dan Field committed
566
        const Rect.fromLTRB(0.0, 0.0, 800.0, 60.0),
567 568 569
      );
      expect(
        tester.getRect(find.widgetWithText(Center, '0')),
Dan Field's avatar
Dan Field committed
570
        const Rect.fromLTRB(0.0, 60.0, 800.0, 260.0),
571 572
      );

573
      mockHelper.refreshCompleter.complete(null);
574
      await tester.pump();
575 576 577 578 579 580
      expect(mockHelper.invocations, contains(matchesBuilder(
        refreshState: RefreshIndicatorMode.done,
        pulledExtent: 60,
        refreshIndicatorExtent: 60, // Default value.
        refreshTriggerPullDistance: 100, // Default value.
      )));
581 582 583 584 585

      await tester.pump(const Duration(seconds: 5));
      expect(find.text('-1'), findsNothing);
      expect(
        tester.getRect(find.widgetWithText(Center, '0')),
Dan Field's avatar
Dan Field committed
586
        const Rect.fromLTRB(0.0, 0.0, 800.0, 200.0),
587
      );
Dan Field's avatar
Dan Field committed
588
    }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
589 590

    testWidgets('builder still called when sliver snapped back more than 90%', (WidgetTester tester) async {
591
      mockHelper.refreshIndicator = const Center(child: Text('-1'));
592 593

      await tester.pumpWidget(
594 595
        CupertinoApp(
          home: CustomScrollView(
596 597
            slivers: <Widget>[
              CupertinoSliverRefreshControl(
598 599
                builder: mockHelper.builder,
                onRefresh: mockHelper.refreshTask,
600 601 602 603 604 605 606
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

607
      await tester.drag(find.text('0'), const Offset(0.0, 150.0), touchSlopY: 0);
608
      await tester.pump();
609 610 611 612 613 614
      expect(mockHelper.invocations, contains(matchesBuilder(
        refreshState: RefreshIndicatorMode.armed,
        pulledExtent: 150,
        refreshTriggerPullDistance: 100,  // default value.
        refreshIndicatorExtent: 60,  // default value.
      )));
615 616
      expect(
        tester.getRect(find.widgetWithText(Center, '-1')),
Dan Field's avatar
Dan Field committed
617
        const Rect.fromLTRB(0.0, 0.0, 800.0, 150.0),
618
      );
619
      expect(mockHelper.invocations, contains(const RefreshTaskInvocation()));
620 621 622 623 624

      // 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));
625 626 627 628 629 630
      expect(mockHelper.invocations, contains(matchesBuilder(
        refreshState: RefreshIndicatorMode.refresh,
        pulledExtent: 60,
        refreshTriggerPullDistance: 100,  // default value.
        refreshIndicatorExtent: 60,  // default value.
      )));
631 632
      expect(
        tester.getRect(find.widgetWithText(Center, '-1')),
Dan Field's avatar
Dan Field committed
633
        const Rect.fromLTRB(0.0, 0.0, 800.0, 60.0),
634 635 636
      );
      expect(
        tester.getRect(find.widgetWithText(Center, '0')),
Dan Field's avatar
Dan Field committed
637
        const Rect.fromLTRB(0.0, 60.0, 800.0, 260.0),
638 639
      );

640
      mockHelper.refreshCompleter.complete(null);
641
      await tester.pump();
642 643 644 645 646 647 648

      expect(mockHelper.invocations, contains(matchesBuilder(
        refreshState: RefreshIndicatorMode.done,
        pulledExtent: 60,
        refreshTriggerPullDistance: 100,  // default value.
        refreshIndicatorExtent: 60,  // default value.
      )));
649 650 651 652

      // Waiting for refresh control to reach approximately 5% of height
      await tester.pump(const Duration(milliseconds: 400));

653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684
      if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) {
        expect(
          tester.getRect(find.widgetWithText(Center, '0')).top,
          moreOrLessEquals(3.9543032206542765, epsilon: 4e-1),
        );
        expect(
          tester.getRect(find.widgetWithText(Center, '-1')).height,
          moreOrLessEquals(3.9543032206542765, epsilon: 4e-1),
        );
        expect(mockHelper.invocations, contains(matchesBuilder(
          refreshState: RefreshIndicatorMode.inactive,
          pulledExtent: 3.9543032206542765, // ~5% of 60.0
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
        )));
      }
      else {
        expect(
          tester.getRect(find.widgetWithText(Center, '0')).top,
          moreOrLessEquals(3.0, epsilon: 4e-1),
        );
        expect(
          tester.getRect(find.widgetWithText(Center, '-1')).height,
          moreOrLessEquals(3.0, epsilon: 4e-1),
        );
        expect(mockHelper.invocations, contains(matchesBuilder(
          refreshState: RefreshIndicatorMode.inactive,
          pulledExtent: 2.6980688300546443, // ~5% of 60.0
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
        )));
      }
685
      expect(find.text('-1'), findsOneWidget);
Dan Field's avatar
Dan Field committed
686
    }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
687 688 689 690

    testWidgets(
      'retracting sliver during done cannot be pulled to refresh again until fully retracted',
      (WidgetTester tester) async {
691
        mockHelper.refreshIndicator = const Center(child: Text('-1'));
692 693

        await tester.pumpWidget(
694 695
          CupertinoApp(
            home: CustomScrollView(
696
              slivers: <Widget>[
697
                CupertinoSliverRefreshControl(
698 699
                  builder: mockHelper.builder,
                  onRefresh: mockHelper.refreshTask,
700 701 702 703 704 705 706
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

707
        await tester.drag(find.text('0'), const Offset(0.0, 150.0), touchSlopY: 0.0);
708
        await tester.pump();
709
        expect(mockHelper.invocations, contains(const RefreshTaskInvocation()));
710

711
        mockHelper.refreshCompleter.complete(null);
712
        await tester.pump();
713 714 715 716 717 718
        expect(mockHelper.invocations, contains(matchesBuilder(
          refreshState: RefreshIndicatorMode.done,
          pulledExtent: 150.0, // Still overscrolled here.
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
        )));
719 720 721 722

        // Let it start going away but not fully.
        await tester.pump(const Duration(milliseconds: 100));
        // The refresh indicator is still building.
723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746
        if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) {
          expect(mockHelper.invocations, contains(matchesBuilder(
            refreshState: RefreshIndicatorMode.done,
            pulledExtent: 90.13497854600749,
            refreshTriggerPullDistance: 100,  // default value.
            refreshIndicatorExtent: 60,  // default value.
          )));
          expect(
            tester.getBottomLeft(find.widgetWithText(Center, '-1')).dy,
            moreOrLessEquals(90.13497854600749),
          );
        }
        else {
          expect(mockHelper.invocations, contains(matchesBuilder(
            refreshState: RefreshIndicatorMode.done,
            pulledExtent: 91.31180913199277,
            refreshTriggerPullDistance: 100,  // default value.
            refreshIndicatorExtent: 60,  // default value.
          )));
          expect(
            tester.getBottomLeft(find.widgetWithText(Center, '-1')).dy,
            moreOrLessEquals(91.311809131992776),
          );
        }
747 748 749

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

        // Instead, it's still in the done state because the sliver never
        // fully retracted.
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
        if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) {
          expect(mockHelper.invocations, contains(matchesBuilder(
            refreshState: RefreshIndicatorMode.done,
            pulledExtent: 97.71721346565732,
            refreshTriggerPullDistance: 100,  // default value.
            refreshIndicatorExtent: 60,  // default value.
          )));
        }
        else {
          expect(mockHelper.invocations, contains(matchesBuilder(
            refreshState: RefreshIndicatorMode.done,
            pulledExtent: 147.3772721631821,
            refreshTriggerPullDistance: 100,  // default value.
            refreshIndicatorExtent: 60,  // default value.
          )));
        }
771 772 773 774 775 776

        // 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')),
Dan Field's avatar
Dan Field committed
777
          const Rect.fromLTRB(0.0, 0.0, 800.0, 200.0),
778 779 780
        );

        // Start another drag. It's now in drag mode.
781
        await tester.drag(find.text('0'), const Offset(0.0, 40.0), touchSlopY: 0.0);
782
        await tester.pump();
783 784 785 786 787 788
        expect(mockHelper.invocations, contains(matchesBuilder(
          refreshState: RefreshIndicatorMode.drag,
          pulledExtent: 40,
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
        )));
789 790 791
      },
      variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }),
    );
792 793 794 795

    testWidgets(
      'sliver held in overscroll when task finishes completes normally',
      (WidgetTester tester) async {
796
        mockHelper.refreshIndicator = const Center(child: Text('-1'));
797 798

        await tester.pumpWidget(
799 800
          CupertinoApp(
            home: CustomScrollView(
801
              slivers: <Widget>[
802
                CupertinoSliverRefreshControl(
803 804
                  builder: mockHelper.builder,
                  onRefresh: mockHelper.refreshTask,
805 806 807 808 809 810 811
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

812
        final TestGesture gesture = await tester.startGesture(Offset.zero);
813 814 815
        // Start a refresh.
        await gesture.moveBy(const Offset(0.0, 150.0));
        await tester.pump();
816
        expect(mockHelper.invocations, contains(const RefreshTaskInvocation()));
817 818

        // Complete the task while held down.
819
        mockHelper.refreshCompleter.complete(null);
820
        await tester.pump();
821 822 823 824 825 826 827

        expect(mockHelper.invocations, contains(matchesBuilder(
          refreshState: RefreshIndicatorMode.done,
          pulledExtent: 150.0, // Still overscrolled here.
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
        )));
828 829
        expect(
          tester.getRect(find.widgetWithText(Center, '0')),
Dan Field's avatar
Dan Field committed
830
          const Rect.fromLTRB(0.0, 150.0, 800.0, 350.0),
831 832 833 834 835 836 837 838
        );

        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')),
Dan Field's avatar
Dan Field committed
839
          const Rect.fromLTRB(0.0, 0.0, 800.0, 200.0),
840
        );
841 842 843
      },
      variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }),
    );
844 845 846 847

    testWidgets(
      'sliver scrolled away when task completes properly removes itself',
      (WidgetTester tester) async {
848 849 850 851 852
        if (testListLength < 4) {
          // This test only makes sense when the list is long enough that
          // the indicator can be scrolled away while refreshing.
          return;
        }
853
        mockHelper.refreshIndicator = const Center(child: Text('-1'));
854 855

        await tester.pumpWidget(
856 857
          CupertinoApp(
            home: CustomScrollView(
858
              slivers: <Widget>[
859
                CupertinoSliverRefreshControl(
860 861
                  builder: mockHelper.builder,
                  onRefresh: mockHelper.refreshTask,
862 863 864 865 866 867 868 869 870 871
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

        // Start a refresh.
        await tester.drag(find.text('0'), const Offset(0.0, 150.0));
        await tester.pump();
872
        expect(mockHelper.invocations, contains(const RefreshTaskInvocation()));
873 874 875 876 877

        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.
878 879 880 881 882 883
        expect(mockHelper.invocations, contains(matchesBuilder(
          refreshState: RefreshIndicatorMode.done,
          pulledExtent: 60,
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
        )));
884 885 886

        // Now the sliver is scrolled off screen.
        expect(
887
          tester.getTopLeft(find.widgetWithText(Center, '-1', skipOffstage: false)).dy,
888 889 890
          moreOrLessEquals(-175.38461538461536),
        );
        expect(
891
          tester.getBottomLeft(find.widgetWithText(Center, '-1', skipOffstage: false)).dy,
892 893 894 895
          moreOrLessEquals(-115.38461538461536),
        );

        // Complete the task while scrolled away.
896
        mockHelper.refreshCompleter.complete(null);
897 898 899 900 901 902 903 904 905 906 907 908 909 910 911
        // 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();

912 913 914 915 916 917
        expect(mockHelper.invocations, contains(matchesBuilder(
          refreshState: RefreshIndicatorMode.done,
          pulledExtent: 4.615384615384642,
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
        )));
918 919 920 921 922 923 924

        // 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')),
Dan Field's avatar
Dan Field committed
925
          const Rect.fromLTRB(0.0, 0.0, 800.0, 200.0),
926
        );
927 928 929
      },
      variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }),
    );
930 931 932 933

    testWidgets(
      "don't do anything unless it can be overscrolled at the start of the list",
      (WidgetTester tester) async {
934
        mockHelper.refreshIndicator = const Center(child: Text('-1'));
935 936

        await tester.pumpWidget(
937 938
          CupertinoApp(
            home: CustomScrollView(
939 940
              slivers: <Widget>[
                buildAListOfStuff(),
941
                CupertinoSliverRefreshControl( // it's in the middle now.
942 943
                  builder: mockHelper.builder,
                  onRefresh: mockHelper.refreshTask,
944 945 946 947 948 949 950
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

951 952
        await tester.fling(find.byType(SizedBox).first, const Offset(0.0, 200.0), 2000.0);
        await tester.fling(find.byType(SizedBox).first, const Offset(0.0, -200.0), 3000.0, warnIfMissed: false); // IgnorePointer is enabled while scroll is ballistic.
953

954
        expect(mockHelper.invocations, isEmpty);
955 956 957
      },
      variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }),
    );
958 959 960 961

    testWidgets(
      'without an onRefresh, builder is called with arm for one frame then sliver goes away',
      (WidgetTester tester) async {
962
        mockHelper.refreshIndicator = const Center(child: Text('-1'));
963 964

        await tester.pumpWidget(
965 966
          CupertinoApp(
            home: CustomScrollView(
967
              slivers: <Widget>[
968
                CupertinoSliverRefreshControl(
969
                  builder: mockHelper.builder,
970 971 972 973 974 975 976
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

977
        await tester.drag(find.text('0'), const Offset(0.0, 150.0), touchSlopY: 0.0);
978
        await tester.pump();
979 980 981 982 983 984

        expect(mockHelper.invocations.first, matchesBuilder(
          refreshState: RefreshIndicatorMode.armed,
          pulledExtent: 150.0,
          refreshTriggerPullDistance: 100.0, // Default value.
          refreshIndicatorExtent: 60.0, // Default value.
985 986 987
        ));

        await tester.pump(const Duration(milliseconds: 10));
988

989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
        if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) {
          expect(mockHelper.invocations.last, matchesBuilder(
            refreshState: RefreshIndicatorMode.done,
            pulledExtent: moreOrLessEquals(148.36088180097366),
            refreshTriggerPullDistance: 100.0, // Default value.
            refreshIndicatorExtent: 60.0, // Default value.
          ));
        }
        else {
          expect(mockHelper.invocations.last, matchesBuilder(
            refreshState: RefreshIndicatorMode.done,
            pulledExtent: moreOrLessEquals(148.6463892921364),
            refreshTriggerPullDistance: 100.0, // Default value.
            refreshIndicatorExtent: 60.0, // Default value.
          ));
        }
1005 1006 1007 1008 1009

        await tester.pump(const Duration(seconds: 5));
        expect(find.text('-1'), findsNothing);
        expect(
          tester.getRect(find.widgetWithText(Center, '0')),
Dan Field's avatar
Dan Field committed
1010
          const Rect.fromLTRB(0.0, 0.0, 800.0, 200.0),
1011
        );
1012 1013 1014
      },
      variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }),
    );
1015 1016 1017

    testWidgets('Should not crash when dragged', (WidgetTester tester) async {
      await tester.pumpWidget(
1018 1019
        CupertinoApp(
          home: CustomScrollView(
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036
            physics: const BouncingScrollPhysics(),
            slivers: <Widget>[
              CupertinoSliverRefreshControl(
                onRefresh: () async => Future<void>.delayed(const Duration(days: 2000)),
              ),
            ],
          ),
        ),
      );

      await tester.dragFrom(const Offset(100, 10), const Offset(0.0, 50.0), touchSlopY: 0);
      await tester.pump();

      await tester.dragFrom(const Offset(100, 10), const Offset(0, 500), touchSlopY: 0);
      await tester.pump();

      expect(tester.takeException(), isNull);
Dan Field's avatar
Dan Field committed
1037
    }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
1038 1039 1040 1041

    // Test to make sure the refresh sliver's overscroll isn't eaten by the
    // nav bar sliver https://github.com/flutter/flutter/issues/74516.
    testWidgets(
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056
      'properly displays when the refresh sliver is behind the large title nav bar sliver',
      (WidgetTester tester) async {
        await tester.pumpWidget(
          CupertinoApp(
            home: CustomScrollView(
              slivers: <Widget>[
                const CupertinoSliverNavigationBar(
                  largeTitle: Text('Title'),
                ),
                CupertinoSliverRefreshControl(
                  builder: mockHelper.builder,
                ),
                buildAListOfStuff(),
              ],
            ),
1057
          ),
1058
        );
1059

1060
        final double initialFirstCellY = tester.getTopLeft(find.widgetWithText(SizedBox, '0')).dy;
1061

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

1066 1067 1068 1069 1070 1071 1072
        expect(mockHelper.invocations.first, matchesBuilder(
          refreshState: RefreshIndicatorMode.drag,
          pulledExtent: 50,
          refreshTriggerPullDistance: 100,  // default value.
          refreshIndicatorExtent: 60,  // default value.
        ));
        expect(mockHelper.invocations, hasLength(1));
1073

1074 1075 1076 1077 1078 1079 1080
        expect(
          tester.getTopLeft(find.widgetWithText(SizedBox, '0')).dy,
          initialFirstCellY + 50,
        );
      },
      variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }),
    );
1081
  }
1082

1083
  void stateMachineTestGroup() {
1084 1085
    testWidgets('starts in inactive state', (WidgetTester tester) async {
      await tester.pumpWidget(
1086 1087
        CupertinoApp(
          home: CustomScrollView(
1088
            slivers: <Widget>[
1089
              CupertinoSliverRefreshControl(
1090
                builder: mockHelper.builder,
1091 1092 1093 1094 1095 1096 1097 1098
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

      expect(
1099
        CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder, skipOffstage: false))),
1100 1101
        RefreshIndicatorMode.inactive,
      );
Dan Field's avatar
Dan Field committed
1102
    }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
1103 1104 1105

    testWidgets('goes to drag and returns to inactive in a small drag', (WidgetTester tester) async {
      await tester.pumpWidget(
1106 1107
        CupertinoApp(
          home: CustomScrollView(
1108
            slivers: <Widget>[
1109
              CupertinoSliverRefreshControl(
1110
                builder: mockHelper.builder,
1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

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

      expect(
1122
        CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1123 1124 1125 1126 1127 1128
        RefreshIndicatorMode.drag,
      );

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

      expect(
1129
        CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder, skipOffstage: false))),
1130 1131
        RefreshIndicatorMode.inactive,
      );
Dan Field's avatar
Dan Field committed
1132
    }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
1133 1134 1135

    testWidgets('goes to armed the frame it passes the threshold', (WidgetTester tester) async {
      await tester.pumpWidget(
1136 1137
        CupertinoApp(
          home: CustomScrollView(
1138
            slivers: <Widget>[
1139
              CupertinoSliverRefreshControl(
1140
                builder: mockHelper.builder,
1141 1142 1143 1144 1145 1146 1147 1148
                refreshTriggerPullDistance: 80.0,
              ),
              buildAListOfStuff(),
            ],
          ),
        ),
      );

1149
      final TestGesture gesture = await tester.startGesture(Offset.zero);
1150 1151 1152
      await gesture.moveBy(const Offset(0.0, 79.0));
      await tester.pump();
      expect(
1153
        CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1154 1155
        RefreshIndicatorMode.drag,
      );
1156 1157 1158 1159 1160 1161
      if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) {
        await gesture.moveBy(const Offset(0.0, 20.0)); // Overscrolling, need to move more than 1px.
      }
      else {
        await gesture.moveBy(const Offset(0.0, 3.0)); // Overscrolling, need to move more than 1px.
      }
1162 1163
      await tester.pump();
      expect(
1164
        CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1165 1166
        RefreshIndicatorMode.armed,
      );
Dan Field's avatar
Dan Field committed
1167
    }, variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }));
1168 1169 1170 1171 1172

    testWidgets(
      'goes to refresh the frame it crossed back the refresh threshold',
      (WidgetTester tester) async {
        await tester.pumpWidget(
1173 1174
          CupertinoApp(
            home: CustomScrollView(
1175
              slivers: <Widget>[
1176
                CupertinoSliverRefreshControl(
1177 1178
                  builder: mockHelper.builder,
                  onRefresh: mockHelper.refreshTask,
1179 1180 1181 1182 1183 1184 1185 1186 1187
                  refreshTriggerPullDistance: 90.0,
                  refreshIndicatorExtent: 50.0,
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

1188
        final TestGesture gesture = await tester.startGesture(Offset.zero);
1189 1190 1191
        await gesture.moveBy(const Offset(0.0, 90.0)); // Arm it.
        await tester.pump();
        expect(
1192
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1193 1194 1195
          RefreshIndicatorMode.armed,
        );

1196 1197 1198 1199 1200 1201
        if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) {
          await gesture.moveBy(const Offset(0.0, -310.0)); // Overscrolling, need to move more than -40.
        }
        else {
          await gesture.moveBy(const Offset(0.0, -80.0)); // Overscrolling, need to move more than -40.
        }
1202
        await tester.pump();
1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214
        if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) {
          expect(
            tester.getTopLeft(find.widgetWithText(SizedBox, '0')).dy,
            moreOrLessEquals(49.469222222222214), // Below 50 now.
          );
        }
        else {
          expect(
            tester.getTopLeft(find.widgetWithText(SizedBox, '0')).dy,
            moreOrLessEquals(49.775111111111116), // Below 50 now.
          );
        }
1215
        expect(
1216
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1217 1218
          RefreshIndicatorMode.refresh,
        );
1219 1220 1221
      },
      variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }),
    );
1222 1223 1224 1225 1226

    testWidgets(
      'goes to done internally as soon as the task finishes',
      (WidgetTester tester) async {
        await tester.pumpWidget(
1227 1228
          CupertinoApp(
            home: CustomScrollView(
1229
              slivers: <Widget>[
1230
                CupertinoSliverRefreshControl(
1231 1232
                  builder: mockHelper.builder,
                  onRefresh: mockHelper.refreshTask,
1233 1234 1235 1236 1237 1238 1239
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

1240
        await tester.drag(find.text('0'), const Offset(0.0, 100.0), touchSlopY: 0.0);
1241 1242
        await tester.pump();
        expect(
1243
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1244 1245 1246 1247 1248 1249 1250
          RefreshIndicatorMode.armed,
        );
        // The sliver scroll offset correction is applied on the next frame.
        await tester.pump();

        await tester.pump(const Duration(seconds: 2));
        expect(
1251
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1252 1253 1254
          RefreshIndicatorMode.refresh,
        );
        expect(
1255
          tester.getRect(find.widgetWithText(SizedBox, '0')),
Dan Field's avatar
Dan Field committed
1256
          const Rect.fromLTRB(0.0, 60.0, 800.0, 260.0),
1257 1258
        );

1259
        mockHelper.refreshCompleter.complete(null);
1260 1261 1262 1263
        // 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(
1264
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1265 1266
          RefreshIndicatorMode.done,
        );
1267 1268 1269
      },
      variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }),
    );
1270 1271 1272 1273 1274

    testWidgets(
      'goes back to inactive when retracting back past 10% of arming distance',
      (WidgetTester tester) async {
        await tester.pumpWidget(
1275 1276
          CupertinoApp(
            home: CustomScrollView(
1277
              slivers: <Widget>[
1278
                CupertinoSliverRefreshControl(
1279 1280
                  builder: mockHelper.builder,
                  onRefresh: mockHelper.refreshTask,
1281 1282 1283 1284 1285 1286 1287
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

1288
        final TestGesture gesture = await tester.startGesture(Offset.zero);
1289 1290 1291
        await gesture.moveBy(const Offset(0.0, 150.0));
        await tester.pump();
        expect(
1292
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1293 1294 1295
          RefreshIndicatorMode.armed,
        );

1296
        mockHelper.refreshCompleter.complete(null);
1297
        expect(
1298
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1299 1300 1301 1302 1303
          RefreshIndicatorMode.done,
        );
        await tester.pump();

        // Now back in overscroll mode.
1304 1305 1306 1307 1308 1309
        if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) {
          await gesture.moveBy(const Offset(0.0, -590.0));
        }
        else {
          await gesture.moveBy(const Offset(0.0, -200.0));
        }
1310
        await tester.pump();
1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322
        if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) {
          expect(
            tester.getTopLeft(find.widgetWithText(SizedBox, '0')).dy,
            moreOrLessEquals(25.916444444444423),
          );
        }
        else {
          expect(
            tester.getTopLeft(find.widgetWithText(SizedBox, '0')).dy,
            moreOrLessEquals(27.944444444444457),
          );
        }
1323 1324
        // Need to bring it to 100 * 0.1 to reset to inactive.
        expect(
1325
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1326 1327 1328
          RefreshIndicatorMode.done,
        );

1329 1330 1331 1332 1333 1334
        if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) {
          await gesture.moveBy(const Offset(0.0, -160.0));
        }
        else {
          await gesture.moveBy(const Offset(0.0, -35.0));
        }
1335
        await tester.pump();
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347
        if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) {
          expect(
            tester.getTopLeft(find.widgetWithText(SizedBox, '0')).dy,
            moreOrLessEquals(9.15133037440173),
          );
        }
        else {
          expect(
            tester.getTopLeft(find.widgetWithText(SizedBox, '0')).dy,
            moreOrLessEquals(9.313890708161875),
          );
        }
1348
        expect(
1349
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1350 1351
          RefreshIndicatorMode.inactive,
        );
1352 1353 1354
      },
      variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }),
    );
1355 1356 1357 1358 1359

    testWidgets(
      'goes back to inactive if already scrolled away when task completes',
      (WidgetTester tester) async {
        await tester.pumpWidget(
1360 1361
          CupertinoApp(
            home: CustomScrollView(
1362
              slivers: <Widget>[
1363
                CupertinoSliverRefreshControl(
1364 1365
                  builder: mockHelper.builder,
                  onRefresh: mockHelper.refreshTask,
1366 1367 1368 1369 1370 1371 1372
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

1373
        final TestGesture gesture = await tester.startGesture(Offset.zero);
1374 1375 1376
        await gesture.moveBy(const Offset(0.0, 150.0));
        await tester.pump();
        expect(
1377
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1378 1379 1380 1381
          RefreshIndicatorMode.armed,
        );
        await tester.pump(); // Sliver scroll offset correction is applied one frame later.

1382 1383 1384 1385 1386 1387 1388 1389
        double indicatorDestinationPosition = -145.0332383665717;
        if (debugDefaultTargetPlatformOverride == TargetPlatform.macOS) {
          await gesture.moveBy(const Offset(0.0, -600.0));
          indicatorDestinationPosition = -164.33475946989466;
        }
        else {
          await gesture.moveBy(const Offset(0.0, -300.0));
        }
1390 1391 1392
        await tester.pump();
        // The refresh indicator is offscreen now.
        expect(
1393
          tester.getTopLeft(find.widgetWithText(SizedBox, '0')).dy,
1394
          moreOrLessEquals(indicatorDestinationPosition),
1395 1396
        );
        expect(
1397
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder, skipOffstage: false))),
1398 1399 1400
          RefreshIndicatorMode.refresh,
        );

1401
        mockHelper.refreshCompleter.complete(null);
1402 1403 1404
        // The sliver layout extent is removed on next frame.
        await tester.pump();
        expect(
1405
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder, skipOffstage: false))),
1406 1407 1408 1409
          RefreshIndicatorMode.inactive,
        );
        // Nothing moved.
        expect(
1410
          tester.getTopLeft(find.widgetWithText(SizedBox, '0')).dy,
1411
          moreOrLessEquals(indicatorDestinationPosition),
1412 1413 1414 1415
        );
        await tester.pump(const Duration(seconds: 2));
        // Everything stayed as is.
        expect(
1416
          tester.getTopLeft(find.widgetWithText(SizedBox, '0')).dy,
1417
          moreOrLessEquals(indicatorDestinationPosition),
1418
        );
1419 1420 1421
      },
      variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }),
    );
1422 1423 1424 1425

    testWidgets(
      "don't have to build any indicators or occupy space during refresh",
      (WidgetTester tester) async {
1426
        mockHelper.refreshIndicator = const Center(child: Text('-1'));
1427 1428

        await tester.pumpWidget(
1429 1430
          CupertinoApp(
            home: CustomScrollView(
1431
              slivers: <Widget>[
1432
                CupertinoSliverRefreshControl(
1433
                  builder: null,
1434
                  onRefresh: mockHelper.refreshTask,
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445
                  refreshIndicatorExtent: 0.0,
                ),
                buildAListOfStuff(),
              ],
            ),
          ),
        );

        await tester.drag(find.text('0'), const Offset(0.0, 150.0));
        await tester.pump();
        expect(
1446
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder))),
1447 1448 1449 1450 1451 1452 1453
          RefreshIndicatorMode.armed,
        );

        await tester.pump();
        await tester.pump(const Duration(seconds: 5));
        // In refresh mode but has no UI.
        expect(
1454
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder, skipOffstage: false))),
1455 1456 1457 1458
          RefreshIndicatorMode.refresh,
        );
        expect(
          tester.getRect(find.widgetWithText(Center, '0')),
Dan Field's avatar
Dan Field committed
1459
          const Rect.fromLTRB(0.0, 0.0, 800.0, 200.0),
1460 1461
        );

1462
        mockHelper.refreshCompleter.complete(null);
1463 1464 1465
        await tester.pump();
        // Goes to inactive right away since the sliver is already collapsed.
        expect(
1466
          CupertinoSliverRefreshControl.state(tester.element(find.byType(LayoutBuilder, skipOffstage: false))),
1467 1468
          RefreshIndicatorMode.inactive,
        );
1469 1470 1471
      },
      variant: const TargetPlatformVariant(<TargetPlatform>{ TargetPlatform.iOS,  TargetPlatform.macOS }),
    );
1472

1473
    testWidgets('buildRefreshIndicator progress', (WidgetTester tester) async {
1474
      await tester.pumpWidget(
1475 1476
        CupertinoApp(
          home: Builder(
1477 1478 1479 1480 1481 1482 1483
            builder: (BuildContext context) {
              return CupertinoSliverRefreshControl.buildRefreshIndicator(
                context,
                RefreshIndicatorMode.drag,
                10, 100, 10,
              );
            },
1484 1485 1486
          ),
        ),
      );
1487
      expect(tester.widget<CupertinoActivityIndicator>(find.byType(CupertinoActivityIndicator)).progress, 10.0 / 100.0);
1488 1489

      await tester.pumpWidget(
1490 1491
        CupertinoApp(
          home: Builder(
1492 1493 1494 1495 1496 1497 1498
            builder: (BuildContext context) {
              return CupertinoSliverRefreshControl.buildRefreshIndicator(
                context,
                RefreshIndicatorMode.drag,
                26, 100, 10,
              );
            },
1499 1500 1501
          ),
        ),
      );
1502
      expect(tester.widget<CupertinoActivityIndicator>(find.byType(CupertinoActivityIndicator)).progress, 26.0 / 100.0);
1503

1504
      await tester.pumpWidget(
1505 1506
        CupertinoApp(
          home: Builder(
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517
            builder: (BuildContext context) {
              return CupertinoSliverRefreshControl.buildRefreshIndicator(
                context,
                RefreshIndicatorMode.drag,
                100, 100, 10,
              );
            },
          ),
        ),
      );
      expect(tester.widget<CupertinoActivityIndicator>(find.byType(CupertinoActivityIndicator)).progress, 100.0 / 100.0);
1518
    });
1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538

    testWidgets('indicator should not become larger when overscrolled', (WidgetTester tester) async {
      // test for https://github.com/flutter/flutter/issues/79841
      await tester.pumpWidget(
        Directionality(
          textDirection: TextDirection.ltr,
          child: Builder(
            builder: (BuildContext context) {
              return CupertinoSliverRefreshControl.buildRefreshIndicator(
                context,
                RefreshIndicatorMode.done,
                120, 100, 10,
              );
            },
          ),
        ),
      );

      expect(tester.widget<CupertinoActivityIndicator>(find.byType(CupertinoActivityIndicator)).radius, 14.0);
    });
1539
  }
1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554

  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);
1555 1556 1557 1558 1559 1560

  testWidgets(
    'Does not crash when paintExtent > remainingPaintExtent',
    (WidgetTester tester) async {
      // Regression test for https://github.com/flutter/flutter/issues/46871.
      await tester.pumpWidget(
1561 1562
        CupertinoApp(
          home: CustomScrollView(
1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577
            physics: const BouncingScrollPhysics(),
            slivers: <Widget>[
              const CupertinoSliverRefreshControl(),
              SliverList(
                delegate: SliverChildBuilderDelegate(
                  (BuildContext context, int index) => const SizedBox(height: 100),
                  childCount: 20,
                ),
              ),
            ],
          ),
        ),
      );

      // Drag the content down far enough so that
1578
      // geometry.paintExtent > constraints.maxPaintExtent
1579 1580 1581 1582
      await tester.dragFrom(const Offset(10, 10), const Offset(0, 500));
      await tester.pump();

      expect(tester.takeException(), isNull);
1583 1584
    },
  );
1585 1586
}

1587 1588 1589 1590 1591 1592
class FakeBuilder {
  Completer<void> refreshCompleter = Completer<void>.sync();
  final List<MockHelperInvocation> invocations = <MockHelperInvocation>[];

  Widget refreshIndicator = Container();

1593 1594 1595 1596 1597 1598
  Widget builder(
    BuildContext context,
    RefreshIndicatorMode refreshState,
    double pulledExtent,
    double refreshTriggerPullDistance,
    double refreshIndicatorExtent,
1599 1600 1601 1602 1603 1604 1605 1606 1607 1608
  ) {
    if (pulledExtent < 0.0) {
      throw TestFailure('The pulledExtent should never be less than 0.0');
    }
    if (refreshTriggerPullDistance < 0.0) {
      throw TestFailure('The refreshTriggerPullDistance should never be less than 0.0');
    }
    if (refreshIndicatorExtent < 0.0) {
      throw TestFailure('The refreshIndicatorExtent should never be less than 0.0');
    }
1609 1610 1611 1612 1613 1614
    invocations.add(BuilderInvocation(
      refreshState: refreshState,
      pulledExtent: pulledExtent,
      refreshTriggerPullDistance: refreshTriggerPullDistance,
      refreshIndicatorExtent: refreshIndicatorExtent,
    ));
1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635
    return refreshIndicator;
  }

  Future<void> refreshTask() {
    invocations.add(const RefreshTaskInvocation());
    return refreshCompleter.future;
  }
}

abstract class MockHelperInvocation {
  const MockHelperInvocation();
}

@immutable
class RefreshTaskInvocation extends MockHelperInvocation {
  const RefreshTaskInvocation();
}

@immutable
class BuilderInvocation extends MockHelperInvocation {
  const BuilderInvocation({
1636 1637 1638 1639
    required this.refreshState,
    required this.pulledExtent,
    required this.refreshIndicatorExtent,
    required this.refreshTriggerPullDistance,
1640 1641 1642 1643 1644 1645 1646 1647 1648 1649
  });

  final RefreshIndicatorMode refreshState;
  final double pulledExtent;
  final double refreshTriggerPullDistance;
  final double refreshIndicatorExtent;

  @override
  String toString() => '{refreshState: $refreshState, pulledExtent: $pulledExtent, refreshTriggerPullDistance: $refreshTriggerPullDistance, refreshIndicatorExtent: $refreshIndicatorExtent}';
}
1650

1651
Matcher matchesBuilder({
1652 1653 1654 1655
  required RefreshIndicatorMode refreshState,
  required dynamic pulledExtent,
  required dynamic refreshTriggerPullDistance,
  required dynamic refreshIndicatorExtent,
1656 1657 1658 1659 1660 1661
}) {
  return isA<BuilderInvocation>()
    .having((BuilderInvocation invocation) => invocation.refreshState, 'refreshState', refreshState)
    .having((BuilderInvocation invocation) => invocation.pulledExtent, 'pulledExtent', pulledExtent)
    .having((BuilderInvocation invocation) => invocation.refreshTriggerPullDistance, 'refreshTriggerPullDistance', refreshTriggerPullDistance)
    .having((BuilderInvocation invocation) => invocation.refreshIndicatorExtent, 'refreshIndicatorExtent', refreshIndicatorExtent);
1662
}