api [nfc]: Rename references of UnreadChannelSnapshot to match it's name

Author: Khader-1

lib/api/model/initial_snapshot.dart

@@ -229,7 +229,8 @@ class UnreadMessagesSnapshot {
   @JsonKey(name: 'pms')
   final List<UnreadDmSnapshot> dms;
 
-  final List<UnreadChannelSnapshot> streams;
+  @JsonKey(name: 'streams')
+  final List<UnreadChannelSnapshot> channels;
   final List<UnreadHuddleSnapshot> huddles;
 
   // Unlike other lists of message IDs here, [mentions] is *not* sorted.
@@ -240,7 +241,7 @@ class UnreadMessagesSnapshot {
   const UnreadMessagesSnapshot({
     required this.count,
     required this.dms,
-    required this.streams,
+    required this.channels,
     required this.huddles,
     required this.mentions,
     required this.oldUnreadsMissing,
@@ -275,7 +276,7 @@ class UnreadDmSnapshot {
   Map<String, dynamic> toJson() => _$UnreadDmSnapshotToJson(this);
 }
 
-/// An item in [UnreadMessagesSnapshot.streams].
+/// An item in [UnreadMessagesSnapshot.channels].
 @JsonSerializable(fieldRename: FieldRename.snake)
 class UnreadChannelSnapshot {
   final String topic;

lib/api/model/initial_snapshot.g.dart

@@ -45,10 +45,10 @@ class Unreads extends ChangeNotifier {
     final dms = <DmNarrow, QueueList<int>>{};
     final mentions = Set.of(initial.mentions);
 
-    for (final unreadStreamSnapshot in initial.streams) {
-      final streamId = unreadStreamSnapshot.streamId;
-      final topic = unreadStreamSnapshot.topic;
-      (streams[streamId] ??= {})[topic] = QueueList.from(unreadStreamSnapshot.unreadMessageIds);
+    for (final unreadChannelSnapshot in initial.channels) {
+      final streamId = unreadChannelSnapshot.streamId;
+      final topic = unreadChannelSnapshot.topic;
+      (streams[streamId] ??= {})[topic] = QueueList.from(unreadChannelSnapshot.unreadMessageIds);
     }
 
     for (final unreadDmSnapshot in initial.dms) {

lib/model/unreads.dart

@@ -2,7 +2,28 @@ import 'package:checks/checks.dart';
 import 'package:test/scaffolding.dart';
 import 'package:zulip/api/model/initial_snapshot.dart';
 
+import '../../stdlib_checks.dart';
+
 void main() {
+  test('UnreadMessagesSnapshot from json recognizes channels as streams', () {
+    final snapshot = UnreadMessagesSnapshot.fromJson({
+      'count': 1,
+      'pms': <dynamic>[],
+      'huddles': <dynamic>[],
+      'mentions': <dynamic>[],
+      'old_unreads_missing': false,
+      'streams': [{
+        'stream_id': 1,
+        'topic': 'topic name',
+        'unread_message_ids': [1, 2]}]
+    });
+
+    check(snapshot.channels).single.jsonEquals(
+      UnreadChannelSnapshot(
+        topic: 'topic name', streamId: 1,
+        unreadMessageIds: [1, 2]));
+  });
+
   test('UnreadDmSnapshot: require sorted unreadMessageIds', () {
     check(() => UnreadDmSnapshot.fromJson({
       'other_user_id': 1,

test/api/model/initial_snapshot_test.dart

@@ -396,15 +396,15 @@ DmMessage dmMessage({
 UnreadMessagesSnapshot unreadMsgs({
   int? count,
   List<UnreadDmSnapshot>? dms,
-  List<UnreadChannelSnapshot>? streams,
+  List<UnreadChannelSnapshot>? channels,
   List<UnreadHuddleSnapshot>? huddles,
   List<int>? mentions,
   bool? oldUnreadsMissing,
 }) {
   return UnreadMessagesSnapshot(
     count: count ?? 0,
     dms: dms ?? [],
-    streams: streams ?? [],
+    channels: channels ?? [],
     huddles: huddles ?? [],
     mentions: mentions ?? [],
     oldUnreadsMissing: oldUnreadsMissing ?? false,

test/example_data.dart

@@ -30,7 +30,7 @@ void main() {
   void prepare({
     UnreadMessagesSnapshot initial = const UnreadMessagesSnapshot(
       count: 0,
-      streams: [],
+      channels: [],
       dms: [],
       huddles: [],
       mentions: [],
@@ -113,7 +113,7 @@ void main() {
 
       prepare(initial: UnreadMessagesSnapshot(
         count: 0,
-        streams: [
+        channels: [
           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]),

test/model/unreads_test.dart

@@ -865,7 +865,7 @@ void main() {
 
     testWidgets('from unread to read', (WidgetTester tester) async {
       final message = eg.streamMessage(flags: []);
-      final unreadMsgs = eg.unreadMsgs(streams:[
+      final unreadMsgs = eg.unreadMsgs(channels:[
         UnreadChannelSnapshot(topic: message.topic, streamId: message.streamId, unreadMessageIds: [message.id])
       ]);
       await setupMessageListPage(tester, messages: [message], unreadMsgs: unreadMsgs);
@@ -883,7 +883,7 @@ void main() {
 
     testWidgets("messages don't shift position", (WidgetTester tester) async {
       final message = eg.streamMessage(flags: []);
-      final unreadMsgs = eg.unreadMsgs(streams:[
+      final unreadMsgs = eg.unreadMsgs(channels:[
         UnreadChannelSnapshot(topic: message.topic, streamId: message.streamId,
           unreadMessageIds: [message.id])
       ]);
@@ -912,7 +912,7 @@ void main() {
       // and a couple of smoke tests showing this button is wired up to it.
 
       final message = eg.streamMessage(flags: []);
-      final unreadMsgs = eg.unreadMsgs(streams: [
+      final unreadMsgs = eg.unreadMsgs(channels: [
         UnreadChannelSnapshot(streamId: message.streamId, topic: message.topic,
           unreadMessageIds: [message.id]),
       ]);

test/widgets/message_list_test.dart

@@ -146,7 +146,7 @@ void main() {
 
   testWidgets('unread badge shows with unreads', (tester) async {
     final stream = eg.stream();
-    final unreadMsgs = eg.unreadMsgs(streams: [
+    final unreadMsgs = eg.unreadMsgs(channels: [
       UnreadChannelSnapshot(streamId: stream.streamId, topic: 'a', unreadMessageIds: [1, 2]),
     ]);
     await setupStreamListPage(tester, subscriptions: [
@@ -157,7 +157,7 @@ void main() {
 
   testWidgets('unread badge counts unmuted only', (tester) async {
     final stream = eg.stream();
-    final unreadMsgs = eg.unreadMsgs(streams: [
+    final unreadMsgs = eg.unreadMsgs(channels: [
       UnreadChannelSnapshot(streamId: stream.streamId, topic: 'a', unreadMessageIds: [1, 2]),
       UnreadChannelSnapshot(streamId: stream.streamId, topic: 'b', unreadMessageIds: [3]),
     ]);
@@ -177,7 +177,7 @@ void main() {
 
   testWidgets('unread badge does not show with no unreads', (tester) async {
     final stream = eg.stream();
-    final unreadMsgs = eg.unreadMsgs(streams: []);
+    final unreadMsgs = eg.unreadMsgs(channels: []);
     await setupStreamListPage(tester, subscriptions: [
       eg.subscription(stream),
     ], unreadMsgs: unreadMsgs);
@@ -186,7 +186,7 @@ void main() {
 
   testWidgets('color propagates to icon and badge', (tester) async {
     final stream = eg.stream();
-    final unreadMsgs = eg.unreadMsgs(streams: [
+    final unreadMsgs = eg.unreadMsgs(channels: [
       UnreadChannelSnapshot(streamId: stream.streamId, topic: 'a', unreadMessageIds: [1, 2]),
     ]);
     final subscription = eg.subscription(stream, color: Colors.red.value);
@@ -224,7 +224,7 @@ void main() {
         eg.userTopicItem(stream1, 'a', UserTopicVisibilityPolicy.unmuted),
         eg.userTopicItem(stream2, 'b', UserTopicVisibilityPolicy.unmuted),
       ],
-      unreadMsgs: eg.unreadMsgs(streams: [
+      unreadMsgs: eg.unreadMsgs(channels: [
         UnreadChannelSnapshot(streamId: stream1.streamId, topic: 'a', unreadMessageIds: [1, 2]),
         UnreadChannelSnapshot(streamId: stream2.streamId, topic: 'b', unreadMessageIds: [3]),
       ]),