api [nfc]: Rename ZulipStream to Channel

Fixes parts of zulip#631

Author: Khader-1

lib/api/model/events.dart

@@ -347,7 +347,7 @@ class StreamCreateEvent extends StreamEvent {
   @override
   String get op => 'create';
 
-  final List<ZulipStream> streams;
+  final List<Channel> streams;
 
   StreamCreateEvent({required super.id, required this.streams});
 
@@ -364,7 +364,7 @@ class StreamDeleteEvent extends StreamEvent {
   @override
   String get op => 'delete';
 
-  final List<ZulipStream> streams;
+  final List<Channel> streams;
 
   StreamDeleteEvent({required super.id, required this.streams});
 

lib/api/model/events.g.dart

@@ -34,7 +34,7 @@ class InitialSnapshot {
 
   final UnreadMessagesSnapshot unreadMsgs;
 
-  final List<ZulipStream> streams;
+  final List<Channel> streams;
 
   // Servers pre-5.0 don't have `user_settings`, and instead provide whatever
   // user settings they support at toplevel in the initial snapshot. Since we're

lib/api/model/initial_snapshot.dart

@@ -302,12 +302,10 @@ enum UserRole{
 
 /// As in `streams` in the initial snapshot.
 ///
-/// Not called `Stream` because dart:async uses that name.
-///
 /// For docs, search for "if stream"
 /// in <https://zulip.com/api/register-queue>.
 @JsonSerializable(fieldRename: FieldRename.snake)
-class ZulipStream {
+class Channel {
   final int streamId;
   final String name;
   final String description;
@@ -337,7 +335,7 @@ class ZulipStream {
       ?? (json['can_remove_subscribers_group_id'] as int?);
   }
 
-  ZulipStream({
+  Channel({
     required this.streamId,
     required this.name,
     required this.description,
@@ -353,10 +351,10 @@ class ZulipStream {
     required this.streamWeeklyTraffic,
   });
 
-  factory ZulipStream.fromJson(Map<String, dynamic> json) =>
-    _$ZulipStreamFromJson(json);
+  factory Channel.fromJson(Map<String, dynamic> json) =>
+    _$ChannelFromJson(json);
 
-  Map<String, dynamic> toJson() => _$ZulipStreamToJson(this);
+  Map<String, dynamic> toJson() => _$ChannelToJson(this);
 }
 
 /// Policy for which users can post to the stream.
@@ -385,7 +383,7 @@ enum StreamPostPolicy {
 /// For docs, search for "subscriptions:"
 /// in <https://zulip.com/api/register-queue>.
 @JsonSerializable(fieldRename: FieldRename.snake)
-class Subscription extends ZulipStream {
+class Subscription extends Channel {
   // final List<int> subscribers; // we register with includeSubscribers false
 
   bool? desktopNotifications;

lib/api/model/initial_snapshot.g.dart

@@ -323,9 +323,9 @@ class PerAccountStore extends ChangeNotifier with StreamStore, MessageStore {
   // Streams, topics, and stuff about them.
 
   @override
-  Map<int, ZulipStream> get streams => _streams.streams;
+  Map<int, Channel> get streams => _streams.streams;
   @override
-  Map<String, ZulipStream> get streamsByName => _streams.streamsByName;
+  Map<String, Channel> get streamsByName => _streams.streamsByName;
   @override
   Map<int, Subscription> get subscriptions => _streams.subscriptions;
   @override

lib/api/model/model.dart

@@ -9,8 +9,8 @@ import '../api/model/model.dart';
 ///
 /// The data structures described here are implemented at [StreamStoreImpl].
 mixin StreamStore {
-  Map<int, ZulipStream> get streams;
-  Map<String, ZulipStream> get streamsByName;
+  Map<int, Channel> get streams;
+  Map<String, Channel> get streamsByName;
   Map<int, Subscription> get subscriptions;
   UserTopicVisibilityPolicy topicVisibilityPolicy(int streamId, String topic);
 
@@ -77,7 +77,7 @@ class StreamStoreImpl with StreamStore {
     final subscriptions = Map.fromEntries(initialSnapshot.subscriptions.map(
       (subscription) => MapEntry(subscription.streamId, subscription)));
 
-    final streams = Map<int, ZulipStream>.of(subscriptions);
+    final streams = Map<int, Channel>.of(subscriptions);
     for (final stream in initialSnapshot.streams) {
       streams.putIfAbsent(stream.streamId, () => stream);
     }
@@ -108,9 +108,9 @@ class StreamStoreImpl with StreamStore {
   });
 
   @override
-  final Map<int, ZulipStream> streams;
+  final Map<int, Channel> streams;
   @override
-  final Map<String, ZulipStream> streamsByName;
+  final Map<String, Channel> streamsByName;
   @override
   final Map<int, Subscription> subscriptions;
 

lib/api/model/model.g.dart

@@ -78,13 +78,13 @@ abstract final class ZulipIcons {
   // END GENERATED ICON DATA
 }
 
-IconData iconDataForStream(ZulipStream stream) {
+IconData iconDataForStream(Channel stream) {
   // TODO: these icons aren't quite right yet;
   //   see this message and the one after it:
   //   https://chat.zulip.org/#narrow/stream/243-mobile-team/topic/design.3A.20.23F117.20.22Inbox.22.20screen/near/1680637
   return switch(stream) {
-    ZulipStream(isWebPublic: true) => ZulipIcons.globe,
-    ZulipStream(inviteOnly: true) => ZulipIcons.lock,
-    ZulipStream() => ZulipIcons.hash_sign,
+    Channel(isWebPublic: true) => ZulipIcons.globe,
+    Channel(inviteOnly: true) => ZulipIcons.lock,
+    Channel() => ZulipIcons.hash_sign,
   };
 }

lib/model/store.dart

@@ -124,7 +124,7 @@ class MessageListAppBarTitle extends StatelessWidget {
   final Narrow narrow;
 
   Widget _buildStreamRow(BuildContext context, {
-    ZulipStream? stream,
+    Channel? stream,
     required String text,
   }) {
     // A null [Icon.icon] makes a blank space.

lib/model/stream.dart

@@ -23,7 +23,7 @@ extension UserChecks on Subject<User> {
   Subject<bool> get isSystemBot => has((x) => x.isSystemBot, 'isSystemBot');
 }
 
-extension ZulipStreamChecks on Subject<ZulipStream> {
+extension ChannelChecks on Subject<Channel> {
   Subject<int?> get canRemoveSubscribersGroup => has((e) => e.canRemoveSubscribersGroup, 'canRemoveSubscribersGroup');
 }
 

lib/widgets/icons.dart

@@ -66,7 +66,7 @@ void main() {
     });
   });
 
-  group('ZulipStream.canRemoveSubscribersGroup', () {
+  group('Channel.canRemoveSubscribersGroup', () {
     final Map<String, dynamic> baseJson = Map.unmodifiable({
       'stream_id': 123,
       'name': 'A stream',
@@ -84,21 +84,21 @@ void main() {
     });
 
     test('smoke', () {
-      check(ZulipStream.fromJson({ ...baseJson,
+      check(Channel.fromJson({ ...baseJson,
         'can_remove_subscribers_group': 123,
       })).canRemoveSubscribersGroup.equals(123);
     });
 
     // TODO(server-8): field renamed in FL 197
     test('support old can_remove_subscribers_group_id', () {
-      check(ZulipStream.fromJson({ ...baseJson,
+      check(Channel.fromJson({ ...baseJson,
         'can_remove_subscribers_group_id': 456,
       })).canRemoveSubscribersGroup.equals(456);
     });
 
     // TODO(server-6): field added in FL 142
     test('support field missing', () {
-      check(ZulipStream.fromJson({ ...baseJson,
+      check(Channel.fromJson({ ...baseJson,
       })).canRemoveSubscribersGroup.isNull();
     });
   });

lib/widgets/message_list.dart

@@ -149,7 +149,7 @@ final User fourthUser  = user(fullName: 'Fourth User', email: 'fourth@example');
 // Streams and subscriptions.
 //
 
-ZulipStream stream({
+Channel stream({
   int? streamId,
   String? name,
   String? description,
@@ -164,7 +164,7 @@ ZulipStream stream({
   int? canRemoveSubscribersGroup,
   int? streamWeeklyTraffic,
 }) {
-  return ZulipStream(
+  return Channel(
     streamId: streamId ?? 123, // TODO generate example IDs
     name: name ?? 'A stream', // TODO generate example names
     description: description ?? 'A description', // TODO generate example descriptions
@@ -185,9 +185,9 @@ const _stream = stream;
 /// Construct an example subscription from a stream.
 ///
 /// We only allow overrides of values specific to the [Subscription], all
-/// other properties are copied from the [ZulipStream] provided.
+/// other properties are copied from the [Channel] provided.
 Subscription subscription(
-  ZulipStream stream, {
+  Channel stream, {
   bool? desktopNotifications,
   bool? emailNotifications,
   bool? wildcardMentionsNotify,
@@ -294,7 +294,7 @@ int _lastMessageId = 1000;
 StreamMessage streamMessage({
   int? id,
   User? sender,
-  ZulipStream? stream,
+  Channel? stream,
   String? topic,
   String? content,
   String? contentMarkdown,
@@ -537,7 +537,7 @@ InitialSnapshot initialSnapshot({
   List<RecentDmConversation>? recentPrivateConversations,
   List<Subscription>? subscriptions,
   UnreadMessagesSnapshot? unreadMsgs,
-  List<ZulipStream>? streams,
+  List<Channel>? streams,
   UserSettings? userSettings,
   List<UserTopicItem>? userTopics,
   Map<String, RealmDefaultExternalAccount>? realmDefaultExternalAccounts,

test/api/model/model_checks.dart

@@ -18,7 +18,7 @@ Set<String> getUrlSyntaxVariants(String urlString) {
 
 Future<PerAccountStore> setupStore({
   required Uri realmUrl,
-  List<ZulipStream>? streams,
+  List<Channel>? streams,
   List<User>? users,
 }) async {
   final account = eg.selfAccount.copyWith(realmUrl: realmUrl);
@@ -37,7 +37,7 @@ void main() {
   final realmUrl = Uri.parse('https://example.com/');
 
   void testExpectedNarrows(List<(String, Narrow?)> testCases, {
-    List<ZulipStream>? streams,
+    List<Channel>? streams,
     List<User>? users,
   }) {
     assert(streams != null || users != null);

test/api/model/model_test.dart

@@ -39,8 +39,8 @@ extension PerAccountStoreChecks on Subject<PerAccountStore> {
   Subject<int> get selfUserId => has((x) => x.selfUserId, 'selfUserId');
   Subject<UserSettings?> get userSettings => has((x) => x.userSettings, 'userSettings');
   Subject<Map<int, User>> get users => has((x) => x.users, 'users');
-  Subject<Map<int, ZulipStream>> get streams => has((x) => x.streams, 'streams');
-  Subject<Map<String, ZulipStream>> get streamsByName => has((x) => x.streamsByName, 'streamsByName');
+  Subject<Map<int, Channel>> get streams => has((x) => x.streams, 'streams');
+  Subject<Map<String, Channel>> get streamsByName => has((x) => x.streamsByName, 'streamsByName');
   Subject<Map<int, Subscription>> get subscriptions => has((x) => x.subscriptions, 'subscriptions');
   Subject<Map<int, Message>> get messages => has((x) => x.messages, 'messages');
   Subject<Unreads> get unreads => has((x) => x.unreads, 'unreads');

test/example_data.dart

@@ -190,7 +190,7 @@ void main() {
     });
 
     UserTopicItem makeUserTopicItem(
-        ZulipStream stream, String topic, UserTopicVisibilityPolicy policy) {
+        Channel stream, String topic, UserTopicVisibilityPolicy policy) {
       return UserTopicItem(
         streamId: stream.streamId,
         topicName: topic,

test/model/internal_link_test.dart

@@ -129,11 +129,11 @@ extension PerAccountStoreTestExtension on PerAccountStore {
     }
   }
 
-  Future<void> addStream(ZulipStream stream) async {
+  Future<void> addStream(Channel stream) async {
     await addStreams([stream]);
   }
 
-  Future<void> addStreams(List<ZulipStream> streams) async {
+  Future<void> addStreams(List<Channel> streams) async {
     await handleEvent(StreamCreateEvent(id: 1, streams: streams));
   }
 
@@ -145,7 +145,7 @@ extension PerAccountStoreTestExtension on PerAccountStore {
     await handleEvent(SubscriptionAddEvent(id: 1, subscriptions: subscriptions));
   }
 
-  Future<void> addUserTopic(ZulipStream stream, String topic, UserTopicVisibilityPolicy visibilityPolicy) async {
+  Future<void> addUserTopic(Channel stream, String topic, UserTopicVisibilityPolicy visibilityPolicy) async {
     await handleEvent(UserTopicEvent(
       id: 1,
       streamId: stream.streamId,

test/model/store_checks.dart

@@ -52,7 +52,7 @@ void main() {
   late PerAccountStore store;
 
   Future<void> setupPage(WidgetTester tester, {
-    List<ZulipStream>? streams,
+    List<Channel>? streams,
     List<Subscription>? subscriptions,
     List<User>? users,
     required List<Message> unreadMessages,
@@ -82,7 +82,7 @@ void main() {
   }
 
   List<StreamMessage> generateStreamMessages({
-    required ZulipStream stream,
+    required Channel stream,
     required int count,
     required List<MessageFlag> flags,
   }) {

test/model/stream_test.dart

@@ -46,7 +46,7 @@ void main() {
     bool foundOldest = true,
     int? messageCount,
     List<Message>? messages,
-    List<ZulipStream>? streams,
+    List<Channel>? streams,
     List<User>? users,
     List<Subscription>? subscriptions,
     UnreadMessagesSnapshot? unreadMsgs,
@@ -374,7 +374,7 @@ void main() {
       testWidgets('show stream name from stream data when known', (tester) async {
         final streamBefore = eg.stream(name: 'old stream name');
         // TODO(#182) this test would be more realistic using a StreamUpdateEvent
-        final streamAfter = ZulipStream.fromJson({
+        final streamAfter = Channel.fromJson({
           ...(deepToJson(streamBefore) as Map<String, dynamic>),
           'name': 'new stream name',
         });