TF-145 Add domain layer for getAllEmail in Caching

lib/features/thread/domain/constants/thread_constants.dart

@@ -1,5 +1,27 @@
+import 'package:jmap_dart_client/jmap/core/properties/properties.dart';
 import 'package:jmap_dart_client/jmap/core/unsigned_int.dart';
+import 'package:model/email/email_property.dart';
 
 class ThreadConstants {
   static final defaultLimit = UnsignedInt(20);
+  static final propertiesDefault = Properties({
+    EmailProperty.id,
+    EmailProperty.subject,
+    EmailProperty.from,
+    EmailProperty.to,
+    EmailProperty.cc,
+    EmailProperty.bcc,
+    EmailProperty.keywords,
+    EmailProperty.size,
+    EmailProperty.receivedAt,
+    EmailProperty.sentAt,
+    EmailProperty.preview,
+    EmailProperty.hasAttachment,
+    EmailProperty.replyTo,
+    EmailProperty.mailboxIds,
+  });
+  static final propertiesUpdatedDefault = Properties({
+    EmailProperty.keywords,
+    EmailProperty.mailboxIds,
+  });
 }

lib/features/thread/domain/model/email_response.dart

@@ -0,0 +1,21 @@
+
+import 'package:equatable/equatable.dart';
+import 'package:jmap_dart_client/jmap/core/state.dart';
+import 'package:jmap_dart_client/jmap/mail/email/email.dart';
+
+class EmailResponse with EquatableMixin {
+  final List<Email>? emailList;
+  final State? state;
+
+  EmailResponse({
+    this.emailList,
+    this.state
+  });
+
+  bool hasEmails() => emailList != null && emailList!.isNotEmpty;
+
+  bool hasState() => state != null;
+
+  @override
+  List<Object?> get props => [emailList, state];
+}

lib/features/thread/domain/repository/thread_repository.dart

@@ -3,17 +3,20 @@ import 'package:jmap_dart_client/jmap/core/filter/filter.dart';
 import 'package:jmap_dart_client/jmap/core/properties/properties.dart';
 import 'package:jmap_dart_client/jmap/core/sort/comparator.dart';
 import 'package:jmap_dart_client/jmap/core/unsigned_int.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/thread/domain/model/email_response.dart';
 
 abstract class ThreadRepository {
-  Future<List<Email>> getAllEmail(
+  Stream<EmailResponse> getAllEmail(
     AccountId accountId,
     {
       int? position,
       UnsignedInt? limit,
       Set<Comparator>? sort,
       Filter? filter,
-      Properties? properties
+      Properties? propertiesCreated,
+      Properties? propertiesUpdated,
+      MailboxId? inMailboxId
     }
   );
 }

lib/features/thread/domain/state/get_all_email_state.dart

@@ -1,13 +1,15 @@
 import 'package:core/core.dart';
+import 'package:jmap_dart_client/jmap/core/state.dart';
 import 'package:model/model.dart';
 
 class GetAllEmailSuccess extends UIState {
   final List<PresentationEmail> emailList;
+  final State? currentEmailState;
 
-  GetAllEmailSuccess(this.emailList);
+  GetAllEmailSuccess({required this.emailList, this.currentEmailState});
 
   @override
-  List<Object> get props => [emailList];
+  List<Object?> get props => [emailList, currentEmailState];
 }
 
 class GetAllEmailFailure extends FeatureFailure {

lib/features/thread/domain/usecases/get_emails_in_mailbox_interactor.dart

@@ -1,13 +1,15 @@
 import 'package:core/core.dart';
-import 'package:model/model.dart';
 import 'package:dartz/dartz.dart';
 import 'package:jmap_dart_client/jmap/account_id.dart';
 import 'package:jmap_dart_client/jmap/core/filter/filter.dart';
 import 'package:jmap_dart_client/jmap/core/properties/properties.dart';
 import 'package:jmap_dart_client/jmap/core/sort/comparator.dart';
 import 'package:jmap_dart_client/jmap/core/unsigned_int.dart';
+import 'package:jmap_dart_client/jmap/mail/mailbox/mailbox.dart';
+import 'package:tmail_ui_user/features/thread/domain/model/email_response.dart';
 import 'package:tmail_ui_user/features/thread/domain/repository/thread_repository.dart';
 import 'package:tmail_ui_user/features/thread/domain/state/get_all_email_state.dart';
+import 'package:model/model.dart';
 
 class GetEmailsInMailboxInteractor {
   final ThreadRepository threadRepository;
@@ -21,23 +23,36 @@ class GetEmailsInMailboxInteractor {
       UnsignedInt? limit,
       Set<Comparator>? sort,
       Filter? filter,
-      Properties? properties
+      Properties? propertiesCreated,
+      Properties? propertiesUpdated,
+      MailboxId? inMailboxId
     }
   ) async* {
     try {
       yield Right<Failure, Success>(LoadingState());
-      final emailList = await threadRepository.getAllEmail(
+
-        accountId,
+      yield* threadRepository
-        position: position,
+        .getAllEmail(
-        limit: limit,
+          accountId,
-        sort: sort,
+          position: position,
-        filter: filter,
+          limit: limit,
-        properties: properties
+          sort: sort,
-      );
+          filter: filter,
-      final presentationEmailList = emailList.map((email) => email.toPresentationEmail()).toList();
+          propertiesCreated: propertiesCreated,
-      yield Right<Failure, Success>(GetAllEmailSuccess(presentationEmailList));
+          propertiesUpdated: propertiesUpdated,
+          inMailboxId: inMailboxId)
+        .map(_toGetEmailState);
     } catch (e) {
       yield Left(GetAllEmailFailure(e));
     }
   }
+
+  Either<Failure, Success> _toGetEmailState(EmailResponse emailResponse) {
+    final presentationEmailList = emailResponse.emailList
+      ?.map((email) => email.toPresentationEmail()).toList() ?? List.empty();
+
+    return Right<Failure, Success>(GetAllEmailSuccess(
+      emailList: presentationEmailList,
+      currentEmailState: emailResponse.state));
+  }
 }

model/lib/email/email_property.dart

@@ -0,0 +1,17 @@
+
+class EmailProperty {
+  static const String id = 'id';
+  static const String keywords = 'keywords';
+  static const String size = 'size';
+  static const String receivedAt = 'receivedAt';
+  static const String hasAttachment = 'hasAttachment';
+  static const String preview = 'preview';
+  static const String subject = 'subject';
+  static const String sentAt = 'sentAt';
+  static const String from = 'from';
+  static const String to = 'to';
+  static const String cc = 'cc';
+  static const String bcc = 'bcc';
+  static const String replyTo = 'replyTo';
+  static const String mailboxIds = 'mailboxIds';
+}

model/lib/extensions/email_extension.dart

@@ -1,6 +1,8 @@
 
+import 'package:jmap_dart_client/jmap/core/properties/properties.dart';
 import 'package:jmap_dart_client/jmap/mail/email/email.dart';
 import 'package:jmap_dart_client/jmap/mail/email/keyword_identifier.dart';
+import 'package:model/email/email_property.dart';
 import 'package:model/model.dart';
 
 extension EmailExtension on Email {
@@ -65,4 +67,23 @@ extension EmailExtension on Email {
       selectMode: selectMode
     );
   }
+
+  Email combineEmail(Email newEmail, Properties updatedProperties) {
+    return Email(
+      newEmail.id,
+      keywords: updatedProperties.contain(EmailProperty.keywords) ? newEmail.keywords : keywords,
+      size: updatedProperties.contain(EmailProperty.size) ? newEmail.size : size,
+      receivedAt: updatedProperties.contain(EmailProperty.receivedAt) ? newEmail.receivedAt : receivedAt,
+      hasAttachment: updatedProperties.contain(EmailProperty.hasAttachment) ? newEmail.hasAttachment : hasAttachment,
+      preview: updatedProperties.contain(EmailProperty.preview) ? newEmail.preview : preview,
+      subject: updatedProperties.contain(EmailProperty.subject) ? newEmail.subject : subject,
+      sentAt: updatedProperties.contain(EmailProperty.sentAt) ? newEmail.sentAt : sentAt,
+      from: updatedProperties.contain(EmailProperty.from) ? newEmail.from : from,
+      to: updatedProperties.contain(EmailProperty.to) ? newEmail.to : to,
+      cc: updatedProperties.contain(EmailProperty.cc) ? newEmail.cc : cc,
+      bcc: updatedProperties.contain(EmailProperty.bcc) ? newEmail.bcc : bcc,
+      replyTo: updatedProperties.contain(EmailProperty.replyTo) ? newEmail.replyTo : replyTo,
+      mailboxIds: updatedProperties.contain(EmailProperty.mailboxIds) ? newEmail.mailboxIds : mailboxIds,
+    );
+  }
 }

model/lib/extensions/list_email_extension.dart

@@ -0,0 +1,35 @@
+
+import 'package:jmap_dart_client/jmap/mail/email/email.dart';
+import 'package:jmap_dart_client/jmap/core/sort/comparator.dart';
+import 'package:jmap_dart_client/jmap/mail/email/email_comparator_property.dart';
+import 'package:jmap_dart_client/jmap/core/extensions/utc_date_extension.dart';
+import 'package:jmap_dart_client/jmap/core/extensions/string_extension.dart';
+import 'package:jmap_dart_client/jmap/core/extensions/unsigned_int_extension.dart';
+
+extension ListEmailExtension on List<Email> {
+
+  Email? findEmail(EmailId emailId) {
+    try {
+      return firstWhere((email) => email.id == emailId);
+    } catch (e) {
+      return null;
+    }
+  }
+
+  void sortBy(Comparator comparator) {
+    sort((email1, email2) {
+      if (comparator.property == EmailComparatorProperty.sentAt
+          || comparator.property == EmailComparatorProperty.receivedAt) {
+        final emailTime1 = email1.sentAt ?? email1.receivedAt;
+        final emailTime2 = email2.sentAt ?? email2.receivedAt;
+        return emailTime1.compareToSort(emailTime2, comparator.isAscending);
+      } if (comparator.property == EmailComparatorProperty.subject) {
+        return email1.subject.compareToSort(email2.subject, comparator.isAscending);
+      } if (comparator.property == EmailComparatorProperty.size) {
+        return email1.size.compareToSort(email2.size, comparator.isAscending);
+      } else {
+        return 0;
+      }
+    });
+  }
+}

model/lib/extensions/list_extension.dart

@@ -0,0 +1,10 @@
+
+extension ListExtension<T> on List<T>? {
+
+  List<T>? union(List<T>? other) {
+    if (other != null) {
+      this?.addAll(other);
+    }
+    return this;
+  }
+}

model/lib/model.dart

@@ -27,6 +27,7 @@ export 'email/read_actions.dart';
 export 'email/attachment.dart';
 export 'email/move_action.dart';
 export 'email/mark_star_action.dart';
+export 'email/email_property.dart';
 
 // Extensions
 export 'extensions/email_address_extension.dart';
@@ -46,6 +47,8 @@ export 'extensions/mailbox_extension.dart';
 export 'extensions/mailbox_name_extension.dart';
 export 'extensions/properties_extension.dart';
 export 'extensions/list_mailbox_extension.dart';
+export 'extensions/list_extension.dart';
+export 'extensions/list_email_extension.dart';
 
 // Download
 export 'download/download_task_id.dart';