api: Update ZulipStream for API changes

Author: sirpengi

lib/api/model/model.dart

@@ -252,7 +252,17 @@ class ZulipStream {
   final StreamPostPolicy streamPostPolicy;
   // final bool isAnnouncementOnly; // deprecated for `streamPostPolicy`; ignore
 
-  final int? canRemoveSubscribersGroupId; // TODO(server-6)
+  // TODO(server-6): `canRemoveSubscribersGroupId` added in FL 142
+  // TODO(server-8): in FL 197 renamed to `canRemoveSubscribersGroup`
+  @JsonKey(readValue: _readCanRemoveSubscribersGroup)
+  final int? canRemoveSubscribersGroup;
+
+  // TODO(server-8): added in FL 199, was previously only on [Subscription] objects
+  final int? streamWeeklyTraffic;
+
+  static int? _readCanRemoveSubscribersGroup(Map json, String key) {
+    return json[key] ?? json['can_remove_subscribers_group_id'];
+  }
 
   ZulipStream({
     required this.streamId,
@@ -266,7 +276,8 @@ class ZulipStream {
     required this.historyPublicToSubscribers,
     required this.messageRetentionDays,
     required this.streamPostPolicy,
-    required this.canRemoveSubscribersGroupId,
+    required this.canRemoveSubscribersGroup,
+    required this.streamWeeklyTraffic,
   });
 
   factory ZulipStream.fromJson(Map<String, dynamic> json) =>

lib/api/model/model.g.dart

@@ -1,6 +1,10 @@
 import 'package:checks/checks.dart';
 import 'package:zulip/api/model/model.dart';
 
+extension ZulipStreamChecks on Subject<ZulipStream> {
+  Subject<int?> get canRemoveSubscribersGroup => has((e) => e.canRemoveSubscribersGroup, 'canRemoveSubscribersGroup');
+}
+
 extension MessageChecks on Subject<Message> {
   Subject<String> get content => has((e) => e.content, 'content');
   Subject<bool> get isMeMessage => has((e) => e.isMeMessage, 'isMeMessage');

test/api/model/model_checks.dart

@@ -65,6 +65,43 @@ void main() {
     });
   });
 
+  group('ZulipStream.canRemoveSubscribersGroup', () {
+    final Map<String, dynamic> baseJson = Map.unmodifiable({
+      'stream_id': 123,
+      'name': 'A stream',
+      'description': 'A description',
+      'rendered_description': '<p>A description</p>',
+      'date_created': 1686774898,
+      'first_message_id': null,
+      'invite_only': false,
+      'is_web_public': false,
+      'history_public_to_subscribers': true,
+      'message_retention_days': null,
+      'stream_post_policy': StreamPostPolicy.any.apiValue,
+      // 'can_remove_subscribers_group': null,
+      'stream_weekly_traffic': null,
+    });
+
+    test('smoke', () {
+      check(ZulipStream.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,
+        '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,
+      })).canRemoveSubscribersGroup.isNull();
+    });
+  });
+
   group('Message', () {
     test('no crash on unrecognized flag', () {
       final m1 = Message.fromJson(

test/api/model/model_test.dart

@@ -104,7 +104,8 @@ ZulipStream stream({
   bool? historyPublicToSubscribers,
   int? messageRetentionDays,
   StreamPostPolicy? streamPostPolicy,
-  int? canRemoveSubscribersGroupId,
+  int? canRemoveSubscribersGroup,
+  int? streamWeeklyTraffic,
 }) {
   return ZulipStream(
     streamId: streamId ?? 123, // TODO generate example IDs
@@ -118,7 +119,8 @@ ZulipStream stream({
     historyPublicToSubscribers: historyPublicToSubscribers ?? true,
     messageRetentionDays: messageRetentionDays,
     streamPostPolicy: streamPostPolicy ?? StreamPostPolicy.any,
-    canRemoveSubscribersGroupId: canRemoveSubscribersGroupId ?? 123,
+    canRemoveSubscribersGroup: canRemoveSubscribersGroup ?? 123,
+    streamWeeklyTraffic: streamWeeklyTraffic,
   );
 }
 const _stream = stream;