refactor(data): remove interest model and related operations

fulleni · fulleni · commit 64d3373ceea3 · 2025-11-11T09:44:11.000+01:00
- Remove interest model from model registry
- Remove interest operations from data operation registry
- Update user preference handling to manage interests within UserContentPreferences
- Simplify interest-related permission checks and validations
diff --git a/lib/src/registry/data_operation_registry.dart b/lib/src/registry/data_operation_registry.dart
@@ -121,8 +121,6 @@ class DataOperationRegistry {
           c.read<DataRepository<RemoteConfig>>().read(id: id, userId: null),
       'dashboard_summary': (c, id) =>
           c.read<DashboardSummaryService>().getSummary(),
-      'interest': (c, id) =>
-          c.read<DataRepository<Interest>>().read(id: id, userId: null),
       'in_app_notification': (c, id) => c
           .read<DataRepository<InAppNotification>>()
           .read(id: id, userId: null),
@@ -170,13 +168,6 @@ class DataOperationRegistry {
           .read<DataRepository<Language>>()
           .readAll(userId: uid, filter: f, sort: s, pagination: p),
       'user': (c, uid, f, s, p) => c.read<DataRepository<User>>().readAll(
-        userId: uid,
-        filter: f,
-        sort: s,
-        pagination: p,
-      ),
-      'interest': (c, uid, f, s, p) =>
-          c.read<DataRepository<Interest>>().readAll(
             userId: uid,
             filter: f,
             sort: s,
@@ -277,30 +268,6 @@ class DataOperationRegistry {
           userId: null,
         );
       },
-      'interest': (context, item, uid) async {
-        _log.info('Executing custom creator for interest.');
-        final authenticatedUser = context.read<User>();
-        final interestToCreate = (item as Interest).copyWith(
-          userId: authenticatedUser.id,
-        );
-
-        // 1. Fetch current user preferences to get existing interests.
-        final preferences = await context
-            .read<DataRepository<UserContentPreferences>>()
-            .read(id: authenticatedUser.id);
-
-        // 2. Check limits before creating.
-        await context.read<UserPreferenceLimitService>().checkInterestLimits(
-          user: authenticatedUser,
-          interest: interestToCreate,
-          existingInterests: preferences.interests,
-        );
-
-        // 3. Proceed with creation.
-        return context.read<DataRepository<Interest>>().create(
-          item: interestToCreate,
-        );
-      },
     });
 
     // --- Register Item Updaters ---
@@ -419,53 +386,111 @@ class DataOperationRegistry {
           'Executing custom updater for user_content_preferences ID: $id.',
         );
         final authenticatedUser = context.read<User>();
-        final preferencesToUpdate = item as UserContentPreferences;
+        final userPreferenceLimitService =
+            context.read<UserPreferenceLimitService>();
+        final userContentPreferencesRepository =
+            context.read<DataRepository<UserContentPreferences>>();
 
-        // 1. Check limits before updating.
-        await context
-            .read<UserPreferenceLimitService>()
-            .checkUserContentPreferencesLimits(
-              user: authenticatedUser,
-              updatedPreferences: preferencesToUpdate,
-            );
+        final preferencesToUpdate = item as UserContentPreferences;
 
-        // 2. Proceed with update.
-        return context.read<DataRepository<UserContentPreferences>>().update(
+        // 1. Fetch the current state of the user's preferences.
+        final currentPreferences = await userContentPreferencesRepository.read(
           id: id,
-          item: preferencesToUpdate,
         );
-      },
-      'remote_config': (c, id, item, uid) => c
-          .read<DataRepository<RemoteConfig>>()
-          .update(id: id, item: item as RemoteConfig, userId: uid),
-      'interest': (context, id, item, uid) async {
-        _log.info('Executing custom updater for interest ID: $id.');
-        final authenticatedUser = context.read<User>();
-        final interestToUpdate = item as Interest;
 
-        // 1. Fetch current user preferences to get existing interests.
-        final preferences = await context
-            .read<DataRepository<UserContentPreferences>>()
-            .read(id: authenticatedUser.id);
+        // 2. Detect changes in the interests list.
+        final currentIds =
+            currentPreferences.interests.map((i) => i.id).toSet();
+        final updatedIds =
+            preferencesToUpdate.interests.map((i) => i.id).toSet();
 
-        // Exclude the interest being updated from the list for limit checking.
-        final otherInterests = preferences.interests
-            .where((i) => i.id != id)
-            .toList();
+        final addedIds = updatedIds.difference(currentIds);
+        final removedIds = currentIds.difference(updatedIds);
 
-        // 2. Check limits before updating.
-        await context.read<UserPreferenceLimitService>().checkInterestLimits(
+        // For simplicity and clear validation, enforce one change at a time.
+        if (addedIds.length + removedIds.length > 1) {
+          throw const BadRequestException(
+            'Only one interest can be added or removed per request.',
+          );
+        }
+
+        // 3. Perform permission and limit checks based on the detected action.
+        if (addedIds.isNotEmpty) {
+          // --- Interest Added ---
+          final addedInterestId = addedIds.first;
+          _log.info(
+            'Detected interest addition for user ${authenticatedUser.id}.',
+          );
+
+          final addedInterest = preferencesToUpdate.interests
+              .firstWhere((i) => i.id == addedInterestId);
+
+          // Check business logic limits.
+          await userPreferenceLimitService.checkInterestLimits(
+            user: authenticatedUser,
+            interest: addedInterest,
+            existingInterests: currentPreferences.interests,
+          );
+        } else if (removedIds.isNotEmpty) {
+          // --- Interest Removed ---
+          _log.info(
+            'Detected interest removal for user ${authenticatedUser.id}.',
+          );
+
+        } else {
+          // --- Interest Potentially Updated ---
+          // Check if any existing interest was modified.
+          Interest? updatedInterest;
+          for (final newInterest in preferencesToUpdate.interests) {
+            // Find the corresponding interest in the old list.
+            final oldInterest = currentPreferences.interests.firstWhere(
+              (i) => i.id == newInterest.id,
+              // This should not be hit if add/remove is handled, but as a
+              // safeguard, we use the newInterest to avoid null issues.
+              orElse: () => newInterest,
+            );
+            if (newInterest != oldInterest) {
+              updatedInterest = newInterest;
+              break; // Found the updated one, no need to continue loop.
+            }
+          }
+
+          if (updatedInterest != null) {
+            _log.info(
+              'Detected interest update for user ${authenticatedUser.id}.',
+            );
+
+            // Check business logic limits.
+            final otherInterests = currentPreferences.interests
+                .where((i) => i.id != updatedInterest!.id)
+                .toList();
+            await userPreferenceLimitService.checkInterestLimits(
+              user: authenticatedUser,
+              interest: updatedInterest,
+              existingInterests: otherInterests,
+            );
+          }
+        }
+
+        // 4. Always validate general preference limits (followed items, etc.).
+        await userPreferenceLimitService.checkUserContentPreferencesLimits(
           user: authenticatedUser,
-          interest: interestToUpdate,
-          existingInterests: otherInterests,
+          updatedPreferences: preferencesToUpdate,
         );
 
-        // 3. Proceed with update.
-        return context.read<DataRepository<Interest>>().update(
+        // 5. If all checks pass, proceed with the update.
+        _log.info(
+          'All preference validations passed for user ${authenticatedUser.id}. '
+          'Proceeding with update.',
+        );
+        return userContentPreferencesRepository.update(
           id: id,
-          item: interestToUpdate,
+          item: preferencesToUpdate,
         );
       },
+      'remote_config': (c, id, item, uid) => c
+          .read<DataRepository<RemoteConfig>>()
+          .update(id: id, item: item as RemoteConfig, userId: uid),
     });
 
     // --- Register Item Deleters ---
@@ -490,8 +515,6 @@ class DataOperationRegistry {
       'push_notification_device': (c, id, uid) => c
           .read<DataRepository<PushNotificationDevice>>()
           .delete(id: id, userId: uid),
-      'interest': (c, id, uid) =>
-          c.read<DataRepository<Interest>>().delete(id: id, userId: uid),
       'in_app_notification': (c, id, uid) => c
           .read<DataRepository<InAppNotification>>()
           .delete(id: id, userId: uid),
diff --git a/lib/src/registry/model_registry.dart b/lib/src/registry/model_registry.dart
@@ -463,40 +463,6 @@ final modelRegistry = <String, ModelConfig<dynamic>>{
       requiresOwnershipCheck: true,
     ),
   ),
-  'interest': ModelConfig<Interest>(
-    fromJson: Interest.fromJson,
-    getId: (i) => i.id,
-    getOwnerId: (dynamic item) => (item as Interest).userId,
-    // Collection GET is admin-only to prevent listing all users' interests.
-    getCollectionPermission: const ModelActionPermission(
-      type: RequiredPermissionType.adminOnly,
-    ),
-    // Item GET is unsupported. Interests are managed as part of the
-    // UserContentPreferences object, not as individual top-level documents.
-    getItemPermission: const ModelActionPermission(
-      type: RequiredPermissionType.unsupported,
-    ),
-    // POST is allowed for any authenticated user to create their own interest.
-    // A custom creator in DataOperationRegistry will enforce role-based limits.
-    postPermission: const ModelActionPermission(
-      type: RequiredPermissionType.specificPermission,
-      permission: Permissions.interestCreateOwned,
-      requiresOwnershipCheck: false,
-    ),
-    // PUT is allowed for any authenticated user to update their own interest.
-    // A custom updater in DataOperationRegistry will enforce role-based limits.
-    putPermission: const ModelActionPermission(
-      type: RequiredPermissionType.specificPermission,
-      permission: Permissions.interestUpdateOwned,
-      requiresOwnershipCheck: true,
-    ),
-    // DELETE is allowed for any authenticated user to delete their own interest.
-    deletePermission: const ModelActionPermission(
-      type: RequiredPermissionType.specificPermission,
-      permission: Permissions.interestDeleteOwned,
-      requiresOwnershipCheck: true,
-    ),
-  ),
   'in_app_notification': ModelConfig<InAppNotification>(
     fromJson: InAppNotification.fromJson,
     getId: (n) => n.id,
