model: Handle live-updates to savedSnippets

Author: PIG208

lib/model/saved_snippet.dart

@@ -0,0 +1,38 @@
+import 'package:collection/collection.dart';
+
+import '../api/model/events.dart';
+import '../api/model/model.dart';
+import 'store.dart';
+
+mixin SavedSnippetStore {
+  Map<int, SavedSnippet> get savedSnippets;
+}
+
+class SavedSnippetStoreImpl extends PerAccountStoreBase with SavedSnippetStore {
+  SavedSnippetStoreImpl({
+    required super.core,
+    required Iterable<SavedSnippet> savedSnippets,
+  }) : _savedSnippets = {
+         for (final savedSnippet in savedSnippets)
+           savedSnippet.id: savedSnippet,
+       };
+
+  @override
+  late Map<int, SavedSnippet> savedSnippets = UnmodifiableMapView(_savedSnippets);
+  final Map<int, SavedSnippet> _savedSnippets;
+
+  void handleSavedSnippetsEvent(SavedSnippetsEvent event) {
+    switch (event) {
+      case SavedSnippetsAddEvent(:final savedSnippet):
+        _savedSnippets[savedSnippet.id] = savedSnippet;
+
+      case SavedSnippetsUpdateEvent(:final savedSnippet):
+        assert(_savedSnippets[savedSnippet.id]!.dateCreated
+                 == savedSnippet.dateCreated); // TODO(log)
+        _savedSnippets[savedSnippet.id] = savedSnippet;
+
+      case SavedSnippetsRemoveEvent(:final savedSnippetId):
+        _savedSnippets.remove(savedSnippetId);
+    }
+  }
+}

lib/model/store.dart

@@ -29,6 +29,7 @@ import 'message_list.dart';
 import 'recent_dm_conversations.dart';
 import 'recent_senders.dart';
 import 'channel.dart';
+import 'saved_snippet.dart';
 import 'settings.dart';
 import 'typing_status.dart';
 import 'unreads.dart';
@@ -431,7 +432,7 @@ Uri? tryResolveUrl(Uri baseUrl, String reference) {
 /// This class does not attempt to poll an event queue
 /// to keep the data up to date.  For that behavior, see
 /// [UpdateMachine].
-class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStore, UserStore, ChannelStore, MessageStore {
+class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStore, SavedSnippetStore, UserStore, ChannelStore, MessageStore {
   /// Construct a store for the user's data, starting from the given snapshot.
   ///
   /// The global store must already have been updated with
@@ -485,6 +486,8 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
       emailAddressVisibility: initialSnapshot.emailAddressVisibility,
       emoji: EmojiStoreImpl(
         core: core, allRealmEmoji: initialSnapshot.realmEmoji),
+      savedSnippets: SavedSnippetStoreImpl(
+        core: core, savedSnippets: initialSnapshot.savedSnippets ?? []),
       userSettings: initialSnapshot.userSettings,
       typingNotifier: TypingNotifier(
         core: core,
@@ -523,6 +526,7 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
     required this.customProfileFields,
     required this.emailAddressVisibility,
     required EmojiStoreImpl emoji,
+    required SavedSnippetStoreImpl savedSnippets,
     required this.userSettings,
     required this.typingNotifier,
     required UserStoreImpl users,
@@ -534,6 +538,7 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
     required this.recentSenders,
   }) : _realmEmptyTopicDisplayName = realmEmptyTopicDisplayName,
        _emoji = emoji,
+       _savedSnippets = savedSnippets,
        _users = users,
        _channels = channels,
        _messages = messages;
@@ -619,6 +624,10 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
   ////////////////////////////////
   // Data attached to the self-account on the realm.
 
+  @override
+  Map<int, SavedSnippet> get savedSnippets => _savedSnippets.savedSnippets;
+  final SavedSnippetStoreImpl _savedSnippets;
+
   final UserSettings? userSettings; // TODO(server-5)
 
   final TypingNotifier typingNotifier;
@@ -868,6 +877,11 @@ class PerAccountStore extends PerAccountStoreBase with ChangeNotifier, EmojiStor
         autocompleteViewManager.handleRealmUserUpdateEvent(event);
         notifyListeners();
 
+      case SavedSnippetsEvent():
+        assert(debugLog('server event: saved_snippets/${event.op}'));
+        _savedSnippets.handleSavedSnippetsEvent(event);
+        notifyListeners();
+
       case ChannelEvent():
         assert(debugLog("server event: stream/${event.op}"));
         _channels.handleChannelEvent(event);

test/api/model/model_checks.dart

@@ -21,6 +21,12 @@ extension UserChecks on Subject<User> {
   Subject<bool> get isSystemBot => has((x) => x.isSystemBot, 'isSystemBot');
 }
 
+extension SavedSnippetChecks on Subject<SavedSnippet> {
+  Subject<int> get id => has((x) => x.id, 'id');
+  Subject<String> get title => has((x) => x.title, 'title');
+  Subject<String> get content => has((x) => x.content, 'content');
+}
+
 extension ZulipStreamChecks on Subject<ZulipStream> {
 }
 

test/example_data.dart

@@ -250,6 +250,28 @@ final User thirdUser = user(fullName: 'Third User');
 
 final User fourthUser  = user(fullName: 'Fourth User');
 
+////////////////////////////////////////////////////////////////
+// Data attached to the self-account on the realm
+//
+
+int _nextSavedSnippetId() => _lastSavedSnippetId++;
+int _lastSavedSnippetId = 1;
+
+SavedSnippet savedSnippet({
+  int? id,
+  String? title,
+  String? content,
+  int? dateCreated,
+}) {
+  _checkPositive(id, 'saved snippet ID');
+  return SavedSnippet(
+    id: id ?? _nextSavedSnippetId(),
+    title: title ?? 'A saved snippet',
+    content: content ?? 'foo bar baz',
+    dateCreated: dateCreated ?? 1234567890, // TODO generate timestamp
+  );
+}
+
 ////////////////////////////////////////////////////////////////
 // Streams and subscriptions.
 //

test/model/saved_snippet.dart

@@ -0,0 +1,44 @@
+import 'package:checks/checks.dart';
+import 'package:flutter_test/flutter_test.dart';
+import 'package:zulip/api/model/events.dart';
+import 'package:zulip/api/model/model.dart';
+
+import '../api/model/model_checks.dart';
+import '../example_data.dart' as eg;
+import 'store_checks.dart';
+
+void main() {
+  test('handleSavedSnippetsEvent', () async {
+    final store = eg.store(initialSnapshot: eg.initialSnapshot(
+      savedSnippets: [eg.savedSnippet(id: 101)]));
+    check(store).savedSnippets.values.single.id.equals(101);
+
+    await store.handleEvent(SavedSnippetsAddEvent(id: 1,
+      savedSnippet: eg.savedSnippet(
+        id: 102,
+        title: 'foo title',
+        content: 'foo content',
+      )));
+    check(store).savedSnippets.values.deepEquals(<Condition<Object?>>[
+      (it) => it.isA<SavedSnippet>().id.equals(101),
+      (it) => it.isA<SavedSnippet>()..id.equals(102)
+                                    ..title.equals('foo title')
+                                    ..content.equals('foo content')
+    ]);
+
+    await store.handleEvent(SavedSnippetsRemoveEvent(id: 1, savedSnippetId: 101));
+    check(store).savedSnippets.values.single.id.equals(102);
+
+    await store.handleEvent(SavedSnippetsUpdateEvent(id: 1,
+      savedSnippet: eg.savedSnippet(
+        id: 102,
+        title: 'bar title',
+        content: 'bar content',
+        dateCreated: store.savedSnippets.values.single.dateCreated,
+      )));
+    check(store).savedSnippets.values.single
+      ..id.equals(102)
+      ..title.equals('bar title')
+      ..content.equals('bar content');
+  });
+}

test/model/store_checks.dart

@@ -55,6 +55,7 @@ extension PerAccountStoreChecks on Subject<PerAccountStore> {
   Subject<int> get accountId => has((x) => x.accountId, 'accountId');
   Subject<Account> get account => has((x) => x.account, 'account');
   Subject<int> get selfUserId => has((x) => x.selfUserId, 'selfUserId');
+  Subject<Map<int, SavedSnippet>> get savedSnippets => has((x) => x.savedSnippets, 'savedSnippets');
   Subject<UserSettings?> get userSettings => has((x) => x.userSettings, 'userSettings');
   Subject<Map<int, ZulipStream>> get streams => has((x) => x.streams, 'streams');
   Subject<Map<String, ZulipStream>> get streamsByName => has((x) => x.streamsByName, 'streamsByName');