store: Add channelFolders

Author: chrisbobbe

lib/api/model/model.dart

@@ -854,13 +854,13 @@ class Subscription extends ZulipStream {
 @JsonSerializable(fieldRename: FieldRename.snake)
 class ChannelFolder {
   final int id;
-  final String name;
-  final int? order; // TODO(server-11); added in a later FL than the rest
+  String name;
+  int? order; // TODO(server-11); added in a later FL than the rest
   final int? dateCreated;
   final int? creatorId;
-  final String description;
-  final String renderedDescription;
-  final bool isArchived;
+  String description;
+  String renderedDescription;
+  bool isArchived;
 
   ChannelFolder({
     required this.id,

lib/model/channel.dart

@@ -42,6 +42,9 @@ mixin ChannelStore on UserStore {
   /// and [streamsByName].
   Map<int, Subscription> get subscriptions;
 
+  /// All the channel folders, including archived ones, indexed by ID.
+  Map<int, ChannelFolder> get channelFolders;
+
   static int compareChannelsByName(ZulipStream a, ZulipStream b) {
     // A user gave feedback wanting zulip-flutter to match web in putting
     // emoji-prefixed channels first; see #1202.
@@ -267,6 +270,9 @@ mixin ProxyChannelStore on ChannelStore {
   @override
   Map<int, Subscription> get subscriptions => channelStore.subscriptions;
 
+  @override
+  Map<int, ChannelFolder> get channelFolders => channelStore.channelFolders;
+
   @override
   UserTopicVisibilityPolicy topicVisibilityPolicy(int streamId, TopicName topic) =>
     channelStore.topicVisibilityPolicy(streamId, topic);
@@ -306,6 +312,9 @@ class ChannelStoreImpl extends HasUserStore with ChannelStore {
       streams.putIfAbsent(stream.streamId, () => stream);
     }
 
+    final channelFolders = Map.fromEntries((initialSnapshot.channelFolders ?? [])
+      .map((channelFolder) => MapEntry(channelFolder.id, channelFolder)));
+
     final topicVisibility = <int, TopicKeyedMap<UserTopicVisibilityPolicy>>{};
     for (final item in initialSnapshot.userTopics ?? const <UserTopicItem>[]) {
       if (_warnInvalidVisibilityPolicy(item.visibilityPolicy)) {
@@ -321,6 +330,7 @@ class ChannelStoreImpl extends HasUserStore with ChannelStore {
       streams: streams,
       streamsByName: streams.map((_, stream) => MapEntry(stream.name, stream)),
       subscriptions: subscriptions,
+      channelFolders: channelFolders,
       topicVisibility: topicVisibility,
     );
   }
@@ -330,6 +340,7 @@ class ChannelStoreImpl extends HasUserStore with ChannelStore {
     required this.streams,
     required this.streamsByName,
     required this.subscriptions,
+    required this.channelFolders,
     required this.topicVisibility,
   });
 
@@ -339,6 +350,8 @@ class ChannelStoreImpl extends HasUserStore with ChannelStore {
   final Map<String, ZulipStream> streamsByName;
   @override
   final Map<int, Subscription> subscriptions;
+  @override
+  final Map<int, ChannelFolder> channelFolders;
 
   @override
   Map<int, TopicKeyedMap<UserTopicVisibilityPolicy>> get debugTopicVisibility => topicVisibility;
@@ -500,6 +513,31 @@ class ChannelStoreImpl extends HasUserStore with ChannelStore {
     }
   }
 
+  void handleChannelFolderEvent(ChannelFolderEvent event) {
+    switch (event) {
+      case ChannelFolderAddEvent():
+        final newChannelFolder = event.channelFolder;
+        channelFolders[newChannelFolder.id] = newChannelFolder;
+      case ChannelFolderUpdateEvent():
+        final change = event.data;
+        final channelFolder = channelFolders[event.channelFolderId];
+        if (channelFolder == null) return; // TODO(log)
+
+        if (change.name != null)                channelFolder.name = change.name!;
+        if (change.description != null)         channelFolder.description = change.description!;
+        if (change.renderedDescription != null) channelFolder.renderedDescription = change.renderedDescription!;
+        if (change.isArchived != null)          channelFolder.isArchived = change.isArchived!;
+      case ChannelFolderReorderEvent():
+        final order = event.order;
+        for (int i = 0; i < order.length; i++) {
+          final id = order[i];
+          final channelFolder = channelFolders[id];
+          if (channelFolder == null) continue; // TODO(log)
+          channelFolder.order = i;
+        }
+    }
+  }
+
   void handleUserTopicEvent(UserTopicEvent event) {
     UserTopicVisibilityPolicy visibilityPolicy = event.visibilityPolicy;
     if (_warnInvalidVisibilityPolicy(visibilityPolicy)) {

lib/model/store.dart

@@ -805,7 +805,7 @@ class PerAccountStore extends PerAccountStoreBase with
 
       case ChannelFolderEvent():
         assert(debugLog("server event: channel_folder/${event.op}"));
-        // TODO handle
+        _channels.handleChannelFolderEvent(event);
         break;
 
       case UserStatusEvent():

test/api/model/model_checks.dart

@@ -56,6 +56,17 @@ extension ZulipStreamChecks on Subject<ZulipStream> {
   Subject<int> get streamId => has((x) => x.streamId, 'streamId');
 }
 
+extension ChannelFolderChecks on Subject<ChannelFolder> {
+  Subject<int> get id => has((x) => x.id, 'id');
+  Subject<String> get name => has((x) => x.name, 'name');
+  Subject<int?> get order => has((x) => x.order, 'order');
+  Subject<int?> get dateCreated => has((x) => x.dateCreated, 'dateCreated');
+  Subject<int?> get creatorId => has((x) => x.creatorId, 'creatorId');
+  Subject<String> get description => has((x) => x.description, 'description');
+  Subject<String> get renderedDescription => has((x) => x.renderedDescription, 'renderedDescription');
+  Subject<bool> get isArchived => has((x) => x.isArchived, 'isArchived');
+}
+
 extension TopicNameChecks on Subject<TopicName> {
   Subject<String> get apiName => has((x) => x.apiName, 'apiName');
   Subject<String?> get displayName => has((x) => x.displayName, 'displayName');

test/example_data.dart

@@ -553,6 +553,49 @@ Subscription subscription(
   );
 }
 
+/// A fresh channel folder ID,
+/// from a random but always strictly increasing sequence.
+int _nextChannelFolderId() => (_lastChannelFolderId += 1 + Random().nextInt(100));
+int _lastChannelFolderId = 1000;
+
+ChannelFolder channelFolder({
+  int? id,
+  String? name,
+  int? order,
+  int? dateCreated,
+  int? creatorId,
+  String? description,
+  String? renderedDescription,
+  bool? isArchived,
+}) {
+  final effectiveId = id ?? _nextChannelFolderId();
+  final effectiveDescription = description ?? 'An example channel folder.';
+  return ChannelFolder(
+    id: effectiveId,
+    name: name ?? 'channel folder $effectiveId',
+    order: order,
+    dateCreated: dateCreated ?? utcTimestamp(),
+    creatorId: creatorId ?? selfUser.userId,
+    description: effectiveDescription,
+    renderedDescription: renderedDescription ?? '<p>$effectiveDescription</p>',
+    isArchived: isArchived ?? false,
+  );
+}
+
+ChannelFolderChange channelFolderChange({
+  String? name,
+  String? description,
+  String? renderedDescription,
+  bool? isArchived,
+}) {
+  return ChannelFolderChange(
+    name: name,
+    description: description,
+    renderedDescription: renderedDescription,
+    isArchived: isArchived,
+  );
+}
+
 /// The [TopicName] constructor, but shorter.
 ///
 /// Useful in test code that mentions a lot of topics in a compact format.

test/model/channel_test.dart

@@ -137,6 +137,88 @@ void main() {
     });
   });
 
+  group('ChannelFolderEvent', () {
+    group('add', () {
+      test('smoke', () async {
+        final folder1 = eg.channelFolder(id: 1);
+        final folder2 = eg.channelFolder(id: 2);
+        final store = eg.store(initialSnapshot: eg.initialSnapshot(
+          channelFolders: [folder1]));
+
+        await store.handleEvent(ChannelFolderAddEvent(
+          id: 1, channelFolder: folder2));
+        check(store.channelFolders).deepEquals({1: folder1, 2: folder2});
+      });
+    });
+
+    group('update', () {
+      void doTest(ChannelFolderChange change) {
+        final ChannelFolderChange(
+          :name, :description, :renderedDescription, :isArchived) = change;
+        final testDescription = [
+          if (name != null)                'name: $name',
+          if (description != null)         'description: $description',
+          if (renderedDescription != null) 'renderedDescription: $renderedDescription',
+          if (isArchived != null)          'isArchived: $isArchived',
+        ].join(', ');
+        test(testDescription, () async {
+          final channelFolder = eg.channelFolder();
+          assert(name == null || name != channelFolder.name);
+          assert(description == null || description != channelFolder.description);
+          assert(renderedDescription == null || renderedDescription != channelFolder.renderedDescription);
+          assert(isArchived == null || isArchived != channelFolder.isArchived);
+
+          final store = eg.store(initialSnapshot: eg.initialSnapshot(
+            channelFolders: [channelFolder]));
+          await store.handleEvent(ChannelFolderUpdateEvent(id: 1,
+            channelFolderId: channelFolder.id, data: change));
+          check(store.channelFolders.values.single)
+            ..name.equals(name ?? channelFolder.name)
+            ..description.equals(description ?? channelFolder.description)
+            ..renderedDescription.equals(renderedDescription ?? channelFolder.renderedDescription)
+            ..isArchived.equals(isArchived ?? channelFolder.isArchived);
+        });
+      }
+
+      doTest(eg.channelFolderChange(name: 'new name'));
+      doTest(eg.channelFolderChange(description: 'new description'));
+      doTest(eg.channelFolderChange(renderedDescription: '<p>new description</p>'));
+      doTest(eg.channelFolderChange(isArchived: true));
+
+      doTest(eg.channelFolderChange(
+        name: 'new name',
+        description: 'new description',
+        renderedDescription: '<p>new description</p>',
+        isArchived: true,
+      ));
+    });
+
+    group('reorder', () {
+      List<ChannelFolder> foldersFromStoreInOrder(PerAccountStore store) {
+        return store.channelFolders.values.toList()
+          ..sort((a, b) => a.order!.compareTo(b.order!));
+      }
+
+      test('smoke', () async {
+        final folderA = eg.channelFolder(order: 0);
+        final folderB = eg.channelFolder(order: 1);
+        final folderC = eg.channelFolder(order: 2);
+
+        final store = eg.store(initialSnapshot: eg.initialSnapshot(
+          channelFolders: [folderA, folderB, folderC]));
+        check(foldersFromStoreInOrder(store)).deepEquals([folderA, folderB, folderC]);
+
+        await store.handleEvent(ChannelFolderReorderEvent(id: 1,
+          order: [folderA.id, folderC.id, folderB.id]));
+        check(foldersFromStoreInOrder(store)).deepEquals([folderA, folderC, folderB]);
+
+        await store.handleEvent(ChannelFolderReorderEvent(id: 1,
+          order: [folderC.id, folderB.id, folderA.id]));
+        check(foldersFromStoreInOrder(store)).deepEquals([folderC, folderB, folderA]);
+      });
+    });
+  });
+
   group('topic visibility', () {
     final stream1 = eg.stream();
     final stream2 = eg.stream();

test/model/test_store.dart

@@ -335,6 +335,10 @@ extension PerAccountStoreTestExtension on PerAccountStore {
     await handleEvent(SubscriptionRemoveEvent(id: 1, streamIds: channelIds));
   }
 
+  Future<void> addChannelFolder(ChannelFolder channelFolder) async {
+    await handleEvent(ChannelFolderAddEvent(id: 1, channelFolder: channelFolder));
+  }
+
   Future<void> setUserTopic(ZulipStream stream, String topic, UserTopicVisibilityPolicy visibilityPolicy) async {
     await handleEvent(eg.userTopicEvent(stream.streamId, topic, visibilityPolicy));
   }