Skip to content

home: Stop assuming account existence from loading page #1235

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 27, 2025
Merged

home: Stop assuming account existence from loading page #1235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
127239b
home test [nfc]: Extract helpers to be shared
PIG208 Jan 24, 2025
1c684a4
home: Stop assuming account existence from loading page
PIG208 Dec 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 15 additions & 4 deletions lib/widgets/home.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,11 @@ const kTryAnotherAccountWaitPeriod = Duration(seconds: 5);
class _LoadingPlaceholderPage extends StatefulWidget {
const _LoadingPlaceholderPage({required this.accountId});

/// The relevant account for this page.
///
/// The account is not guaranteed to exist in the global store. This can
/// happen briefly when the account is removed from the database for logout,
/// but before [PerAccountStoreWidget.routeToRemoveOnLogout] is processed.
final int accountId;

@override
Expand Down Expand Up @@ -180,9 +185,15 @@ class _LoadingPlaceholderPageState extends State<_LoadingPlaceholderPage> {
@override
Widget build(BuildContext context) {
final zulipLocalizations = ZulipLocalizations.of(context);
final realmUrl = GlobalStoreWidget.of(context)
// TODO(#1219) `!` is incorrect
.getAccount(widget.accountId)!.realmUrl;
final account = GlobalStoreWidget.of(context).getAccount(widget.accountId);

if (account == null) {
// We should only reach this state very briefly.
// See [_LoadingPlaceholderPage.accountId].
return Scaffold(
appBar: AppBar(),
body: const SizedBox.shrink());
}

return Scaffold(
appBar: AppBar(),
Expand All @@ -201,7 +212,7 @@ class _LoadingPlaceholderPageState extends State<_LoadingPlaceholderPage> {
child: Column(
children: [
const SizedBox(height: 16),
Text(zulipLocalizations.tryAnotherAccountMessage(realmUrl.toString())),
Text(zulipLocalizations.tryAnotherAccountMessage(account.realmUrl.toString())),
const SizedBox(height: 8),
ElevatedButton(
onPressed: () => Navigator.push(context,
Expand Down
71 changes: 54 additions & 17 deletions test/widgets/home_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import 'package:zulip/api/model/events.dart';
import 'package:zulip/model/narrow.dart';
import 'package:zulip/model/store.dart';
import 'package:zulip/widgets/about_zulip.dart';
import 'package:zulip/widgets/actions.dart';
import 'package:zulip/widgets/app.dart';
import 'package:zulip/widgets/app_bar.dart';
import 'package:zulip/widgets/home.dart';
Expand All @@ -21,6 +22,7 @@ import '../api/fake_api.dart';
import '../example_data.dart' as eg;
import '../flutter_checks.dart';
import '../model/binding.dart';
import '../model/store_checks.dart';
import '../model/test_store.dart';
import '../test_navigation.dart';
import 'message_list_checks.dart';
Expand Down Expand Up @@ -49,6 +51,23 @@ void main () {
await tester.pump();
}

void checkOnLoadingPage() {
check(find.byType(CircularProgressIndicator).hitTestable()).findsOne();
check(find.byType(ChooseAccountPage)).findsNothing();
check(find.byType(HomePage)).findsNothing();
}

ModalRoute<void>? getRouteOf(WidgetTester tester, Finder finder) =>
ModalRoute.of(tester.element(finder));

void checkOnHomePage(WidgetTester tester, {required Account expectedAccount}) {
check(find.byType(CircularProgressIndicator)).findsNothing();
check(find.byType(ChooseAccountPage)).findsNothing();
check(find.byType(HomePage).hitTestable()).findsOne();
check(getRouteOf(tester, find.byType(HomePage)))
.isA<MaterialAccountWidgetRoute>().accountId.equals(expectedAccount.id);
}

group('bottom nav navigation', () {
testWidgets('preserve states when switching between views', (tester) async {
await prepare(tester);
Expand Down Expand Up @@ -255,30 +274,13 @@ void main () {
const loadPerAccountDuration = Duration(seconds: 30);
assert(loadPerAccountDuration > kTryAnotherAccountWaitPeriod);

void checkOnLoadingPage() {
check(find.byType(CircularProgressIndicator).hitTestable()).findsOne();
check(find.byType(ChooseAccountPage)).findsNothing();
check(find.byType(HomePage)).findsNothing();
}

void checkOnChooseAccountPage() {
// Ignore the possible loading page in the background.
check(find.byType(CircularProgressIndicator).hitTestable()).findsNothing();
check(find.byType(ChooseAccountPage)).findsOne();
check(find.byType(HomePage)).findsNothing();
}

ModalRoute<void>? getRouteOf(WidgetTester tester, Finder finder) =>
ModalRoute.of(tester.element(finder));

void checkOnHomePage(WidgetTester tester, {required Account expectedAccount}) {
check(find.byType(CircularProgressIndicator)).findsNothing();
check(find.byType(ChooseAccountPage)).findsNothing();
check(find.byType(HomePage).hitTestable()).findsOne();
check(getRouteOf(tester, find.byType(HomePage)))
.isA<MaterialAccountWidgetRoute>().accountId.equals(expectedAccount.id);
}

Future<void> prepare(WidgetTester tester) async {
addTearDown(testBinding.reset);
await testBinding.globalStore.add(eg.selfAccount, eg.initialSnapshot());
Expand Down Expand Up @@ -442,4 +444,39 @@ void main () {
checkOnHomePage(tester, expectedAccount: eg.selfAccount);
});
});

testWidgets('logging out while still loading', (tester) async {
// Regression test for: https://github.com/zulip/zulip-flutter/issues/1219
addTearDown(testBinding.reset);
await testBinding.globalStore.add(eg.selfAccount, eg.initialSnapshot());
await tester.pumpWidget(const ZulipApp());
await tester.pump(); // wait for the loading page
checkOnLoadingPage();

final element = tester.element(find.byType(MaterialApp));
final future = logOutAccount(element, eg.selfAccount.id);
await tester.pump(TestGlobalStore.removeAccountDuration);
await future;
// No error expected from briefly not having
// access to the account being logged out.
check(testBinding.globalStore).accountIds.isEmpty();
});

testWidgets('logging out after fully loaded', (tester) async {
// Regression test for: https://github.com/zulip/zulip-flutter/issues/1219
addTearDown(testBinding.reset);
await testBinding.globalStore.add(eg.selfAccount, eg.initialSnapshot());
await tester.pumpWidget(const ZulipApp());
await tester.pump(); // wait for the loading page
await tester.pump(); // wait for store
checkOnHomePage(tester, expectedAccount: eg.selfAccount);

final element = tester.element(find.byType(HomePage));
final future = logOutAccount(element, eg.selfAccount.id);
await tester.pump(TestGlobalStore.removeAccountDuration);
await future;
// No error expected from briefly not having
// access to the account being logged out.
check(testBinding.globalStore).accountIds.isEmpty();
});
}