feat(llc, samples): add network and lifecycle state providers (#44)

Author: xsahil03x

melos.yaml

@@ -34,9 +34,10 @@ command:
       firebase_messaging: ^15.0.0
       flex_grid_view: ^0.1.0
       flutter_local_notifications: ^18.0.1
-      injectable: ^2.5.1
       http: ^1.1.0
+      injectable: ^2.5.1
       intl: ">=0.18.1 <=0.21.0"
+      internet_connection_checker_plus: ^2.9.0
       jiffy: ^6.3.2
       photo_view: ^0.15.0
       json_annotation: ^4.9.0
@@ -46,7 +47,7 @@ command:
       shared_preferences: ^2.5.3
       state_notifier: ^1.0.0
       stream_feeds: ^0.2.0
-      stream_core: ^0.1.0
+      stream_core: ^0.2.0
       video_player: ^2.10.0
       uuid: ^4.5.1
 

packages/stream_feeds/CHANGELOG.md

@@ -1,3 +1,6 @@
+## Unreleased
+- [BREAKING] Renamed `AppLifecycleStateProvider` to `LifecycleStateProvider` and `AppLifecycleState` to `LifecycleState`.
+
 ## 0.2.0
 - [BREAKING] Update API client code, specifically the FeedOwnCapability enum.
 - Fix unknown enums for `List<FeedOwnCapability>` in `GetOrCreateFeedResponse` to be `FeedOwnCapability.unknown`.

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

@@ -63,7 +63,7 @@ class StreamFeedsClientImpl implements StreamFeedsClient {
     TokenProvider? tokenProvider,
     RetryStrategy? retryStrategy,
     NetworkStateProvider? networkStateProvider,
-    AppLifecycleStateProvider? appLifecycleStateProvider,
+    LifecycleStateProvider? lifecycleStateProvider,
     List<AutomaticReconnectionPolicy>? reconnectionPolicies,
   }) {
     // TODO: Make this configurable
@@ -111,7 +111,7 @@ class StreamFeedsClientImpl implements StreamFeedsClient {
       client: _ws,
       retryStrategy: retryStrategy,
       networkStateProvider: networkStateProvider,
-      appLifecycleStateProvider: appLifecycleStateProvider,
+      lifecycleStateProvider: lifecycleStateProvider,
       policies: reconnectionPolicies,
     );
 

packages/stream_feeds/lib/src/feeds_client.dart

@@ -158,7 +158,7 @@ abstract interface class StreamFeedsClient {
     TokenProvider? tokenProvider,
     RetryStrategy? retryStrategy,
     NetworkStateProvider? networkStateProvider,
-    AppLifecycleStateProvider? appLifecycleStateProvider,
+    LifecycleStateProvider? lifecycleStateProvider,
     List<AutomaticReconnectionPolicy>? reconnectionPolicies,
   }) = StreamFeedsClientImpl;
 

packages/stream_feeds/pubspec.yaml

@@ -32,7 +32,7 @@ dependencies:
   retrofit: ^4.6.0
   rxdart: ^0.28.0
   state_notifier: ^1.0.0
-  stream_core: ^0.1.0
+  stream_core: ^0.2.0
   uuid: ^4.5.1
 
 dev_dependencies:

sample_app/lib/app/content/auth_controller.dart

@@ -14,11 +14,15 @@ class AuthController extends ValueNotifier<AuthState> {
     this._appPreferences,
     @Named('apn') this._iosPushProvider,
     @Named('firebase') this._androidPushProvider,
+    this._networkStateProvider,
+    this._lifecycleStateProvider,
   ) : super(const Unauthenticated());
 
   final AppPreferences _appPreferences;
   final PushProvider _iosPushProvider;
   final PushProvider _androidPushProvider;
+  final NetworkStateProvider _networkStateProvider;
+  final LifecycleStateProvider _lifecycleStateProvider;
 
   PushTokenManager? _pushTokenManager;
 
@@ -31,6 +35,8 @@ class AuthController extends ValueNotifier<AuthState> {
       user: credentials.user,
       apiKey: DemoAppConfig.current.apiKey,
       tokenProvider: TokenProvider.static(token),
+      networkStateProvider: _networkStateProvider,
+      lifecycleStateProvider: _lifecycleStateProvider,
     );
 
     final result = await runSafely(client.connect);

sample_app/lib/core/di/app_module.dart

@@ -1,6 +1,7 @@
 import 'package:firebase_core/firebase_core.dart';
 import 'package:flutter_local_notifications/flutter_local_notifications.dart';
 import 'package:injectable/injectable.dart';
+import 'package:internet_connection_checker_plus/internet_connection_checker_plus.dart';
 import 'package:shared_preferences/shared_preferences.dart';
 
 import '../../firebase_options.dart';
@@ -30,4 +31,7 @@ abstract class AppModule {
 
   @lazySingleton
   LocalNotification get localNotifications => LocalNotification();
+
+  @lazySingleton
+  InternetConnection get internet => InternetConnection.createInstance();
 }

sample_app/lib/core/di/di_initializer.config.dart

@@ -0,0 +1,45 @@
+import 'dart:async';
+
+import 'package:flutter/cupertino.dart';
+import 'package:injectable/injectable.dart';
+import 'package:stream_feeds/stream_feeds.dart';
+
+@LazySingleton(as: LifecycleStateProvider)
+class AppLifecycleStateProvider
+    with Disposable, WidgetsBindingObserver
+    implements LifecycleStateProvider {
+  AppLifecycleStateProvider() {
+    // Start listening to lifecycle changes.
+    WidgetsBinding.instance.addObserver(this);
+  }
+
+  @override
+  LifecycleStateEmitter get state => _state;
+  late final _state = MutableStateEmitter(LifecycleState.foreground);
+
+  @override
+  void didChangeAppLifecycleState(AppLifecycleState state) {
+    final wasInBackground = _state.value == LifecycleState.background;
+    final isInBackground = !_isAppInForeground(state);
+
+    if (wasInBackground && !isInBackground) {
+      _state.value = LifecycleState.foreground;
+    } else if (!wasInBackground && isInBackground) {
+      _state.value = LifecycleState.background;
+    }
+  }
+
+  bool _isAppInForeground(AppLifecycleState state) {
+    return switch (state) {
+      AppLifecycleState.resumed || AppLifecycleState.inactive => true,
+      _ => false,
+    };
+  }
+
+  @override
+  Future<void> dispose() async {
+    await _state.close();
+    WidgetsBinding.instance.removeObserver(this);
+    return super.dispose();
+  }
+}

sample_app/lib/reconnect_providers/lifecycle_state_provider.dart

@@ -0,0 +1,38 @@
+import 'dart:async';
+
+import 'package:injectable/injectable.dart';
+import 'package:internet_connection_checker_plus/internet_connection_checker_plus.dart';
+import 'package:stream_feeds/stream_feeds.dart';
+
+@LazySingleton(as: NetworkStateProvider)
+final class InternetStateProvider
+    with Disposable
+    implements NetworkStateProvider {
+  InternetStateProvider({
+    required InternetConnection checker,
+  }) : _checker = checker {
+    // Subscribe to the status changes.
+    _connectionSubscription = _checker.onStatusChange.listen(_onStatusChange);
+  }
+
+  final InternetConnection _checker;
+
+  @override
+  NetworkStateEmitter get state => _state;
+  late final _state = MutableStateEmitter(NetworkState.unknown);
+
+  StreamSubscription<InternetStatus>? _connectionSubscription;
+  void _onStatusChange(InternetStatus status) {
+    _state.value = switch (status) {
+      InternetStatus.connected => NetworkState.connected,
+      InternetStatus.disconnected => NetworkState.disconnected,
+    };
+  }
+
+  @override
+  Future<void> dispose() async {
+    await _state.close();
+    await _connectionSubscription?.cancel();
+    return super.dispose();
+  }
+}