core: add pagination and update example (#222)

* fix: use data not used on setUser

* feat: add pagination management to core feed bloc

* feat: update and expand core example

* docs: update CHANGELOG

* fix ci

* ui kit: bump depedency

* bump dev dependencies

* github action build workflow: channel stable

* ui kit: fix full screen media test

* ui kit: fix debug fill properties test

* ui kit: fix FlatActivityListPage test

* fix test: !timersPending exception
A Timer is still pending even after the widget tree was disposed.

* fix flat feed core test

* bloc: queryPaginatedReactions wip

* loadMoreReactions wip

* test bloc.queryPaginatedReactions

* Aggregated Feed: Paginated Activities (#219)

* aggregated feed builder wip

* loadMoreGroupedActivities

* fix analyzer

* internal annotation

* update todo

* make NextParams const

* apply reviews

* test queryPaginatedGroupedActivities wip

* clean up a bit + aggregated feed test passing

* format

* onAddActivityGroup + getEnrichedActivityDetail
+onRemoveActivityGroup

* test AggregatedFeedCore

* test getEnrichedActivity

* format

* test onAddActivityGroup

* feat: add refresh to feed bloc and other fixes

* feat: add flags to paginated results

* fix: nested child reactions now reactive

* fix fileExt extension for .mov

* fix linter issues

* time parameter in onAddActivity

* ImagePreview: fix typo in error message

* make GenericFeedBloc immutable

* make GenericFeedBloc immutable

* fix: add missing pubspec file

* test: fix missing flags argument

* chore: fix linter warnings

* chore: avoid print

* test: update

* chore: fix lints

* chore: remove late keyword

* remove activity and lookupAttr

* feat: add core build context extensions

* docs: expand core example

* format

* chore: update example

* format

* fix bloc test

* format

* update llc and faye changelogs

* faye: version bump

* update pubspec and tweak changelog

* llc: tweak changelog + bump pubspec version

* workflow: reduce min_coverage constraint

* tweak changelog

* update version header in llc

* version bump

Co-authored-by: Sacha Arbonel <sacha.arbonel@hotmail.fr>

Author: HayesGordon

.github/workflows/build.yaml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       matrix:
         channel:
-          - dev
+          - stable
 
     steps:
       - uses: actions/checkout@v2
@@ -64,7 +64,7 @@ jobs:
       - uses: VeryGoodOpenSource/very_good_coverage@v1.2.0
         with:
           path: packages/stream_feed/coverage/lcov.info
-          min_coverage: 80 
+          min_coverage: 78
       - uses: VeryGoodOpenSource/very_good_coverage@v1.2.0
         with:
           path: packages/faye_dart/coverage/lcov.info

analysis_options.yaml

@@ -1,4 +1,3 @@
-
 # This is the default analysis_options.yaml for all packages and examples
 # If a package needs specific rules, create the analysis_options.yaml on it
 # include this file, like:
@@ -11,10 +10,13 @@ analyzer:
     - lib/**/*.g.dart
     - lib/**/*.freezed.dart
     - example/main.dart
+  errors:
+    todo: ignore
 
 linter:
   rules:
     - always_use_package_imports
+    - avoid_print
     - avoid_empty_else
     - avoid_relative_lib_imports
     - avoid_slow_async_io
@@ -60,7 +62,7 @@ linter:
     - await_only_futures
     - camel_case_extensions
     - camel_case_types
-    - cascade_invocations
+    # - cascade_invocations
 
     - constant_identifier_names
     - curly_braces_in_flow_control_structures
@@ -74,7 +76,7 @@ linter:
     - leading_newlines_in_multiline_strings
     - library_names
     - library_prefixes
-    - lines_longer_than_80_chars
+    # - lines_longer_than_80_chars
     - missing_whitespace_between_adjacent_strings
     - non_constant_identifier_names
     - null_closures
@@ -151,4 +153,4 @@ linter:
     - cast_nullable_to_non_nullable
     - unnecessary_null_checks
     - tighten_type_of_initializing_formals
-    - null_check_on_nullable_type_parameter
+    - null_check_on_nullable_type_parameter

example/lib/client_provider.dart

@@ -1,3 +1,4 @@
+import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/widgets.dart';
 import 'package:stream_feed/stream_feed.dart';
@@ -9,6 +10,7 @@ class ClientProvider extends InheritedWidget {
     required Widget child,
   }) : super(key: key, child: child);
 
+  /// Access the [StreamFeedClient] from the provider to perform API actions.
   final StreamFeedClient client;
 
   static ClientProvider of(BuildContext context) {
@@ -21,4 +23,10 @@ class ClientProvider extends InheritedWidget {
   bool updateShouldNotify(ClientProvider old) {
     return old.child != child || old.client != client;
   }
+
+  @override
+  void debugFillProperties(DiagnosticPropertiesBuilder properties) {
+    super.debugFillProperties(properties);
+    properties.add(DiagnosticsProperty<StreamFeedClient>('client', client));
+  }
 }

example/lib/timeline_screen.dart

@@ -4,8 +4,6 @@ import 'package:stream_feed/stream_feed.dart';
 import 'package:stream_feed_example/activity_item.dart';
 import 'package:stream_feed_example/extension.dart';
 
-// ignore_for_file: public_member_api_docs
-
 class TimelineScreen extends StatefulWidget {
   const TimelineScreen({
     required this.currentUser,
@@ -34,14 +32,14 @@ class _TimelineScreenState extends State<TimelineScreen> {
   Future<void> _listenToFeed() async {
     _feedSubscription = await _client
         .flatFeed('timeline', widget.currentUser.id)
+        // ignore: avoid_print
         .subscribe(print);
   }
 
   Future<void> _loadActivities({bool pullToRefresh = false}) async {
     if (!pullToRefresh) setState(() => _isLoading = true);
     final userFeed = _client.flatFeed('timeline', widget.currentUser.id);
     final data = await userFeed.getActivities();
-    final data2 = await userFeed.getEnrichedActivities();
     if (!pullToRefresh) _isLoading = false;
     setState(() => activities = data);
   }
@@ -50,7 +48,7 @@ class _TimelineScreenState extends State<TimelineScreen> {
   void didChangeDependencies() {
     super.didChangeDependencies();
     _client = context.client;
-    // _listenToFeed();
+    _listenToFeed();
     _loadActivities();
   }
 

example/pubspec.yaml

@@ -1,23 +1,23 @@
 name: stream_feed_example
 description: A new Flutter application.
 
-publish_to: 'none' # Remove this line if you wish to publish to pub.dev
+publish_to: "none" # Remove this line if you wish to publish to pub.dev
 version: 1.0.0+1
 
 environment:
-  sdk: '>=2.12.0 <3.0.0'
+  sdk: ">=2.12.0 <3.0.0"
 
 dependencies:
   cupertino_icons: ^1.0.2
   flutter:
     sdk: flutter
-  timeago: ^3.0.2
   stream_feed:
     path: ../packages/stream_feed
+  timeago: ^3.0.2
 
 dev_dependencies:
   flutter_test:
     sdk: flutter
 
 flutter:
-  uses-material-design: true
+  uses-material-design: true

packages/faye_dart/CHANGELOG.md

@@ -1,3 +1,6 @@
+## [0.1.1+2] - (27-05-2022)
+- nothing new / lints
+  
 ## [0.1.1+1] - (25-02-2022)
 
 - fix: implement Equatable on `FayeClient`. With this change, if you fetch your client from an `InheritedWidget` for example, `updateShouldNotify` doesn't trigger every time.

packages/faye_dart/lib/src/channel.dart

@@ -4,7 +4,7 @@ import 'package:faye_dart/src/grammar.dart' as grammar;
 import 'package:faye_dart/src/message.dart';
 import 'package:faye_dart/src/subscription.dart';
 
-const event_message = 'message';
+const eventMessage = 'message';
 
 class Channel with EquatableMixin, EventEmitter<Message> {
   Channel(this.name);
@@ -81,14 +81,14 @@ extension ChannelMapX on Map<String, Channel> {
 
   void subscribe(String name, Subscription subscription) {
     final channel = putIfAbsent(name, () => Channel(name));
-    channel.bind(event_message, subscription);
+    channel.bind(eventMessage, subscription);
   }
 
   bool unsubscribe(String name, Subscription subscription) {
     final channel = this[name];
     if (channel == null) return false;
-    channel.unbind(event_message, subscription);
-    if (!channel.hasListeners(event_message)) {
+    channel.unbind(eventMessage, subscription);
+    if (!channel.hasListeners(eventMessage)) {
       remove(name);
       return true;
     }
@@ -99,7 +99,7 @@ extension ChannelMapX on Map<String, Channel> {
     final channels = Channel.expand(message.channel);
     if (channels == null) return;
     for (final channel in channels) {
-      this[channel]?.trigger(event_message, message);
+      this[channel]?.trigger(eventMessage, message);
     }
   }
 }

packages/faye_dart/lib/src/client.dart

@@ -5,15 +5,14 @@ import 'dart:math' as math;
 import 'package:equatable/equatable.dart';
 import 'package:faye_dart/faye_dart.dart';
 import 'package:faye_dart/src/channel.dart';
+import 'package:faye_dart/src/extensible.dart';
 import 'package:faye_dart/src/message.dart';
 import 'package:faye_dart/src/timeout_helper.dart';
 import 'package:logging/logging.dart';
 import 'package:meta/meta.dart';
 import 'package:web_socket_channel/status.dart' as status;
 import 'package:web_socket_channel/web_socket_channel.dart';
 
-import 'package:faye_dart/src/extensible.dart';
-
 /// Connexion status of the client
 enum FayeClientState {
   unconnected,
@@ -67,7 +66,7 @@ class FayeClient with Extensible, TimeoutHelper, EquatableMixin {
   final int retry;
   final _channels = <String, Channel>{};
 
-  var _advice = Advice(
+  var _advice = const Advice(
     reconnect: Advice.retry,
     interval: 1000 * defaultConnectionInterval,
     timeout: 1000 * defaultConnectionTimeout,
@@ -113,7 +112,7 @@ class FayeClient with Extensible, TimeoutHelper, EquatableMixin {
 
   void _initWebSocketChannel() {
     _manuallyClosed = false;
-    _logger.info("Initiating connection with $baseUrl");
+    _logger.info('Initiating connection with $baseUrl');
     if (_webSocketChannel != null) {
       _closeWebSocketChannel();
     }
@@ -129,7 +128,7 @@ class FayeClient with Extensible, TimeoutHelper, EquatableMixin {
     cancelAllTimeout();
 
     if (_webSocketChannel != null) {
-      _logger.info("Closing connection for $baseUrl");
+      _logger.info('Closing connection for $baseUrl');
       _unsubscribeFromWebsocket();
       _webSocketChannel?.sink.close(status.goingAway);
       _webSocketChannel = null;
@@ -150,10 +149,8 @@ class FayeClient with Extensible, TimeoutHelper, EquatableMixin {
 
   void _unsubscribeFromWebsocket() {
     _logger.info('Stopped listening to $baseUrl');
-    if (_websocketSubscription != null) {
-      _websocketSubscription!.cancel();
-      _websocketSubscription = null;
-    }
+    _websocketSubscription?.cancel();
+    _websocketSubscription = null;
   }
 
   void _onDataReceived(dynamic data) {
@@ -194,7 +191,7 @@ class FayeClient with Extensible, TimeoutHelper, EquatableMixin {
 
     _initWebSocketChannel();
 
-    _logger.info("Initiating handshake with $baseUrl");
+    _logger.info('Initiating handshake with $baseUrl');
 
     _sendMessage(
       Message(
@@ -279,7 +276,9 @@ class FayeClient with Extensible, TimeoutHelper, EquatableMixin {
   }
 
   void _subscribeChannels(Iterable<String> channels, {bool force = false}) {
-    for (final channel in channels) subscribe(channel, force: force);
+    for (final channel in channels) {
+      subscribe(channel, force: force);
+    }
   }
 
   Future<Subscription> subscribe(
@@ -390,7 +389,7 @@ class FayeClient with Extensible, TimeoutHelper, EquatableMixin {
     final id = _generateMessageId();
     message.id = id;
     pipeThroughExtensions('outgoing', message, (message) {
-      _logger.info("sending message : $message");
+      _logger.info('sending message : $message');
       if (onResponse != null) _responseCallbacks[id] = onResponse;
       final data = jsonEncode(message);
       _webSocketChannel?.sink.add(data);
@@ -404,7 +403,7 @@ class FayeClient with Extensible, TimeoutHelper, EquatableMixin {
       callback = _responseCallbacks.remove(id);
     }
     pipeThroughExtensions('incoming', message, (message) {
-      _logger.info("received message : $message");
+      _logger.info('received message : $message');
       if (message.advice != null) _handleAdvice(message.advice!);
       _deliverMessage(message);
       callback?.call(message);
@@ -435,7 +434,7 @@ class FayeClient with Extensible, TimeoutHelper, EquatableMixin {
       _connectRequestInProgress = false;
       _logger.info('Closed connection for $_clientId');
     }
-    setTimeout(Duration(milliseconds: _advice.interval), () => connect());
+    setTimeout(Duration(milliseconds: _advice.interval), connect);
   }
 
   @override

packages/faye_dart/lib/src/error.dart

@@ -1,4 +1,4 @@
-import 'grammar.dart' as grammar;
+import 'package:faye_dart/src/grammar.dart' as grammar;
 
 class FayeClientError {
   const FayeClientError({

packages/faye_dart/lib/src/event_emitter.dart

@@ -19,13 +19,15 @@ class EventEmitter<T> {
   /// Mapping of events to a list of event handlers
   late final _events = <String, LinkedList<_ListenerEntry<T>>>{};
 
-  /// A callback for error reporting if one of the listeners added with [bind] throws.
+  /// A callback for error reporting if one of the listeners added with [bind]
+  /// throws.
   ///
   /// This callback should not throw.
   ///
   /// It exists for error reporting, and should not be used otherwise.
   ///
-  /// If no [onError] is specified, fallbacks to [Zone.current.handleUncaughtError].
+  /// If no [onError] is specified, fallbacks to
+  /// [Zone.current.handleUncaughtError].
   ErrorListener? onError;
 
   bool _mounted = true;
@@ -71,7 +73,9 @@ class EventEmitter<T> {
         }
       }
     }
-    for (final entry in removables) listeners.remove(entry);
+    for (final entry in removables) {
+      listeners.remove(entry);
+    }
     if (didThrow) throw Error();
   }
 
@@ -123,7 +127,7 @@ class EventEmitter<T> {
     assert(_debugIsMounted(), '');
     final listeners = _events[event];
     if (listeners == null) {
-      throw "Event not available";
+      throw 'Event not available';
     }
     return listeners.isNotEmpty;
   }

packages/faye_dart/lib/src/extensible.dart

@@ -1,6 +1,6 @@
 import 'dart:collection';
 
-import 'message.dart';
+import 'package:faye_dart/src/message.dart';
 
 typedef MessageHandler = Message Function(Message message);
 
@@ -24,10 +24,10 @@ class Extensible {
     void Function(Message message) callback,
   ) {
     if (_extensions.isEmpty) return callback(message);
-    var extensions = Queue<Map<String, MessageHandler>>.from(_extensions);
+    final extensions = Queue<Map<String, MessageHandler>>.from(_extensions);
     void pipe(Message message) {
       if (extensions.isEmpty) return callback(message);
-      var extension = extensions.removeFirst();
+      final extension = extensions.removeFirst();
       final fn = extension[stage];
       if (fn == null) return pipe(message);
       final modifiedMessage = fn(message);

packages/faye_dart/lib/src/grammar.dart

@@ -1,11 +1,11 @@
 const channelName =
-    r"^\/(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)))+(\/(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)))+)*$";
+    r'^\/(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)))+(\/(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)))+)*$';
 
 const channelPattern =
-    r"^(\/(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)))+)*\/\*{1,2}$";
+    r'^(\/(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)))+)*\/\*{1,2}$';
 
 const error =
-    r"^([0-9][0-9][0-9]:(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)| |\/|\*|\.))*(,(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)| |\/|\*|\.))*)*:(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)| |\/|\*|\.))*|[0-9][0-9][0-9]::(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)| |\/|\*|\.))*)$";
+    r'^([0-9][0-9][0-9]:(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)| |\/|\*|\.))*(,(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)| |\/|\*|\.))*)*:(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)| |\/|\*|\.))*|[0-9][0-9][0-9]::(((([a-z]|[A-Z])|[0-9])|(\-|\_|\!|\~|\(|\)|\$|\@)| |\/|\*|\.))*)$';
 
 const version =
-    r"^([0-9])+(\.(([a-z]|[A-Z])|[0-9])(((([a-z]|[A-Z])|[0-9])|\-|\_))*)*$";
+    r'^([0-9])+(\.(([a-z]|[A-Z])|[0-9])(((([a-z]|[A-Z])|[0-9])|\-|\_))*)*$';