Support history clearing (tomgilder#311)

miguelcmedeiros · Dec 26, 2022 · decb11a · decb11a
1 parent e6f04ec
commit decb11a
Show file tree

Hide file tree

Showing 2 changed files with 60 additions and 0 deletions.
diff --git a/lib/src/route_history.dart b/lib/src/route_history.dart
@@ -57,6 +57,17 @@ class RouteHistory {
     return true;
   }
 
+  /// Clear the navigation history.
+  ///
+  /// Does nothing if there's no history entry.
+  void clear() {
+    if (_index < 0) return;
+    final last = _history[_index];
+    _index = 0;
+    _history.clear();
+    _history.add(last);
+  }
+
 // coverage:ignore-start
   void _goToIndex(int index) {
     if (index == _index) {

diff --git a/test/history_test.dart b/test/history_test.dart
@@ -431,4 +431,53 @@ void main() {
     await tester.pumpPageTransition();
     expect(find.byType(PageThree), findsOneWidget);
   });
+
+  testWidgets('Check clearing history behavior', (tester) async {
+    final pageOneKey = GlobalKey();
+    final routeMap = RouteMap(
+      routes: {
+        '/': (_) => MaterialPage<void>(child: PageOne(key: pageOneKey)),
+        '/two': (_) => const MaterialPageTwo(),
+        '/two/three': (_) => const MaterialPageThree(),
+      },
+    );
+    final delegate = RoutemasterDelegate(routesBuilder: (_) => routeMap);
+
+    await tester.pumpWidget(
+      MaterialApp.router(
+        routeInformationParser: const RoutemasterParser(),
+        routerDelegate: delegate,
+      ),
+    );
+    await tester.pump();
+
+    final history = delegate.history;
+
+    // Push: / -> /two
+    delegate.push('/two');
+    await tester.pumpPageTransition();
+    expect(find.byType(PageTwo), findsOneWidget);
+
+    // Push: /two -> /two/three
+    delegate.push('/two/three');
+    await tester.pumpPageTransition();
+    expect(find.byType(PageThree), findsOneWidget);
+
+    // Back to page /two
+    history.back();
+    await tester.pumpPageTransition();
+
+    // Can go back -> /
+    expect(history.canGoBack, isTrue);
+    // Can go forward -> /two/three
+    expect(history.canGoForward, isTrue);
+
+    // Clear the history
+    history.clear();
+
+    // Cannot go back
+    expect(history.canGoBack, isFalse);
+    // Cannot go forward
+    expect(history.canGoForward, isFalse);
+  });
 }