app: Move initialization of GlobalStore from GlobalStoreWidget to ZulipApp

Author: rajveermalviya

lib/widgets/app.dart

@@ -7,6 +7,7 @@ import 'package:flutter/scheduler.dart';
 import '../generated/l10n/zulip_localizations.dart';
 import '../log.dart';
 import '../model/actions.dart';
+import '../model/binding.dart';
 import '../model/localizations.dart';
 import '../model/store.dart';
 import '../notifications/display.dart';
@@ -151,10 +152,19 @@ class ZulipApp extends StatefulWidget {
 }
 
 class _ZulipAppState extends State<ZulipApp> with WidgetsBindingObserver {
+  GlobalStore? _globalStore;
+
   @override
   void initState() {
     super.initState();
     WidgetsBinding.instance.addObserver(this);
+    () async {
+      final globalStore = await ZulipBinding.instance.getGlobalStoreUniquely();
+      if (!mounted) return;
+      setState(() {
+        _globalStore = globalStore;
+      });
+    }();
   }
 
   @override
@@ -212,7 +222,10 @@ class _ZulipAppState extends State<ZulipApp> with WidgetsBindingObserver {
 
   @override
   Widget build(BuildContext context) {
+    if (_globalStore == null) return const LoadingPlaceholder();
+
     return GlobalStoreWidget(
+      store: _globalStore!,
       child: Builder(builder: (context) {
         return MaterialApp(
           onGenerateTitle: (BuildContext context) {

lib/widgets/store.dart

@@ -1,8 +1,6 @@
 import 'package:flutter/material.dart';
 import 'package:flutter/scheduler.dart';
 
-import '../model/binding.dart';
-import '../model/database.dart';
 import '../model/settings.dart';
 import '../model/store.dart';
 import 'page.dart';
@@ -15,15 +13,14 @@ import 'page.dart';
 ///  * [GlobalStoreWidget.of], to get access to the data.
 ///  * [PerAccountStoreWidget], for the user's data associated with a
 ///    particular Zulip account.
-class GlobalStoreWidget extends StatefulWidget {
-  const GlobalStoreWidget({
+class GlobalStoreWidget extends InheritedNotifier<GlobalStore> {
+  GlobalStoreWidget({
     super.key,
-    this.placeholder = const LoadingPlaceholder(),
-    required this.child,
-  });
-
-  final Widget placeholder;
-  final Widget child;
+    required GlobalStore store,
+    required Widget child,
+  }) : super(notifier: store,
+         child: _GlobalSettingsStoreInheritedWidget(
+           store: store.settings, child: child));
 
   /// The app's global data store.
   ///
@@ -48,7 +45,7 @@ class GlobalStoreWidget extends StatefulWidget {
   ///  * [PerAccountStoreWidget.of], for the user's data associated with a
   ///    particular Zulip account.
   static GlobalStore of(BuildContext context) {
-    final widget = context.dependOnInheritedWidgetOfExactType<_GlobalStoreInheritedWidget>();
+    final widget = context.dependOnInheritedWidgetOfExactType<GlobalStoreWidget>();
     assert(widget != null, 'No GlobalStoreWidget ancestor');
     return widget!.store;
   }
@@ -75,47 +72,10 @@ class GlobalStoreWidget extends StatefulWidget {
     return widget!.store;
   }
 
-  @override
-  State<GlobalStoreWidget> createState() => _GlobalStoreWidgetState();
-}
-
-class _GlobalStoreWidgetState extends State<GlobalStoreWidget> {
-  GlobalStore? store;
-
-  @override
-  void initState() {
-    super.initState();
-    (() async {
-      final store = await ZulipBinding.instance.getGlobalStoreUniquely();
-      setState(() {
-        this.store = store;
-      });
-    })();
-  }
-
-  @override
-  Widget build(BuildContext context) {
-    final store = this.store;
-    if (store == null) return widget.placeholder;
-    return _GlobalStoreInheritedWidget(store: store, child: widget.child);
-  }
-}
-
-// This is separate from [GlobalStoreWidget] only because we need
-// a [StatefulWidget] to get hold of the store, and an [InheritedWidget] to
-// provide it to descendants, and one widget can't be both of those.
-class _GlobalStoreInheritedWidget extends InheritedNotifier<GlobalStore> {
-  _GlobalStoreInheritedWidget({
-    required GlobalStore store,
-    required Widget child,
-  }) : super(notifier: store,
-         child: _GlobalSettingsStoreInheritedWidget(
-           store: store.settings, child: child));
-
   GlobalStore get store => notifier!;
 }
 
-// This is like [_GlobalStoreInheritedWidget] except it subscribes to the
+// This is like [GlobalStoreWidget] except it subscribes to the
 // [GlobalSettingsStore] instead of the overall [GlobalStore].
 // That enables [settingsOf] to do the same.
 class _GlobalSettingsStoreInheritedWidget extends InheritedNotifier<GlobalSettingsStore> {

test/widgets/app_test.dart

@@ -6,9 +6,11 @@ import 'package:flutter_test/flutter_test.dart';
 import 'package:zulip/log.dart';
 import 'package:zulip/model/actions.dart';
 import 'package:zulip/model/database.dart';
+import 'package:zulip/model/store.dart';
 import 'package:zulip/widgets/app.dart';
 import 'package:zulip/widgets/home.dart';
 import 'package:zulip/widgets/page.dart';
+import 'package:zulip/widgets/store.dart';
 
 import '../example_data.dart' as eg;
 import '../flutter_checks.dart';
@@ -23,6 +25,31 @@ import 'test_app.dart';
 void main() {
   TestZulipBinding.ensureInitialized();
 
+  testWidgets('ZulipApp loads data while showing placeholder', (tester) async {
+    addTearDown(testBinding.reset);
+
+    GlobalStore? globalStore;
+    await tester.pumpWidget(ZulipApp());
+    unawaited(ZulipApp.navigator.then((navigator) {
+      globalStore = GlobalStoreWidget.of(navigator.context);
+    }));
+
+    // First, shows a loading page instead of child.
+    check(tester.any(find.byType(CircularProgressIndicator))).isTrue();
+    check(globalStore).isNull();
+
+    await tester.pump();
+    // Then after loading, shows the ChooseAccountPage, with provided store.
+    check(tester.any(find.byType(CircularProgressIndicator))).isFalse();
+    check(tester.any(find.byType(ChooseAccountPage))).isTrue();
+    check(globalStore).identicalTo(testBinding.globalStore);
+
+    await testBinding.globalStore.add(eg.selfAccount, eg.initialSnapshot());
+    check(globalStore).isNotNull()
+      .accountEntries.single
+      .equals((accountId: eg.selfAccount.id, account: eg.selfAccount));
+  });
+
   group('ZulipApp initial navigation', () {
     late List<Route<dynamic>> pushedRoutes = [];
 

test/widgets/content_test.dart

@@ -15,7 +15,6 @@ import 'package:zulip/widgets/content.dart';
 import 'package:zulip/widgets/icons.dart';
 import 'package:zulip/widgets/message_list.dart';
 import 'package:zulip/widgets/page.dart';
-import 'package:zulip/widgets/store.dart';
 import 'package:zulip/widgets/text.dart';
 
 import '../example_data.dart' as eg;
@@ -1139,9 +1138,9 @@ void main() {
 
       final httpClient = prepareBoringImageHttpClient();
 
-      await tester.pumpWidget(GlobalStoreWidget(
-        child: PerAccountStoreWidget(accountId: eg.selfAccount.id,
-          child: RealmContentNetworkImage(src))));
+      await tester.pumpWidget(TestZulipApp(
+        accountId: eg.selfAccount.id,
+        child: RealmContentNetworkImage(src)));
       await tester.pump();
       await tester.pump();
 
@@ -1181,9 +1180,9 @@ void main() {
       await store.addUser(user);
 
       prepareBoringImageHttpClient();
-      await tester.pumpWidget(GlobalStoreWidget(
-        child: PerAccountStoreWidget(accountId: eg.selfAccount.id,
-          child: AvatarImage(userId: user.userId, size: size ?? 30))));
+      await tester.pumpWidget(TestZulipApp(
+        accountId: eg.selfAccount.id,
+        child: AvatarImage(userId: user.userId, size: size ?? 30)));
       await tester.pump();
       await tester.pump();
       tester.widget(find.byType(AvatarImage));