Skip to content

Commit 24e36d2

Browse files
sachaarbonelsachaarbonel
authored
Flat Feed: support for activities pagination (#210)
1 parent 62d6acb commit 24e36d2

File tree

14 files changed

+370
-2
lines changed

14 files changed

+370
-2
lines changed

‎.github/workflows/build.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ jobs:
6464
- uses: VeryGoodOpenSource/[email protected]
6565
with:
6666
path: packages/stream_feed/coverage/lcov.info
67-
min_coverage: 81
67+
min_coverage: 80
6868
- uses: VeryGoodOpenSource/[email protected]
6969
with:
7070
path: packages/faye_dart/coverage/lcov.info

‎packages/stream_feed/lib/src/client/flat_feed.dart‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,9 @@ import 'package:stream_feed/src/core/models/feed_id.dart';
99
import 'package:stream_feed/src/core/models/filter.dart';
1010
import 'package:stream_feed/src/core/models/personalized_feed.dart';
1111
import 'package:stream_feed/src/core/util/default.dart';
12+
import 'package:stream_feed/src/core/util/parse_next.dart';
1213
import 'package:stream_feed/src/core/util/token_helper.dart';
14+
import 'package:stream_feed/stream_feed.dart';
1315

1416
/// {@template flatFeed}
1517
/// Flat is the default feed type - and the only feed type that you can follow.
@@ -82,6 +84,7 @@ class FlatFeed extends Feed {
8284
final token = userToken ??
8385
TokenHelper.buildFeedToken(secret!, TokenAction.read, feedId);
8486
final result = await feed.getActivities(token, feedId, options);
87+
print(result);
8588
final data = (result.data!['results'] as List)
8689
.map((e) => Activity.fromJson(e))
8790
.toList(growable: false);
@@ -137,6 +140,34 @@ class FlatFeed extends Feed {
137140
return data;
138141
}
139142

143+
/// ```dart
144+
/// final paginated = await getPaginatedEnrichedActivities();
145+
/// final nextParams = parseNext(paginated.next!);
146+
/// await getPaginatedEnrichedActivities(limit: nextParams.limit,filter: nextParams.idLT);
147+
/// ```
148+
Future<PaginatedActivities<A, Ob, T, Or>>
149+
getPaginatedEnrichedActivities<A, Ob, T, Or>({
150+
int? limit,
151+
int? offset,
152+
String? session,
153+
Filter? filter,
154+
EnrichmentFlags? flags,
155+
String? ranking, //TODO: no way to parameterized marker?
156+
}) {
157+
final options = {
158+
'limit': limit ?? Default.limit,
159+
'offset': offset ?? Default.offset, //TODO:add session everywhere
160+
...filter?.params ?? Default.filter.params,
161+
...Default.marker.params,
162+
if (flags != null) ...flags.params,
163+
if (ranking != null) 'ranking': ranking,
164+
if (session != null) 'session': session,
165+
};
166+
final token = userToken ??
167+
TokenHelper.buildFeedToken(secret!, TokenAction.read, feedId);
168+
return feed.paginatedActivities(token, feedId, options);
169+
}
170+
140171
/// {@template personalizedFeed}
141172
/// Retrieve a personalized feed for the currentUser
142173
/// i.e. a feed of based on user's activities.

‎packages/stream_feed/lib/src/core/api/feed_api.dart‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import 'package:stream_feed/src/core/models/activity_update.dart';
66
import 'package:stream_feed/src/core/models/feed_id.dart';
77
import 'package:stream_feed/src/core/models/follow.dart';
88
import 'package:stream_feed/src/core/models/follow_stats.dart';
9+
import 'package:stream_feed/src/core/models/paginated_activities.dart';
910
import 'package:stream_feed/src/core/models/personalized_feed.dart';
1011
import 'package:stream_feed/src/core/util/default.dart';
1112
import 'package:stream_feed/src/core/util/extension.dart';
@@ -89,6 +90,21 @@ class FeedAPI {
8990
queryParameters: options,
9091
);
9192

93+
/// Retrieve paginated activities
94+
Future<PaginatedActivities<A, Ob, T, Or>> paginatedActivities<A, Ob, T, Or>(
95+
Token token,
96+
FeedId feed,
97+
Map<String, Object?> options,
98+
) async {
99+
final response = await _client.get<Map>(
100+
Routes.buildEnrichedFeedUrl(feed),
101+
headers: {'Authorization': '$token'},
102+
queryParameters: options,
103+
);
104+
return PaginatedActivities<A, Ob, T, Or>.fromJson(
105+
response.data as Map<String, dynamic>);
106+
}
107+
92108
/// Retrieve the number of followers and following feed stats of the current
93109
/// feed.
94110
///

‎packages/stream_feed/lib/src/core/models/filter.dart‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import 'package:equatable/equatable.dart';
2+
13
enum _Filter {
24
idGreaterThanOrEqual,
35

@@ -26,7 +28,7 @@ extension _FilterX on _Filter {
2628
/// Note: when using id_gt[e] the reactions are ordered by the created_at field,
2729
/// in ascending order.
2830
/// {@endtemplate}
29-
class Filter {
31+
class Filter extends Equatable {
3032
final Map<_Filter, String> _filters = {};
3133

3234
/// Serialize [Filter] parameters
@@ -61,4 +63,7 @@ class Filter {
6163

6264
@override
6365
String toString() => _filters.toString();
66+
67+
@override
68+
List<Object?> get props => [_filters];
6469
}

‎packages/stream_feed/lib/src/core/models/index.dart‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@ export 'following.dart';
1616
export 'foreign_id_time_pair.dart';
1717
export 'group.dart';
1818
export 'lookup_attribute.dart';
19+
export 'next_params.dart';
1920
export 'notification_feed_meta.dart';
2021
export 'open_graph_data.dart';
22+
export 'paginated_activities.dart';
2123
export 'reaction.dart';
2224
export 'realtime_message.dart';
2325
export 'resize.dart';

‎packages/stream_feed/lib/src/core/models/next_params.dart‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
import 'package:equatable/equatable.dart';
2+
import 'package:stream_feed/src/core/models/filter.dart';
3+
4+
class NextParams extends Equatable {
5+
final int limit;
6+
final Filter idLT;
7+
final int? offset;
8+
final String? ranking;
9+
final bool? withOwnReactions;
10+
final bool? withRecentReactions;
11+
final bool? withReactionCounts;
12+
final bool? withOwnChildren;
13+
final int? recentReactionsLimit;
14+
final String? reactionKindsFilter;
15+
16+
NextParams(
17+
{required this.limit,
18+
required this.idLT,
19+
this.ranking,
20+
this.withOwnReactions,
21+
this.withRecentReactions,
22+
this.withReactionCounts,
23+
this.withOwnChildren,
24+
this.recentReactionsLimit,
25+
this.reactionKindsFilter,
26+
this.offset});
27+
28+
@override
29+
List<Object?> get props => [limit, idLT];
30+
}

‎packages/stream_feed/lib/src/core/models/paginated_activities.dart‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
import 'package:json_annotation/json_annotation.dart';
2+
import 'package:stream_feed/src/core/models/activity.dart';
3+
import 'package:stream_feed/src/core/models/collection_entry.dart';
4+
import 'package:stream_feed/src/core/models/enriched_activity.dart';
5+
import 'package:stream_feed/src/core/models/paginated.dart';
6+
import 'package:stream_feed/src/core/models/reaction.dart';
7+
import 'package:stream_feed/src/core/models/user.dart';
8+
9+
part 'paginated_activities.g.dart';
10+
11+
/// Paginated activities feed
12+
@JsonSerializable(createToJson: true, genericArgumentFactories: true)
13+
class PaginatedActivities<A, Ob, T, Or>
14+
extends Paginated<GenericEnrichedActivity<A, Ob, T, Or>> {
15+
/// Builds a [PaginatedActivities].
16+
const PaginatedActivities({
17+
String? next,
18+
List<GenericEnrichedActivity<A, Ob, T, Or>>? results,
19+
String? duration,
20+
}) : super(next, results, duration);
21+
22+
/// Deserialize json to [PaginatedReactions]
23+
factory PaginatedActivities.fromJson(
24+
Map<String, dynamic> json, [
25+
A Function(Object? json)? fromJsonA,
26+
Ob Function(Object? json)? fromJsonOb,
27+
T Function(Object? json)? fromJsonT,
28+
Or Function(Object? json)? fromJsonOr,
29+
]) =>
30+
_$PaginatedActivitiesFromJson<A, Ob, T, Or>(
31+
json,
32+
fromJsonA ??
33+
(jsonA) => (A == User)
34+
? User.fromJson(jsonA! as Map<String, dynamic>) as A
35+
: jsonA as A,
36+
fromJsonOb ??
37+
(jsonOb) => (Ob == CollectionEntry)
38+
? CollectionEntry.fromJson(jsonOb! as Map<String, dynamic>)
39+
as Ob
40+
: jsonOb as Ob,
41+
fromJsonT ??
42+
(jsonT) => (T == Activity)
43+
? Activity.fromJson(jsonT! as Map<String, dynamic>) as T
44+
: jsonT as T,
45+
fromJsonOr ??
46+
(jsonOr) {
47+
if (Or == User) {
48+
return User.fromJson(jsonOr! as Map<String, dynamic>) as Or;
49+
} else if (Or == Reaction) {
50+
return Reaction.fromJson(jsonOr! as Map<String, dynamic>) as Or;
51+
} else {
52+
return jsonOr as Or;
53+
}
54+
},
55+
);
56+
57+
@override
58+
List<Object?> get props => [...super.props];
59+
60+
/// Serialize to json
61+
Map<String, dynamic> toJson(
62+
Object? Function(A value) toJsonA,
63+
Object? Function(Ob value) toJsonOb,
64+
Object? Function(T value) toJsonT,
65+
Object? Function(Or value) toJsonOr,
66+
) =>
67+
_$PaginatedActivitiesToJson(this, toJsonA, toJsonOb, toJsonT, toJsonOr);
68+
}

‎packages/stream_feed/lib/src/core/models/paginated_activities.g.dart‎

Lines changed: 50 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎packages/stream_feed/lib/src/core/util/index.dart‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
export 'enrichment.dart';
22
export 'extension.dart';
3+
export 'parse_next.dart';
34
export 'typedefs.dart';

‎packages/stream_feed/lib/src/core/util/parse_next.dart‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
import 'package:stream_feed/src/core/models/filter.dart';
2+
import 'package:stream_feed/src/core/models/next_params.dart';
3+
4+
NextParams parseNext(String next) {
5+
final uri = Uri.parse(next);
6+
final queryParameters = uri.queryParameters;
7+
final nextParams = NextParams(
8+
idLT: Filter().idLessThan(queryParameters['id_lt']!),
9+
limit: int.parse(queryParameters['limit']!),
10+
ranking: queryParameters['ranking'],
11+
withOwnReactions: queryParameters['withOwnReactions'] as bool?,
12+
withRecentReactions: queryParameters['withRecentReactions'] as bool?,
13+
withReactionCounts: queryParameters['withReactionCounts'] as bool?,
14+
withOwnChildren: queryParameters['withOwnChildren'] as bool?,
15+
recentReactionsLimit: queryParameters['recentReactionsLimit'] != null
16+
? int.tryParse(queryParameters['recentReactionsLimit']!)
17+
: null,
18+
reactionKindsFilter: queryParameters['reactionKindsFilter'],
19+
offset: queryParameters['offset'] != null
20+
? int.tryParse(queryParameters['offset']!)
21+
: null);
22+
return nextParams;
23+
}

0 commit comments

Comments
 (0)