store: Add UserStore.getUserStatus, with event updates

Co-authored-by: Chris Bobbe <[email protected]>

Author: sm-sayedi

lib/model/store.dart

@@ -688,6 +688,9 @@ class PerAccountStore extends PerAccountStoreBase with
   MutedUsersVisibilityEffect mightChangeShouldMuteDmConversation(MutedUsersEvent event) =>
     _users.mightChangeShouldMuteDmConversation(event);
 
+  @override
+  UserStatus getUserStatus(int userId) => _users.getUserStatus(userId);
+
   final UserStoreImpl _users;
 
   final TypingStatus typingStatus;
@@ -960,8 +963,9 @@ class PerAccountStore extends PerAccountStoreBase with
         notifyListeners();
 
       case UserStatusEvent():
-        // TODO: handle
-        break;
+        assert(debugLog("server event: user_status"));
+        _users.handleUserStatusEvent(event);
+        notifyListeners();
 
       case UserTopicEvent():
         assert(debugLog("server event: user_topic"));

lib/model/user.dart

@@ -102,6 +102,11 @@ mixin UserStore on PerAccountStoreBase {
   /// Whether the given event might change the result of [shouldMuteDmConversation]
   /// for its list of muted users, compared to the current state.
   MutedUsersVisibilityEffect mightChangeShouldMuteDmConversation(MutedUsersEvent event);
+
+  /// The status of the user with the given ID.
+  ///
+  /// If no status is set for the user, returns [UserStatus.zero].
+  UserStatus getUserStatus(int userId);
 }
 
 /// Whether and how a given [MutedUsersEvent] may affect the results
@@ -135,7 +140,9 @@ class UserStoreImpl extends PerAccountStoreBase with UserStore {
          .followedBy(initialSnapshot.realmNonActiveUsers)
          .followedBy(initialSnapshot.crossRealmBots)
          .map((user) => MapEntry(user.userId, user))),
-       _mutedUsers = Set.from(initialSnapshot.mutedUsers.map((item) => item.id));
+       _mutedUsers = Set.from(initialSnapshot.mutedUsers.map((item) => item.id)),
+       _userStatuses = initialSnapshot.userStatuses.map((userId, change) =>
+         MapEntry(userId, change.apply(UserStatus.zero)));
 
   final Map<int, User> _users;
 
@@ -175,6 +182,11 @@ class UserStoreImpl extends PerAccountStoreBase with UserStore {
     }
   }
 
+  final Map<int, UserStatus> _userStatuses;
+
+  @override
+  UserStatus getUserStatus(int userId) => _userStatuses[userId] ?? UserStatus.zero;
+
   void handleRealmUserEvent(RealmUserEvent event) {
     switch (event) {
       case RealmUserAddEvent():
@@ -214,6 +226,11 @@ class UserStoreImpl extends PerAccountStoreBase with UserStore {
     }
   }
 
+  void handleUserStatusEvent(UserStatusEvent event) {
+    _userStatuses[event.userId] =
+      event.change.apply(getUserStatus(event.userId));
+  }
+
   void handleMutedUsersEvent(MutedUsersEvent event) {
     _mutedUsers.clear();
     _mutedUsers.addAll(event.mutedUsers.map((item) => item.id));

test/model/user_test.dart

@@ -10,6 +10,9 @@ import '../api/model/model_checks.dart';
 import '../example_data.dart' as eg;
 import 'test_store.dart';
 
+typedef StatusData = (String? statusText, String? emojiName, String? emojiCode,
+  String? reactionType);
+
 void main() {
   group('userDisplayName', () {
     test('on a known user', () async {
@@ -83,6 +86,85 @@ void main() {
     });
   });
 
+  testWidgets('UserStatusEvent', (tester) async {
+    UserStatusChange userStatus(StatusData data) => UserStatusChange.fromJson({
+      'status_text': data.$1,
+      'emoji_name': data.$2,
+      'emoji_code': data.$3,
+      'reaction_type': data.$4,
+    });
+
+    void checkUserStatus(UserStatus userStatus, StatusData expected) {
+      check(userStatus).text.equals(expected.$1);
+
+      switch (expected) {
+        case (_, String emojiName, String emojiCode, String reactionType):
+          check(userStatus.emoji!)
+            ..emojiName.equals(emojiName)
+            ..emojiCode.equals(emojiCode)
+            ..reactionType.equals(ReactionType.fromApiValue(reactionType));
+        default:
+          check(userStatus.emoji).isNull();
+      }
+    }
+
+    UserStatusEvent userStatusEvent(StatusData data, {required int userId}) =>
+      UserStatusEvent(
+        id: 1,
+        userId: userId,
+        change: UserStatusChange.fromJson({
+          'status_text': data.$1,
+          'emoji_name': data.$2,
+          'emoji_code': data.$3,
+          'reaction_type': data.$4,
+        }));
+
+    final store = eg.store(initialSnapshot: eg.initialSnapshot(
+      userStatuses: {
+        1: userStatus(('Busy', 'working_on_it', '1f6e0', 'unicode_emoji')),
+        2: userStatus((null, 'calendar', '1f4c5', 'unicode_emoji')),
+        3: userStatus(('Commuting', null, null, null)),
+      }));
+    checkUserStatus(store.getUserStatus(1),
+      ('Busy', 'working_on_it', '1f6e0', 'unicode_emoji'));
+    checkUserStatus(store.getUserStatus(2),
+      (null, 'calendar', '1f4c5', 'unicode_emoji'));
+    checkUserStatus(store.getUserStatus(3),
+      ('Commuting', null, null, null));
+    check(store.getUserStatus(4))..text.isNull()..emoji.isNull();
+    check(store.getUserStatus(5))..text.isNull()..emoji.isNull();
+
+    await store.handleEvent(userStatusEvent(userId: 1,
+      ('Out sick', 'sick', '1f912', 'unicode_emoji')));
+    checkUserStatus(store.getUserStatus(1),
+      ('Out sick', 'sick', '1f912', 'unicode_emoji'));
+
+    await store.handleEvent(userStatusEvent(userId: 2,
+      ('In a meeting', null, null, null)));
+    checkUserStatus(store.getUserStatus(2),
+      ('In a meeting', 'calendar', '1f4c5', 'unicode_emoji'));
+
+    await store.handleEvent(userStatusEvent(userId: 3,
+      ('', 'bus', '1f68c', 'unicode_emoji')));
+    checkUserStatus(store.getUserStatus(3),
+      (null, 'bus', '1f68c', 'unicode_emoji'));
+
+    await store.handleEvent(userStatusEvent(userId: 4,
+      ('Vacationing', null, null, null)));
+    checkUserStatus(store.getUserStatus(4),
+      ('Vacationing', null, null, null));
+
+    await store.handleEvent(userStatusEvent(userId: 5,
+      ('Working remotely', '', '', '')));
+    checkUserStatus(store.getUserStatus(5),
+      ('Working remotely', null, null, null));
+
+    await store.handleEvent(userStatusEvent(userId: 1,
+      ('', '', '', '')));
+    checkUserStatus(store.getUserStatus(1),
+      (null, null, null, null));
+  });
+
   group('MutedUsersEvent', () {
     testWidgets('smoke', (tester) async {
       late PerAccountStore store;