store: Add UserStore.getUserStatus, with event updates

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

Author: sm-sayedi

lib/model/store.dart

@@ -665,6 +665,9 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
   bool isUserMuted(int userId, {MutedUsersEvent? event}) =>
     _users.isUserMuted(userId, event: event);
 
+  @override
+  UserStatus getUserStatus(int userId) => _users.getUserStatus(userId);
+
   final UserStoreImpl _users;
 
   final TypingStatus typingStatus;
@@ -930,8 +933,9 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
         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

@@ -85,6 +85,11 @@ mixin UserStore on PerAccountStoreBase {
   /// Looks for [userId] in a private [Set],
   /// or in [event.mutedUsers] instead if event is non-null.
   bool isUserMuted(int userId, {MutedUsersEvent? event});
+
+  /// The status of the user with the given ID.
+  ///
+  /// If no status is set for a user, returns [UserStatus.zero].
+  UserStatus getUserStatus(int userId);
 }
 
 /// The implementation of [UserStore] that does the work.
@@ -101,7 +106,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;
 
@@ -118,6 +125,11 @@ class UserStoreImpl extends PerAccountStoreBase with UserStore {
     return (event?.mutedUsers.map((item) => item.id) ?? _mutedUsers).contains(userId);
   }
 
+  final Map<int, UserStatus> _userStatuses;
+
+  @override
+  UserStatus getUserStatus(int userId) => _userStatuses[userId] ?? UserStatus.zero;
+
   void handleRealmUserEvent(RealmUserEvent event) {
     switch (event) {
       case RealmUserAddEvent():
@@ -157,6 +169,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

@@ -7,6 +7,12 @@ 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);
+
+typedef StatusEventData = (int userId, String? statusText, String? emojiName,
+  String? emojiCode, String? reactionType);
+
 void main() {
   group('userDisplayName', () {
     test('on a known user', () async {
@@ -80,6 +86,82 @@ 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(StatusEventData data) => UserStatusEvent(
+      id: 1,
+      userId: data.$1,
+      change: UserStatusChange.fromJson({
+        'status_text': data.$2,
+        'emoji_name': data.$3,
+        'emoji_code': data.$4,
+        'reaction_type': data.$5,
+      }),
+    );
+
+    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((1,
+      'Out sick', 'sick', '1f912', 'unicode_emoji')));
+    checkUserStatus(store.getUserStatus(1),
+      ('Out sick', 'sick', '1f912', 'unicode_emoji'));
+
+    await store.handleEvent(userStatusEvent((2,
+      'In a meeting', null, null, null)));
+    checkUserStatus(store.getUserStatus(2),
+      ('In a meeting', 'calendar', '1f4c5', 'unicode_emoji'));
+
+    await store.handleEvent(userStatusEvent((3,
+      '', 'bus', '1f68c', 'unicode_emoji')));
+    checkUserStatus(store.getUserStatus(3),
+      (null, 'bus', '1f68c', 'unicode_emoji'));
+
+    await store.handleEvent(userStatusEvent((4,
+      'Vacationing', null, null, null)));
+    checkUserStatus(store.getUserStatus(4),
+      ('Vacationing', null, null, null));
+
+    await store.handleEvent(userStatusEvent((5,
+      'Working remotely', '', '', '')));
+    checkUserStatus(store.getUserStatus(5),
+      ('Working remotely', null, null, null));
+  });
+
   testWidgets('MutedUsersEvent', (tester) async {
     final user1 = eg.user(userId: 1);
     final user2 = eg.user(userId: 2);