From 47945dbec7d41be3a0a76b3d1ba69f0f5b2f659b Mon Sep 17 00:00:00 2001 From: Mehul Ahal <112100480+MehulAhal@users.noreply.github.com> Date: Thu, 22 Dec 2022 22:29:37 +0100 Subject: [PATCH] fixed connection problem --- .../core/services/connection_service.dart | 142 ------------------ .../core/services/connections_service.dart | 95 ++++++++++++ .../core/services/logging_service.dart | 9 +- .../core/services/overlay_service.dart | 26 +++- lib/features/core/widgets/mcg_scaffold.dart | 82 ++++++---- .../views/gallery/gallery_view_model.dart | 2 +- .../image_carousel/image_carousel_view.dart | 1 + lib/l10n/generated/intl/messages_en.dart | 2 + lib/l10n/generated/l10n.dart | 10 ++ lib/l10n/intl_en.arb | 4 +- lib/locator.dart | 41 +++-- 11 files changed, 218 insertions(+), 196 deletions(-) delete mode 100644 lib/features/core/services/connection_service.dart create mode 100644 lib/features/core/services/connections_service.dart diff --git a/lib/features/core/services/connection_service.dart b/lib/features/core/services/connection_service.dart deleted file mode 100644 index 20216d4..0000000 --- a/lib/features/core/services/connection_service.dart +++ /dev/null @@ -1,142 +0,0 @@ -import 'dart:async'; -import 'dart:io'; - -import 'package:connectivity_plus/connectivity_plus.dart'; -import 'package:flutter/foundation.dart'; -import 'package:internet_connection_checker/internet_connection_checker.dart'; -import 'package:mc_gallery/features/core/services/logging_service.dart'; - -import '/locator.dart'; - -/// Used to observe the current connection type. -class ConnectionService with LoggingService { - ConnectionService({ - required Connectivity connectivity, - required InternetConnectionChecker internetConnectionChecker, - bool shouldInitialize = true, - }) : _connectivity = connectivity, - _internetConnectionChecker = internetConnectionChecker { - if (shouldInitialize) initialize(); - } - - ConnectivityResult? _connectivityResult; - ConnectivityResult? get connectivityResult => _connectivityResult; - - final Connectivity _connectivity; - final Map _connectivitySubscriptions = {}; - - final InternetConnectionChecker _internetConnectionChecker; - - final Completer _isInitialized = Completer(); - - Completer? _hasInternetConnection; - - final ValueNotifier _hasInternetConnectionListenable = ValueNotifier(false); - ValueListenable get hasInternetConnectionListenable => _hasInternetConnectionListenable; - - Future get hasInternetConnection async { - try { - if (_hasInternetConnection == null) { - _hasInternetConnection = Completer(); - try { - final hasInternetConnection = await _internetConnectionChecker.hasConnection; - _hasInternetConnection!.complete(hasInternetConnection); - return hasInternetConnection; - } catch (error) { - _hasInternetConnection!.complete(false); - return false; - } finally { - _hasInternetConnection = null; - } - } else { - final awaitedHasInternet = await _hasInternetConnection!.future; - - return awaitedHasInternet; - } - } on SocketException catch (_, __) { - return false; - } - } - - Future initialize() async { - try { - final tag = runtimeType.toString(); - if (_connectivitySubscriptions[tag] != null) { - await dispose(); - } - _connectivitySubscriptions[tag] = _connectivity.onConnectivityChanged.listen( - _onConnectivityChanged, - cancelOnError: false, - onError: (error, stack) {}, - ); - await _onConnectivityChanged(await _connectivity.checkConnectivity()); - _internetConnectionChecker.onStatusChange.listen((final event) { - switch (event) { - case InternetConnectionStatus.connected: - _hasInternetConnectionListenable.value = true; - break; - case InternetConnectionStatus.disconnected: - _hasInternetConnectionListenable.value = false; - break; - } - }); - _isInitialized.complete(); - } catch (error, stackTrace) { - handle(error, stackTrace); - } - } - - Future dispose() async { - for (final subscription in _connectivitySubscriptions.values) { - await subscription.cancel(); - } - _connectivitySubscriptions.clear(); - _connectivityResult = null; - } - - Future addListener({ - required String tag, - required Future Function({ - required ConnectivityResult connectivityResult, - required bool hasInternet, - }) - listener, - bool tryCallListenerOnAdd = true, - }) async { - try { - if (_connectivityResult != null && tryCallListenerOnAdd) - await listener( - connectivityResult: _connectivityResult!, hasInternet: await hasInternetConnection); - _connectivitySubscriptions[tag] = - _connectivity.onConnectivityChanged.listen((connectivityResult) async { - await listener( - connectivityResult: connectivityResult, hasInternet: await hasInternetConnection); - }); - } catch (error, stackTrace) { - handle(error, stackTrace); - } - } - - Future removeListener({required String tag}) async { - try { - final subscription = _connectivitySubscriptions[tag]; - if (subscription != null) { - await subscription.cancel(); - } else {} - } catch (error, stackTrace) { - handle(error, stackTrace); - } - } - - Future _onConnectivityChanged(ConnectivityResult connectivityResult) async { - try { - _connectivityResult = connectivityResult; - } catch (error, stackTrace) { - handle(error, stackTrace); - } - } - - static ConnectionService get locate => Locator.locate(); -} - -class NoInternetException implements Exception {} diff --git a/lib/features/core/services/connections_service.dart b/lib/features/core/services/connections_service.dart new file mode 100644 index 0000000..c975563 --- /dev/null +++ b/lib/features/core/services/connections_service.dart @@ -0,0 +1,95 @@ +import 'dart:async'; + +import 'package:connectivity_plus/connectivity_plus.dart'; +import 'package:flutter/foundation.dart'; +import 'package:internet_connection_checker/internet_connection_checker.dart'; + +import '/features/core/services/logging_service.dart'; +import '/locator.dart'; + +/// Used to observe the current connection type. +class ConnectionsService { + ConnectionsService({ + required Connectivity connectivity, + required InternetConnectionChecker internetConnectionChecker, + required LoggingService loggingService, + }) : _internetConnectionChecker = internetConnectionChecker, + _connectivity = connectivity, + _loggingService = loggingService { + _init(); + } + + final InternetConnectionChecker _internetConnectionChecker; + final Connectivity _connectivity; + final LoggingService _loggingService; + + late final ValueNotifier _internetConnectionStatusNotifier; + ValueListenable get internetConnectionStatusListenable => + _internetConnectionStatusNotifier; + late final ValueNotifier _connectivityResultNotifier; + ValueListenable get connectivityResultListenable => + _connectivityResultNotifier; + + Future _init() async { + // Initialize notifiers + _internetConnectionStatusNotifier = + ValueNotifier(await _internetConnectionChecker.connectionStatus); + _connectivityResultNotifier = ValueNotifier(await _connectivity.checkConnectivity()); + _loggingService + .info('Initial internet status: ${internetConnectionStatusListenable.value.nameWithIcon}'); + _loggingService + .info('Initial connectivity result: ${connectivityResultListenable.value.nameWithIcon}'); + + // Attach converters by listening to stream + _internetConnectionChecker.onStatusChange + .listen((final InternetConnectionStatus internetConnectionStatus) { + _loggingService.info( + 'Internet status changed to: ${internetConnectionStatus.nameWithIcon}. Notifying...'); + _internetConnectionStatusNotifier.value = internetConnectionStatus; + }); + _connectivity.onConnectivityChanged.listen((final connectivityResult) { + _loggingService + .info('Connectivity result changed to: ${connectivityResult.nameWithIcon}. Notifying...'); + _connectivityResultNotifier.value = connectivityResult; + }); + + Locator.instance().signalReady(this); + } + + Future dispose() async { + _internetConnectionStatusNotifier.dispose(); + _connectivityResultNotifier.dispose(); + } + + static ConnectionsService get locate => Locator.locate(); +} + +extension _connectionStatusEmojiExtension on InternetConnectionStatus { + String get nameWithIcon { + switch (this) { + case InternetConnectionStatus.connected: + return '$name (🌐✅)'; + case InternetConnectionStatus.disconnected: + return '$name (🔌)'; + } + } +} + +extension _connectivityEmojiExtension on ConnectivityResult { + String get nameWithIcon { + switch (this) { + case ConnectivityResult.bluetooth: + return '$name (ᛒ🟦)'; + case ConnectivityResult.wifi: + return '$name (◲)'; + case ConnectivityResult.ethernet: + return '$name (🌐)'; + case ConnectivityResult.mobile: + return '$name (📶)'; + case ConnectivityResult.none: + return '$name (🔌)'; + case ConnectivityResult.vpn: + return '$name (🔒)'; + } + } +} diff --git a/lib/features/core/services/logging_service.dart b/lib/features/core/services/logging_service.dart index 18b26bb..6144583 100644 --- a/lib/features/core/services/logging_service.dart +++ b/lib/features/core/services/logging_service.dart @@ -13,7 +13,9 @@ class LoggingService { settings: TalkerSettings( useHistory: false, ), - logger: TalkerLogger(formater: const ColoredLoggerFormatter()), + logger: TalkerLogger( + formater: + !Platform.isIOS ? const ColoredLoggerFormatter() : const ExtendedLoggerFormatter()), loggerSettings: TalkerLoggerSettings( enableColors: !Platform.isIOS, ), @@ -44,7 +46,10 @@ class LoggingService { dio.interceptors.add( TalkerDioLogger( talker: Talker( - logger: TalkerLogger(formater: const ColoredLoggerFormatter()), + logger: TalkerLogger( + formater: !Platform.isIOS + ? const ColoredLoggerFormatter() + : const ExtendedLoggerFormatter()), settings: TalkerSettings( useConsoleLogs: true, useHistory: false, diff --git a/lib/features/core/services/overlay_service.dart b/lib/features/core/services/overlay_service.dart index ab49ab7..aba06c9 100644 --- a/lib/features/core/services/overlay_service.dart +++ b/lib/features/core/services/overlay_service.dart @@ -16,18 +16,30 @@ class OverlayService { required String tag, required OverlayEntry overlayEntry, }) { - _overlayEntryMap.addEntries([MapEntry(tag.hashCode, overlayEntry)]); - - Overlay.of(context, rootOverlay: true)?.insert(overlayEntry); - _loggingService.info('Overlay inserted with tag: $tag'); + if (!_overlayEntryMap.containsKey(tag.hashCode) && !overlayEntry.mounted) { + _overlayEntryMap.addEntries([MapEntry(tag.hashCode, overlayEntry)]); + try { + Overlay.of(context, rootOverlay: true)?.insert(overlayEntry); + //todo(mehul): Fix and not ignore Overlay building while Widget building error. + } on FlutterError catch (_) {} + _loggingService.info('Overlay inserted with tag: $tag'); + } else + _loggingService.info('Overlay with tag: $tag, NOT inserted'); } void removeOverlayEntry({ required String tag, }) { - _overlayEntryMap[tag.hashCode]?.remove(); - _overlayEntryMap.remove(tag.hashCode); - _loggingService.info('Overlay removed with tag: $tag'); + if (_overlayEntryMap.containsKey(tag.hashCode)) { + final _overlayEntry = _overlayEntryMap[tag.hashCode]; + if (_overlayEntry?.mounted ?? false) { + _overlayEntryMap[tag.hashCode]?.remove(); + _overlayEntryMap.remove(tag.hashCode); + _loggingService.info('Overlay removed with tag: $tag'); + } else + _loggingService.info('Overlay with tag: $tag already mounted OR not found. Skipped'); + } else + _loggingService.info('Overlay with tag: $tag already exists. Skipped'); } void dispose() { diff --git a/lib/features/core/widgets/mcg_scaffold.dart b/lib/features/core/widgets/mcg_scaffold.dart index 2b15aa3..2487280 100644 --- a/lib/features/core/widgets/mcg_scaffold.dart +++ b/lib/features/core/widgets/mcg_scaffold.dart @@ -1,12 +1,15 @@ import 'package:flutter/foundation.dart'; import 'package:flutter/material.dart'; -import 'package:flutter/widgets.dart'; +import 'package:internet_connection_checker/internet_connection_checker.dart'; +import 'package:mc_gallery/features/core/data/constants/const_colors.dart'; +import 'package:mc_gallery/features/core/services/logging_service.dart'; +import 'package:mc_gallery/l10n/generated/l10n.dart'; -import '../data/constants/const_durations.dart'; -import '../services/connection_service.dart'; +import '/features/core/services/connections_service.dart'; +import '/features/core/services/overlay_service.dart'; -class McgScaffold extends StatelessWidget { - const McgScaffold({ +class McgScaffold extends StatelessWidget with LoggingService { + McgScaffold({ this.appBar, this.bodyBuilderWaiter, this.body, @@ -28,36 +31,59 @@ class McgScaffold extends StatelessWidget { /// Enabling listing to [ConnectionState], showing a small text at the top, when connectivity is lost. final bool forceInternetCheck; + final ConnectionsService _connectionsService = ConnectionsService.locate; + final OverlayService _overlayService = OverlayService.locate; @override Widget build(BuildContext context) { - final Widget loginOptionsBody = bodyBuilderWaiter != null - ? ValueListenableBuilder( - valueListenable: bodyBuilderWaiter!, - builder: (context, final isReady, child) => !isReady - ? Center(child: waitingWidget ?? const CircularProgressIndicator()) - : body ?? const SizedBox.shrink(), - ) - : body ?? const SizedBox.shrink(); + if (forceInternetCheck) { + _connectionsService.internetConnectionStatusListenable.addListener( + () => _handleOverlayDisplay(context: context), + ); + if (_connectionsService.internetConnectionStatusListenable.value == + InternetConnectionStatus.disconnected) _handleOverlayDisplay(context: context); + } return Scaffold( appBar: appBar, - body: forceInternetCheck - ? SingleChildScrollView( - child: ValueListenableBuilder( - valueListenable: ConnectionService.locate.hasInternetConnectionListenable, - builder: (context, hasInternetConnection, _) => Column( - children: [ - AnimatedSwitcher( - duration: ConstDurations.defaultAnimationDuration, - child: !hasInternetConnection ? Text('No internet') : const SizedBox.shrink(), - ), - loginOptionsBody, - ], - ), - ), + body: bodyBuilderWaiter != null + ? ValueListenableBuilder( + valueListenable: bodyBuilderWaiter!, + builder: (context, final isReady, child) => !isReady + ? Center(child: waitingWidget ?? const CircularProgressIndicator()) + : body ?? const SizedBox.shrink(), ) - : loginOptionsBody, + : body ?? const SizedBox.shrink(), ); } + + void _handleOverlayDisplay({required BuildContext context}) { + switch (_connectionsService.internetConnectionStatusListenable.value) { + case InternetConnectionStatus.disconnected: + _overlayService.insertOverlayEntry( + context, + tag: runtimeType.toString(), + overlayEntry: OverlayEntry( + opaque: false, + builder: (_) => Align( + alignment: Alignment.topCenter, + child: Card( + elevation: 16, + surfaceTintColor: ConstColours.transparent, + color: ConstColours.transparent, + child: Padding( + padding: const EdgeInsets.all(16), + child: Text( + Strings.current.noInternetMessage, + ), + ), + ), + ), + ), + ); + break; + case InternetConnectionStatus.connected: + _overlayService.removeOverlayEntry(tag: runtimeType.toString()); + } + } } diff --git a/lib/features/home/views/gallery/gallery_view_model.dart b/lib/features/home/views/gallery/gallery_view_model.dart index 5128a2f..4e213d8 100644 --- a/lib/features/home/views/gallery/gallery_view_model.dart +++ b/lib/features/home/views/gallery/gallery_view_model.dart @@ -1,5 +1,5 @@ -import 'package:flutter/cupertino.dart'; import 'package:flutter/foundation.dart'; +import 'package:flutter/widgets.dart'; import 'package:flutter_cache_manager/flutter_cache_manager.dart'; import '/features/core/abstracts/base_view_model.dart'; diff --git a/lib/features/home/views/image_carousel/image_carousel_view.dart b/lib/features/home/views/image_carousel/image_carousel_view.dart index e87a700..af30987 100644 --- a/lib/features/home/views/image_carousel/image_carousel_view.dart +++ b/lib/features/home/views/image_carousel/image_carousel_view.dart @@ -32,6 +32,7 @@ class ImageCarouselView extends StatelessWidget { argumentBuilder: () => imageCarouselViewArguments, builder: (context, final model) => McgScaffold( bodyBuilderWaiter: model.isInitialised, + forceInternetCheck: true, appBar: AppBar( title: Text(model.strings.imageCarousel), ), diff --git a/lib/l10n/generated/intl/messages_en.dart b/lib/l10n/generated/intl/messages_en.dart index ed85749..46b3ea6 100644 --- a/lib/l10n/generated/intl/messages_en.dart +++ b/lib/l10n/generated/intl/messages_en.dart @@ -27,6 +27,8 @@ class MessageLookup extends MessageLookupByLibrary { "imageCarousel": MessageLookupByLibrary.simpleMessage("Image carousel"), "imageDetails": MessageLookupByLibrary.simpleMessage( "Lorem ipsum dolor sit amet. A odio aliquam est sunt explicabo cum galisum asperiores qui voluptas tempora qui aliquid similique. Ut quam laborum ex nostrum recusandae ab sunt ratione quo tempore corporis 33 voluptas nulla aut obcaecati perspiciatis.\n\nAd eveniet exercitationem ad odit quidem aut omnis corporis ea nulla illum qui quisquam temporibus? Est obcaecati similique et quisquam unde ea impedit mollitia ea accusamus natus hic doloribus quis! Et dolorem rerum id doloribus sint ea porro quia ut reprehenderit ratione?"), + "noInternetMessage": MessageLookupByLibrary.simpleMessage( + "Are you sure that you\'re connected to the internet?"), "somethingWentWrong": MessageLookupByLibrary.simpleMessage("Something went wrong"), "startLoadingPrompt": diff --git a/lib/l10n/generated/l10n.dart b/lib/l10n/generated/l10n.dart index 7c4f39c..ec0ad09 100644 --- a/lib/l10n/generated/l10n.dart +++ b/lib/l10n/generated/l10n.dart @@ -109,6 +109,16 @@ class Strings { args: [], ); } + + /// `Are you sure that you're connected to the internet?` + String get noInternetMessage { + return Intl.message( + 'Are you sure that you\'re connected to the internet?', + name: 'noInternetMessage', + desc: '', + args: [], + ); + } } class AppLocalizationDelegate extends LocalizationsDelegate { diff --git a/lib/l10n/intl_en.arb b/lib/l10n/intl_en.arb index e08a39f..9f04702 100644 --- a/lib/l10n/intl_en.arb +++ b/lib/l10n/intl_en.arb @@ -8,5 +8,7 @@ "startLoadingPrompt": "Press me to start loading", "imageCarousel": "Image carousel", - "imageDetails": "Lorem ipsum dolor sit amet. A odio aliquam est sunt explicabo cum galisum asperiores qui voluptas tempora qui aliquid similique. Ut quam laborum ex nostrum recusandae ab sunt ratione quo tempore corporis 33 voluptas nulla aut obcaecati perspiciatis.\n\nAd eveniet exercitationem ad odit quidem aut omnis corporis ea nulla illum qui quisquam temporibus? Est obcaecati similique et quisquam unde ea impedit mollitia ea accusamus natus hic doloribus quis! Et dolorem rerum id doloribus sint ea porro quia ut reprehenderit ratione?" + "imageDetails": "Lorem ipsum dolor sit amet. A odio aliquam est sunt explicabo cum galisum asperiores qui voluptas tempora qui aliquid similique. Ut quam laborum ex nostrum recusandae ab sunt ratione quo tempore corporis 33 voluptas nulla aut obcaecati perspiciatis.\n\nAd eveniet exercitationem ad odit quidem aut omnis corporis ea nulla illum qui quisquam temporibus? Est obcaecati similique et quisquam unde ea impedit mollitia ea accusamus natus hic doloribus quis! Et dolorem rerum id doloribus sint ea porro quia ut reprehenderit ratione?", + + "noInternetMessage": "Are you sure that you're connected to the internet?" } \ No newline at end of file diff --git a/lib/locator.dart b/lib/locator.dart index cb1b0f1..a0f6706 100644 --- a/lib/locator.dart +++ b/lib/locator.dart @@ -3,18 +3,18 @@ import 'dart:async'; import 'package:connectivity_plus/connectivity_plus.dart'; import 'package:get_it/get_it.dart'; import 'package:internet_connection_checker/internet_connection_checker.dart'; -import 'package:mc_gallery/features/core/abstracts/router/app_router.dart'; -import 'package:mc_gallery/features/core/services/logging_service.dart'; -import 'package:mc_gallery/features/core/services/navigation_service.dart'; -import 'package:mc_gallery/features/home/api/unsplash_images_api.dart'; -import 'package:mc_gallery/features/home/services/image_cache_manager_service.dart'; -import 'package:mc_gallery/features/home/services/images_service.dart'; -import 'package:mc_gallery/features/home/views/gallery/gallery_view_model.dart'; -import 'package:mc_gallery/features/home/views/image_carousel/image_carousel_view_model.dart'; +import 'features/core/abstracts/router/app_router.dart'; import 'features/core/services/app_lifecycle_service.dart'; -import 'features/core/services/connection_service.dart'; +import 'features/core/services/connections_service.dart'; +import 'features/core/services/logging_service.dart'; +import 'features/core/services/navigation_service.dart'; import 'features/core/services/overlay_service.dart'; +import 'features/home/api/unsplash_images_api.dart'; +import 'features/home/services/image_cache_manager_service.dart'; +import 'features/home/services/images_service.dart'; +import 'features/home/views/gallery/gallery_view_model.dart'; +import 'features/home/views/image_carousel/image_carousel_view_model.dart'; GetIt get locate => Locator.instance(); @@ -58,37 +58,48 @@ class Locator { ); } - static FutureOr _registerServices(GetIt it) { + static FutureOr _registerServices(GetIt it) async { it.registerLazySingleton( () => NavigationService( mcgRouter: McgRouter.locate, ), ); + it.registerFactory( () => LoggingService(), ); - it.registerLazySingleton( - () => ConnectionService( + + it.registerSingleton( + ConnectionsService( connectivity: Connectivity(), internetConnectionChecker: InternetConnectionChecker(), + loggingService: LoggingService.locate, ), + signalsReady: true, + dispose: (final param) async => await param.dispose(), ); + await it.isReady(); + it.registerLazySingleton( () => OverlayService( loggingService: LoggingService.locate, ), dispose: (param) => param.dispose(), ); - instance().registerSingleton( + + it.registerSingleton( AppLifecycleService( loggingService: LoggingService.locate, ), - dispose: (param) async => await param.dispose(), + dispose: (final param) async => await param.dispose(), ); - it.registerSingleton( + + it.registerSingleton( ImagesService(imagesApi: UnsplashImagesApi.locate, loggingService: LoggingService.locate), signalsReady: true, ); + await it.isReady(); + it.registerSingleton( ImageCacheManagerService( appLifecycleService: AppLifecycleService.locate,