store: Store global settings on global store

To add integration tests for global store with sqlite, we might want
to switch to LiveGlobalStore, or at least make part of it testable
with an in-memory database (like we do for database_test.dart).
Leaving that to the future.

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

Author: PIG208

lib/model/store.dart

@@ -53,8 +53,31 @@ export 'database.dart' show Account, AccountsCompanion, AccountAlreadyExistsExce
 ///  * [LiveGlobalStore], the implementation of this class that
 ///    we use outside of tests.
 abstract class GlobalStore extends ChangeNotifier {
-  GlobalStore({required Iterable<Account> accounts})
-    : _accounts = Map.fromEntries(accounts.map((a) => MapEntry(a.id, a)));
+  GlobalStore({
+    required GlobalSettingsData globalSettings,
+    required Iterable<Account> accounts,
+  })
+    : _globalSettings = globalSettings,
+      _accounts = Map.fromEntries(accounts.map((a) => MapEntry(a.id, a)));
+
+  /// A cache of the [GlobalSettingsData] singleton in the underlying data store.
+  GlobalSettingsData get globalSettings => _globalSettings;
+  GlobalSettingsData _globalSettings;
+
+  /// Update the global settings in the store, returning the new version.
+  ///
+  /// The global settings must already exist in the store.
+  Future<GlobalSettingsData> updateGlobalSettings(GlobalSettingsCompanion data) async {
+    await doUpdateGlobalSettings(data);
+    _globalSettings = _globalSettings.copyWithCompanion(data);
+    notifyListeners();
+    return _globalSettings;
+  }
+
+  /// Update the global settings in the underlying data store.
+  ///
+  /// This should only be called from [updateGlobalSettings].
+  Future<void> doUpdateGlobalSettings(GlobalSettingsCompanion data);
 
   /// A cache of the [Accounts] table in the underlying data store.
   final Map<int, Account> _accounts;
@@ -814,6 +837,7 @@ Uri? tryResolveUrl(Uri baseUrl, String reference) {
 class LiveGlobalStore extends GlobalStore {
   LiveGlobalStore._({
     required AppDatabase db,
+    required super.globalSettings,
     required super.accounts,
   }) : _db = db;
 
@@ -830,8 +854,11 @@ class LiveGlobalStore extends GlobalStore {
   // by doing this loading up front before constructing a [GlobalStore].
   static Future<GlobalStore> load() async {
     final db = AppDatabase(NativeDatabase.createInBackground(await _dbFile()));
+    final globalSettings = await db.ensureGlobalSettings();
     final accounts = await db.select(db.accounts).get();
-    return LiveGlobalStore._(db: db, accounts: accounts);
+    return LiveGlobalStore._(db: db,
+      globalSettings: globalSettings,
+      accounts: accounts);
   }
 
   /// The file path to use for the app database.
@@ -855,6 +882,12 @@ class LiveGlobalStore extends GlobalStore {
 
   final AppDatabase _db;
 
+  @override
+  Future<void> doUpdateGlobalSettings(GlobalSettingsCompanion data) async {
+    final rowsAffected = await _db.update(_db.globalSettings).write(data);
+    assert(rowsAffected == 1);
+  }
+
   @override
   Future<PerAccountStore> doLoadPerAccount(int accountId) async {
     final updateMachine = await UpdateMachine.load(this, accountId);

test/example_data.dart

@@ -885,9 +885,16 @@ GlobalSettingsData globalSettings({
     themeSetting: themeSetting,
   );
 }
+const _globalSettings = globalSettings;
 
-TestGlobalStore globalStore({List<Account> accounts = const []}) {
-  return TestGlobalStore(accounts: accounts);
+TestGlobalStore globalStore({
+  GlobalSettingsData? globalSettings,
+  List<Account> accounts = const [],
+}) {
+  return TestGlobalStore(
+    globalSettings: globalSettings ?? _globalSettings(),
+    accounts: accounts,
+  );
 }
 const _globalStore = globalStore;
 

test/model/store_checks.dart

@@ -22,6 +22,7 @@ extension AccountChecks on Subject<Account> {
 }
 
 extension GlobalStoreChecks on Subject<GlobalStore> {
+  Subject<GlobalSettingsData> get globalSettings => has((x) => x.globalSettings, 'globalSettings');
   Subject<Iterable<Account>> get accounts => has((x) => x.accounts, 'accounts');
   Subject<Iterable<int>> get accountIds => has((x) => x.accountIds, 'accountIds');
   Subject<Iterable<({ int accountId, Account account })>> get accountEntries => has((x) => x.accountEntries, 'accountEntries');

test/model/store_test.dart

@@ -14,6 +14,8 @@ import 'package:zulip/api/route/messages.dart';
 import 'package:zulip/api/route/realm.dart';
 import 'package:zulip/log.dart';
 import 'package:zulip/model/actions.dart';
+import 'package:zulip/model/database.dart';
+import 'package:zulip/model/settings.dart';
 import 'package:zulip/model/store.dart';
 import 'package:zulip/notifications/receive.dart';
 
@@ -29,6 +31,31 @@ import 'test_store.dart';
 void main() {
   TestZulipBinding.ensureInitialized();
 
+  group('GlobalStore.updateGlobalSettings', () {
+    test('smoke', () async {
+      final globalStore = eg.globalStore();
+      check(globalStore).globalSettings.themeSetting.equals(null);
+
+      final result = await globalStore.updateGlobalSettings(
+        GlobalSettingsCompanion(themeSetting: Value(ThemeSetting.dark)));
+      check(globalStore).globalSettings.themeSetting.equals(ThemeSetting.dark);
+      check(result).equals(globalStore.globalSettings);
+    });
+
+    test('should notify listeners', () async {
+      int notifyCount = 0;
+      final globalStore = eg.globalStore();
+      globalStore.addListener(() => notifyCount++);
+      check(notifyCount).equals(0);
+
+      await globalStore.updateGlobalSettings(
+        GlobalSettingsCompanion(themeSetting: Value(ThemeSetting.light)));
+      check(notifyCount).equals(1);
+    });
+
+    // TODO integration tests with sqlite
+  });
+
   final account1 = eg.selfAccount.copyWith(id: 1);
   final account2 = eg.otherAccount.copyWith(id: 2);
 
@@ -1125,7 +1152,9 @@ void main() {
 }
 
 class LoadingTestGlobalStore extends TestGlobalStore {
-  LoadingTestGlobalStore({required super.accounts});
+  LoadingTestGlobalStore({
+    required super.accounts,
+  }) : super(globalSettings: eg.globalSettings());
 
   Map<int, List<Completer<PerAccountStore>>> completers = {};
 

test/model/test_store.dart

@@ -1,6 +1,7 @@
 import 'package:zulip/api/model/events.dart';
 import 'package:zulip/api/model/initial_snapshot.dart';
 import 'package:zulip/api/model/model.dart';
+import 'package:zulip/model/database.dart';
 import 'package:zulip/model/store.dart';
 import 'package:zulip/widgets/store.dart';
 
@@ -22,7 +23,12 @@ import '../example_data.dart' as eg;
 ///
 /// See also [TestZulipBinding.globalStore], which provides one of these.
 class TestGlobalStore extends GlobalStore {
-  TestGlobalStore({required super.accounts});
+  TestGlobalStore({required super.globalSettings, required super.accounts});
+
+  @override
+  Future<void> doUpdateGlobalSettings(GlobalSettingsCompanion data) async {
+    // Nothing to do.
+  }
 
   final Map<
     ({Uri realmUrl, int? zulipFeatureLevel, String? email, String? apiKey}),