Merge pull request #199 from GetStream/refactorflat-feed-core-builder

Author: sachaarbonel

.github/workflows/build.yaml

@@ -68,7 +68,7 @@ jobs:
       - uses: VeryGoodOpenSource/[email protected]
         with:
           path: packages/faye_dart/coverage/lcov.info
-          min_coverage: 49
+          min_coverage: 48
       - uses: VeryGoodOpenSource/[email protected]
         with:
           path: packages/stream_feed_flutter_core/coverage/lcov.info

packages/faye_dart/lib/src/client.dart

@@ -2,10 +2,10 @@ import 'dart:async';
 import 'dart:convert';
 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/message.dart';
-import 'package:faye_dart/src/subscription.dart';
 import 'package:faye_dart/src/timeout_helper.dart';
 import 'package:logging/logging.dart';
 import 'package:meta/meta.dart';
@@ -47,7 +47,7 @@ const defaultConnectionTimeout = 60;
 const defaultConnectionInterval = 0;
 const bayeuxVersion = '1.0';
 
-class FayeClient with Extensible, TimeoutHelper {
+class FayeClient with Extensible, TimeoutHelper, EquatableMixin {
   FayeClient(
     this.baseUrl, {
     this.protocols,
@@ -437,4 +437,14 @@ class FayeClient with Extensible, TimeoutHelper {
     }
     setTimeout(Duration(milliseconds: _advice.interval), () => connect());
   }
+
+  @override
+  List<Object?> get props => [
+        _clientId,
+        _advice,
+        _channels,
+        _responseCallbacks,
+        _connectRequestInProgress,
+        _manuallyClosed,
+      ];
 }

packages/faye_dart/lib/src/subscription.dart

@@ -1,3 +1,5 @@
+import 'package:equatable/equatable.dart';
+
 import 'client.dart';
 import 'message.dart';
 
@@ -35,4 +37,7 @@ class Subscription {
     _client.unsubscribe(_channel, this);
     _cancelled = true;
   }
+
+  @override
+  List<Object?> get props => [_client, _channel, _callback, _withChannel];
 }

packages/faye_dart/test/mock.dart

@@ -1,4 +1,6 @@
 import 'package:faye_dart/src/client.dart';
 import 'package:mocktail/mocktail.dart';
 
-class MockClient extends Mock implements FayeClient {}
+class MockClient extends Mock implements FayeClient {
+  bool operator ==(Object? other) => true;
+}

packages/stream_feed/lib/src/client/analytics_client.dart

@@ -1,3 +1,4 @@
+import 'package:equatable/equatable.dart';
 import 'package:stream_feed/src/core/api/analytics_api.dart';
 import 'package:stream_feed/src/core/http/stream_http_client.dart';
 import 'package:stream_feed/src/core/http/token.dart';
@@ -15,7 +16,7 @@ import 'package:stream_feed/src/core/util/token_helper.dart';
 /// - Viewing another user's profile page
 /// - Searching for a certain user/content/topic/etc.
 /// {@endtemplate}
-class StreamAnalytics {
+class StreamAnalytics extends Equatable {
   /// [StreamAnalytics] constructor:
   ///
   /// {@macro analytics}
@@ -121,4 +122,11 @@ class StreamAnalytics {
         userToken ?? TokenHelper.buildAnalytics(secret!, TokenAction.write);
     return _analytics.trackEngagements(token, engagementDataList);
   }
+
+  @override
+  List<Object?> get props => [
+        secret,
+        userToken,
+        userData,
+      ];
 }

packages/stream_feed/lib/src/client/stream_feed_client_impl.dart

@@ -1,3 +1,4 @@
+import 'package:equatable/equatable.dart';
 import 'package:faye_dart/faye_dart.dart';
 import 'package:logging/logging.dart';
 import 'package:stream_feed/src/client/aggregated_feed.dart';
@@ -32,7 +33,7 @@ final _levelEmojiMapper = {
 };
 
 ///{@macro stream_feed_client}
-class StreamFeedClientImpl implements StreamFeedClient {
+class StreamFeedClientImpl with EquatableMixin implements StreamFeedClient {
   /// Builds a [StreamFeedClientImpl].
   ///{@macro stream_feed_client}
   StreamFeedClientImpl(
@@ -348,9 +349,23 @@ class StreamFeedClientImpl implements StreamFeedClient {
         userToken ?? TokenHelper.buildUsersToken(secret!, TokenAction.delete);
     return _api.users.delete(token, id);
   }
+
+  @override
+  List<Object?> get props => [
+        apiKey,
+        appId,
+        secret,
+        userToken,
+        _userConnected,
+        _faye,
+        _subscriptions,
+      ];
+
+  @override
+  bool get stringify => true;
 }
 
-class _FeedSubscription {
+class _FeedSubscription extends Equatable {
   const _FeedSubscription({
     required this.token,
     required this.userId,
@@ -371,4 +386,7 @@ class _FeedSubscription {
   final String token;
   final String userId;
   final Subscription? fayeSubscription;
+
+  @override
+  List<Object?> get props => [token, userId, fayeSubscription];
 }

packages/stream_feed/pubspec.yaml

@@ -11,7 +11,8 @@ dependencies:
   collection: ^1.15.0
   dio: ^4.0.0
   equatable: ^2.0.0
-  faye_dart: ^0.1.0
+  faye_dart:
+    path: ../faye_dart
   http_parser: ^4.0.0
   intl: ^0.17.0
   jose: ^0.3.2

packages/stream_feed_flutter/lib/src/default/default.dart

@@ -0,0 +1,3 @@
+export 'empty_state.dart';
+export 'error_state.dart';
+export 'loading_state.dart';

…d_flutter_core/lib/src/states/empty.dart …flutter/lib/src/default/empty_state.dartpackages/stream_feed_flutter_core/lib/src/states/empty.dart renamed to packages/stream_feed_flutter/lib/src/default/empty_state.dart packages/stream_feed_flutter_core/lib/src/states/empty.dart renamed to packages/stream_feed_flutter/lib/src/default/empty_state.dart

@@ -2,11 +2,11 @@ import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 
 /// {@template onEmptyWidget}
-/// A builder for building a widget when the state is empty.
-/// An Empty State Widget to be used for empty states
+/// A default widget to be displayed for empty state builders.
 /// {@endtemplate}
 class EmptyStateWidget extends StatelessWidget {
   /// Builds an [EmptyStateWidget].
+  ///
   /// {@macro onEmptyWidget}
   const EmptyStateWidget({
     Key? key,

…d_flutter_core/lib/src/states/error.dart …flutter/lib/src/default/error_state.dartpackages/stream_feed_flutter_core/lib/src/states/error.dart renamed to packages/stream_feed_flutter/lib/src/default/error_state.dart packages/stream_feed_flutter_core/lib/src/states/error.dart renamed to packages/stream_feed_flutter/lib/src/default/error_state.dart

@@ -2,13 +2,12 @@ import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
 
 /// {@template onErrorWidget}
-/// A builder for building a widget when an error occurs.
-///
-/// [ErrorStateWidget] is the default widget
+/// A default widget to display for error builders.
 /// {@endtemplate}
 
 class ErrorStateWidget extends StatelessWidget {
   /// Builds an [ErrorStateWidget].
+  ///
   /// {@macro onErrorWidget}
   const ErrorStateWidget({
     Key? key,