feat(llc): Add caching for own capabilities (#47)

Author: renefloor

packages/stream_feeds/CHANGELOG.md

@@ -1,5 +1,6 @@
 ## Next release
 - Update API client with renaming `addReaction` to `addActivityReaction` and `deleteReaction` to `deleteActivityReaction`.
+- Update `activity.currentFeed` capabilities when adding or updating activity from websocket events.
 
 ## 0.3.0
 - [BREAKING] Renamed `AppLifecycleStateProvider` to `LifecycleStateProvider` and `AppLifecycleState` to `LifecycleState`.

packages/stream_feeds/lib/src/client/feeds_client_impl.dart

@@ -15,6 +15,7 @@ import '../models/push_notifications_config.dart';
 import '../repository/activities_repository.dart';
 import '../repository/app_repository.dart';
 import '../repository/bookmarks_repository.dart';
+import '../repository/capabilities_repository.dart';
 import '../repository/comments_repository.dart';
 import '../repository/devices_repository.dart';
 import '../repository/feeds_repository.dart';
@@ -163,6 +164,7 @@ class StreamFeedsClientImpl implements StreamFeedsClient {
     _feedsRepository = FeedsRepository(feedsApi);
     _moderationRepository = ModerationRepository(feedsApi);
     _pollsRepository = PollsRepository(feedsApi);
+    _capabilitiesRepository = CapabilitiesRepository(feedsApi);
 
     moderation = ModerationClient(_moderationRepository);
 
@@ -193,6 +195,7 @@ class StreamFeedsClientImpl implements StreamFeedsClient {
   late final FeedsRepository _feedsRepository;
   late final ModerationRepository _moderationRepository;
   late final PollsRepository _pollsRepository;
+  late final CapabilitiesRepository _capabilitiesRepository;
 
   // TODO: Fill this with correct values
   late final _systemEnvironmentManager = SystemEnvironmentManager(
@@ -272,6 +275,7 @@ class StreamFeedsClientImpl implements StreamFeedsClient {
       pollsRepository: _pollsRepository,
       eventsEmitter: events,
       onReconnectEmitter: onReconnectEmitter,
+      capabilitiesRepository: _capabilitiesRepository,
     );
   }
 
@@ -306,7 +310,9 @@ class StreamFeedsClientImpl implements StreamFeedsClient {
       activitiesRepository: _activitiesRepository,
       commentsRepository: _commentsRepository,
       pollsRepository: _pollsRepository,
+      capabilitiesRepository: _capabilitiesRepository,
       eventsEmitter: events,
+      initialActivityData: initialData,
     );
   }
 
@@ -316,6 +322,7 @@ class StreamFeedsClientImpl implements StreamFeedsClient {
       query: query,
       currentUserId: user.id,
       activitiesRepository: _activitiesRepository,
+      capabilitiesRepository: _capabilitiesRepository,
       eventsEmitter: events,
     );
   }

packages/stream_feeds/lib/src/generated/api/model/own_capabilities_batch_response.dart

@@ -23,7 +23,7 @@ class OwnCapabilitiesBatchResponse with _$OwnCapabilitiesBatchResponse {
   });
 
   @override
-  final Map<String, List<String>> capabilities;
+  final Map<String, List<FeedOwnCapability>> capabilities;
 
   @override
   final String duration;

packages/stream_feeds/lib/src/generated/api/model/own_capabilities_batch_response.freezed.dart

@@ -201,6 +201,17 @@ class ActivityData with _$ActivityData {
   /// Custom data associated with the activity.
   @override
   final Map<String, Object?>? custom;
+
+  /// Creates a new [ActivityData] instance with the updated ownCapabilities on [currentFeed].
+  ActivityData copyWithCurrentFeedCapabilities({
+    required List<FeedOwnCapability> capabilities,
+  }) {
+    return copyWith(
+      currentFeed: currentFeed?.copyWith(
+        ownCapabilities: capabilities,
+      ),
+    );
+  }
 }
 
 /// Extension type for activity visibility settings.

packages/stream_feeds/lib/src/generated/api/model/own_capabilities_batch_response.g.dart

@@ -0,0 +1,98 @@
+import 'dart:async';
+
+import '../../stream_feeds.dart' as api;
+import '../../stream_feeds.dart';
+import '../utils/batcher.dart';
+
+class CapabilitiesRepository {
+  CapabilitiesRepository(api.DefaultApi api) : _api = api;
+
+  final api.DefaultApi _api;
+  final Map<String, List<FeedOwnCapability>> _capabilities = {};
+
+  late final Batcher<String, Result<Map<String, List<FeedOwnCapability>>>>
+      _fetchBatcher = Batcher(
+    action: (feeds) => _fetchWithRetry(feeds: feeds),
+  );
+
+  Future<Result<Map<String, List<FeedOwnCapability>>>> fetchCapabilities({
+    required List<String> feeds,
+  }) async {
+    final result = await _api.ownCapabilitiesBatch(
+      ownCapabilitiesBatchRequest: api.OwnCapabilitiesBatchRequest(
+        feeds: feeds,
+      ),
+    );
+
+    return result.map((response) {
+      _mergeWithCache(response.capabilities);
+      return response.capabilities;
+    });
+  }
+
+  void cacheCapabilitiesForFeeds(List<FeedData> feeds) {
+    for (final feed in feeds) {
+      cacheCapabilities(feed.id, feed.ownCapabilities);
+    }
+  }
+
+  void cacheCapabilities(String feed, List<FeedOwnCapability> capabilities) {
+    _capabilities[feed] = capabilities;
+  }
+
+  Future<List<FeedOwnCapability>?> getCapabilities(String feed) async {
+    return _capabilities[feed] ??
+        (await _fetchBatchedFeedCapabilities(feed)).getOrNull();
+  }
+
+  void dispose() {
+    _fetchBatcher.dispose();
+  }
+
+  Future<Result<Map<String, List<FeedOwnCapability>>>> _fetchWithRetry({
+    required List<String> feeds,
+    bool isRetry = false,
+  }) async {
+    final result = await fetchCapabilities(feeds: feeds);
+    if (result.shouldRetry() && !isRetry) {
+      await Future<void>.delayed(const Duration(milliseconds: 500));
+      return _fetchWithRetry(feeds: feeds, isRetry: true);
+    }
+    return result;
+  }
+
+  Future<Result<List<FeedOwnCapability>>> _fetchBatchedFeedCapabilities(
+    String feed,
+  ) async {
+    final capabilities = await _fetchBatcher.add(feed);
+    return capabilities.map((capabilities) => capabilities[feed] ?? []);
+  }
+
+  void _mergeWithCache(Map<String, List<FeedOwnCapability>> capabilities) {
+    _capabilities.addAll(capabilities);
+  }
+}
+
+extension on Result<Map<String, List<FeedOwnCapability>>> {
+  bool shouldRetry() {
+    switch (this) {
+      case api.Success():
+        return false;
+
+      case final api.Failure failure:
+        final error = failure.error;
+        if (error is! StreamDioException) {
+          return false;
+        }
+        final exception = error.exception;
+        if (exception is! HttpClientException) {
+          return false;
+        }
+        final statusCode = exception.statusCode;
+        if (statusCode == null) {
+          return false;
+        }
+        return statusCode < 100 || statusCode >= 500;
+    }
+  }
+}

packages/stream_feeds/lib/src/models/activity_data.dart

@@ -16,6 +16,7 @@ import '../models/request/activity_add_comment_request.dart';
 import '../models/request/activity_update_comment_request.dart';
 import '../models/threaded_comment_data.dart';
 import '../repository/activities_repository.dart';
+import '../repository/capabilities_repository.dart';
 import '../repository/comments_repository.dart';
 import '../repository/polls_repository.dart';
 import 'activity_comment_list.dart';
@@ -40,6 +41,7 @@ class Activity with Disposable {
     required this.activitiesRepository,
     required this.commentsRepository,
     required this.pollsRepository,
+    required this.capabilitiesRepository,
     required this.eventsEmitter,
     ActivityData? initialActivityData,
   }) {
@@ -76,6 +78,7 @@ class Activity with Disposable {
   final ActivitiesRepository activitiesRepository;
   final CommentsRepository commentsRepository;
   final PollsRepository pollsRepository;
+  final CapabilitiesRepository capabilitiesRepository;
 
   late final ActivityCommentList _commentsList;
 
@@ -101,7 +104,12 @@ class Activity with Disposable {
   Future<Result<ActivityData>> get() async {
     final result = await activitiesRepository.getActivity(activityId);
 
-    result.onSuccess(_stateNotifier.onActivityUpdated);
+    result.onSuccess((activity) {
+      _stateNotifier.onActivityUpdated(activity);
+      if (activity.currentFeed case final feed?) {
+        capabilitiesRepository.cacheCapabilitiesForFeeds([feed]);
+      }
+    });
 
     // Query the comments as well (state will be updated automatically)
     await queryComments();

packages/stream_feeds/lib/src/repository/capabilities_repository.dart

@@ -7,6 +7,7 @@ import 'package:stream_core/stream_core.dart';
 import '../models/activity_data.dart';
 import '../models/query_configuration.dart';
 import '../repository/activities_repository.dart';
+import '../repository/capabilities_repository.dart';
 import 'activity_list_state.dart';
 import 'event/activity_list_event_handler.dart';
 import 'query/activities_query.dart';
@@ -26,6 +27,7 @@ class ActivityList with Disposable {
     required this.query,
     required this.currentUserId,
     required this.activitiesRepository,
+    required this.capabilitiesRepository,
     required this.eventsEmitter,
   }) {
     _stateNotifier = ActivityListStateNotifier(
@@ -34,13 +36,17 @@ class ActivityList with Disposable {
     );
 
     // Attach event handlers for real-time updates
-    final handler = ActivityListEventHandler(state: _stateNotifier);
+    final handler = ActivityListEventHandler(
+      state: _stateNotifier,
+      capabilitiesRepository: capabilitiesRepository,
+    );
     _eventsSubscription = eventsEmitter.listen(handler.handleEvent);
   }
 
   final ActivitiesQuery query;
   final String currentUserId;
   final ActivitiesRepository activitiesRepository;
+  final CapabilitiesRepository capabilitiesRepository;
 
   late final ActivityListStateNotifier _stateNotifier;
 
@@ -93,10 +99,19 @@ class ActivityList with Disposable {
     final result = await activitiesRepository.queryActivities(query);
 
     result.onSuccess(
-      (activitiesData) => _stateNotifier.onQueryMoreActivities(
-        activitiesData,
-        QueryConfiguration(filter: query.filter, sort: query.sort),
-      ),
+      (activitiesData) {
+        _stateNotifier.onQueryMoreActivities(
+          activitiesData,
+          QueryConfiguration(filter: query.filter, sort: query.sort),
+        );
+
+        capabilitiesRepository.cacheCapabilitiesForFeeds(
+          activitiesData.items
+              .map((activity) => activity.currentFeed)
+              .nonNulls
+              .toList(),
+        );
+      },
     );
 
     return result.map((activitiesData) => activitiesData.items);