TF-3977 Add disable spam banner in preferences setting

lib/features/mailbox_dashboard/data/datasource/spam_report_datasource.dart

@@ -8,11 +8,11 @@ import 'package:tmail_ui_user/features/mailbox_dashboard/domain/model/spam_repor
 import 'package:tmail_ui_user/features/mailbox_dashboard/domain/model/unread_spam_emails_response.dart';
 
 abstract class SpamReportDataSource {
-  Future<bool> storeLastTimeDismissedSpamReported(DateTime lastTimeDismissedSpamReported);
+  Future<void> storeLastTimeDismissedSpamReported(DateTime lastTimeDismissedSpamReported);
 
   Future<DateTime> getLastTimeDismissedSpamReported();
 
-  Future<bool> deleteLastTimeDismissedSpamReported();
+  Future<void> deleteLastTimeDismissedSpamReported();
 
   Future<UnreadSpamEmailsResponse> findNumberOfUnreadSpamEmails(
     Session session,
@@ -27,7 +27,5 @@ abstract class SpamReportDataSource {
 
   Future<void> storeSpamReportState(SpamReportState spamReportState);
 
-  Future<void> deleteSpamReportState();
-
   Future<Mailbox> getSpamMailboxCached(AccountId accountId, UserName userName);
 }

lib/features/mailbox_dashboard/data/datasource_impl/hive_spam_report_datasource_impl.dart

@@ -22,11 +22,6 @@ class HiveSpamReportDataSourceImpl extends SpamReportDataSource {
     throw UnimplementedError();
   }
 
-  @override
-  Future<void> deleteSpamReportState() {
-    throw UnimplementedError();
-  }
-
   @override
   Future<UnreadSpamEmailsResponse> findNumberOfUnreadSpamEmails(Session session, AccountId accountId, {MailboxFilterCondition? mailboxFilterCondition, UnsignedInt? limit}) {
     throw UnimplementedError();

lib/features/mailbox_dashboard/data/datasource_impl/local_spam_report_datasource_impl.dart

@@ -5,35 +5,50 @@ import 'package:jmap_dart_client/jmap/core/user_name.dart';
 import 'package:jmap_dart_client/jmap/mail/mailbox/mailbox.dart';
 import 'package:jmap_dart_client/jmap/mail/mailbox/mailbox_filter_condition.dart';
 import 'package:tmail_ui_user/features/mailbox_dashboard/data/datasource/spam_report_datasource.dart';
-import 'package:tmail_ui_user/features/mailbox_dashboard/data/local/local_spam_report_manager.dart';
 import 'package:tmail_ui_user/features/mailbox_dashboard/domain/model/spam_report_state.dart';
 import 'package:tmail_ui_user/features/mailbox_dashboard/domain/model/unread_spam_emails_response.dart';
+import 'package:tmail_ui_user/features/manage_account/data/local/preferences_setting_manager.dart';
+import 'package:tmail_ui_user/features/manage_account/presentation/model/preferences/spam_report_config.dart';
 import 'package:tmail_ui_user/main/exceptions/exception_thrower.dart';
 
 class LocalSpamReportDataSourceImpl extends SpamReportDataSource {
-  final LocalSpamReportManager _localSpamReportManager;
+  final PreferencesSettingManager _preferencesSettingManager;
   final ExceptionThrower _exceptionThrower;
 
-  LocalSpamReportDataSourceImpl(this._localSpamReportManager, this._exceptionThrower);
+  LocalSpamReportDataSourceImpl(
+    this._preferencesSettingManager,
+    this._exceptionThrower,
+  );
 
   @override
   Future<DateTime> getLastTimeDismissedSpamReported() async {
     return Future.sync(() async {
-      return await _localSpamReportManager.getLastTimeDismissedSpamReported();
+      final spamReportConfig =
+          await _preferencesSettingManager.getSpamReportConfig();
+      return DateTime.fromMillisecondsSinceEpoch(
+        spamReportConfig.lastTimeDismissedMilliseconds,
+      );
     }).catchError(_exceptionThrower.throwException);
   }
 
   @override
-  Future<bool> storeLastTimeDismissedSpamReported(DateTime lastTimeDismissedSpamReported) async {
+  Future<void> storeLastTimeDismissedSpamReported(
+    DateTime lastTimeDismissedSpamReported,
+  ) async {
     return Future.sync(() async {
-      return await _localSpamReportManager.storeLastTimeDismissedSpamReported(lastTimeDismissedSpamReported);
+      return await _preferencesSettingManager.updateSpamReport(
+        lastTimeDismissedMilliseconds:
+            lastTimeDismissedSpamReported.millisecondsSinceEpoch,
+      );
     }).catchError(_exceptionThrower.throwException);
   }
-  
+
   @override
-  Future<bool> deleteLastTimeDismissedSpamReported() {
+  Future<void> deleteLastTimeDismissedSpamReported() {
     return Future.sync(() async {
-      return await _localSpamReportManager.deleteLastTimeDismissedSpamReported();
+      return await _preferencesSettingManager.updateSpamReport(
+        lastTimeDismissedMilliseconds: 0,
+      );
     }).catchError(_exceptionThrower.throwException);
   }
 
@@ -49,24 +64,21 @@ class LocalSpamReportDataSourceImpl extends SpamReportDataSource {
     throw UnimplementedError();
   }
 
-  @override
-  Future<void> deleteSpamReportState() {
-    return Future.sync(() async {
-      return await _localSpamReportManager.deleteLastTimeDismissedSpamReported();
-    }).catchError(_exceptionThrower.throwException);
-  }
-
   @override
   Future<SpamReportState> getSpamReportState() {
     return Future.sync(() async {
-      return await _localSpamReportManager.getSpamReportState();
+      final spamReportConfig =
+        await _preferencesSettingManager.getSpamReportConfig();
+      return spamReportConfig.spamReportState;
     }).catchError(_exceptionThrower.throwException);
   }
 
   @override
   Future<void> storeSpamReportState(SpamReportState spamReportState) {
     return Future.sync(() async {
-      return await _localSpamReportManager.storeSpamReportState(spamReportState);
+      return await _preferencesSettingManager.updateSpamReport(
+        isEnabled: spamReportState == SpamReportState.enabled,
+      );
     }).catchError(_exceptionThrower.throwException);
   }
 

lib/features/mailbox_dashboard/data/local/local_spam_report_manager.dart

@@ -1,48 +0,0 @@
-import 'package:core/utils/app_logger.dart';
-import 'package:shared_preferences/shared_preferences.dart';
-import 'package:tmail_ui_user/features/mailbox_dashboard/domain/model/spam_report_state.dart';
-
-class LocalSpamReportManager {
-  static const String _keyLastTimeDismissedSpamReported = 'KEY_LAST_TIME_DISMISSED_SPAM_REPORTED';
-  static const String _keySpamReportState = 'KEY_SPAM_REPORT_STATE';
-
-  final SharedPreferences _sharedPreferences;
-
-  LocalSpamReportManager(this._sharedPreferences);
-
-  Future<DateTime> getLastTimeDismissedSpamReported() async {
-    final timeStamp = _sharedPreferences.getInt(_keyLastTimeDismissedSpamReported) ?? 0;
-    log('LocalSpamReportManager::getLastTimeDismissedSpamReported:timeStamp: $timeStamp');
-    final lastTimeDismissedSpamReported =  DateTime.fromMillisecondsSinceEpoch(timeStamp);
-    return lastTimeDismissedSpamReported;
-  }
-  
-  Future<bool> storeLastTimeDismissedSpamReported(DateTime lastTimeDismissedSpamReported) async {
-    final timeStamp = lastTimeDismissedSpamReported.millisecondsSinceEpoch;
-    log('LocalSpamReportManager::storeLastTimeDismissedSpamReported:timeStamp: $timeStamp');
-    return await _sharedPreferences.setInt(_keyLastTimeDismissedSpamReported, timeStamp);
-  }
-
-  Future<bool> deleteLastTimeDismissedSpamReported() async {
-    return await _sharedPreferences.remove(_keyLastTimeDismissedSpamReported);
-  }
-
-  Future<bool> deleteSpamReportState() async {
-    return await _sharedPreferences.remove(_keySpamReportState);
-  }
-
-  Future<SpamReportState> getSpamReportState() async {
-    final spamReportState = _sharedPreferences.getString(_keySpamReportState) ?? '';
-    return spamReportState == SpamReportState.disabled.keyValue ? SpamReportState.disabled : SpamReportState.enabled;
-  }
-
-  Future<bool> storeSpamReportState(SpamReportState spamReportState) async {
-    final spamReportState0 = spamReportState.keyValue;
-    return await _sharedPreferences.setString(_keySpamReportState, spamReportState0);
-  }
-
-  Future<void> clear() async {
-    await deleteLastTimeDismissedSpamReported();
-    await deleteSpamReportState();
-  }
-}

lib/features/mailbox_dashboard/data/repository/spam_report_repository_impl.dart

@@ -36,11 +36,6 @@ class SpamReportRepositoryImpl extends SpamReportRepository {
     return mapDataSource[DataSourceType.local]!.storeSpamReportState(spamReportState);
   }
   
-  @override
-  Future<void> deleteSpamReportState() {
-    return mapDataSource[DataSourceType.local]!.deleteSpamReportState();
-  }
-
   @override
   Future<Mailbox> getSpamMailboxCached(AccountId accountId, UserName userName) {
     return mapDataSource[DataSourceType.hiveCache]!.getSpamMailboxCached(accountId, userName);

lib/features/mailbox_dashboard/domain/repository/spam_report_repository.dart

@@ -14,7 +14,5 @@ abstract class SpamReportRepository {
 
   Future<void> storeSpamReportState(SpamReportState spamReportState);
 
-  Future<void> deleteSpamReportState();
-
   Future<Mailbox> getSpamMailboxCached(AccountId accountId, UserName userName);
 }

lib/features/mailbox_dashboard/domain/usecases/delete_spam_report_state_interactor.dart

@@ -1,21 +0,0 @@
-import 'package:core/presentation/state/failure.dart';
-import 'package:core/presentation/state/success.dart';
-import 'package:dartz/dartz.dart';
-import 'package:tmail_ui_user/features/mailbox_dashboard/domain/repository/spam_report_repository.dart';
-import 'package:tmail_ui_user/features/mailbox_dashboard/domain/state/delete_spam_report_state.dart';
-
-class DeleteSpamReportStateInteractor {
-  final SpamReportRepository _spamReportRepository;
-
-  DeleteSpamReportStateInteractor(this._spamReportRepository);
-
-  Stream<Either<Failure, Success>> execute() async* {
-    try {
-      yield Right<Failure, Success>(DeleteSpamReportStateLoading());
-      await _spamReportRepository.deleteSpamReportState();
-      yield Right<Failure, Success>(DeleteSpamReportStateSuccess());
-    } catch (e) {
-      yield Left<Failure, Success>(DeleteSpamReportStateFailure(e));
-    }
-  }
-}

lib/features/mailbox_dashboard/presentation/bindings/mailbox_dashboard_bindings.dart

@@ -69,7 +69,6 @@ import 'package:tmail_ui_user/features/mailbox_dashboard/data/datasource_impl/lo
 import 'package:tmail_ui_user/features/mailbox_dashboard/data/datasource_impl/search_datasource_impl.dart';
 import 'package:tmail_ui_user/features/mailbox_dashboard/data/datasource_impl/session_storage_composer_datasoure_impl.dart';
 import 'package:tmail_ui_user/features/mailbox_dashboard/data/local/local_sort_order_manager.dart';
-import 'package:tmail_ui_user/features/mailbox_dashboard/data/local/local_spam_report_manager.dart';
 import 'package:tmail_ui_user/features/mailbox_dashboard/data/network/linagora_ecosystem_api.dart';
 import 'package:tmail_ui_user/features/mailbox_dashboard/data/repository/app_grid_repository_impl.dart';
 import 'package:tmail_ui_user/features/mailbox_dashboard/data/repository/composer_cache_repository_impl.dart';
@@ -100,6 +99,7 @@ import 'package:tmail_ui_user/features/mailbox_dashboard/presentation/controller
 import 'package:tmail_ui_user/features/mailbox_dashboard/presentation/controller/mailbox_dashboard_controller.dart';
 import 'package:tmail_ui_user/features/mailbox_dashboard/presentation/controller/search_controller.dart';
 import 'package:tmail_ui_user/features/mailbox_dashboard/presentation/controller/spam_report_controller.dart';
+import 'package:tmail_ui_user/features/manage_account/data/local/preferences_setting_manager.dart';
 import 'package:tmail_ui_user/features/manage_account/domain/repository/identity_repository.dart';
 import 'package:tmail_ui_user/features/manage_account/domain/usecases/get_all_identities_interactor.dart';
 import 'package:tmail_ui_user/features/manage_account/presentation/identities/identity_interactors_bindings.dart';
@@ -278,7 +278,7 @@ class MailboxDashBoardBindings extends BaseBindings {
       Get.find<HtmlTransform>(),
       Get.find<CacheExceptionThrower>()));
     Get.lazyPut(() => LocalSpamReportDataSourceImpl(
-      Get.find<LocalSpamReportManager>(),
+      Get.find<PreferencesSettingManager>(),
       Get.find<CacheExceptionThrower>(),
     ));
     Get.lazyPut(() => HiveSpamReportDataSourceImpl(

lib/features/mailbox_dashboard/presentation/controller/mailbox_dashboard_controller.dart

@@ -2004,6 +2004,7 @@ class MailboxDashBoardController extends ReloadableController
     _getAllIdentities();
     notifyThreadDetailSettingUpdated();
     getServerSetting();
+    spamReportController.getSpamReportStateAction();
   }
 
   Future<List<PresentationEmail>> quickSearchEmails(String query) async {
@@ -2074,6 +2075,7 @@ class MailboxDashBoardController extends ReloadableController
     _getAllIdentities();
     notifyThreadDetailSettingUpdated();
     getServerSetting();
+    spamReportController.getSpamReportStateAction();
   }
 
   void _handleUpdateVacationSuccess(UpdateVacationSuccess success) {

lib/features/mailbox_dashboard/presentation/controller/spam_report_controller.dart

@@ -19,6 +19,8 @@ import 'package:tmail_ui_user/features/mailbox_dashboard/domain/usecases/get_spa
 import 'package:tmail_ui_user/features/mailbox_dashboard/domain/usecases/store_last_time_dismissed_spam_reported_interactor.dart';
 import 'package:tmail_ui_user/features/mailbox_dashboard/domain/usecases/store_spam_report_state_interactor.dart';
 import 'package:tmail_ui_user/features/mailbox_dashboard/presentation/controller/mailbox_dashboard_controller.dart';
+import 'package:tmail_ui_user/features/mailbox_dashboard/presentation/model/spam_report_loader_status.dart';
+import 'package:tmail_ui_user/main/routes/route_navigation.dart';
 
 class SpamReportController extends BaseController {
   final StoreSpamReportInteractor _storeSpamReportInteractor;
@@ -29,6 +31,9 @@ class SpamReportController extends BaseController {
   final presentationSpamMailbox = Rxn<PresentationMailbox>();
   final spamReportState = Rx<SpamReportState>(SpamReportState.enabled);
 
+  AppLifecycleListener? _appLifecycleListener;
+  SpamReportLoaderStatus _spamReportLoaderStatus = SpamReportLoaderStatus.idle;
+
   SpamReportController(
     this._storeSpamReportInteractor,
     this._storeSpamReportStateInteractor,
@@ -36,28 +41,60 @@ class SpamReportController extends BaseController {
     this._getSpamMailboxCachedInteractor
   );
 
+  @override
+  void onInit() {
+    super.onInit();
+    _appLifecycleListener ??= AppLifecycleListener(
+      onResume: () {
+        if (_spamReportLoaderStatus == SpamReportLoaderStatus.loading) {
+          return;
+        }
+        getSpamReportStateAction();
+      },
+    );
+  }
+
   @override
   void handleSuccessViewState(Success success) {
-    super.handleSuccessViewState(success);
     if (success is StoreLastTimeDismissedSpamReportSuccess) {
       presentationSpamMailbox.value = null;
+    } else if (success is GetSpamReportStateLoading) {
+      _spamReportLoaderStatus = SpamReportLoaderStatus.loading;
     } else if (success is GetSpamReportStateSuccess) {
-      spamReportState.value = success.spamReportState;
+      _loadSpamReportConfigSuccess(success.spamReportState);
     } else if (success is StoreSpamReportStateSuccess) {
       spamReportState.value = success.spamReportState;
+      getBinding<MailboxDashBoardController>()?.refreshSpamReportBanner();
     } else if (success is GetSpamMailboxCachedSuccess) {
       presentationSpamMailbox.value = success.spamMailbox.toPresentationMailbox();
+    } else {
+      super.handleSuccessViewState(success);
     }
   }
 
   @override
   void handleFailureViewState(Failure failure) {
-    super.handleFailureViewState(failure);
     if (failure is GetSpamMailboxCachedFailure) {
       presentationSpamMailbox.value = null;
+    } else if (failure is GetSpamReportStateFailure) {
+      _spamReportLoaderStatus = SpamReportLoaderStatus.completed;
+    } else {
+      super.handleFailureViewState(failure);
     }
   }
 
+  @override
+  void handleErrorViewState(Object error, StackTrace stackTrace) {
+    super.handleErrorViewState(error, stackTrace);
+    _spamReportLoaderStatus = SpamReportLoaderStatus.completed;
+  }
+
+  void _loadSpamReportConfigSuccess(SpamReportState newState) {
+    spamReportState.value = newState;
+    _spamReportLoaderStatus = SpamReportLoaderStatus.completed;
+    getBinding<MailboxDashBoardController>()?.refreshSpamReportBanner();
+  }
+
   void dismissSpamReportAction(BuildContext context) {
     if (Get.isRegistered<MailboxDashBoardController>()) {
       final mailboxDashBoardController = Get.find<MailboxDashBoardController>();
@@ -109,4 +146,10 @@ class SpamReportController extends BaseController {
   void setSpamPresentationMailbox(PresentationMailbox? spamMailbox) {
     presentationSpamMailbox.value = spamMailbox;
   }
+
+  @override
+  void onClose() {
+    _appLifecycleListener?.dispose();
+    super.onClose();
+  }
 }

lib/features/mailbox_dashboard/presentation/model/spam_report_loader_status.dart

@@ -0,0 +1 @@
+enum SpamReportLoaderStatus { idle, loading, completed }