TF-524 Clean up recent search cache

lib/features/caching/recent_search_cache_client.dart

@@ -30,7 +30,12 @@ class RecentSearchCacheClient extends HiveCacheClient<RecentSearchCache> {
 
   @override
   Future<void> deleteMultipleItem(List<String> listKey) {
-    throw UnimplementedError();
+    return Future.sync(() async {
+      final boxEmail = await openBox();
+      return boxEmail.deleteAll(listKey);
+    }).catchError((error) {
+      throw error;
+    });
   }
 
   @override

lib/features/cleanup/data/datasource/cleanup_datasource.dart

@@ -1,10 +1,9 @@
 
-import 'package:tmail_ui_user/features/cleanup/domain/model/cleanup_rule.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/model/email_cleanup_rule.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/model/recent_search_cleanup_rule.dart';
 
 abstract class CleanupDataSource {
-  Future<bool> cleanEmailCache(CleanupRule cleanupRule);
+  Future<void> cleanEmailCache(EmailCleanupRule cleanupRule);
 
-  Future<void> saveTimeCleanEmail(DateTime lastTime);
-
-  Future<DateTime?> getTimeCleanEmail();
+  Future<void> cleanRecentSearchCache(RecentSearchCleanupRule cleanupRule);
 }

lib/features/cleanup/data/datasource_impl/cleanup_datasource_impl.dart

@@ -1,19 +1,19 @@
 
-import 'package:shared_preferences/shared_preferences.dart';
 import 'package:tmail_ui_user/features/cleanup/data/datasource/cleanup_datasource.dart';
-import 'package:tmail_ui_user/features/cleanup/data/utils/cleanup_constant.dart';
-import 'package:tmail_ui_user/features/cleanup/domain/model/cleanup_rule.dart';
+import 'package:tmail_ui_user/features/cleanup/data/local/recent_search_cache_manager.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/model/email_cleanup_rule.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/model/recent_search_cleanup_rule.dart';
 import 'package:tmail_ui_user/features/thread/data/local/email_cache_manager.dart';
 
 class CleanupDataSourceImpl extends CleanupDataSource {
 
   final EmailCacheManager emailCacheManager;
-  final SharedPreferences sharedPreferences;
+  final RecentSearchCacheManager recentSearchCacheManager;
 
-  CleanupDataSourceImpl(this.emailCacheManager, this.sharedPreferences);
+  CleanupDataSourceImpl(this.emailCacheManager, this.recentSearchCacheManager);
 
   @override
-  Future<bool> cleanEmailCache(CleanupRule cleanupRule) {
+  Future<void> cleanEmailCache(EmailCleanupRule cleanupRule) {
     return Future.sync(() async {
       return await emailCacheManager.clean(cleanupRule);
     }).catchError((error) {
@@ -22,19 +22,9 @@ class CleanupDataSourceImpl extends CleanupDataSource {
   }
 
   @override
-  Future<void> saveTimeCleanEmail(DateTime lastTime) {
+  Future<void> cleanRecentSearchCache(RecentSearchCleanupRule cleanupRule) {
     return Future.sync(() async {
-      await sharedPreferences.setString(CleanupConstant.keyTimeCleanupEmail, lastTime.toIso8601String());
-    }).catchError((error) {
-      throw error;
-    });
-  }
-
-  @override
-  Future<DateTime?> getTimeCleanEmail() {
-    return Future.sync(() async {
-      final lastTime = sharedPreferences.getString(CleanupConstant.keyTimeCleanupEmail);
-      return DateTime.tryParse(lastTime ?? '');
+      return await recentSearchCacheManager.clean(cleanupRule);
     }).catchError((error) {
       throw error;
     });

lib/features/cleanup/data/local/recent_search_cache_manager.dart

@@ -0,0 +1,27 @@
+
+import 'package:tmail_ui_user/features/caching/recent_search_cache_client.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/model/recent_search_cleanup_rule.dart';
+import 'package:tmail_ui_user/features/mailbox_dashboard/data/model/recent_search_cache.dart';
+
+class RecentSearchCacheManager {
+
+  final RecentSearchCacheClient _recentSearchCacheClient;
+
+  RecentSearchCacheManager(this._recentSearchCacheClient);
+
+  Future<void> clean(RecentSearchCleanupRule cleanupRule) async {
+    final recentSearchCacheExist = await _recentSearchCacheClient.isExistTable();
+    if (recentSearchCacheExist) {
+      final listRecentSearchCache = await _recentSearchCacheClient.getAll();
+      listRecentSearchCache.sortByCreationDate();
+
+      if (listRecentSearchCache.length > cleanupRule.storageLimit) {
+        final newListKeyRecent = listRecentSearchCache
+            .sublist(cleanupRule.storageLimit)
+            .map((recent) => recent.value)
+            .toList();
+        await _recentSearchCacheClient.deleteMultipleItem(newListKeyRecent);
+      }
+    }
+  }
+}

lib/features/cleanup/data/repository/cleanup_repository_impl.dart

@@ -1,6 +1,7 @@
 
 import 'package:tmail_ui_user/features/cleanup/data/datasource/cleanup_datasource.dart';
-import 'package:tmail_ui_user/features/cleanup/domain/model/cleanup_rule.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/model/email_cleanup_rule.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/model/recent_search_cleanup_rule.dart';
 import 'package:tmail_ui_user/features/cleanup/domain/repository/cleanup_repository.dart';
 
 class CleanupRepositoryImpl extends CleanupRepository {
@@ -10,10 +11,12 @@ class CleanupRepositoryImpl extends CleanupRepository {
   CleanupRepositoryImpl(this.cleanupDataSource);
 
   @override
-  Future<void> cleanEmailCache(CleanupRule cleanupRule) async {
-    final isSuccess = await cleanupDataSource.cleanEmailCache(cleanupRule);
-    if (isSuccess) {
-      await cleanupDataSource.saveTimeCleanEmail(DateTime.now());
-    }
+  Future<void> cleanEmailCache(EmailCleanupRule cleanupRule) {
+    return cleanupDataSource.cleanEmailCache(cleanupRule);
+  }
+
+  @override
+  Future<void> cleanRecentSearchCache(RecentSearchCleanupRule cleanupRule) {
+    return cleanupDataSource.cleanRecentSearchCache(cleanupRule);
   }
 }

lib/features/cleanup/data/utils/cleanup_constant.dart

@@ -1,3 +0,0 @@
-class CleanupConstant {
-  static const keyTimeCleanupEmail = 'KEY_TIME_CLEANUP_EMAIL';
-}

lib/features/cleanup/domain/model/cleanup_rule.dart

@@ -1,13 +1,12 @@
 
 import 'package:equatable/equatable.dart';
 
-class CleanupRule with EquatableMixin {
-  final Duration cachingEmailPeriod;
+abstract class CleanupRule with EquatableMixin {
 
-  CleanupRule(this.cachingEmailPeriod);
+  CleanupRule();
 
   @override
-  List<Object?> get props => [cachingEmailPeriod];
+  List<Object?> get props => [];
 }
 
 class Duration with EquatableMixin {

lib/features/cleanup/domain/model/email_cleanup_rule.dart

@@ -0,0 +1,11 @@
+
+import 'package:tmail_ui_user/features/cleanup/domain/model/cleanup_rule.dart';
+
+class EmailCleanupRule extends CleanupRule {
+  final Duration cachingEmailPeriod;
+
+  EmailCleanupRule(this.cachingEmailPeriod) : super();
+
+  @override
+  List<Object?> get props => [cachingEmailPeriod];
+}

lib/features/cleanup/domain/model/recent_search_cleanup_rule.dart

@@ -0,0 +1,13 @@
+
+import 'package:tmail_ui_user/features/cleanup/domain/model/cleanup_rule.dart';
+
+class RecentSearchCleanupRule extends CleanupRule {
+  final int storageLimit;
+
+  RecentSearchCleanupRule(
+      {this.storageLimit = 10}
+  ) : super();
+
+  @override
+  List<Object?> get props => [storageLimit];
+}

lib/features/cleanup/domain/repository/cleanup_repository.dart

@@ -1,5 +1,8 @@
-import 'package:tmail_ui_user/features/cleanup/domain/model/cleanup_rule.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/model/email_cleanup_rule.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/model/recent_search_cleanup_rule.dart';
 
 abstract class CleanupRepository {
-  Future<void> cleanEmailCache(CleanupRule cleanupRule);
+  Future<void> cleanEmailCache(EmailCleanupRule cleanupRule);
+
+  Future<void> cleanRecentSearchCache(RecentSearchCleanupRule cleanupRule);
 }

lib/features/cleanup/domain/state/cleanup_recent_search_cache_state.dart

@@ -0,0 +1,18 @@
+import 'package:core/core.dart';
+
+class CleanupRecentSearchCacheSuccess extends UIState {
+
+  CleanupRecentSearchCacheSuccess();
+
+  @override
+  List<Object> get props => [];
+}
+
+class CleanupRecentSearchCacheFailure extends FeatureFailure {
+  final dynamic exception;
+
+  CleanupRecentSearchCacheFailure(this.exception);
+
+  @override
+  List<Object> get props => [exception];
+}

lib/features/cleanup/domain/usecases/cleanup_email_cache_interactor.dart

@@ -1,6 +1,6 @@
 import 'package:core/core.dart';
 import 'package:dartz/dartz.dart';
-import 'package:tmail_ui_user/features/cleanup/domain/model/cleanup_rule.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/model/email_cleanup_rule.dart';
 import 'package:tmail_ui_user/features/cleanup/domain/repository/cleanup_repository.dart';
 import 'package:tmail_ui_user/features/cleanup/domain/state/cleanup_email_cache_state.dart';
 
@@ -9,7 +9,7 @@ class CleanupEmailCacheInteractor {
 
   CleanupEmailCacheInteractor(this.cleanupRepository);
 
-  Future<Either<Failure, Success>> execute(CleanupRule cleanupRule) async {
+  Future<Either<Failure, Success>> execute(EmailCleanupRule cleanupRule) async {
     try {
       await cleanupRepository.cleanEmailCache(cleanupRule);
       return Right<Failure, Success>(CleanupEmailCacheSuccess());

lib/features/cleanup/domain/usecases/cleanup_recent_search_cache_interactor.dart

@@ -0,0 +1,21 @@
+import 'package:core/core.dart';
+import 'package:dartz/dartz.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/model/recent_search_cleanup_rule.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/repository/cleanup_repository.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/state/cleanup_recent_search_cache_state.dart';
+
+class CleanupRecentSearchCacheInteractor {
+  final CleanupRepository cleanupRepository;
+
+  CleanupRecentSearchCacheInteractor(this.cleanupRepository);
+
+  Future<Either<Failure, Success>> execute(RecentSearchCleanupRule cleanupRule) async {
+    try {
+      await cleanupRepository.cleanRecentSearchCache(cleanupRule);
+      log('CleanupRecentSearchCacheInteractor::execute(): SUCCESS');
+      return Right<Failure, Success>(CleanupRecentSearchCacheSuccess());
+    } catch (e) {
+      return Left(CleanupRecentSearchCacheFailure(e));
+    }
+  }
+}

lib/features/home/presentation/home_bindings.dart

@@ -1,12 +1,13 @@
 import 'package:core/core.dart';
 import 'package:get/get.dart';
-import 'package:shared_preferences/shared_preferences.dart';
 import 'package:tmail_ui_user/features/base/base_bindings.dart';
 import 'package:tmail_ui_user/features/cleanup/data/datasource/cleanup_datasource.dart';
 import 'package:tmail_ui_user/features/cleanup/data/datasource_impl/cleanup_datasource_impl.dart';
+import 'package:tmail_ui_user/features/cleanup/data/local/recent_search_cache_manager.dart';
 import 'package:tmail_ui_user/features/cleanup/data/repository/cleanup_repository_impl.dart';
 import 'package:tmail_ui_user/features/cleanup/domain/repository/cleanup_repository.dart';
 import 'package:tmail_ui_user/features/cleanup/domain/usecases/cleanup_email_cache_interactor.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/usecases/cleanup_recent_search_cache_interactor.dart';
 import 'package:tmail_ui_user/features/home/presentation/home_controller.dart';
 import 'package:tmail_ui_user/features/login/domain/usecases/get_credential_interactor.dart';
 import 'package:tmail_ui_user/features/thread/data/local/email_cache_manager.dart';
@@ -22,6 +23,7 @@ class HomeBindings extends BaseBindings {
         Get.find<AuthorizationInterceptors>(),
         Get.find<CleanupEmailCacheInteractor>(),
         Get.find<EmailReceiveManager>(),
+        Get.find<CleanupRecentSearchCacheInteractor>(),
     ));
   }
 
@@ -34,13 +36,14 @@ class HomeBindings extends BaseBindings {
   void bindingsDataSourceImpl() {
     Get.lazyPut(() => CleanupDataSourceImpl(
         Get.find<EmailCacheManager>(),
-        Get.find<SharedPreferences>(),
+        Get.find<RecentSearchCacheManager>(),
     ));
   }
 
   @override
   void bindingsInteractor() {
     Get.lazyPut(() => CleanupEmailCacheInteractor(Get.find<CleanupRepository>()));
+    Get.lazyPut(() => CleanupRecentSearchCacheInteractor(Get.find<CleanupRepository>()));
   }
 
   @override

lib/features/home/presentation/home_controller.dart

@@ -4,7 +4,10 @@ import 'package:flutter_downloader/flutter_downloader.dart';
 import 'package:get/get.dart';
 import 'package:jmap_dart_client/jmap/mail/email/email_address.dart';
 import 'package:tmail_ui_user/features/cleanup/domain/model/cleanup_rule.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/model/email_cleanup_rule.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/model/recent_search_cleanup_rule.dart';
 import 'package:tmail_ui_user/features/cleanup/domain/usecases/cleanup_email_cache_interactor.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/usecases/cleanup_recent_search_cache_interactor.dart';
 import 'package:tmail_ui_user/features/login/domain/state/get_credential_state.dart';
 import 'package:tmail_ui_user/features/login/domain/usecases/get_credential_interactor.dart';
 import 'package:tmail_ui_user/main/routes/app_routes.dart';
@@ -17,6 +20,7 @@ class HomeController extends GetxController {
   final AuthorizationInterceptors _authorizationInterceptors;
   final CleanupEmailCacheInteractor _cleanupEmailCacheInteractor;
   final EmailReceiveManager _emailReceiveManager;
+  final CleanupRecentSearchCacheInteractor _cleanupRecentSearchCacheInteractor;
 
   HomeController(
     this._getCredentialInteractor,
@@ -24,6 +28,7 @@ class HomeController extends GetxController {
     this._authorizationInterceptors,
     this._cleanupEmailCacheInteractor,
     this._emailReceiveManager,
+    this._cleanupRecentSearchCacheInteractor,
   );
 
   @override
@@ -38,8 +43,8 @@ class HomeController extends GetxController {
 
   @override
   void onReady() {
+    _cleanupCache();
     super.onReady();
-    _cleanupEmailCache();
   }
 
   void _initFlutterDownloader() {
@@ -50,9 +55,11 @@ class HomeController extends GetxController {
 
   static void downloadCallback(String id, DownloadTaskStatus status, int progress) {}
 
-  void _cleanupEmailCache() async {
-    await _cleanupEmailCacheInteractor.execute(CleanupRule(Duration.defaultCacheInternal))
-      .then((value) => _getCredentialAction());
+  void _cleanupCache() async {
+    await Future.wait([
+      _cleanupEmailCacheInteractor.execute(EmailCleanupRule(Duration.defaultCacheInternal)),
+      _cleanupRecentSearchCacheInteractor.execute(RecentSearchCleanupRule())
+    ]).then((value) => _getCredentialAction());
   }
 
   void _getCredentialAction() async {

lib/features/mailbox_dashboard/data/model/recent_search_cache.dart

@@ -1,6 +1,7 @@
 
 import 'package:equatable/equatable.dart';
 import 'package:hive/hive.dart';
+import 'package:jmap_dart_client/jmap/core/extensions/date_time_extension.dart';
 import 'package:tmail_ui_user/features/caching/utils/caching_constants.dart';
 import 'package:tmail_ui_user/features/mailbox_dashboard/domain/model/recent_search.dart';
 
@@ -35,4 +36,13 @@ extension RecentSearchCacheExtension on RecentSearchCache {
   bool match(String pattern) {
     return value.toLowerCase().contains(pattern.toLowerCase());
   }
+}
+
+extension ListRecentSearchCacheExtension on List<RecentSearchCache> {
+
+  void sortByCreationDate() {
+    sort((recentSearch1, recentSearch2) {
+      return recentSearch1.creationDate.compareToSort(recentSearch1.creationDate, false);
+    });
+  }
 }

lib/features/mailbox_dashboard/data/model/recent_search_cache.g.dart

@@ -0,0 +1,44 @@
+// GENERATED CODE - DO NOT MODIFY BY HAND
+
+part of 'recent_search_cache.dart';
+
+// **************************************************************************
+// TypeAdapterGenerator
+// **************************************************************************
+
+class RecentSearchCacheAdapter extends TypeAdapter<RecentSearchCache> {
+  @override
+  final int typeId = 7;
+
+  @override
+  RecentSearchCache read(BinaryReader reader) {
+    final numOfFields = reader.readByte();
+    final fields = <int, dynamic>{
+      for (int i = 0; i < numOfFields; i++) reader.readByte(): reader.read(),
+    };
+    return RecentSearchCache(
+      fields[0] as String,
+      fields[1] as DateTime,
+    );
+  }
+
+  @override
+  void write(BinaryWriter writer, RecentSearchCache obj) {
+    writer
+      ..writeByte(2)
+      ..writeByte(0)
+      ..write(obj.value)
+      ..writeByte(1)
+      ..write(obj.creationDate);
+  }
+
+  @override
+  int get hashCode => typeId.hashCode;
+
+  @override
+  bool operator ==(Object other) =>
+      identical(this, other) ||
+      other is RecentSearchCacheAdapter &&
+          runtimeType == other.runtimeType &&
+          typeId == other.typeId;
+}

lib/features/thread/data/extensions/email_cache_extension.dart

@@ -6,7 +6,7 @@ import 'package:jmap_dart_client/jmap/core/utc_date.dart';
 import 'package:jmap_dart_client/jmap/mail/email/email.dart';
 import 'package:jmap_dart_client/jmap/mail/email/keyword_identifier.dart';
 import 'package:jmap_dart_client/jmap/mail/mailbox/mailbox.dart';
-import 'package:tmail_ui_user/features/cleanup/domain/model/cleanup_rule.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/model/email_cleanup_rule.dart';
 import 'package:tmail_ui_user/features/thread/data/model/email_cache.dart';
 import 'package:tmail_ui_user/features/thread/data/extensions/email_address_hive_cache_extension.dart';
 
@@ -34,7 +34,7 @@ extension EmailCacheExtension on EmailCache {
     );
   }
 
-  bool expireTimeCaching(CleanupRule cleanupRule) {
+  bool expireTimeCaching(EmailCleanupRule cleanupRule) {
     final currentTime = DateTime.now();
     if (receivedAt != null) {
       final countDay = currentTime.daysBetween(receivedAt!.toLocal());

lib/features/thread/data/local/email_cache_manager.dart

@@ -4,7 +4,7 @@ import 'package:model/model.dart';
 import 'package:jmap_dart_client/jmap/mail/email/email.dart';
 import 'package:jmap_dart_client/jmap/mail/mailbox/mailbox.dart';
 import 'package:tmail_ui_user/features/caching/email_cache_client.dart';
-import 'package:tmail_ui_user/features/cleanup/domain/model/cleanup_rule.dart';
+import 'package:tmail_ui_user/features/cleanup/domain/model/email_cleanup_rule.dart';
 import 'package:tmail_ui_user/features/thread/data/extensions/email_cache_extension.dart';
 import 'package:tmail_ui_user/features/thread/data/extensions/email_extension.dart';
 import 'package:tmail_ui_user/features/thread/data/extensions/list_email_cache_extension.dart';
@@ -63,7 +63,7 @@ class EmailCacheManager {
     }
   }
 
-  Future<bool> clean(CleanupRule cleanupRule) async {
+  Future<void> clean(EmailCleanupRule cleanupRule) async {
     final emailCacheExist = await _emailCacheClient.isExistTable();
     if (emailCacheExist) {
       final listEmailCache = await _emailCacheClient.getAll();
@@ -72,8 +72,6 @@ class EmailCacheManager {
         .map((emailCache) => emailCache.id)
         .toList();
       await _emailCacheClient.deleteMultipleItem(listEmailIdCacheExpire);
-      return true;
     }
-    return false;
   }
 }

lib/main/bindings/local/local_bindings.dart

@@ -6,6 +6,7 @@ import 'package:tmail_ui_user/features/caching/email_cache_client.dart';
 import 'package:tmail_ui_user/features/caching/mailbox_cache_client.dart';
 import 'package:tmail_ui_user/features/caching/recent_search_cache_client.dart';
 import 'package:tmail_ui_user/features/caching/state_cache_client.dart';
+import 'package:tmail_ui_user/features/cleanup/data/local/recent_search_cache_manager.dart';
 import 'package:tmail_ui_user/features/mailbox/data/local/mailbox_cache_manager.dart';
 import 'package:tmail_ui_user/features/thread/data/local/email_cache_manager.dart';
 
@@ -28,6 +29,7 @@ class LocalBindings extends Bindings {
     Get.put(EmailCacheClient());
     Get.put(EmailCacheManager(Get.find<EmailCacheClient>()));
     Get.put(RecentSearchCacheClient());
+    Get.put(RecentSearchCacheManager(Get.find<RecentSearchCacheClient>()));
     Get.put(CachingManager(
       Get.find<MailboxCacheClient>(),
       Get.find<StateCacheClient>(),