squash! nav: Always clear stack before navigating to HomePage

Note to self: drop this commit message when squashing.

Signed-off-by: Zixuan James Li <[email protected]>

Author: PIG208

lib/widgets/app.dart

@@ -266,8 +266,12 @@ class ChooseAccountPage extends StatelessWidget {
         // The default trailing padding with M3 is 24px. Decrease by 12 because
         // IconButton (the "…" button) comes with 12px padding on all sides.
         contentPadding: const EdgeInsetsDirectional.only(start: 16, end: 12),
-        onTap: () => Navigator.push(context,
-          HomePage.buildRoute(accountId: accountId))));
+        onTap: () async {
+          final navigator = Navigator.of(context);
+          navigator.popUntil((route) => route.isFirst);
+          unawaited(navigator.pushReplacement(
+            HomePage.buildRoute(accountId: accountId)));
+        }));
   }
 
   @override

lib/widgets/login.dart

@@ -395,10 +395,10 @@ class _LoginPageState extends State<LoginPage> {
       return;
     }
 
-    unawaited(Navigator.of(context).pushAndRemoveUntil(
-      HomePage.buildRoute(accountId: accountId),
-      (route) => (route is! _LoginSequenceRoute)),
-    );
+    final navigator = Navigator.of(context);
+    navigator.popUntil((route) => route.isFirst);
+    unawaited(Navigator.of(context).pushReplacement(
+      HomePage.buildRoute(accountId: accountId)));
   }
 
   Future<int> _getUserId(String email, String apiKey) async {

test/widgets/app_test.dart

@@ -1,3 +1,5 @@
+import 'dart:async';
+
 import 'package:checks/checks.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter_test/flutter_test.dart';
@@ -22,13 +24,20 @@ void main() {
 
   group('ZulipApp initial navigation', () {
     late List<Route<dynamic>> pushedRoutes = [];
+    late List<Route<dynamic>> poppedRoutes = [];
 
     Future<void> prepare(WidgetTester tester) async {
       addTearDown(testBinding.reset);
 
       pushedRoutes = [];
-      final testNavObserver = TestNavigatorObserver()
-        ..onPushed = (route, prevRoute) => pushedRoutes.add(route);
+      poppedRoutes = [];
+      final testNavObserver = TestNavigatorObserver();
+      testNavObserver.onPushed = (route, prevRoute) => pushedRoutes.add(route);
+      testNavObserver.onPopped = (route, prevRoute) => poppedRoutes.add(route);
+      testNavObserver.onReplaced = (route, prevRoute) {
+        poppedRoutes.add(prevRoute!);
+        pushedRoutes.add(route!);
+      };
       await tester.pumpWidget(ZulipApp(navigatorObservers: [testNavObserver]));
       await tester.pump();
     }
@@ -53,6 +62,44 @@ void main() {
           ..page.isA<HomePage>(),
       ]);
     });
+
+    testWidgets('choosing an account clears the navigator stack', (tester) async {
+      addTearDown(testBinding.reset);
+      await testBinding.globalStore.add(eg.selfAccount, eg.initialSnapshot());
+      await testBinding.globalStore.add(eg.otherAccount, eg.initialSnapshot());
+
+      await prepare(tester);
+
+      final navigator = await ZulipApp.navigator;
+      unawaited(navigator.push(
+        MaterialWidgetRoute(page: const ChooseAccountPage())));
+      await tester.pumpAndSettle();
+
+      check(poppedRoutes).isEmpty();
+      check(pushedRoutes).deepEquals(<Condition<Object?>>[
+        (it) => it.isA<MaterialAccountWidgetRoute>()
+          ..accountId.equals(eg.selfAccount.id)
+          ..page.isA<HomePage>(),
+        (it) => it.isA<MaterialWidgetRoute>()
+          ..page.isA<ChooseAccountPage>()
+      ]);
+      pushedRoutes.clear();
+
+      await tester.tap(find.text(eg.otherAccount.email));
+      await tester.pump();
+      check(poppedRoutes).deepEquals(<Condition<Object?>>[
+        (it) => it.isA<MaterialWidgetRoute>()
+          ..page.isA<ChooseAccountPage>(),
+        (it) => it.isA<MaterialAccountWidgetRoute>()
+          ..accountId.equals(eg.selfAccount.id)
+          ..page.isA<HomePage>(),
+      ]);
+      check(pushedRoutes).deepEquals(<Condition<Object?>>[
+        (it) => it.isA<MaterialAccountWidgetRoute>()
+          ..accountId.equals(eg.otherAccount.id)
+          ..page.isA<HomePage>(),
+      ]);
+    });
   });
 
   group('ChooseAccountPage', () {

test/widgets/login_test.dart

@@ -70,6 +70,7 @@ void main() {
   group('LoginPage', () {
     late FakeApiConnection connection;
     late List<Route<dynamic>> pushedRoutes;
+    late List<Route<dynamic>> poppedRoutes;
 
     void checkNotLoggedInStartingRoutes() {
       final expected = <Condition<Object?>>[
@@ -88,8 +89,14 @@ void main() {
         zulipFeatureLevel: serverSettings.zulipFeatureLevel);
 
       pushedRoutes = [];
-      final testNavObserver = TestNavigatorObserver()
-        ..onPushed = (route, prevRoute) => pushedRoutes.add(route);
+      poppedRoutes = [];
+      final testNavObserver = TestNavigatorObserver();
+      testNavObserver.onPushed = (route, prevRoute) => pushedRoutes.add(route);
+      testNavObserver.onPopped = (route, prevRoute) => poppedRoutes.add(route);
+      testNavObserver.onReplaced = (route, prevRoute) {
+        poppedRoutes.add(prevRoute!);
+        pushedRoutes.add(route!);
+      };
       await tester.pumpWidget(ZulipApp(navigatorObservers: [testNavObserver]));
       await tester.pump();
       final navigator = await ZulipApp.navigator;
@@ -143,6 +150,39 @@ void main() {
             id: testBinding.globalStore.accounts.single.id));
       });
 
+      testWidgets('logging into a different account', (tester) async {
+        await testBinding.globalStore.add(eg.selfAccount, eg.initialSnapshot());
+        final serverSettings = eg.serverSettings();
+        await prepare(tester, serverSettings);
+        check(poppedRoutes).isEmpty();
+        check(pushedRoutes).deepEquals(<Condition<Object?>>[
+          (it) => it.isA<MaterialAccountWidgetRoute>()
+            ..accountId.equals(eg.selfAccount.id)
+            ..page.isA<HomePage>(),
+          (it) => it.isA<MaterialWidgetRoute>()
+            ..page.isA<LoginPage>(),
+        ]);
+        pushedRoutes.clear();
+
+        await login(tester, eg.otherAccount);
+        final loggedInAccount = testBinding.globalStore.accounts.singleWhere(
+          (account) => account != eg.selfAccount);
+        check(loggedInAccount).equals(eg.otherAccount.copyWith(
+          id: loggedInAccount.id));
+        check(poppedRoutes).deepEquals(<Condition<Object?>>[
+          (it) => it.isA<MaterialWidgetRoute>()
+            ..page.isA<LoginPage>(),
+          (it) => it.isA<MaterialAccountWidgetRoute>()
+            ..accountId.equals(eg.selfAccount.id)
+            ..page.isA<HomePage>(),
+        ]);
+        check(pushedRoutes).deepEquals(<Condition<Object?>>[
+          (it) => it.isA<MaterialAccountWidgetRoute>()
+            ..accountId.equals(loggedInAccount.id)
+            ..page.isA<HomePage>(),
+        ]);
+      });
+
       testWidgets('trims whitespace on username', (tester) async {
         final serverSettings = eg.serverSettings();
         await prepare(tester, serverSettings);