store [nfc]: Move selfUserId to PerAccountStoreBase

Author: PIG208

lib/model/recent_dm_conversations.dart

@@ -7,18 +7,19 @@ import '../api/model/initial_snapshot.dart';
 import '../api/model/model.dart';
 import '../api/model/events.dart';
 import 'narrow.dart';
+import 'store.dart';
 
 /// A view-model for the recent-DM-conversations UI.
 ///
 /// This maintains the list of recent DM conversations,
 /// plus additional data in order to efficiently maintain the list.
-class RecentDmConversationsView extends ChangeNotifier {
+class RecentDmConversationsView extends PerAccountStoreBase with ChangeNotifier {
   factory RecentDmConversationsView({
+    required CorePerAccountStore core,
     required List<RecentDmConversation> initial,
-    required int selfUserId,
   }) {
     final entries = initial.map((conversation) => MapEntry(
-        DmNarrow.ofRecentDmConversation(conversation, selfUserId: selfUserId),
+        DmNarrow.ofRecentDmConversation(conversation, selfUserId: core.selfUserId),
         conversation.maxMessageId,
       )).toList()..sort((a, b) => -a.value.compareTo(b.value));
 
@@ -33,18 +34,18 @@ class RecentDmConversationsView extends ChangeNotifier {
     }
 
     return RecentDmConversationsView._(
+      core: core,
       map: Map.fromEntries(entries),
       sorted: QueueList.from(entries.map((e) => e.key)),
       latestMessagesByRecipient: latestMessagesByRecipient,
-      selfUserId: selfUserId,
     );
   }
 
   RecentDmConversationsView._({
+    required super.core,
     required this.map,
     required this.sorted,
     required this.latestMessagesByRecipient,
-    required this.selfUserId,
   });
 
   /// The latest message ID in each conversation.
@@ -62,8 +63,6 @@ class RecentDmConversationsView extends ChangeNotifier {
   /// it might have been sent by anyone in its conversation.)
   final Map<int, int> latestMessagesByRecipient;
 
-  final int selfUserId;
-
   /// Insert the key at the proper place in [sorted].
   ///
   /// Optimized, taking O(1) time, for the case where that place is the start,

lib/model/store.dart

@@ -329,10 +329,15 @@ class AccountNotFoundException implements Exception {}
 
 /// A bundle of items that are useful to [PerAccountStore] and its substores.
 class CorePerAccountStore {
-  CorePerAccountStore({required this.connection, required this.queueId});
+  CorePerAccountStore({
+    required this.connection,
+    required this.queueId,
+    required this.selfUserId,
+  });
 
   final ApiConnection connection; // TODO(#135): update zulipFeatureLevel with events
   final String queueId;
+  final int selfUserId;
 }
 
 /// A base class for [PerAccountStore] and its substores,
@@ -345,6 +350,7 @@ abstract class PerAccountStoreBase {
 
   ApiConnection get connection => _core.connection;
   String get queueId => _core.queueId;
+  int get selfUserId => _core.selfUserId;
 }
 
 /// Store for the user's data for a given Zulip account.
@@ -388,7 +394,8 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
     }
 
     final realmUrl = account.realmUrl;
-    final core = CorePerAccountStore(connection: connection, queueId: queueId);
+    final core = CorePerAccountStore(
+      connection: connection, queueId: queueId, selfUserId: account.userId);
     final channels = ChannelStoreImpl(initialSnapshot: initialSnapshot);
     return PerAccountStore._(
       globalStore: globalStore,
@@ -414,21 +421,22 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
           milliseconds: initialSnapshot.serverTypingStartedWaitPeriodMilliseconds),
       ),
       users: UserStoreImpl(
-        selfUserId: account.userId,
+        core: core,
         initialSnapshot: initialSnapshot),
       typingStatus: TypingStatus(
-        selfUserId: account.userId,
+        core: core,
         typingStartedExpiryPeriod: Duration(milliseconds: initialSnapshot.serverTypingStartedExpiryPeriodMilliseconds),
       ),
       channels: channels,
       messages: MessageStoreImpl(core: core),
       unreads: Unreads(
+        core: core,
         initial: initialSnapshot.unreadMsgs,
-        selfUserId: account.userId,
         channelStore: channels,
       ),
       recentDmConversationsView: RecentDmConversationsView(
-        initial: initialSnapshot.recentPrivateConversations, selfUserId: account.userId),
+        core: core,
+        initial: initialSnapshot.recentPrivateConversations),
       recentSenders: RecentSenders(),
     );
   }

lib/model/typing_status.dart

@@ -7,17 +7,17 @@ import '../api/model/events.dart';
 import '../api/route/typing.dart';
 import 'binding.dart';
 import 'narrow.dart';
+import 'store.dart';
 
 /// The model for tracking the typing status organized by narrows.
 ///
 /// Listeners are notified when a typist is added or removed from any narrow.
-class TypingStatus extends ChangeNotifier {
+class TypingStatus extends PerAccountStoreBase with ChangeNotifier {
   TypingStatus({
-    required this.selfUserId,
+    required super.core,
     required this.typingStartedExpiryPeriod,
   });
 
-  final int selfUserId;
   final Duration typingStartedExpiryPeriod;
 
   Iterable<SendableNarrow> get debugActiveNarrows => _timerMapsByNarrow.keys;

lib/model/unreads.dart

@@ -10,6 +10,7 @@ import '../log.dart';
 import 'algorithms.dart';
 import 'narrow.dart';
 import 'channel.dart';
+import 'store.dart';
 
 /// The view-model for unread messages.
 ///
@@ -34,10 +35,10 @@ import 'channel.dart';
 //   sync to those unreads, because the user has shown an interest in them.
 // TODO When loading a message list with stream messages, check all the stream
 //   messages and refresh [mentions] (see [mentions] dartdoc).
-class Unreads extends ChangeNotifier {
+class Unreads extends PerAccountStoreBase with ChangeNotifier {
   factory Unreads({
+    required CorePerAccountStore core,
     required UnreadMessagesSnapshot initial,
-    required int selfUserId,
     required ChannelStore channelStore,
   }) {
     final streams = <int, Map<TopicName, QueueList<int>>>{};
@@ -52,32 +53,32 @@ class Unreads extends ChangeNotifier {
 
     for (final unreadDmSnapshot in initial.dms) {
       final otherUserId = unreadDmSnapshot.otherUserId;
-      final narrow = DmNarrow.withUser(otherUserId, selfUserId: selfUserId);
+      final narrow = DmNarrow.withUser(otherUserId, selfUserId: core.selfUserId);
       dms[narrow] = QueueList.from(unreadDmSnapshot.unreadMessageIds);
     }
 
     for (final unreadHuddleSnapshot in initial.huddles) {
-      final narrow = DmNarrow.ofUnreadHuddleSnapshot(unreadHuddleSnapshot, selfUserId: selfUserId);
+      final narrow = DmNarrow.ofUnreadHuddleSnapshot(unreadHuddleSnapshot, selfUserId: core.selfUserId);
       dms[narrow] = QueueList.from(unreadHuddleSnapshot.unreadMessageIds);
     }
 
     return Unreads._(
+      core: core,
       channelStore: channelStore,
       streams: streams,
       dms: dms,
       mentions: mentions,
       oldUnreadsMissing: initial.oldUnreadsMissing,
-      selfUserId: selfUserId,
     );
   }
 
   Unreads._({
+    required super.core,
     required this.channelStore,
     required this.streams,
     required this.dms,
     required this.mentions,
     required this.oldUnreadsMissing,
-    required this.selfUserId,
   });
 
   final ChannelStore channelStore;
@@ -125,8 +126,6 @@ class Unreads extends ChangeNotifier {
   /// Is set to false when the user clears out all unreads.
   bool oldUnreadsMissing;
 
-  final int selfUserId;
-
   // TODO(#370): maintain this count incrementally, rather than recomputing from scratch
   int countInCombinedFeedNarrow() {
     int c = 0;

lib/model/user.dart

@@ -2,6 +2,7 @@ import '../api/model/events.dart';
 import '../api/model/initial_snapshot.dart';
 import '../api/model/model.dart';
 import 'localizations.dart';
+import 'store.dart';
 
 /// The portion of [PerAccountStore] describing the users in the realm.
 mixin UserStore {
@@ -80,19 +81,16 @@ mixin UserStore {
 /// Generally the only code that should need this class is [PerAccountStore]
 /// itself.  Other code accesses this functionality through [PerAccountStore],
 /// or through the mixin [UserStore] which describes its interface.
-class UserStoreImpl with UserStore {
+class UserStoreImpl extends PerAccountStoreBase with UserStore {
   UserStoreImpl({
-    required this.selfUserId,
+    required super.core,
     required InitialSnapshot initialSnapshot,
   }) : _users = Map.fromEntries(
          initialSnapshot.realmUsers
          .followedBy(initialSnapshot.realmNonActiveUsers)
          .followedBy(initialSnapshot.crossRealmBots)
          .map((user) => MapEntry(user.userId, user)));
 
-  @override
-  final int selfUserId;
-
   final Map<int, User> _users;
 
   @override

test/model/recent_dm_conversations_test.dart

@@ -6,6 +6,7 @@ import 'package:zulip/model/recent_dm_conversations.dart';
 
 import '../example_data.dart' as eg;
 import 'recent_dm_conversations_checks.dart';
+import 'store_checks.dart';
 
 void main() {
   group('RecentDmConversationsView', () {
@@ -18,18 +19,19 @@ void main() {
     }
 
     test('construct from initial data', () {
-      check(RecentDmConversationsView(selfUserId: eg.selfUser.userId,
-        initial: []))
+      check(eg.store(initialSnapshot: eg.initialSnapshot(
+        recentPrivateConversations: [],
+      ))).recentDmConversationsView
           ..map.isEmpty()
           ..sorted.isEmpty()
           ..latestMessagesByRecipient.isEmpty();
 
-      check(RecentDmConversationsView(selfUserId: eg.selfUser.userId,
-        initial: [
+      check(eg.store(initialSnapshot: eg.initialSnapshot(
+        recentPrivateConversations: [
           RecentDmConversation(userIds: [],     maxMessageId: 200),
           RecentDmConversation(userIds: [1],    maxMessageId: 100),
           RecentDmConversation(userIds: [2, 1], maxMessageId: 300), // userIds out of order
-        ]))
+        ]))).recentDmConversationsView
           ..map.deepEquals({
             key([1, 2]): 300,
             key([]):     200,
@@ -41,11 +43,11 @@ void main() {
 
     group('message event (new message)', () {
       RecentDmConversationsView setupView() {
-        return RecentDmConversationsView(selfUserId: eg.selfUser.userId,
-          initial: [
+        return eg.store(initialSnapshot: eg.initialSnapshot(
+          recentPrivateConversations: [
             RecentDmConversation(userIds: [1],    maxMessageId: 200),
             RecentDmConversation(userIds: [1, 2], maxMessageId: 100),
-          ]);
+          ])).recentDmConversationsView;
       }
 
       test('(check base state)', () {

test/model/typing_status_test.dart

@@ -77,9 +77,10 @@ void main() {
     int? selfUserId,
     Map<SendableNarrow, List<User>> typistsByNarrow = const {},
   }) {
-    model = TypingStatus(
-      selfUserId: selfUserId ?? eg.selfUser.userId,
-      typingStartedExpiryPeriod: const Duration(milliseconds: 15000));
+    final store = eg.store(account: eg.selfAccount.copyWith(id: selfUserId),
+      initialSnapshot: eg.initialSnapshot(
+        serverTypingStartedExpiryPeriodMilliseconds:  15000));
+    model = store.typingStatus;
     check(model.debugActiveNarrows).isEmpty();
     notifiedCount = 0;
     model.addListener(() => notifiedCount += 1);

test/model/unreads_test.dart

@@ -37,10 +37,10 @@ void main() {
       oldUnreadsMissing: false,
     ),
   }) {
-    channelStore = eg.store();
+    channelStore = eg.store(
+      initialSnapshot: eg.initialSnapshot(unreadMsgs: initial));
     notifiedCount = 0;
-    model = Unreads(initial: initial,
-        selfUserId: eg.selfUser.userId, channelStore: channelStore)
+    model = channelStore.unreads
       ..addListener(() {
         notifiedCount++;
       });