Merge pull request #134 from flutter-news-app-full-source-code/feat/app-version-enforcement

Feat/app version enforcement

Author: fulleni

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 1.1.0
+
+-   **Feature:** Implemented app version enforcement based on remote configuration, including a dedicated `UpdateRequiredPage` to guide users to update.
+-   **Enhancement:** Integrated `package_info_plus` and `pub_semver` for accurate version retrieval and comparison across platforms (Android, iOS, Web).
+
 ## 1.0.1
 
 -   **Version Control:** Transitioned from date-based versioning to semantic versioning. This release marks the first version following the semantic versioning standard.

lib/app/bloc/app_bloc.dart

@@ -11,7 +11,9 @@ import 'package:flutter_news_app_mobile_client_full_source_code/app/config/confi
     as local_config;
 import 'package:flutter_news_app_mobile_client_full_source_code/app/services/demo_data_initializer_service.dart';
 import 'package:flutter_news_app_mobile_client_full_source_code/app/services/demo_data_migration_service.dart';
+import 'package:flutter_news_app_mobile_client_full_source_code/app/services/package_info_service.dart';
 import 'package:logging/logging.dart';
+import 'package:pub_semver/pub_semver.dart';
 
 part 'app_event.dart';
 part 'app_state.dart';
@@ -41,6 +43,7 @@ class AppBloc extends Bloc<AppEvent, AppState> {
     required GlobalKey<NavigatorState> navigatorKey,
     required RemoteConfig? initialRemoteConfig,
     required HttpException? initialRemoteConfigError,
+    required PackageInfoService packageInfoService,
     this.demoDataMigrationService,
     this.demoDataInitializerService,
     this.initialUser,
@@ -51,6 +54,7 @@ class AppBloc extends Bloc<AppEvent, AppState> {
        _userRepository = userRepository,
        _environment = environment,
        _navigatorKey = navigatorKey,
+       _packageInfoService = packageInfoService,
        _logger = Logger('AppBloc'),
        super(
          AppState(
@@ -71,6 +75,7 @@ class AppBloc extends Bloc<AppEvent, AppState> {
     on<AppUserContentPreferencesRefreshed>(_onUserContentPreferencesRefreshed);
     on<AppSettingsChanged>(_onAppSettingsChanged);
     on<AppPeriodicConfigFetchRequested>(_onAppPeriodicConfigFetchRequested);
+    on<AppVersionCheckRequested>(_onAppVersionCheckRequested);
     on<AppUserFeedDecoratorShown>(_onAppUserFeedDecoratorShown);
     on<AppUserContentPreferencesChanged>(_onAppUserContentPreferencesChanged);
     on<AppLogoutRequested>(_onLogoutRequested);
@@ -91,6 +96,7 @@ class AppBloc extends Bloc<AppEvent, AppState> {
   final DataRepository<User> _userRepository;
   final local_config.AppEnvironment _environment;
   final GlobalKey<NavigatorState> _navigatorKey;
+  final PackageInfoService _packageInfoService;
   final Logger _logger;
   final DemoDataMigrationService? demoDataMigrationService;
   final DemoDataInitializerService? demoDataInitializerService;
@@ -259,14 +265,14 @@ class AppBloc extends Bloc<AppEvent, AppState> {
       return;
     }
 
-    if (state.remoteConfig!.appStatus.isLatestVersionOnly) {
-      // TODO(fulleni): Compare with actual app version.
-      _logger.info(
-        '[AppBloc] App update required. Transitioning to updateRequired state.',
-      );
-      emit(state.copyWith(status: AppLifeCycleStatus.updateRequired));
-      return;
-    }
+    // Dispatch AppVersionCheckRequested to handle version enforcement.
+    add(
+      AppVersionCheckRequested(
+        remoteConfig: state.remoteConfig!,
+        // Not a background check during startup
+        isBackgroundCheck: false,
+      ),
+    );
 
     // If we reach here, the app is not under maintenance or requires update.
     // Now, handle user-specific data loading.
@@ -547,17 +553,13 @@ class AppBloc extends Bloc<AppEvent, AppState> {
         return;
       }
 
-      if (remoteConfig.appStatus.isLatestVersionOnly) {
-        // TODO(fulleni): Compare with actual app version.
-        emit(
-          state.copyWith(
-            status: AppLifeCycleStatus.updateRequired,
-            remoteConfig: remoteConfig,
-            initialRemoteConfigError: null,
-          ),
-        );
-        return;
-      }
+      // Dispatch AppVersionCheckRequested to handle version enforcement.
+      add(
+        AppVersionCheckRequested(
+          remoteConfig: remoteConfig,
+          isBackgroundCheck: event.isBackgroundCheck,
+        ),
+      );
 
       final finalStatus = state.user!.appRole == AppUserRole.standardUser
           ? AppLifeCycleStatus.authenticated
@@ -598,6 +600,105 @@ class AppBloc extends Bloc<AppEvent, AppState> {
     }
   }
 
+  /// Handles the [AppVersionCheckRequested] event to enforce app version updates.
+  Future<void> _onAppVersionCheckRequested(
+    AppVersionCheckRequested event,
+    Emitter<AppState> emit,
+  ) async {
+    final remoteConfig = event.remoteConfig;
+    final isBackgroundCheck = event.isBackgroundCheck;
+
+    if (!remoteConfig.appStatus.isLatestVersionOnly) {
+      _logger.info(
+        '[AppBloc] Version enforcement not enabled. Skipping version check.',
+      );
+      return;
+    }
+
+    final currentAppVersionString = await _packageInfoService.getAppVersion();
+
+    if (currentAppVersionString == null) {
+      _logger.warning(
+        '[AppBloc] Could not determine current app version. '
+        'Skipping version comparison.',
+      );
+      // If we can't get the current version, we can't enforce.
+      // Do not block the app, but log a warning.
+      return;
+    }
+
+    try {
+      final currentVersion = Version.parse(currentAppVersionString);
+      final latestRequiredVersion = Version.parse(
+        remoteConfig.appStatus.latestAppVersion,
+      );
+
+      if (currentVersion >= latestRequiredVersion) {
+        _logger.info(
+          '[AppBloc] App version ($currentVersion) is up to date '
+          'or newer than required ($latestRequiredVersion).',
+        );
+        // If the app is up to date, and it was previously in an updateRequired
+        // state (e.g., after an update), transition it back to a normal state.
+        if (state.status == AppLifeCycleStatus.updateRequired) {
+          final finalStatus = state.user!.appRole == AppUserRole.standardUser
+              ? AppLifeCycleStatus.authenticated
+              : AppLifeCycleStatus.anonymous;
+          emit(
+            state.copyWith(
+              status: finalStatus,
+              currentAppVersion: currentAppVersionString,
+            ),
+          );
+        } else {
+          emit(state.copyWith(currentAppVersion: currentAppVersionString));
+        }
+      } else {
+        _logger.info(
+          '[AppBloc] App version ($currentVersion) is older than '
+          'required ($latestRequiredVersion). Transitioning to updateRequired state.',
+        );
+        emit(
+          state.copyWith(
+            status: AppLifeCycleStatus.updateRequired,
+            currentAppVersion: currentAppVersionString,
+          ),
+        );
+      }
+    } on FormatException catch (e, s) {
+      _logger.severe(
+        '[AppBloc] Failed to parse app version string: $currentAppVersionString '
+        'or latest required version: ${remoteConfig.appStatus.latestAppVersion}.',
+        e,
+        s,
+      );
+      if (!isBackgroundCheck) {
+        emit(
+          state.copyWith(
+            status: AppLifeCycleStatus.criticalError,
+            initialRemoteConfigError: UnknownException(
+              'Failed to parse app version: ${e.message}',
+            ),
+          ),
+        );
+      }
+    } catch (e, s) {
+      _logger.severe(
+        '[AppBloc] Unexpected error during app version check.',
+        e,
+        s,
+      );
+      if (!isBackgroundCheck) {
+        emit(
+          state.copyWith(
+            status: AppLifeCycleStatus.criticalError,
+            initialRemoteConfigError: UnknownException(e.toString()),
+          ),
+        );
+      }
+    }
+  }
+
   /// Handles updating the user's feed decorator status.
   Future<void> _onAppUserFeedDecoratorShown(
     AppUserFeedDecoratorShown event,

lib/app/bloc/app_event.dart

@@ -89,6 +89,28 @@ class AppPeriodicConfigFetchRequested extends AppEvent {
   List<Object> get props => [isBackgroundCheck];
 }
 
+/// Dispatched to request a check of the application's version against
+/// the remote configuration.
+///
+/// This event is used to determine if a mandatory update is required.
+class AppVersionCheckRequested extends AppEvent {
+  const AppVersionCheckRequested({
+    required this.remoteConfig,
+    this.isBackgroundCheck = true,
+  });
+
+  /// The latest remote configuration.
+  final RemoteConfig remoteConfig;
+
+  /// Whether this check is a silent background check.
+  ///
+  /// If `true`, the BLoC will not enter a visible loading state.
+  final bool isBackgroundCheck;
+
+  @override
+  List<Object> get props => [remoteConfig, isBackgroundCheck];
+}
+
 /// Dispatched when the user logs out.
 ///
 /// This event triggers the sign-out process, clearing authentication tokens

lib/app/bloc/app_state.dart

@@ -48,6 +48,7 @@ class AppState extends Equatable {
     this.userContentPreferences,
     this.settings,
     this.selectedBottomNavigationIndex = 0,
+    this.currentAppVersion,
   });
 
   /// The current status of the application, indicating its lifecycle stage.
@@ -84,6 +85,14 @@ class AppState extends Equatable {
   /// The current application environment (e.g., demo, development, production).
   final local_config.AppEnvironment environment;
 
+  /// The current version of the application, fetched from `package_info_plus`.
+  /// This is used for version enforcement.
+  final String? currentAppVersion;
+
+  /// The latest required app version from the remote configuration.
+  /// Returns `null` if remote config is not available.
+  String? get latestAppVersion => remoteConfig?.appStatus.latestAppVersion;
+
   /// The current theme mode (light, dark, or system), derived from [settings].
   /// Defaults to [ThemeMode.system] if [settings] are not yet loaded.
   ThemeMode get themeMode {
@@ -152,6 +161,7 @@ class AppState extends Equatable {
     userContentPreferences,
     selectedBottomNavigationIndex,
     environment,
+    currentAppVersion,
   ];
 
   /// Creates a copy of this [AppState] with the given fields replaced with
@@ -167,6 +177,7 @@ class AppState extends Equatable {
     UserContentPreferences? userContentPreferences,
     int? selectedBottomNavigationIndex,
     local_config.AppEnvironment? environment,
+    String? currentAppVersion,
   }) {
     return AppState(
       status: status ?? this.status,
@@ -182,6 +193,7 @@ class AppState extends Equatable {
       selectedBottomNavigationIndex:
           selectedBottomNavigationIndex ?? this.selectedBottomNavigationIndex,
       environment: environment ?? this.environment,
+      currentAppVersion: currentAppVersion ?? this.currentAppVersion,
     );
   }
 }

lib/app/services/package_info_service.dart

@@ -0,0 +1,49 @@
+import 'package:logging/logging.dart';
+import 'package:package_info_plus/package_info_plus.dart';
+
+/// {@template package_info_service}
+/// An abstract service for retrieving application package information.
+///
+/// This interface allows for mocking and provides a clean way to access
+/// platform-specific app details like version, build number, etc.
+/// {@endtemplate}
+abstract class PackageInfoService {
+  /// {@macro package_info_service}
+  const PackageInfoService();
+
+  /// Retrieves the application's version string (e.g., "1.0.0").
+  ///
+  /// Returns `null` if the version cannot be determined (e.g., on unsupported
+  /// platforms or during an error).
+  Future<String?> getAppVersion();
+}
+
+/// {@template package_info_service_impl}
+/// A concrete implementation of [PackageInfoService] using `package_info_plus`.
+/// {@endtemplate}
+class PackageInfoServiceImpl implements PackageInfoService {
+  /// {@macro package_info_service_impl}
+  PackageInfoServiceImpl({Logger? logger})
+    : _logger = logger ?? Logger('PackageInfoServiceImpl');
+
+  final Logger _logger;
+
+  @override
+  Future<String?> getAppVersion() async {
+    try {
+      final packageInfo = await PackageInfo.fromPlatform();
+      _logger.info(
+        'Successfully fetched package info. Version: ${packageInfo.version}',
+      );
+      return packageInfo.version;
+    } catch (e, s) {
+      _logger.warning(
+        'Failed to get app version from platform. '
+        'This might be expected on some platforms (e.g., web in certain contexts).',
+        e,
+        s,
+      );
+      return null;
+    }
+  }
+}