store [nfc]: Make handleEvent an async method

With #458, we'll want this method to write changes to the database
on certain events, to update the metadata we keep about the user's
Zulip servers.

When it does that, we'll want it to wait for that write to finish
before it moves on to make other changes, and for its caller
[UpdateMachine.poll] to similarly wait.  That saves us from having
to worry about potential races if some later event also wants to
make database changes while the first changes haven't finished yet.
It also gives us a good foundation for generally not showing the
user a confirmation that some change has been made until we've
actually saved the change.

So to do that, we'll need the method to be async, and to return a
Future which its call sites should wait for.  That's this commit.
It completes a series where we did the same thing for its callers,
recursively.

Author: gnprice

integration_test/unreadmarker_test.dart

@@ -51,11 +51,11 @@ void main() {
 
     final messages = await setupMessageListPage(tester, 500);
     await binding.traceAction(() async {
-      store.handleEvent(eg.updateMessageFlagsRemoveEvent(
+      await store.handleEvent(eg.updateMessageFlagsRemoveEvent(
         MessageFlag.read,
         messages));
       await tester.pumpAndSettle();
-      store.handleEvent(UpdateMessageFlagsAddEvent(
+      await store.handleEvent(UpdateMessageFlagsAddEvent(
         id: 1,
         flag: MessageFlag.read,
         messages: messages.map((e) => e.id).toList(),

lib/model/store.dart

@@ -353,7 +353,7 @@ class PerAccountStore extends ChangeNotifier with StreamStore {
     super.dispose();
   }
 
-  void handleEvent(Event event) {
+  Future<void> handleEvent(Event event) async {
     if (event is HeartbeatEvent) {
       assert(debugLog("server event: heartbeat"));
     } else if (event is RealmEmojiUpdateEvent) {
@@ -711,7 +711,7 @@ class UpdateMachine {
 
       final events = result.events;
       for (final event in events) {
-        store.handleEvent(event);
+        await store.handleEvent(event);
       }
       if (events.isNotEmpty) {
         lastEventId = events.last.id;

test/model/stream_test.dart

@@ -62,42 +62,42 @@ void main() {
   group('SubscriptionEvent', () {
     final stream = eg.stream();
 
-    test('SubscriptionProperty.color updates with an int value', () {
+    test('SubscriptionProperty.color updates with an int value', () async {
       final store = eg.store(initialSnapshot: eg.initialSnapshot(
         streams: [stream],
         subscriptions: [eg.subscription(stream, color: 0xFFFF0000)],
       ));
       check(store.subscriptions[stream.streamId]!.color).equals(0xFFFF0000);
 
-      store.handleEvent(SubscriptionUpdateEvent(id: 1,
+      await store.handleEvent(SubscriptionUpdateEvent(id: 1,
         streamId: stream.streamId,
         property: SubscriptionProperty.color,
         value: 0xFFFF00FF));
       check(store.subscriptions[stream.streamId]!.color).equals(0xFFFF00FF);
     });
 
-    test('SubscriptionProperty.isMuted updates with a boolean value', () {
+    test('SubscriptionProperty.isMuted updates with a boolean value', () async {
       final store = eg.store(initialSnapshot: eg.initialSnapshot(
         streams: [stream],
         subscriptions: [eg.subscription(stream, isMuted: false)],
       ));
       check(store.subscriptions[stream.streamId]!.isMuted).isFalse();
 
-      store.handleEvent(SubscriptionUpdateEvent(id: 1,
+      await store.handleEvent(SubscriptionUpdateEvent(id: 1,
         streamId: stream.streamId,
         property: SubscriptionProperty.isMuted,
         value: true));
       check(store.subscriptions[stream.streamId]!.isMuted).isTrue();
     });
 
-    test('SubscriptionProperty.inHomeView updates isMuted instead', () {
+    test('SubscriptionProperty.inHomeView updates isMuted instead', () async {
       final store = eg.store(initialSnapshot: eg.initialSnapshot(
         streams: [stream],
         subscriptions: [eg.subscription(stream, isMuted: false)],
       ));
       check(store.subscriptions[stream.streamId]!.isMuted).isFalse();
 
-      store.handleEvent(SubscriptionUpdateEvent(id: 1,
+      await store.handleEvent(SubscriptionUpdateEvent(id: 1,
         streamId: stream.streamId,
         property: SubscriptionProperty.inHomeView,
         value: false));

test/model/test_store.dart

@@ -115,7 +115,7 @@ class TestGlobalStore extends GlobalStore {
 
 extension PerAccountStoreTestExtension on PerAccountStore {
   Future<void> addUser(User user) async {
-    handleEvent(RealmUserAddEvent(id: 1, person: user));
+    await handleEvent(RealmUserAddEvent(id: 1, person: user));
   }
 
   Future<void> addUsers(Iterable<User> users) async {
@@ -129,19 +129,19 @@ extension PerAccountStoreTestExtension on PerAccountStore {
   }
 
   Future<void> addStreams(List<ZulipStream> streams) async {
-    handleEvent(StreamCreateEvent(id: 1, streams: streams));
+    await handleEvent(StreamCreateEvent(id: 1, streams: streams));
   }
 
   Future<void> addSubscription(Subscription subscription) async {
     await addSubscriptions([subscription]);
   }
 
   Future<void> addSubscriptions(List<Subscription> subscriptions) async {
-    handleEvent(SubscriptionAddEvent(id: 1, subscriptions: subscriptions));
+    await handleEvent(SubscriptionAddEvent(id: 1, subscriptions: subscriptions));
   }
 
   Future<void> addUserTopic(ZulipStream stream, String topic, UserTopicVisibilityPolicy visibilityPolicy) async {
-    handleEvent(UserTopicEvent(
+    await handleEvent(UserTopicEvent(
       id: 1,
       streamId: stream.streamId,
       topicName: topic,

test/model/unreads_test.dart

@@ -192,7 +192,8 @@ void main() {
       check(model.countInStream      (stream.streamId)).equals(5);
       check(model.countInStreamNarrow(stream.streamId)).equals(5);
 
-      streamStore.handleEvent(SubscriptionUpdateEvent(id: 1, streamId: stream.streamId,
+      await streamStore.handleEvent(SubscriptionUpdateEvent(id: 1,
+        streamId: stream.streamId,
         property: SubscriptionProperty.isMuted, value: true));
       check(model.countInStream      (stream.streamId)).equals(2);
       check(model.countInStreamNarrow(stream.streamId)).equals(5);

test/widgets/emoji_reaction_test.dart

@@ -102,12 +102,12 @@ void main() {
                 await prepare();
 
                 await store.addUsers(users);
-                store.handleEvent(RealmEmojiUpdateEvent(id: 1,
+                await store.handleEvent(RealmEmojiUpdateEvent(id: 1,
                   realmEmoji: realmEmoji));
-                store.handleEvent(UserSettingsUpdateEvent(id: 1,
+                await store.handleEvent(UserSettingsUpdateEvent(id: 1,
                   property: UserSettingName.displayEmojiReactionUsers,
                   value: displayEmojiReactionUsers));
-                store.handleEvent(UserSettingsUpdateEvent(id: 1,
+                await store.handleEvent(UserSettingsUpdateEvent(id: 1,
                   property: UserSettingName.emojiset,
                   value: emojiset));
 

test/widgets/inbox_test.dart

@@ -67,7 +67,7 @@ void main() {
 
     for (final message in unreadMessages) {
       assert(!message.flags.contains(MessageFlag.read));
-      store.handleEvent(MessageEvent(id: 1, message: message));
+      await store.handleEvent(MessageEvent(id: 1, message: message));
     }
 
     await tester.pumpWidget(

test/widgets/message_list_test.dart

@@ -481,7 +481,7 @@ void main() {
       }
 
       Future<void> handleNewAvatarEventAndPump(WidgetTester tester, String avatarUrl) async {
-        store.handleEvent(RealmUserUpdateEvent(id: 1, userId: eg.selfUser.userId, avatarUrl: avatarUrl));
+        await store.handleEvent(RealmUserUpdateEvent(id: 1, userId: eg.selfUser.userId, avatarUrl: avatarUrl));
         await tester.pump();
       }
 
@@ -575,7 +575,7 @@ void main() {
         ..value.equals(0.0)
         ..status.equals(AnimationStatus.dismissed);
 
-      store.handleEvent(eg.updateMessageFlagsRemoveEvent(
+      await store.handleEvent(eg.updateMessageFlagsRemoveEvent(
         MessageFlag.read, [message]));
       await tester.pump(); // process handleEvent
       check(getAnimation(tester, message.id))
@@ -595,7 +595,7 @@ void main() {
         ..value.equals(1.0)
         ..status.equals(AnimationStatus.dismissed);
 
-      store.handleEvent(UpdateMessageFlagsAddEvent(
+      await store.handleEvent(UpdateMessageFlagsAddEvent(
         id: 1,
         flag: MessageFlag.read,
         messages: [message.id],
@@ -623,7 +623,7 @@ void main() {
         ..value.equals(1.0)
         ..status.equals(AnimationStatus.dismissed);
 
-      store.handleEvent(UpdateMessageFlagsAddEvent(
+      await store.handleEvent(UpdateMessageFlagsAddEvent(
         id: 0,
         flag: MessageFlag.read,
         messages: [message.id],
@@ -643,7 +643,7 @@ void main() {
 
       // introduce new message
       final newMessage = eg.streamMessage(flags:[MessageFlag.read]);
-      store.handleEvent(MessageEvent(id: 0, message: newMessage));
+      await store.handleEvent(MessageEvent(id: 0, message: newMessage));
       await tester.pump(); // process handleEvent
       check(find.byType(MessageItem).evaluate()).length.equals(2);
       check(getAnimation(tester, message.id))
@@ -678,7 +678,7 @@ void main() {
       await setupMessageListPage(tester, messages: [message]);
       check(isMarkAsReadButtonVisible(tester)).isFalse();
 
-      store.handleEvent(eg.updateMessageFlagsRemoveEvent(
+      await store.handleEvent(eg.updateMessageFlagsRemoveEvent(
         MessageFlag.read, [message]));
       await tester.pumpAndSettle();
       check(isMarkAsReadButtonVisible(tester)).isTrue();
@@ -692,7 +692,7 @@ void main() {
       await setupMessageListPage(tester, messages: [message], unreadMsgs: unreadMsgs);
       check(isMarkAsReadButtonVisible(tester)).isTrue();
 
-      store.handleEvent(UpdateMessageFlagsAddEvent(
+      await store.handleEvent(UpdateMessageFlagsAddEvent(
         id: 1,
         flag: MessageFlag.read,
         messages: [message.id],
@@ -714,7 +714,7 @@ void main() {
       check(tester.widgetList(find.byType(MessageItem))).length.equals(1);
       final before = tester.getTopLeft(find.byType(MessageItem)).dy;
 
-      store.handleEvent(UpdateMessageFlagsAddEvent(
+      await store.handleEvent(UpdateMessageFlagsAddEvent(
         id: 1,
         flag: MessageFlag.read,
         messages: [message.id],

test/widgets/recent_dm_conversations_test.dart

@@ -39,11 +39,11 @@ Future<void> setupPage(WidgetTester tester, {
   }
 
   for (final dmMessage in dmMessages) {
-    store.handleEvent(MessageEvent(id: 1, message: dmMessage));
+    await store.handleEvent(MessageEvent(id: 1, message: dmMessage));
   }
 
   if (newNameForSelfUser != null) {
-    store.handleEvent(RealmUserUpdateEvent(id: 1, userId: eg.selfUser.userId,
+    await store.handleEvent(RealmUserUpdateEvent(id: 1, userId: eg.selfUser.userId,
       fullName: newNameForSelfUser));
   }
 
@@ -151,7 +151,7 @@ void main() {
 
       Future<void> markMessageAsRead(WidgetTester tester, Message message) async {
         final store = await testBinding.globalStore.perAccount(eg.selfAccount.id);
-        store.handleEvent(UpdateMessageFlagsAddEvent(
+        await store.handleEvent(UpdateMessageFlagsAddEvent(
           id: 1, flag: MessageFlag.read, all: false, messages: [message.id]));
         await tester.pump();
       }