model [nfc]: Add atDate param to selfHasPermissionForGroupSetting

This will support full-member permissions checks in the logic we're
about to add, for defaults when a server doesn't know about a given
permission. There aren't currently any defaults with the
"role:fullmembers" value, so this won't control any behavior now.
But some might be added in the future, and we might as well include
it for completeness.

Author: chrisbobbe

lib/model/channel.dart

@@ -161,26 +161,29 @@ mixin ChannelStore on UserStore {
     }
   }
 
-  bool selfHasContentAccess(ZulipStream channel) {
+  bool selfHasContentAccess(ZulipStream channel, {required DateTime atDate}) {
     // Compare web's stream_data.has_content_access.
     if (channel.isWebPublic) return true;
     if (channel is Subscription) return true;
     // Here web calls has_metadata_access... but that always returns true,
     // as its comment says.
     if (selfUser.role == UserRole.guest) return false;
     if (!channel.inviteOnly) return true;
-    return _selfHasContentAccessViaGroupPermissions(channel);
+    return _selfHasContentAccessViaGroupPermissions(channel, atDate: atDate);
   }
 
-  bool _selfHasContentAccessViaGroupPermissions(ZulipStream channel) {
+  bool _selfHasContentAccessViaGroupPermissions(
+    ZulipStream channel, {
+    required DateTime atDate,
+  }) {
     // Compare web's stream_data.has_content_access_via_group_permissions.
     // TODO(#814) try to clean up this logic; perhaps record more explicitly
     //   what default/fallback value to use for a given group-based permission
     //   on older servers.
 
     if (channel.canAddSubscribersGroup != null
         && selfHasPermissionForGroupSetting(channel.canAddSubscribersGroup!,
-             GroupSettingType.stream, 'can_add_subscribers_group')) {
+             GroupSettingType.stream, 'can_add_subscribers_group', atDate: atDate)) {
       // The behavior before this permission was introduced was equivalent to
       // the "nobody" group.
       // TODO(server-10): simplify
@@ -189,7 +192,7 @@ mixin ChannelStore on UserStore {
 
     if (channel.canSubscribeGroup != null
         && selfHasPermissionForGroupSetting(channel.canSubscribeGroup!,
-             GroupSettingType.stream, 'can_subscribe_group')) {
+             GroupSettingType.stream, 'can_subscribe_group', atDate: atDate)) {
       // The behavior before this permission was introduced was equivalent to
       // the "nobody" group.
       // TODO(server-10): simplify

lib/model/message.dart

@@ -109,7 +109,7 @@ mixin MessageStore on ChannelStore {
 
     if (realmCanDeleteAnyMessageGroup != null) {
       if (selfHasPermissionForGroupSetting(realmCanDeleteAnyMessageGroup!,
-            GroupSettingType.realm, 'can_delete_any_message_group')) {
+            GroupSettingType.realm, 'can_delete_any_message_group', atDate: atDate)) {
         return true;
       }
     } else if (selfUser.role.isAtLeast(UserRole.administrator)) {
@@ -119,7 +119,7 @@ mixin MessageStore on ChannelStore {
     if (channel != null) {
       if (channel.canDeleteAnyMessageGroup != null
           && selfHasPermissionForGroupSetting(channel.canDeleteAnyMessageGroup!,
-               GroupSettingType.stream, 'can_delete_any_message_group')) {
+               GroupSettingType.stream, 'can_delete_any_message_group', atDate: atDate)) {
         return true;
       }
     }
@@ -140,7 +140,7 @@ mixin MessageStore on ChannelStore {
 
     if (realmCanDeleteOwnMessageGroup != null) {
       if (!selfHasPermissionForGroupSetting(realmCanDeleteOwnMessageGroup!,
-            GroupSettingType.realm, 'can_delete_own_message_group')) {
+            GroupSettingType.realm, 'can_delete_own_message_group', atDate: atDate)) {
         if (channel == null) {
           // i.e. this is a DM
           return false;
@@ -149,7 +149,7 @@ mixin MessageStore on ChannelStore {
         if (
           channel.canDeleteOwnMessageGroup == null
           || !selfHasPermissionForGroupSetting(channel.canDeleteOwnMessageGroup!,
-               GroupSettingType.stream, 'can_delete_own_message_group')
+               GroupSettingType.stream, 'can_delete_own_message_group', atDate: atDate)
         ) {
           return false;
         }

lib/model/realm.dart

@@ -143,7 +143,7 @@ mixin RealmStore on PerAccountStoreBase, UserGroupStore {
 
   /// Whether the self-user has the given (group-based) permission.
   bool selfHasPermissionForGroupSetting(GroupSettingValue value,
-      GroupSettingType type, String name);
+      GroupSettingType type, String name, {required DateTime atDate});
 }
 
 enum GroupSettingType { realm, stream, group }
@@ -196,8 +196,8 @@ mixin ProxyRealmStore on RealmStore {
   bool selfHasPassedWaitingPeriod({required DateTime byDate}) =>
     realmStore.selfHasPassedWaitingPeriod(byDate: byDate);
   @override
-  bool selfHasPermissionForGroupSetting(GroupSettingValue value, GroupSettingType type, String name) =>
-    realmStore.selfHasPermissionForGroupSetting(value, type, name);
+  bool selfHasPermissionForGroupSetting(GroupSettingValue value, GroupSettingType type, String name, {required DateTime atDate}) =>
+    realmStore.selfHasPermissionForGroupSetting(value, type, name, atDate: atDate);
 }
 
 /// A base class for [PerAccountStore] substores that need access to [RealmStore]
@@ -259,7 +259,7 @@ class RealmStoreImpl extends HasUserGroupStore with RealmStore {
 
   @override
   bool selfHasPermissionForGroupSetting(GroupSettingValue value,
-      GroupSettingType type, String name) {
+      GroupSettingType type, String name, {required DateTime atDate}) {
     // Compare web's settings_data.user_has_permission_for_group_setting.
     //
     // In the whole web app, there's just one caller for that function with

lib/widgets/action_sheet.dart

@@ -436,6 +436,8 @@ void showChannelActionSheet(BuildContext context, {
   required int channelId,
   bool showTopicListButton = true,
 }) {
+  final now = DateTime.now();
+
   final pageContext = PageRoot.contextOf(context);
   final store = PerAccountStoreWidget.of(pageContext);
   final messageListPageState = MessageListPage.maybeAncestorOf(pageContext);
@@ -449,7 +451,7 @@ void showChannelActionSheet(BuildContext context, {
   final isSubscribed = channel is Subscription;
   final buttonSections = [
     if (!isSubscribed
-        && channel != null && store.selfHasContentAccess(channel))
+        && channel != null && store.selfHasContentAccess(channel, atDate: now))
       [SubscribeButton(pageContext: pageContext, channelId: channelId)],
     [
       if (unreadCount > 0)

lib/widgets/all_channels.dart

@@ -93,7 +93,7 @@ class AllChannelsListEntry extends StatelessWidget {
     final designVariables = DesignVariables.of(context);
     final channel = this.channel;
     final Subscription? subscription = channel is Subscription ? channel : null;
-    final hasContentAccess = store.selfHasContentAccess(channel);
+    final hasContentAccess = store.selfHasContentAccess(channel, atDate: DateTime.now());
 
     return Padding(
       padding: EdgeInsetsDirectional.only(start: 8, end: 4),

test/model/realm_test.dart

@@ -5,8 +5,11 @@ import 'package:zulip/api/model/model.dart';
 import 'package:zulip/model/realm.dart';
 
 import '../example_data.dart' as eg;
+import 'binding.dart';
 
 void main() {
+  TestZulipBinding.ensureInitialized();
+
   test('processTopicLikeServer', () {
     final emptyTopicDisplayName = eg.defaultRealmEmptyTopicDisplayName;
 
@@ -53,8 +56,7 @@ void main() {
           initialSnapshot: eg.initialSnapshot(
             realmWaitingPeriodThreshold: 2,
             realmUsers: [selfUser],
-          ),
-        );
+          ));
         check(store.selfHasPassedWaitingPeriod(byDate: currentDate))
           .equals(expected);
       });
@@ -65,13 +67,15 @@ void main() {
     // Most of the implementation of this is in [UserGroupStore.selfInGroupSetting],
     // and is tested in more detail in user_group_test.dart .
 
+    final now = testBinding.utcNow();
+
     bool hasPermission(User selfUser, UserGroup group, String permissionName) {
       final store = eg.store(selfUser: selfUser,
         initialSnapshot: eg.initialSnapshot(
           realmUsers: [selfUser], realmUserGroups: [group]));
       return store.selfHasPermissionForGroupSetting(
         GroupSettingValueNamed(group.id),
-        GroupSettingType.stream, permissionName);
+        GroupSettingType.stream, permissionName, atDate: now);
     }
 
     test('not in group -> no permission', () {

test/widgets/all_channels_test.dart

@@ -60,7 +60,8 @@ void main() {
       canSubscribeGroup: groupSettingWithSelf,
       canAddSubscribersGroup: groupSettingWithSelf);
     await store.addStream(channel);
-    check(store.selfHasContentAccess(channel)).isTrue();
+    check(store.selfHasContentAccess(channel, atDate: testBinding.utcNow()))
+      .isTrue();
     return channel;
   }
 
@@ -187,7 +188,7 @@ void main() {
 
       final maybeToggle = tester.widgetList<Toggle>(
         findInRow(find.byType(Toggle))).singleOrNull;
-      if (store.selfHasContentAccess(channel)) {
+      if (store.selfHasContentAccess(channel, atDate: testBinding.utcNow())) {
         final isSubscribed = channel is Subscription;
         check(maybeToggle).isNotNull().value.equals(isSubscribed);
       } else {