model [nfc]: Move has-passed-waiting-period method to RealmStore

Author: chrisbobbe

lib/model/channel.dart

@@ -213,7 +213,7 @@ mixin ChannelStore on UserStore {
       case ChannelPostPolicy.fullMembers:     {
         if (!role.isAtLeast(UserRole.member)) return false;
         if (role == UserRole.member) {
-          return hasPassedWaitingPeriod(selfUser, byDate: byDate);
+          return selfHasPassedWaitingPeriod(byDate: byDate);
         }
         return true;
       }

lib/model/message.dart

@@ -186,7 +186,7 @@ mixin MessageStore on ChannelStore {
       case RealmDeleteOwnMessagePolicy.fullMembers: {
         if (!role.isAtLeast(UserRole.member)) return false;
         if (role == UserRole.member) {
-          return hasPassedWaitingPeriod(selfUser, byDate: atDate);
+          return selfHasPassedWaitingPeriod(byDate: atDate);
         }
         return true;
       }

lib/model/realm.dart

@@ -128,6 +128,18 @@ mixin RealmStore on PerAccountStoreBase, UserGroupStore {
     return topic;
   }
 
+  /// Whether the self-user has passed the realm's waiting period
+  /// to be a full member.
+  ///
+  /// See:
+  ///   https://zulip.com/api/roles-and-permissions#determining-if-a-user-is-a-full-member
+  ///
+  /// To determine if the self-user is a full member,
+  /// callers must also check that the user's role is at least [UserRole.member].
+  // This used to be a method on [UserStore], but we needed it for permissions
+  // here in [RealmStore].
+  bool selfHasPassedWaitingPeriod({required DateTime byDate});
+
   /// Whether the self-user has the given (group-based) permission.
   bool selfHasPermissionForGroupSetting(GroupSettingValue value,
       GroupSettingType type, String name);
@@ -180,6 +192,9 @@ mixin ProxyRealmStore on RealmStore {
   @override
   List<CustomProfileField> get customProfileFields => realmStore.customProfileFields;
   @override
+  bool selfHasPassedWaitingPeriod({required DateTime byDate}) =>
+    realmStore.selfHasPassedWaitingPeriod(byDate: byDate);
+  @override
   bool selfHasPermissionForGroupSetting(GroupSettingValue value, GroupSettingType type, String name) =>
     realmStore.selfHasPermissionForGroupSetting(value, type, name);
 }
@@ -203,6 +218,7 @@ class RealmStoreImpl extends HasUserGroupStore with RealmStore {
     required User selfUser,
   }) :
     _selfUserRole = selfUser.role,
+    _selfUserDateJoined = selfUser.dateJoined,
     serverPresencePingIntervalSeconds = initialSnapshot.serverPresencePingIntervalSeconds,
     serverPresenceOfflineThresholdSeconds = initialSnapshot.serverPresenceOfflineThresholdSeconds,
     serverTypingStartedExpiryPeriodMilliseconds = initialSnapshot.serverTypingStartedExpiryPeriodMilliseconds,
@@ -224,6 +240,22 @@ class RealmStoreImpl extends HasUserGroupStore with RealmStore {
     realmDefaultExternalAccounts = initialSnapshot.realmDefaultExternalAccounts,
     customProfileFields = _sortCustomProfileFields(initialSnapshot.customProfileFields);
 
+  @override
+  bool selfHasPassedWaitingPeriod({required DateTime byDate}) {
+    // [User.dateJoined] is in UTC. For logged-in users, the format is:
+    // YYYY-MM-DDTHH:mm+00:00, which includes the timezone offset for UTC.
+    // For logged-out spectators, the format is: YYYY-MM-DD, which doesn't
+    // include the timezone offset. In the later case, [DateTime.parse] will
+    // interpret it as the client's local timezone, which could lead to
+    // incorrect results; but that's acceptable for now because the app
+    // doesn't support viewing as a spectator.
+    //
+    // See the related discussion:
+    //   https://chat.zulip.org/#narrow/channel/412-api-documentation/topic/provide.20an.20explicit.20format.20for.20.60realm_user.2Edate_joined.60/near/1980194
+    final dateJoined = DateTime.parse(_selfUserDateJoined);
+    return byDate.difference(dateJoined).inDays >= realmWaitingPeriodThreshold;
+  }
+
   @override
   bool selfHasPermissionForGroupSetting(GroupSettingValue value,
       GroupSettingType type, String name) {
@@ -262,8 +294,20 @@ class RealmStoreImpl extends HasUserGroupStore with RealmStore {
   /// The main home of this information is [UserStore]: `store.selfUser.role`.
   /// We need it here for interpreting some permission settings;
   /// so we denormalize it here to avoid a cycle between substores.
+  ///
+  /// See also [_selfUserDateJoined].
   UserRole _selfUserRole;
 
+  /// The [User.dateJoined] of the self-user.
+  ///
+  /// The main home of this information is [UserStore]:
+  /// `store.selfUser.dateJoined`.
+  /// We need it here for interpreting some permission settings;
+  /// so we denormalize it here to avoid a cycle between substores.
+  ///
+  /// See also [_selfUserRole].
+  final String _selfUserDateJoined;
+
   @override
   final int serverPresencePingIntervalSeconds;
   @override

lib/model/user.dart

@@ -91,28 +91,6 @@ mixin UserStore on PerAccountStoreBase, RealmStore {
     return getUser(senderId)?.fullName ?? message.senderFullName;
   }
 
-  /// Whether [user] has passed the realm's waiting period to be a full member.
-  ///
-  /// See:
-  ///   https://zulip.com/api/roles-and-permissions#determining-if-a-user-is-a-full-member
-  ///
-  /// To determine if a user is a full member, callers must also check that the
-  /// user's role is at least [UserRole.member].
-  bool hasPassedWaitingPeriod(User user, {required DateTime byDate}) {
-    // [User.dateJoined] is in UTC. For logged-in users, the format is:
-    // YYYY-MM-DDTHH:mm+00:00, which includes the timezone offset for UTC.
-    // For logged-out spectators, the format is: YYYY-MM-DD, which doesn't
-    // include the timezone offset. In the later case, [DateTime.parse] will
-    // interpret it as the client's local timezone, which could lead to
-    // incorrect results; but that's acceptable for now because the app
-    // doesn't support viewing as a spectator.
-    //
-    // See the related discussion:
-    //   https://chat.zulip.org/#narrow/channel/412-api-documentation/topic/provide.20an.20explicit.20format.20for.20.60realm_user.2Edate_joined.60/near/1980194
-    final dateJoined = DateTime.parse(user.dateJoined);
-    return byDate.difference(dateJoined).inDays >= realmWaitingPeriodThreshold;
-  }
-
   /// Whether the user with [userId] is muted by the self-user.
   ///
   /// Looks for [userId] in a private [Set],

test/model/realm_test.dart

@@ -35,6 +35,32 @@ void main() {
     doCheck(eg.t('(no topic)'),          eg.t(''),                    370);
   });
 
+  group('selfHasPassedWaitingPeriod', () {
+    final testCases = [
+      ('2024-11-25T10:00+00:00', DateTime.utc(2024, 11, 25 + 0, 10, 00), false),
+      ('2024-11-25T10:00+00:00', DateTime.utc(2024, 11, 25 + 1, 10, 00), false),
+      ('2024-11-25T10:00+00:00', DateTime.utc(2024, 11, 25 + 2, 09, 59), false),
+      ('2024-11-25T10:00+00:00', DateTime.utc(2024, 11, 25 + 2, 10, 00), true),
+      ('2024-11-25T10:00+00:00', DateTime.utc(2024, 11, 25 + 1000, 07, 00), true),
+    ];
+
+    for (final (String dateJoined, DateTime currentDate, bool expected) in testCases) {
+      test('self-user joined at $dateJoined ${expected ? 'has' : "hasn't"} '
+          'passed waiting period by $currentDate', () {
+        final selfUser = eg.user(dateJoined: dateJoined);
+        final store = eg.store(
+          selfUser: selfUser,
+          initialSnapshot: eg.initialSnapshot(
+            realmWaitingPeriodThreshold: 2,
+            realmUsers: [selfUser],
+          ),
+        );
+        check(store.selfHasPassedWaitingPeriod(byDate: currentDate))
+          .equals(expected);
+      });
+    }
+  });
+
   group('selfHasPermissionForGroupSetting', () {
     // Most of the implementation of this is in [UserGroupStore.selfInGroupSetting],
     // and is tested in more detail in user_group_test.dart .

test/model/user_test.dart

@@ -58,28 +58,6 @@ void main() {
     });
   });
 
-  group('hasPassedWaitingPeriod', () {
-    final store = eg.store(initialSnapshot:
-      eg.initialSnapshot(realmWaitingPeriodThreshold: 2));
-
-    final testCases = [
-      ('2024-11-25T10:00+00:00', DateTime.utc(2024, 11, 25 + 0, 10, 00), false),
-      ('2024-11-25T10:00+00:00', DateTime.utc(2024, 11, 25 + 1, 10, 00), false),
-      ('2024-11-25T10:00+00:00', DateTime.utc(2024, 11, 25 + 2, 09, 59), false),
-      ('2024-11-25T10:00+00:00', DateTime.utc(2024, 11, 25 + 2, 10, 00), true),
-      ('2024-11-25T10:00+00:00', DateTime.utc(2024, 11, 25 + 1000, 07, 00), true),
-    ];
-
-    for (final (String dateJoined, DateTime currentDate, bool hasPassedWaitingPeriod) in testCases) {
-      test('user joined at $dateJoined ${hasPassedWaitingPeriod ? 'has' : "hasn't"} '
-          'passed waiting period by $currentDate', () {
-        final user = eg.user(dateJoined: dateJoined);
-        check(store.hasPassedWaitingPeriod(user, byDate: currentDate))
-          .equals(hasPassedWaitingPeriod);
-      });
-    }
-  });
-
   group('RealmUserUpdateEvent', () {
     // TODO write more tests for handling RealmUserUpdateEvent