TF-2536 Change the logic to get all mailbox

Signed-off-by: dab246 <tdvu@linagora.com>
2024-02-05 16:16:40 +07:00
parent 560bba622c
commit d8bfb83e89
19 changed files with 273 additions and 115 deletions
@@ -11,18 +11,18 @@ import 'package:jmap_dart_client/jmap/core/session/session.dart';
 import 'package:jmap_dart_client/jmap/core/state.dart';
 import 'package:jmap_dart_client/jmap/core/user_name.dart';
 import 'package:jmap_dart_client/jmap/mail/email/email.dart';
+import 'package:jmap_dart_client/jmap/mail/mailbox/get/get_mailbox_response.dart';
 import 'package:jmap_dart_client/jmap/mail/mailbox/mailbox.dart';
 import 'package:tmail_ui_user/features/mailbox/data/model/mailbox_change_response.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/create_new_mailbox_request.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/get_mailbox_by_role_response.dart';
-import 'package:tmail_ui_user/features/mailbox/domain/model/mailbox_response.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/move_mailbox_request.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/rename_mailbox_request.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/subscribe_mailbox_request.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/subscribe_multiple_mailbox_request.dart';

 abstract class MailboxDataSource {
-  Future<MailboxResponse> getAllMailbox(Session session, AccountId accountId, {Properties? properties});
+  Future<GetMailboxResponse> getAllMailbox(Session session, AccountId accountId, {Properties? properties});

  Future<List<Mailbox>> getAllMailboxCache(AccountId accountId, UserName userName);

@@ -54,4 +54,6 @@ abstract class MailboxDataSource {
  Future<void> setRoleDefaultMailbox(Session session, AccountId accountId, List<Mailbox> listMailbox);

  Future<GetMailboxByRoleResponse> getMailboxByRole(Session session, AccountId accountId, Role role);
+
+  Future<void> clearAllMailboxCache(AccountId accountId, UserName userName);
 }
@@ -12,13 +12,13 @@ import 'package:jmap_dart_client/jmap/core/state.dart';
 import 'package:jmap_dart_client/jmap/core/unsigned_int.dart';
 import 'package:jmap_dart_client/jmap/core/user_name.dart';
 import 'package:jmap_dart_client/jmap/mail/email/email.dart';
+import 'package:jmap_dart_client/jmap/mail/mailbox/get/get_mailbox_response.dart';
 import 'package:jmap_dart_client/jmap/mail/mailbox/mailbox.dart';
 import 'package:tmail_ui_user/features/mailbox/data/datasource/mailbox_datasource.dart';
 import 'package:tmail_ui_user/features/mailbox/data/local/mailbox_cache_manager.dart';
 import 'package:tmail_ui_user/features/mailbox/data/model/mailbox_change_response.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/create_new_mailbox_request.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/get_mailbox_by_role_response.dart';
-import 'package:tmail_ui_user/features/mailbox/domain/model/mailbox_response.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/move_mailbox_request.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/rename_mailbox_request.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/subscribe_mailbox_request.dart';
@@ -33,7 +33,7 @@ class MailboxCacheDataSourceImpl extends MailboxDataSource {
  MailboxCacheDataSourceImpl(this._mailboxCacheManager, this._exceptionThrower);

  @override
-  Future<MailboxResponse> getAllMailbox(Session session, AccountId accountId, {Properties? properties}) {
+  Future<GetMailboxResponse> getAllMailbox(Session session, AccountId accountId, {Properties? properties}) {
    throw UnimplementedError();
  }

@@ -111,4 +111,11 @@ class MailboxCacheDataSourceImpl extends MailboxDataSource {
  Future<GetMailboxByRoleResponse> getMailboxByRole(Session session, AccountId accountId, Role role, {UnsignedInt? limit}) {
    throw UnimplementedError();
  }
+
+  @override
+  Future<void> clearAllMailboxCache(AccountId accountId, UserName userName) {
+    return Future.sync(() async {
+      return await _mailboxCacheManager.clearAll(accountId, userName);
+    }).catchError(_exceptionThrower.throwException);
+  }
 }
@@ -12,6 +12,7 @@ import 'package:jmap_dart_client/jmap/core/state.dart';
 import 'package:jmap_dart_client/jmap/core/unsigned_int.dart';
 import 'package:jmap_dart_client/jmap/core/user_name.dart';
 import 'package:jmap_dart_client/jmap/mail/email/email.dart';
+import 'package:jmap_dart_client/jmap/mail/mailbox/get/get_mailbox_response.dart';
 import 'package:jmap_dart_client/jmap/mail/mailbox/mailbox.dart';
 import 'package:tmail_ui_user/features/mailbox/data/datasource/mailbox_datasource.dart';
 import 'package:tmail_ui_user/features/mailbox/data/model/mailbox_change_response.dart';
@@ -19,7 +20,6 @@ import 'package:tmail_ui_user/features/mailbox/data/network/mailbox_api.dart';
 import 'package:tmail_ui_user/features/mailbox/data/network/mailbox_isolate_worker.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/create_new_mailbox_request.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/get_mailbox_by_role_response.dart';
-import 'package:tmail_ui_user/features/mailbox/domain/model/mailbox_response.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/move_mailbox_request.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/rename_mailbox_request.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/subscribe_mailbox_request.dart';
@@ -35,7 +35,7 @@ class MailboxDataSourceImpl extends MailboxDataSource {
  MailboxDataSourceImpl(this.mailboxAPI, this._mailboxIsolateWorker, this._exceptionThrower);

  @override
-  Future<MailboxResponse> getAllMailbox(Session session, AccountId accountId, {Properties? properties}) {
+  Future<GetMailboxResponse> getAllMailbox(Session session, AccountId accountId, {Properties? properties}) {
    return Future.sync(() async {
      return await mailboxAPI.getAllMailbox(session, accountId, properties: properties);
    }).catchError(_exceptionThrower.throwException);
@@ -141,4 +141,9 @@ class MailboxDataSourceImpl extends MailboxDataSource {
      return await mailboxAPI.getMailboxByRole(session, accountId, role);
    }).catchError(_exceptionThrower.throwException);
  }
+
+  @override
+  Future<void> clearAllMailboxCache(AccountId accountId, UserName userName) {
+    throw UnimplementedError();
+  }
 }
@@ -1,10 +1,12 @@

+import 'package:collection/collection.dart';
 import 'package:jmap_dart_client/jmap/account_id.dart';
 import 'package:jmap_dart_client/jmap/core/user_name.dart';
 import 'package:jmap_dart_client/jmap/mail/mailbox/mailbox.dart';
 import 'package:model/extensions/account_id_extensions.dart';
 import 'package:model/mailbox/presentation_mailbox.dart';
 import 'package:tmail_ui_user/features/caching/clients/mailbox_cache_client.dart';
+import 'package:tmail_ui_user/features/caching/utils/cache_utils.dart';
 import 'package:tmail_ui_user/features/mailbox/data/extensions/list_mailbox_cache_extension.dart';
 import 'package:tmail_ui_user/features/mailbox/data/extensions/list_mailbox_extension.dart';
 import 'package:tmail_ui_user/features/mailbox/data/extensions/list_mailbox_id_extension.dart';
@@ -17,7 +19,8 @@ class MailboxCacheManager {
  MailboxCacheManager(this._mailboxCacheClient);

  Future<List<Mailbox>> getAllMailbox(AccountId accountId, UserName userName) async {
-    final mailboxCacheList = await _mailboxCacheClient.getListByTupleKey(accountId.asString, userName.value);
+    final nestedKey = TupleKey(accountId.asString, userName.value).encodeKey;
+    final mailboxCacheList = await _mailboxCacheClient.getListByNestedKey(nestedKey);
    return mailboxCacheList.toMailboxList();
  }

@@ -28,35 +31,35 @@ class MailboxCacheManager {
    List<Mailbox>? created,
    List<MailboxId>? destroyed
  }) async {
-    final mailboxCacheExist = await _mailboxCacheClient.isExistTable();
-    if (mailboxCacheExist) {
-      final updatedCacheMailboxes = updated?.toMapCache(accountId, userName) ?? {};
-      final createdCacheMailboxes = created?.toMapCache(accountId, userName) ?? {};
-      final destroyedCacheMailboxes = destroyed?.toCacheKeyList(accountId, userName) ?? [];
-
-      await Future.wait([
-        _mailboxCacheClient.updateMultipleItem(updatedCacheMailboxes),
-        _mailboxCacheClient.insertMultipleItem(createdCacheMailboxes),
-        _mailboxCacheClient.deleteMultipleItem(destroyedCacheMailboxes)
-      ]);
-    } else {
-      final createdCacheMailboxes = created?.toMapCache(accountId, userName) ?? {};
+    if (created?.isNotEmpty == true) {
+      final createdCacheMailboxes = created!.toMapCache(accountId, userName);
      await _mailboxCacheClient.insertMultipleItem(createdCacheMailboxes);
    }
-    return Future.value();
+
+    if (updated?.isNotEmpty == true) {
+      final updatedCacheMailboxes = updated!.toMapCache(accountId, userName);
+      await _mailboxCacheClient.updateMultipleItem(updatedCacheMailboxes);
+    }
+
+    final mailboxCacheExist = await _mailboxCacheClient.isExistTable();
+    if (destroyed?.isNotEmpty == true && mailboxCacheExist) {
+      final destroyedCacheMailboxes = destroyed!.toCacheKeyList(accountId, userName);
+      await _mailboxCacheClient.deleteMultipleItem(destroyedCacheMailboxes);
+    }
  }

  Future<Mailbox> getSpamMailbox(AccountId accountId, UserName userName) async {
-    final mailboxCachedList = await _mailboxCacheClient.getListByTupleKey(accountId.asString, userName.value);
-    final listSpamMailboxCached = mailboxCachedList
-      .toMailboxList()
-      .where((mailbox) => mailbox.role == PresentationMailbox.roleSpam)
-      .toList();
-
-    if (listSpamMailboxCached.isNotEmpty) {
-      return listSpamMailboxCached.first;
+    final mailboxList = await getAllMailbox(accountId, userName);
+    final spamMailbox = mailboxList.firstWhereOrNull((mailbox) => mailbox.role == PresentationMailbox.roleSpam);
+    if (spamMailbox != null) {
+      return spamMailbox;
    } else {
      throw NotFoundSpamMailboxCachedException();
    }
  }
+
+  Future<void> clearAll(AccountId accountId, UserName userName) async {
+    final nestedKey = TupleKey(accountId.asString, userName.value).encodeKey;
+    await _mailboxCacheClient.clearAllDataContainKey(nestedKey);
+  }
 }
@@ -30,12 +30,12 @@ import 'package:model/model.dart';
 import 'package:tmail_ui_user/features/base/mixin/handle_error_mixin.dart';
 import 'package:tmail_ui_user/features/composer/domain/exceptions/set_method_exception.dart';
 import 'package:tmail_ui_user/features/mailbox/data/model/mailbox_change_response.dart';
+import 'package:tmail_ui_user/features/mailbox/domain/exceptions/mailbox_exception.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/exceptions/set_mailbox_method_exception.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/extensions/list_mailbox_id_extension.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/extensions/role_extension.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/create_new_mailbox_request.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/get_mailbox_by_role_response.dart';
-import 'package:tmail_ui_user/features/mailbox/domain/model/mailbox_response.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/mailbox_subscribe_state.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/move_mailbox_request.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/rename_mailbox_request.dart';
@@ -51,7 +51,7 @@ class MailboxAPI with HandleSetErrorMixin {

  MailboxAPI(this.httpClient, this._uuid);

-  Future<MailboxResponse> getAllMailbox(Session session, AccountId accountId, {Properties? properties}) async {
+  Future<GetMailboxResponse> getAllMailbox(Session session, AccountId accountId, {Properties? properties}) async {
    final processingInvocation = ProcessingInvocation();

    final jmapRequestBuilder = JmapRequestBuilder(httpClient, processingInvocation);
@@ -70,11 +70,15 @@ class MailboxAPI with HandleSetErrorMixin {
      .build()
      .execute();

-    final resultCreated = result.parse<GetMailboxResponse>(
+    final getMailboxResponse = result.parse<GetMailboxResponse>(
      queryInvocation.methodCallId,
      GetMailboxResponse.deserialize);

-    return MailboxResponse(mailboxes: resultCreated?.list, state: resultCreated?.state);
+    if (getMailboxResponse == null) {
+      throw NotFoundGetMailboxResponseException();
+    } else {
+      return getMailboxResponse;
+    }
  }

  Future<MailboxChangeResponse> getChanges(Session session, AccountId accountId, State sinceState, {Properties? properties}) async {
@@ -12,6 +12,7 @@ import 'package:jmap_dart_client/jmap/core/properties/properties.dart';
 import 'package:jmap_dart_client/jmap/core/session/session.dart';
 import 'package:jmap_dart_client/jmap/core/state.dart';
 import 'package:jmap_dart_client/jmap/core/unsigned_int.dart';
+import 'package:jmap_dart_client/jmap/core/user_name.dart';
 import 'package:jmap_dart_client/jmap/mail/email/email.dart';
 import 'package:jmap_dart_client/jmap/mail/mailbox/mailbox.dart';
 import 'package:model/extensions/list_mailbox_extension.dart';
@@ -20,10 +21,13 @@ import 'package:tmail_ui_user/features/mailbox/data/datasource/mailbox_datasourc
 import 'package:tmail_ui_user/features/mailbox/data/datasource/state_datasource.dart';
 import 'package:tmail_ui_user/features/mailbox/data/extensions/state_extension.dart';
 import 'package:tmail_ui_user/features/mailbox/data/model/state_type.dart';
+import 'package:tmail_ui_user/features/mailbox/domain/model/cache_mailbox_response.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/create_new_mailbox_request.dart';
+import 'package:tmail_ui_user/features/mailbox/domain/model/full_mailbox_response.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/get_mailbox_by_role_response.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/mailbox_response.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/move_mailbox_request.dart';
+import 'package:tmail_ui_user/features/mailbox/domain/model/partial_mailbox_response.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/rename_mailbox_request.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/subscribe_mailbox_request.dart';
 import 'package:tmail_ui_user/features/mailbox/domain/model/subscribe_multiple_mailbox_request.dart';
@@ -41,59 +45,151 @@ class MailboxRepositoryImpl extends MailboxRepository {

  @override
  Stream<MailboxResponse> getAllMailbox(Session session, AccountId accountId, {Properties? properties}) async* {
-    final localMailboxResponse = await Future.wait([
-      mapDataSource[DataSourceType.local]!.getAllMailboxCache(accountId, session.username),
-      stateDataSource.getState(accountId, session.username, StateType.mailbox)
-    ]).then((List response) {
-      return MailboxResponse(mailboxes: response.first, state: response.last);
-    });
-
-    yield localMailboxResponse;
-
-    if (localMailboxResponse.hasData()) {
-      bool hasMoreChanges = true;
-      State? sinceState = localMailboxResponse.state!;
-
-      while(hasMoreChanges && sinceState != null) {
-        final changesResponse = await mapDataSource[DataSourceType.network]!.getChanges(session, accountId, sinceState, properties: properties);
-
-        hasMoreChanges = changesResponse.hasMoreChanges;
-        sinceState = changesResponse.newStateChanges;
-
-        final newMailboxUpdated = await _combineMailboxCache(
-            mailboxUpdatedList: changesResponse.updated,
-            updatedProperties: changesResponse.updatedProperties,
-            mailboxCacheList: localMailboxResponse.mailboxes!);
-
-        await Future.wait([
-          mapDataSource[DataSourceType.local]!.update(
-              accountId,
-              session.username,
-              updated: newMailboxUpdated,
-              created: changesResponse.created,
-              destroyed: changesResponse.destroyed),
-          if (changesResponse.newStateMailbox != null)
-            stateDataSource.saveState(accountId, session.username, changesResponse.newStateMailbox!.toStateCache(StateType.mailbox)),
-        ]);
-      }
-    } else {
-      final mailboxResponse = await mapDataSource[DataSourceType.network]!.getAllMailbox(session, accountId);
-
-      await Future.wait([
-        mapDataSource[DataSourceType.local]!.update(accountId, session.username, created: mailboxResponse.mailboxes),
-        if (mailboxResponse.state != null)
-          stateDataSource.saveState(accountId, session.username, mailboxResponse.state!.toStateCache(StateType.mailbox)),
-      ]);
+    CacheMailboxResponse? cacheMailboxResponse = await _getAllMailboxFromCache(accountId, session.username);
+    if (cacheMailboxResponse != null) {
+      yield cacheMailboxResponse;
    }

-    final newMailboxResponse = await Future.wait([
-      mapDataSource[DataSourceType.local]!.getAllMailboxCache(accountId, session.username),
-      stateDataSource.getState(accountId, session.username, StateType.mailbox)
-    ]).then((List response) {
-      return MailboxResponse(mailboxes: response.first, state: response.last);
-    });
+    final newMailboxResponse = await _getAllMailboxFromJMAP(accountId, session);
+    if (newMailboxResponse == null) {
+      return;
+    }

-    yield newMailboxResponse;
+    if (newMailboxResponse is FullMailboxResponse) {
+      await _syncNewInCache(
+        accountId,
+        session.username,
+        newMailboxResponse.mailboxes,
+        newMailboxResponse.state!);
+
+      yield newMailboxResponse;
+    } else if (newMailboxResponse is PartialMailboxResponse) {
+      await _syncUpdateInCache(
+        accountId,
+        session.username,
+        newMailboxResponse.mailboxes,
+        newMailboxResponse.state!);
+
+      cacheMailboxResponse = await _getAllMailboxFromCache(accountId, session.username);
+      if (cacheMailboxResponse != null) {
+        yield cacheMailboxResponse;
+      } else {
+        yield newMailboxResponse;
+      }
+    }
+  }
+
+  Future<CacheMailboxResponse?> _getAllMailboxFromCache(AccountId accountId, UserName userName) async {
+    try {
+      final cacheMailboxResponse = await Future.wait([
+        mapDataSource[DataSourceType.local]!.getAllMailboxCache(accountId, userName),
+        stateDataSource.getState(accountId, userName, StateType.mailbox)
+      ], eagerError: true).then((List response) => CacheMailboxResponse(mailboxes: response.first, state: response.last));
+      log('MailboxRepositoryImpl::_getAllMailboxFromCache: MAILBOX_CACHED = ${cacheMailboxResponse.mailboxes.length} | STATE_CACHED = ${cacheMailboxResponse.state?.value}');
+      return cacheMailboxResponse;
+    } catch (e) {
+      logError('MailboxRepositoryImpl::_getAllMailboxFromCache: Exception: $e');
+      return null;
+    }
+  }
+
+  Future<MailboxResponse?> _getAllMailboxFromJMAP(
+    AccountId accountId,
+    Session session,
+    {Properties? properties}
+  ) async {
+    try {
+      final getMailboxResponse = await mapDataSource[DataSourceType.network]!.getAllMailbox(
+        session,
+        accountId,
+        properties: properties);
+      log('MailboxRepositoryImpl::_getAllMailboxFromJMAP: MAILBOX_NETWORK = ${getMailboxResponse.list.length} | STATE_NETWORK = ${getMailboxResponse.state.value}');
+      if (getMailboxResponse.notFound?.isNotEmpty == true) {
+        return PartialMailboxResponse(
+          mailboxNotFound: getMailboxResponse.notFound!,
+          mailboxes: getMailboxResponse.list,
+          state: getMailboxResponse.state);
+      } else {
+        return FullMailboxResponse(
+          mailboxes: getMailboxResponse.list,
+          state: getMailboxResponse.state);
+      }
+    } catch (e) {
+      logError('MailboxRepositoryImpl::_getAllMailboxFromJMAP: Exception: $e');
+      return null;
+    }
+  }
+
+  Future<void> _syncNewInCache(
+    AccountId accountId,
+    UserName userName,
+    List<Mailbox> newMailboxes,
+    State newState,
+  ) async {
+    await Future.wait([
+      _syncNewMailboxesInCache(accountId, userName, newMailboxes),
+      _syncNewMailboxStateInCache(accountId, userName, newState)
+    ]);
+  }
+
+  Future<void> _syncNewMailboxesInCache(
+    AccountId accountId,
+    UserName userName,
+    List<Mailbox> newMailboxes
+  ) async {
+    try {
+      await mapDataSource[DataSourceType.local]!.clearAllMailboxCache(
+        accountId,
+        userName);
+      await mapDataSource[DataSourceType.local]!.update(
+        accountId,
+        userName,
+        created: newMailboxes);
+    } catch (e) {
+      logError('MailboxRepositoryImpl::_syncNewMailboxesInCache: Exception = $e');
+    }
+  }
+
+  Future<void> _syncNewMailboxStateInCache(
+    AccountId accountId,
+    UserName userName,
+    State newState
+  ) async {
+    try {
+      await stateDataSource.saveState(
+        accountId,
+        userName,
+        newState.toStateCache(StateType.mailbox));
+    } catch (e) {
+      logError('MailboxRepositoryImpl::_syncNewMailboxStateInCache: Exception = $e');
+    }
+  }
+
+  Future<void> _syncUpdateInCache(
+    AccountId accountId,
+    UserName userName,
+    List<Mailbox> newMailboxes,
+    State newState,
+  ) async {
+    await Future.wait([
+      _syncUpdateMailboxesInCache(accountId, userName, newMailboxes),
+      _syncNewMailboxStateInCache(accountId, userName, newState)
+    ]);
+  }
+
+  Future<void> _syncUpdateMailboxesInCache(
+    AccountId accountId,
+    UserName userName,
+    List<Mailbox> newMailboxes
+  ) async {
+    try {
+      await mapDataSource[DataSourceType.local]!.update(
+        accountId,
+        userName,
+        updated: newMailboxes);
+    } catch (e) {
+      logError('MailboxRepositoryImpl::_syncUpdateMailboxesInCache: Exception = $e');
+    }
  }

  Future<List<Mailbox>?> _combineMailboxCache({
@@ -156,7 +252,7 @@ class MailboxRepositoryImpl extends MailboxRepository {
      mapDataSource[DataSourceType.local]!.getAllMailboxCache(accountId, session.username),
      stateDataSource.getState(accountId, session.username, StateType.mailbox)
    ]).then((List response) {
-      return MailboxResponse(mailboxes: response.first, state: response.last);
+      return CacheMailboxResponse(mailboxes: response.first, state: response.last);
    });

    yield newMailboxResponse;