api [nfc]: Rename UnreadStreamSnapshot to UnreadChannelSnapshot

Fixes parts of zulip#631
prakhar1144 · Jul 30, 2024 · 3a57292 · 3a57292
1 parent 26fc976
commit 3a57292
Show file tree

Hide file tree

Showing 7 changed files with 28 additions and 28 deletions.
diff --git a/lib/api/model/initial_snapshot.dart b/lib/api/model/initial_snapshot.dart
@@ -229,7 +229,7 @@ class UnreadMessagesSnapshot {
   @JsonKey(name: 'pms')
   final List<UnreadDmSnapshot> dms;
 
-  final List<UnreadStreamSnapshot> streams;
+  final List<UnreadChannelSnapshot> streams;
   final List<UnreadHuddleSnapshot> huddles;
 
   // Unlike other lists of message IDs here, [mentions] is *not* sorted.
@@ -277,21 +277,21 @@ class UnreadDmSnapshot {
 
 /// An item in [UnreadMessagesSnapshot.streams].
 @JsonSerializable(fieldRename: FieldRename.snake)
-class UnreadStreamSnapshot {
+class UnreadChannelSnapshot {
   final String topic;
   final int streamId;
   final List<int> unreadMessageIds;
 
-  UnreadStreamSnapshot({
+  UnreadChannelSnapshot({
     required this.topic,
     required this.streamId,
     required this.unreadMessageIds,
   }) : assert(isSortedWithoutDuplicates(unreadMessageIds));
 
-  factory UnreadStreamSnapshot.fromJson(Map<String, dynamic> json) =>
-    _$UnreadStreamSnapshotFromJson(json);
+  factory UnreadChannelSnapshot.fromJson(Map<String, dynamic> json) =>
+    _$UnreadChannelSnapshotFromJson(json);
 
-  Map<String, dynamic> toJson() => _$UnreadStreamSnapshotToJson(this);
+  Map<String, dynamic> toJson() => _$UnreadChannelSnapshotToJson(this);
 }
 
 /// An item in [UnreadMessagesSnapshot.huddles].

diff --git a/lib/api/model/initial_snapshot.g.dart b/lib/api/model/initial_snapshot.g.dart
diff --git a/test/api/model/initial_snapshot_test.dart b/test/api/model/initial_snapshot_test.dart
@@ -15,14 +15,14 @@ void main() {
     })).throws<AssertionError>();
   });
 
-  test('UnreadStreamSnapshot: require sorted unreadMessageIds', () {
-    check(() => UnreadStreamSnapshot.fromJson({
+  test('UnreadChannelSnapshot: require sorted unreadMessageIds', () {
+    check(() => UnreadChannelSnapshot.fromJson({
       'topic': 'a',
       'stream_id': 1,
       'unread_message_ids': [1, 2, 3],
     })).returnsNormally();
 
-    check(() => UnreadStreamSnapshot.fromJson({
+    check(() => UnreadChannelSnapshot.fromJson({
       'topic': 'a',
       'stream_id': 1,
       'unread_message_ids': [11, 2, 3],

diff --git a/test/example_data.dart b/test/example_data.dart
@@ -396,7 +396,7 @@ DmMessage dmMessage({
 UnreadMessagesSnapshot unreadMsgs({
   int? count,
   List<UnreadDmSnapshot>? dms,
-  List<UnreadStreamSnapshot>? streams,
+  List<UnreadChannelSnapshot>? streams,
   List<UnreadHuddleSnapshot>? huddles,
   List<int>? mentions,
   bool? oldUnreadsMissing,

diff --git a/test/model/unreads_test.dart b/test/model/unreads_test.dart
@@ -114,10 +114,10 @@ void main() {
       prepare(initial: UnreadMessagesSnapshot(
         count: 0,
         streams: [
-          UnreadStreamSnapshot(streamId: stream1.streamId, topic: 'a', unreadMessageIds: [1, 2]),
-          UnreadStreamSnapshot(streamId: stream1.streamId, topic: 'b', unreadMessageIds: [3, 4]),
-          UnreadStreamSnapshot(streamId: stream2.streamId, topic: 'b', unreadMessageIds: [5, 6]),
-          UnreadStreamSnapshot(streamId: stream2.streamId, topic: 'c', unreadMessageIds: [7, 8]),
+          UnreadChannelSnapshot(streamId: stream1.streamId, topic: 'a', unreadMessageIds: [1, 2]),
+          UnreadChannelSnapshot(streamId: stream1.streamId, topic: 'b', unreadMessageIds: [3, 4]),
+          UnreadChannelSnapshot(streamId: stream2.streamId, topic: 'b', unreadMessageIds: [5, 6]),
+          UnreadChannelSnapshot(streamId: stream2.streamId, topic: 'c', unreadMessageIds: [7, 8]),
         ],
         dms: [
           UnreadDmSnapshot(otherUserId: 1, unreadMessageIds: [9, 10]),

diff --git a/test/widgets/message_list_test.dart b/test/widgets/message_list_test.dart
@@ -866,7 +866,7 @@ void main() {
     testWidgets('from unread to read', (WidgetTester tester) async {
       final message = eg.streamMessage(flags: []);
       final unreadMsgs = eg.unreadMsgs(streams:[
-        UnreadStreamSnapshot(topic: message.topic, streamId: message.streamId, unreadMessageIds: [message.id])
+        UnreadChannelSnapshot(topic: message.topic, streamId: message.streamId, unreadMessageIds: [message.id])
       ]);
       await setupMessageListPage(tester, messages: [message], unreadMsgs: unreadMsgs);
       check(isMarkAsReadButtonVisible(tester)).isTrue();
@@ -884,7 +884,7 @@ void main() {
     testWidgets("messages don't shift position", (WidgetTester tester) async {
       final message = eg.streamMessage(flags: []);
       final unreadMsgs = eg.unreadMsgs(streams:[
-        UnreadStreamSnapshot(topic: message.topic, streamId: message.streamId,
+        UnreadChannelSnapshot(topic: message.topic, streamId: message.streamId,
           unreadMessageIds: [message.id])
       ]);
       await setupMessageListPage(tester,
@@ -913,7 +913,7 @@ void main() {
 
       final message = eg.streamMessage(flags: []);
       final unreadMsgs = eg.unreadMsgs(streams: [
-        UnreadStreamSnapshot(streamId: message.streamId, topic: message.topic,
+        UnreadChannelSnapshot(streamId: message.streamId, topic: message.topic,
           unreadMessageIds: [message.id]),
       ]);
 

diff --git a/test/widgets/subscription_list_test.dart b/test/widgets/subscription_list_test.dart
@@ -147,7 +147,7 @@ void main() {
   testWidgets('unread badge shows with unreads', (tester) async {
     final stream = eg.stream();
     final unreadMsgs = eg.unreadMsgs(streams: [
-      UnreadStreamSnapshot(streamId: stream.streamId, topic: 'a', unreadMessageIds: [1, 2]),
+      UnreadChannelSnapshot(streamId: stream.streamId, topic: 'a', unreadMessageIds: [1, 2]),
     ]);
     await setupStreamListPage(tester, subscriptions: [
       eg.subscription(stream),
@@ -158,8 +158,8 @@ void main() {
   testWidgets('unread badge counts unmuted only', (tester) async {
     final stream = eg.stream();
     final unreadMsgs = eg.unreadMsgs(streams: [
-      UnreadStreamSnapshot(streamId: stream.streamId, topic: 'a', unreadMessageIds: [1, 2]),
-      UnreadStreamSnapshot(streamId: stream.streamId, topic: 'b', unreadMessageIds: [3]),
+      UnreadChannelSnapshot(streamId: stream.streamId, topic: 'a', unreadMessageIds: [1, 2]),
+      UnreadChannelSnapshot(streamId: stream.streamId, topic: 'b', unreadMessageIds: [3]),
     ]);
     await setupStreamListPage(tester,
       subscriptions: [eg.subscription(stream, isMuted: true)],
@@ -187,7 +187,7 @@ void main() {
   testWidgets('color propagates to icon and badge', (tester) async {
     final stream = eg.stream();
     final unreadMsgs = eg.unreadMsgs(streams: [
-      UnreadStreamSnapshot(streamId: stream.streamId, topic: 'a', unreadMessageIds: [1, 2]),
+      UnreadChannelSnapshot(streamId: stream.streamId, topic: 'a', unreadMessageIds: [1, 2]),
     ]);
     final subscription = eg.subscription(stream, color: Colors.red.value);
     final swatch = StreamColorSwatch.light(subscription.color);
@@ -225,8 +225,8 @@ void main() {
         eg.userTopicItem(stream2, 'b', UserTopicVisibilityPolicy.unmuted),
       ],
       unreadMsgs: eg.unreadMsgs(streams: [
-        UnreadStreamSnapshot(streamId: stream1.streamId, topic: 'a', unreadMessageIds: [1, 2]),
-        UnreadStreamSnapshot(streamId: stream2.streamId, topic: 'b', unreadMessageIds: [3]),
+        UnreadChannelSnapshot(streamId: stream1.streamId, topic: 'a', unreadMessageIds: [1, 2]),
+        UnreadChannelSnapshot(streamId: stream2.streamId, topic: 'b', unreadMessageIds: [3]),
       ]),
     );