will_pop_test.dart 10.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11
// Copyright 2016 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 'package:flutter_test/flutter_test.dart';
import 'package:flutter/material.dart';

bool willPopValue = false;

class SamplePage extends StatefulWidget {
  @override
12
  SamplePageState createState() => SamplePageState();
13 14 15
}

class SamplePageState extends State<SamplePage> {
16
  ModalRoute<void> _route;
17 18 19

  Future<bool> _callback() async => willPopValue;

20
  @override
21 22
  void didChangeDependencies() {
    super.didChangeDependencies();
23 24 25 26 27 28 29 30 31
    _route?.removeScopedWillPopCallback(_callback);
    _route = ModalRoute.of(context);
    _route?.addScopedWillPopCallback(_callback);
  }

  @override
  void dispose() {
    super.dispose();
    _route?.removeScopedWillPopCallback(_callback);
32 33 34 35
  }

  @override
  Widget build(BuildContext context) {
36 37
    return Scaffold(
      appBar: AppBar(title: const Text('Sample Page')),
38 39 40 41 42 43 44
    );
  }
}

int willPopCount = 0;

class SampleForm extends StatelessWidget {
45
  const SampleForm({ Key key, this.callback }) : super(key: key);
46 47 48 49 50

  final WillPopCallback callback;

  @override
  Widget build(BuildContext context) {
51 52 53 54
    return Scaffold(
      appBar: AppBar(title: const Text('Sample Form')),
      body: SizedBox.expand(
        child: Form(
55 56 57 58
          onWillPop: () {
            willPopCount += 1;
            return callback();
          },
59
          child: const TextField(),
60 61 62 63 64 65
        ),
      ),
    );
  }
}

66 67 68
// Expose the protected hasScopedWillPopCallback getter
class TestPageRoute<T> extends MaterialPageRoute<T> {
  TestPageRoute({ WidgetBuilder builder })
69
    : super(builder: builder, maintainState: true);
70 71 72 73 74

  bool get hasCallback => super.hasScopedWillPopCallback;
}


75 76 77
void main() {
  testWidgets('ModalRoute scopedWillPopupCallback can inhibit back button', (WidgetTester tester) async {
    await tester.pumpWidget(
78 79 80 81
      MaterialApp(
        home: Scaffold(
          appBar: AppBar(title: const Text('Home')),
          body: Builder(
82
            builder: (BuildContext context) {
83 84
              return Center(
                child: FlatButton(
85
                  child: const Text('X'),
86
                  onPressed: () {
87
                    showDialog<void>(
88
                      context: context,
89
                      builder: (BuildContext context) => SamplePage(),
90 91 92 93 94 95 96 97 98 99
                    );
                  },
                ),
              );
            },
          ),
        ),
      ),
    );

100 101 102
    expect(find.byTooltip('Back'), findsNothing);
    expect(find.text('Sample Page'), findsNothing);

103 104 105 106 107 108 109 110 111 112 113 114 115
    await tester.tap(find.text('X'));
    await tester.pump();
    await tester.pump(const Duration(seconds: 1));

    expect(find.text('Sample Page'), findsOneWidget);

    willPopValue = false;
    await tester.tap(find.byTooltip('Back'));
    await tester.pump();
    await tester.pump();
    await tester.pump(const Duration(seconds: 1));
    expect(find.text('Sample Page'), findsOneWidget);

116
    // Use didPopRoute() to simulate the system back button. Check that
117 118 119 120 121
    // didPopRoute() indicates that the notification was handled.
    final dynamic widgetsAppState = tester.state(find.byType(WidgetsApp));
    expect(await widgetsAppState.didPopRoute(), isTrue);
    expect(find.text('Sample Page'), findsOneWidget);

122 123 124 125 126 127 128 129 130 131
    willPopValue = true;
    await tester.tap(find.byTooltip('Back'));
    await tester.pump();
    await tester.pump();
    await tester.pump(const Duration(seconds: 1));
    expect(find.text('Sample Page'), findsNothing);
  });

  testWidgets('Form.willPop can inhibit back button', (WidgetTester tester) async {
    Widget buildFrame() {
132 133 134 135
      return MaterialApp(
        home: Scaffold(
          appBar: AppBar(title: const Text('Home')),
          body: Builder(
136
            builder: (BuildContext context) {
137 138
              return Center(
                child: FlatButton(
139
                  child: const Text('X'),
140
                  onPressed: () {
141
                    Navigator.of(context).push(MaterialPageRoute<void>(
142
                      builder: (BuildContext context) {
143 144
                        return SampleForm(
                          callback: () => Future<bool>.value(willPopValue),
145
                        );
146
                      },
147 148 149 150 151 152 153 154 155 156 157 158 159 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
                    ));
                  },
                ),
              );
            },
          ),
        ),
      );
    }

    await tester.pumpWidget(buildFrame());

    await tester.tap(find.text('X'));
    await tester.pump();
    await tester.pump(const Duration(seconds: 1));

    expect(find.text('Sample Form'), findsOneWidget);

    willPopValue = false;
    willPopCount = 0;
    await tester.tap(find.byTooltip('Back'));
    await tester.pump(); // Start the pop "back" operation.
    await tester.pump(); // Complete the willPop() Future.
    await tester.pump(const Duration(seconds: 1)); // Wait until it has finished.
    expect(find.text('Sample Form'), findsOneWidget);
    expect(willPopCount, 1);

    willPopValue = true;
    willPopCount = 0;
    await tester.tap(find.byTooltip('Back'));
    await tester.pump(); // Start the pop "back" operation.
    await tester.pump(); // Complete the willPop() Future.
    await tester.pump(const Duration(seconds: 1)); // Wait until it has finished.
    expect(find.text('Sample Form'), findsNothing);
    expect(willPopCount, 1);
  });

  testWidgets('Form.willPop callbacks do not accumulate', (WidgetTester tester) async {
    Future<bool> showYesNoAlert(BuildContext context) {
186
      return showDialog<bool>(
187
        context: context,
188
        builder: (BuildContext context) {
189
          return AlertDialog(
190
            actions: <Widget> [
191
              FlatButton(
192 193 194
                child: const Text('YES'),
                onPressed: () { Navigator.of(context).pop(true); },
              ),
195
              FlatButton(
196 197 198 199 200 201
                child: const Text('NO'),
                onPressed: () { Navigator.of(context).pop(false); },
              ),
            ],
          );
        },
202 203 204 205
      );
    }

    Widget buildFrame() {
206 207 208 209
      return MaterialApp(
        home: Scaffold(
          appBar: AppBar(title: const Text('Home')),
          body: Builder(
210
            builder: (BuildContext context) {
211 212
              return Center(
                child: FlatButton(
213
                  child: const Text('X'),
214
                  onPressed: () {
215
                    Navigator.of(context).push(MaterialPageRoute<void>(
216
                      builder: (BuildContext context) {
217
                        return SampleForm(
218 219 220 221 222 223 224 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 250
                          callback: () => showYesNoAlert(context),
                        );
                      }
                    ));
                  },
                ),
              );
            },
          ),
        ),
      );
    }

    await tester.pumpWidget(buildFrame());

    await tester.tap(find.text('X'));
    await tester.pump();
    await tester.pump(const Duration(seconds: 1));

    expect(find.text('Sample Form'), findsOneWidget);

    // Press the Scaffold's back button. This causes the willPop callback
    // to run, which shows the YES/NO Alert Dialog. Veto the back operation
    // by pressing the Alert's NO button.
    await tester.tap(find.byTooltip('Back'));
    await tester.pump(); // Start the pop "back" operation.
    await tester.pump(); // Call willPop which will show an Alert.
    await tester.tap(find.text('NO'));
    await tester.pump(); // Start the dismiss animation.
    await tester.pump(); // Resolve the willPop callback.
    await tester.pump(const Duration(seconds: 1)); // Wait until it has finished.
    expect(find.text('Sample Form'), findsOneWidget);

Ian Hickson's avatar
Ian Hickson committed
251 252 253 254
    // Do it again.
    // Each time the Alert is shown and dismissed the FormState's
    // didChangeDependencies() method runs. We're making sure that the
    // didChangeDependencies() method doesn't add an extra willPop callback.
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
    await tester.tap(find.byTooltip('Back'));
    await tester.pump(); // Start the pop "back" operation.
    await tester.pump(); // Call willPop which will show an Alert.
    await tester.tap(find.text('NO'));
    await tester.pump(); // Start the dismiss animation.
    await tester.pump(); // Resolve the willPop callback.
    await tester.pump(const Duration(seconds: 1)); // Wait until it has finished.
    expect(find.text('Sample Form'), findsOneWidget);

    // This time really dismiss the SampleForm by pressing the Alert's
    // YES button.
    await tester.tap(find.byTooltip('Back'));
    await tester.pump(); // Start the pop "back" operation.
    await tester.pump(); // Call willPop which will show an Alert.
    await tester.tap(find.text('YES'));
    await tester.pump(); // Start the dismiss animation.
    await tester.pump(); // Resolve the willPop callback.
    await tester.pump(const Duration(seconds: 1)); // Wait until it has finished.
    expect(find.text('Sample Form'), findsNothing);
  });

276 277 278 279
  testWidgets('Route.scopedWillPop callbacks do not accumulate', (WidgetTester tester) async {
    StateSetter contentsSetState; // call this to rebuild the route's SampleForm contents
    bool contentsEmpty = false; // when true, don't include the SampleForm in the route

280
    final TestPageRoute<void> route = TestPageRoute<void>(
281
      builder: (BuildContext context) {
282
        return StatefulBuilder(
283 284
          builder: (BuildContext context, StateSetter setState) {
            contentsSetState = setState;
285
            return contentsEmpty ? Container() : SampleForm(key: UniqueKey());
286 287 288 289 290 291
          }
        );
      },
    );

    Widget buildFrame() {
292 293 294 295
      return MaterialApp(
        home: Scaffold(
          appBar: AppBar(title: const Text('Home')),
          body: Builder(
296
            builder: (BuildContext context) {
297 298
              return Center(
                child: FlatButton(
299
                  child: const Text('X'),
300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
                  onPressed: () {
                    Navigator.of(context).push(route);
                  },
                ),
              );
            },
          ),
        ),
      );
    }

    await tester.pumpWidget(buildFrame());

    await tester.tap(find.text('X'));
    await tester.pump();
    await tester.pump(const Duration(seconds: 1));

    expect(find.text('Sample Form'), findsOneWidget);
    expect(route.hasCallback, isTrue);

    // Rebuild the route's SampleForm child an additional 3x for good measure.
    contentsSetState(() { });
    await tester.pump();
    contentsSetState(() { });
    await tester.pump();
    contentsSetState(() { });
    await tester.pump();

    // Now build the route's contents without the sample form.
    contentsEmpty = true;
    contentsSetState(() { });
    await tester.pump();

    expect(route.hasCallback, isFalse);
  });
335
}