Skip to content

Commit 43e819e

Browse files
xsahil03xxsahil03x
committed
feat(llc): implement client-side state for all list types
This commit introduces client-side state management for all list types: - `ActivityList` - `ActivityCommentList` - `ActivityReactionList` - `BookmarkList` - `BookmarkFolderList` - `CommentReplyList` - `CommentReactionList` - `FollowList` - `PollList` - `PollVoteList` It also implements the `Activity` state object. Each list type and the `Activity` object now have: - A dedicated state notifier (e.g., `ActivityListStateNotifier`). - A corresponding state class (e.g., `ActivityListState`) using `freezed`. - Event handlers for real-time updates via WebSockets (e.g., `ActivityListEventHandler`). Key changes: - `FeedsClientImpl`: - Instantiates and returns the new stateful list objects. - Passes necessary repositories and event emitters to these objects. - Adds `pollAnswerCastedFeedEventResolver` and `pollAnswerRemovedFeedEventResolver` to WebSocket event resolvers. - Corrects user image field in `_authenticateUser`. - Handles `ClientException` for anonymous user connection attempts. - State notifiers: - Manage the data (e.g., activities, comments) and pagination state. - Provide methods to update the state based on API responses and WebSocket events. - Utilize `QueryConfiguration` to store and use filter and sort parameters. - State classes: - Define the structure of the observable state (e.g., list of items, pagination data). - Include a `canLoadMore` getter. - Event handlers: - Process specific WebSocket events relevant to their list type. - Call appropriate methods on the state notifier to update the state. - Model updates: - `ThreadedCommentData`: Added mutation methods for reactions and replies, and a `setCommentData` method. - `ActivitiesSortField`: `createdAt` now uses `data.createdAt`, `popularity` uses `data.popularity`. - `ReactionGroupData`: Improved logic in `decrement` and `increment` methods. - `PollData`: Added `ownVotesAndAnswers`, `ownVotes`, `ownAnswers`, and `latestVotes` getters. Added mutation methods for options and answers. - `PollVoteData`: `isAnswer` is now a getter based on `answerText`. - Repository updates: - `CommentsRepository`: `deleteComment` now accepts an optional `hardDelete` parameter. - `PollsRepository`: Removed `userId` parameter from `deletePoll`, `getPoll`, `deletePollOption`, `getPollOption`, and `deletePollVote`. - New event resolvers: - `pollAnswerCastedFeedEventResolver`: Resolves `PollAnswerCastedFeedEvent` from `PollVoteCastedFeedEvent` or `PollVoteChangedFeedEvent`. - `pollAnswerRemovedFeedEventResolver`: Resolves `PollAnswerRemovedFeedEvent` from `PollVoteRemovedFeedEvent`. This provides a reactive way to interact with lists of data from Stream Feeds, automatically handling updates and pagination.
1 parent bc302c5 commit 43e819e

File tree

61 files changed

+4643
-166
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+4643
-166
lines changed

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

Lines changed: 79 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@ import 'dart:async';
22

33
import 'package:stream_core/stream_core.dart';
44

5+
import '../event_resolvers/resolvers.dart' as event_resolvers;
56
import '../feeds_client.dart';
67
import '../generated/api/api.dart' as api;
8+
import '../models/activity_data.dart';
79
import '../models/app_data.dart';
810
import '../models/feed_id.dart';
911
import '../models/feeds_config.dart';
@@ -97,6 +99,10 @@ class StreamFeedsClientImpl implements StreamFeedsClient {
9799
),
98100
messageCodec: const FeedsWsCodec(),
99101
onConnectionEstablished: _authenticateUser,
102+
eventResolvers: [
103+
event_resolvers.pollAnswerCastedFeedEventResolver,
104+
event_resolvers.pollAnswerRemovedFeedEventResolver,
105+
],
100106
);
101107

102108
_connectionRecoveryHandler = ConnectionRecoveryHandler(
@@ -203,7 +209,7 @@ class StreamFeedsClientImpl implements StreamFeedsClient {
203209
userDetails: ConnectUserDetailsRequest(
204210
id: user.id,
205211
name: user.originalName,
206-
image: user.imageUrl,
212+
image: user.image,
207213
custom: user.custom,
208214
),
209215
);
@@ -219,22 +225,21 @@ class StreamFeedsClientImpl implements StreamFeedsClient {
219225

220226
@override
221227
Future<void> connect() async {
222-
if (user.type == UserType.guest) {
223-
throw ArgumentError('Anonymous users cannot connect to the WebSocket.');
228+
if (user.type == UserType.anonymous) {
229+
throw ClientException(message: 'Cannot connect as an anonymous user.');
224230
}
225231

226-
// TODO: Add support for Guest users
227-
228232
// Connect to the WebSocket
229-
unawaited(_ws.connect());
233+
_ws.connect().ignore();
230234

231235
final state = await Future.any([
232236
connectionState.waitFor<Connected>(),
233237
connectionState.waitFor<Disconnected>(),
234238
]);
235239

236240
if (state is Disconnected) {
237-
throw Exception('WebSocket connection failed: $connectionState');
241+
final message = state.source.closeReason;
242+
throw ClientException(message: message);
238243
}
239244
}
240245

@@ -269,38 +274,65 @@ class StreamFeedsClientImpl implements StreamFeedsClient {
269274

270275
@override
271276
FollowList followList(FollowsQuery query) {
272-
// TODO: implement followList
273-
throw UnimplementedError();
277+
return FollowList(
278+
query: query,
279+
feedsRepository: _feedsRepository,
280+
eventsEmitter: events,
281+
);
274282
}
275283

276284
@override
277-
Activity activity(String activityId, FeedId fid) {
278-
// TODO: implement activity
279-
throw UnimplementedError();
285+
Activity activity(
286+
String activityId,
287+
FeedId fid, {
288+
ActivityData? initialData,
289+
}) {
290+
return Activity(
291+
activityId: activityId,
292+
fid: fid,
293+
currentUserId: user.id,
294+
activitiesRepository: _activitiesRepository,
295+
commentsRepository: _commentsRepository,
296+
pollsRepository: _pollsRepository,
297+
eventsEmitter: events,
298+
);
280299
}
281300

282301
@override
283302
ActivityList activityList(ActivitiesQuery query) {
284-
// TODO: implement activityList
285-
throw UnimplementedError();
303+
return ActivityList(
304+
query: query,
305+
currentUserId: user.id,
306+
activitiesRepository: _activitiesRepository,
307+
eventsEmitter: events,
308+
);
286309
}
287310

288311
@override
289312
ActivityReactionList activityReactionList(ActivityReactionsQuery query) {
290-
// TODO: implement activityReactionList
291-
throw UnimplementedError();
313+
return ActivityReactionList(
314+
query: query,
315+
activitiesRepository: _activitiesRepository,
316+
eventsEmitter: events,
317+
);
292318
}
293319

294320
@override
295321
BookmarkList bookmarkList(BookmarksQuery query) {
296-
// TODO: implement bookmarkList
297-
throw UnimplementedError();
322+
return BookmarkList(
323+
query: query,
324+
bookmarksRepository: _bookmarksRepository,
325+
eventsEmitter: events,
326+
);
298327
}
299328

300329
@override
301330
BookmarkFolderList bookmarkFolderList(BookmarkFoldersQuery query) {
302-
// TODO: implement bookmarkFolderList
303-
throw UnimplementedError();
331+
return BookmarkFolderList(
332+
query: query,
333+
bookmarksRepository: _bookmarksRepository,
334+
eventsEmitter: events,
335+
);
304336
}
305337

306338
@override
@@ -314,20 +346,31 @@ class StreamFeedsClientImpl implements StreamFeedsClient {
314346

315347
@override
316348
ActivityCommentList activityCommentList(ActivityCommentsQuery query) {
317-
// TODO: implement activityCommentList
318-
throw UnimplementedError();
349+
return ActivityCommentList(
350+
query: query,
351+
commentsRepository: _commentsRepository,
352+
eventsEmitter: events,
353+
currentUserId: user.id,
354+
);
319355
}
320356

321357
@override
322358
CommentReplyList commentReplyList(CommentRepliesQuery query) {
323-
// TODO: implement commentReplyList
324-
throw UnimplementedError();
359+
return CommentReplyList(
360+
query: query,
361+
currentUserId: user.id,
362+
commentsRepository: _commentsRepository,
363+
eventsEmitter: events,
364+
);
325365
}
326366

327367
@override
328368
CommentReactionList commentReactionList(CommentReactionsQuery query) {
329-
// TODO: implement commentReactionList
330-
throw UnimplementedError();
369+
return CommentReactionList(
370+
query: query,
371+
commentsRepository: _commentsRepository,
372+
eventsEmitter: events,
373+
);
331374
}
332375

333376
@override
@@ -341,14 +384,20 @@ class StreamFeedsClientImpl implements StreamFeedsClient {
341384

342385
@override
343386
PollVoteList pollVoteList(PollVotesQuery query) {
344-
// TODO: implement pollVoteList
345-
throw UnimplementedError();
387+
return PollVoteList(
388+
query: query,
389+
pollsRepository: _pollsRepository,
390+
eventsEmitter: events,
391+
);
346392
}
347393

348394
@override
349395
PollList pollList(PollsQuery query) {
350-
// TODO: implement pollList
351-
throw UnimplementedError();
396+
return PollList(
397+
query: query,
398+
pollsRepository: _pollsRepository,
399+
eventsEmitter: events,
400+
);
352401
}
353402

354403
@override

‎packages/stream_feeds/lib/src/event_resolvers/poll/poll_answer_casted.dart‎

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
import 'package:stream_core/stream_core.dart' as core;
2+
3+
import '../../generated/api/models.dart';
4+
5+
/// Resolves a PollAnswerCastedFeedEvent from a PollVoteCastedFeedEvent or
6+
/// PollVoteChangedFeedEvent if the poll vote indicates an answer was casted.
7+
core.WsEvent? pollAnswerCastedFeedEventResolver(core.WsEvent event) {
8+
if (event is PollVoteCastedFeedEvent) {
9+
final pollVote = event.pollVote;
10+
if (pollVote.isAnswer ?? false) return null;
11+
12+
// If the event is a PollVoteCastedFeedEvent and the pollVote indicates
13+
// an answer was casted, we can resolve it to a PollAnswerCastedFeedEvent.
14+
return PollAnswerCastedFeedEvent(
15+
createdAt: event.createdAt,
16+
custom: event.custom,
17+
feedVisibility: event.feedVisibility,
18+
fid: event.fid,
19+
poll: event.poll,
20+
pollVote: event.pollVote,
21+
receivedAt: event.receivedAt,
22+
);
23+
}
24+
25+
if (event is PollVoteChangedFeedEvent) {
26+
final pollVote = event.pollVote;
27+
if (pollVote.isAnswer ?? false) return null;
28+
29+
// If the event is a PollVoteChangedFeedEvent and the pollVote indicates
30+
// an answer was casted, we can resolve it to a PollAnswerCastedFeedEvent.
31+
return PollAnswerCastedFeedEvent(
32+
createdAt: event.createdAt,
33+
custom: event.custom,
34+
feedVisibility: event.feedVisibility,
35+
fid: event.fid,
36+
poll: event.poll,
37+
pollVote: event.pollVote,
38+
receivedAt: event.receivedAt,
39+
);
40+
}
41+
42+
return null;
43+
}
44+
45+
/// Event indicating that a poll answer has been casted.
46+
///
47+
/// This is a derived event and is not sent by the server directly but can be
48+
/// resolved from PollVoteCastedFeedEvent or PollVoteChangedFeedEvent based on
49+
/// the poll vote details.
50+
class PollAnswerCastedFeedEvent extends core.WsEvent {
51+
const PollAnswerCastedFeedEvent({
52+
required this.createdAt,
53+
required this.custom,
54+
this.feedVisibility,
55+
required this.fid,
56+
required this.poll,
57+
required this.pollVote,
58+
this.receivedAt,
59+
});
60+
61+
final DateTime createdAt;
62+
63+
final Map<String, Object?> custom;
64+
65+
final String? feedVisibility;
66+
67+
final String fid;
68+
69+
final PollResponseData poll;
70+
71+
final PollVoteResponseData pollVote;
72+
73+
final DateTime? receivedAt;
74+
75+
String get type => 'feeds.poll.answer_casted';
76+
}

‎packages/stream_feeds/lib/src/event_resolvers/poll/poll_answer_removed.dart‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
import 'package:stream_core/stream_core.dart' as core;
2+
3+
import '../../generated/api/models.dart';
4+
5+
/// Resolves a PollAnswerRemovedFeedEvent from a PollVoteRemovedFeedEvent if the
6+
/// poll vote indicates an answer was removed.
7+
core.WsEvent? pollAnswerRemovedFeedEventResolver(core.WsEvent event) {
8+
if (event is PollVoteRemovedFeedEvent) {
9+
final pollVote = event.pollVote;
10+
if (pollVote.isAnswer ?? false) return null;
11+
12+
// If the event is a PollVoteRemovedFeedEvent and the poll vote indicates an
13+
// answer was removed, we can resolve it to a PollAnswerRemovedFeedEvent.
14+
return PollAnswerRemovedFeedEvent(
15+
createdAt: event.createdAt,
16+
custom: event.custom,
17+
feedVisibility: event.feedVisibility,
18+
fid: event.fid,
19+
poll: event.poll,
20+
pollVote: event.pollVote,
21+
receivedAt: event.receivedAt,
22+
);
23+
}
24+
25+
return null;
26+
}
27+
28+
/// Event indicating that a poll answer has been removed.
29+
///
30+
/// This is a derived event and is not sent by the server directly but can be
31+
/// resolved from PollVoteRemovedFeedEvent based on the poll vote details.
32+
class PollAnswerRemovedFeedEvent extends core.WsEvent {
33+
const PollAnswerRemovedFeedEvent({
34+
required this.createdAt,
35+
required this.custom,
36+
this.feedVisibility,
37+
required this.fid,
38+
required this.poll,
39+
required this.pollVote,
40+
this.receivedAt,
41+
});
42+
43+
final DateTime createdAt;
44+
45+
final Map<String, Object?> custom;
46+
47+
final String? feedVisibility;
48+
49+
final String fid;
50+
51+
final PollResponseData poll;
52+
53+
final PollVoteResponseData pollVote;
54+
55+
final DateTime? receivedAt;
56+
57+
String get type => 'feeds.poll.answer_removed';
58+
}

‎packages/stream_feeds/lib/src/event_resolvers/resolvers.dart‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
export 'poll/poll_answer_casted.dart';
2+
export 'poll/poll_answer_removed.dart';

0 commit comments

Comments
 (0)