store: Update account with realmName and realmIcon from InitialSnapshot

This will populate these fields for the currently opened account in
the database when the PerAccountStore loads.

Author: rajveermalviya

lib/model/store.dart

@@ -323,6 +323,28 @@ abstract class GlobalStore extends ChangeNotifier {
       zulipFeatureLevel: Value(data.zulipFeatureLevel)));
   }
 
+  /// Update an account with [realmName] and [realmIcon], returning the new version.
+  ///
+  /// The account must already exist in the store.
+  Future<Account> updateRealmData(int accountId, {
+    required String realmName,
+    required Uri realmIcon,
+  }) async {
+    final account = getAccount(accountId)!;
+    if (account.realmName == realmName && account.realmIcon == realmIcon) {
+      return account;
+    }
+
+    return updateAccount(accountId,  AccountsCompanion(
+      realmName: account.realmName != realmName
+        ? Value(realmName)
+        : const Value.absent(),
+      realmIcon: account.realmIcon != realmIcon
+        ? Value(realmIcon)
+        : const Value.absent(),
+    ));
+  }
+
   /// Update an account in the underlying data store.
   Future<void> doUpdateAccount(int accountId, AccountsCompanion data);
 
@@ -1107,6 +1129,12 @@ class UpdateMachine {
       await globalStore.updateZulipVersionData(accountId, zulipVersionData);
       connection.zulipFeatureLevel = zulipVersionData.zulipFeatureLevel;
     }
+    if (globalStore.getAccount(accountId) != null) {
+      // TODO(#668) update realmName and realmIcon on realm update events
+      await globalStore.updateRealmData(accountId,
+        realmName: initialSnapshot.realmName,
+        realmIcon: initialSnapshot.realmIconUrl);
+    }
 
     final store = PerAccountStore.fromInitialSnapshot(
       globalStore: globalStore,

lib/widgets/login.dart

@@ -406,9 +406,7 @@ class _LoginPageState extends State<LoginPage> {
     try {
       accountId = await globalStore.insertAccount(AccountsCompanion.insert(
         realmUrl: realmUrl,
-        // TODO store the updated value from /register
         realmName: Value(widget.serverSettings.realmName),
-        // TODO store the updated value from /register
         realmIcon: Value(widget.serverSettings.realmIcon),
         email: email,
         apiKey: apiKey,

test/model/store_test.dart

@@ -350,7 +350,7 @@ void main() {
 
     // TODO test database gets updated correctly (an integration test with sqlite?)
   });
-  
+
   test('GlobalStore.updateZulipVersionData', () async {
     final [currentZulipVersion,          newZulipVersion             ]
         = ['10.0-beta2-302-gf5b08b11f4', '10.0-beta2-351-g75ac8fe961'];
@@ -376,6 +376,20 @@ void main() {
       zulipFeatureLevel: newZulipFeatureLevel));
   });
 
+  test('GlobalStore.updateRealmData', () async {
+    final selfAccount = eg.selfAccount.copyWith(
+      realmName: Value('Organization A'),
+      realmIcon: Value(Uri.parse('/image-a.png')));
+    final globalStore = eg.globalStore(accounts: [selfAccount]);
+    final updated = await globalStore.updateRealmData(selfAccount.id,
+      realmName: 'Organization B',
+      realmIcon: Uri.parse('/image-b.png'));
+    check(globalStore.getAccount(selfAccount.id)).identicalTo(updated);
+    check(updated).equals(selfAccount.copyWith(
+      realmName: Value('Organization B'),
+      realmIcon: Value(Uri.parse('/image-b.png'))));
+  });
+
   group('GlobalStore.removeAccount', () {
     void checkGlobalStore(GlobalStore store, int accountId, {
       required bool expectAccount,
@@ -509,18 +523,24 @@ void main() {
 
     test('updates account from snapshot', () => awaitFakeAsync((async) async {
       final account = eg.account(user: eg.selfUser,
+        realmName: 'Organization A',
+        realmIcon: Uri.parse('/image-a.png'),
         zulipVersion: '6.0+gabcd',
         zulipMergeBase: '6.0',
         zulipFeatureLevel: 123,
       );
       await prepareStore(account: account);
       check(globalStore.getAccount(account.id)).isNotNull()
+        ..realmName.equals('Organization A')
+        ..realmIcon.equals(Uri.parse('/image-a.png'))
         ..zulipVersion.equals('6.0+gabcd')
         ..zulipMergeBase.equals('6.0')
         ..zulipFeatureLevel.equals(123);
 
       globalStore.useCachedApiConnections = true;
       connection.prepare(json: eg.initialSnapshot(
+        realmName: 'Organization B',
+        realmIconUrl: Uri.parse('/image-b.png'),
         zulipVersion: '8.0+g9876',
         zulipMergeBase: '8.0',
         zulipFeatureLevel: 234,
@@ -529,6 +549,8 @@ void main() {
       updateMachine.debugPauseLoop();
       check(globalStore.getAccount(account.id)).isNotNull()
         ..identicalTo(updateMachine.store.account)
+        ..realmName.equals('Organization B')
+        ..realmIcon.equals(Uri.parse('/image-b.png'))
         ..zulipVersion.equals('8.0+g9876')
         ..zulipMergeBase.equals('8.0')
         ..zulipFeatureLevel.equals(234);