TF-4195 Add interactor/repository/datasource to feature add a Label to an email

labels/lib/converter/keyword_identifier_nullable_converter.dart

@@ -0,0 +1,14 @@
+import 'package:jmap_dart_client/jmap/mail/email/keyword_identifier.dart';
+import 'package:json_annotation/json_annotation.dart';
+
+class KeywordIdentifierNullableConverter
+    implements JsonConverter<KeyWordIdentifier?, String?> {
+  const KeywordIdentifierNullableConverter();
+
+  @override
+  KeyWordIdentifier? fromJson(String? json) =>
+      json != null ? KeyWordIdentifier(json) : null;
+
+  @override
+  String? toJson(KeyWordIdentifier? object) => object?.value;
+}

labels/lib/extensions/label_extension.dart

@@ -2,6 +2,7 @@ import 'package:core/presentation/extensions/color_extension.dart';
 import 'package:core/presentation/extensions/hex_color_extension.dart';
 import 'package:flutter/material.dart';
 import 'package:jmap_dart_client/jmap/core/id.dart';
+import 'package:jmap_dart_client/jmap/mail/email/keyword_identifier.dart';
 import 'package:labels/model/hex_color.dart';
 import 'package:labels/model/label.dart';
 
@@ -28,7 +29,7 @@ extension LabelExtension on Label {
 
   Label copyWith({
     Id? id,
-    String? keyword,
+    KeyWordIdentifier? keyword,
     String? displayName,
     HexColor? color,
   }) {

labels/lib/model/label.dart

@@ -1,8 +1,10 @@
 import 'package:equatable/equatable.dart';
 import 'package:jmap_dart_client/http/converter/id_converter.dart';
 import 'package:jmap_dart_client/jmap/core/id.dart';
+import 'package:jmap_dart_client/jmap/mail/email/keyword_identifier.dart';
 import 'package:json_annotation/json_annotation.dart';
 import 'package:labels/converter/hex_color_nullable_converter.dart';
+import 'package:labels/converter/keyword_identifier_nullable_converter.dart';
 import 'package:labels/model/hex_color.dart';
 
 part 'label.g.dart';
@@ -13,11 +15,12 @@ part 'label.g.dart';
   converters: [
     IdConverter(),
     HexColorNullableConverter(),
+    KeywordIdentifierNullableConverter(),
   ],
 )
 class Label with EquatableMixin {
   final Id? id;
-  final String? keyword;
+  final KeyWordIdentifier? keyword;
   final String? displayName;
   final HexColor? color;
 

labels/test/method/get/get_label_method_test.dart

@@ -3,6 +3,7 @@ import 'package:flutter_test/flutter_test.dart';
 import 'package:http_mock_adapter/http_mock_adapter.dart';
 import 'package:jmap_dart_client/jmap/account_id.dart';
 import 'package:jmap_dart_client/jmap/core/id.dart';
+import 'package:jmap_dart_client/jmap/mail/email/keyword_identifier.dart';
 import 'package:labels/labels.dart';
 
 import '../method_fixtures.dart';
@@ -41,13 +42,13 @@ void main() {
 
       final labelA = Label(
         id: Id('A'),
-        keyword: 'labelA',
+        keyword: KeyWordIdentifier('labelA'),
         displayName: 'Label A',
         color: HexColor('#111111'),
       );
       final labelB = Label(
         id: Id('B'),
-        keyword: 'labelB',
+        keyword: KeyWordIdentifier('labelB'),
         displayName: 'Label B',
         color: HexColor('#222222'),
       );

lib/features/email/data/datasource/email_datasource.dart

@@ -11,6 +11,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/user_name.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/account/account_request.dart';
 import 'package:model/email/attachment.dart';
 import 'package:model/email/mark_star_action.dart';
@@ -203,4 +204,10 @@ abstract class EmailDataSource {
   );
 
   Future<String> generateEntireMessageAsDocument(ViewEntireMessageRequest entireMessageRequest);
+
+  Future<void> addLabelToEmail(
+    AccountId accountId,
+    EmailId emailId,
+    KeyWordIdentifier labelKeyword,
+  );
 }

lib/features/email/data/datasource_impl/email_datasource_impl.dart

@@ -22,6 +22,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/user_name.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/model.dart';
 import 'package:tmail_ui_user/features/composer/domain/model/email_request.dart';
 import 'package:tmail_ui_user/features/email/data/datasource/email_datasource.dart';
@@ -552,4 +553,15 @@ class EmailDataSourceImpl extends EmailDataSource {
   Future<String> generateEntireMessageAsDocument(ViewEntireMessageRequest entireMessageRequest) {
     throw UnimplementedError();
   }
+
+  @override
+  Future<void> addLabelToEmail(
+    AccountId accountId,
+    EmailId emailId,
+    KeyWordIdentifier labelKeyword,
+  ) {
+    return Future.sync(() async {
+      return await emailAPI.addLabelToEmail(accountId, emailId, labelKeyword);
+    }).catchError(_exceptionThrower.throwException);
+  }
 }

lib/features/email/data/datasource_impl/email_hive_cache_datasource_impl.dart

@@ -575,4 +575,9 @@ class EmailHiveCacheDataSourceImpl extends EmailDataSource {
   Future<String> generateEntireMessageAsDocument(ViewEntireMessageRequest entireMessageRequest) {
     throw UnimplementedError();
   }
+
+  @override
+  Future<void> addLabelToEmail(AccountId accountId, EmailId emailId, KeyWordIdentifier labelKeyword) {
+    throw UnimplementedError();
+  }
 }

lib/features/email/data/datasource_impl/email_local_storage_datasource_impl.dart

@@ -21,6 +21,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/user_name.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/account/account_request.dart';
 import 'package:model/email/attachment.dart';
 import 'package:model/email/mark_star_action.dart';
@@ -350,4 +351,9 @@ class EmailLocalStorageDataSourceImpl extends EmailDataSource {
   }) {
     throw UnimplementedError();
   }
+
+  @override
+  Future<void> addLabelToEmail(AccountId accountId, EmailId emailId, KeyWordIdentifier labelKeyword) {
+    throw UnimplementedError();
+  }
 }

lib/features/email/data/datasource_impl/email_session_storage_datasource_impl.dart

@@ -13,6 +13,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/user_name.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/account/account_request.dart';
 import 'package:model/email/attachment.dart';
 import 'package:model/email/mark_star_action.dart';
@@ -264,4 +265,9 @@ class EmailSessionStorageDatasourceImpl extends EmailDataSource {
   }) {
     throw UnimplementedError();
   }
+
+  @override
+  Future<void> addLabelToEmail(AccountId accountId, EmailId emailId, KeyWordIdentifier labelKeyword) {
+    throw UnimplementedError();
+  }
 }

lib/features/email/data/network/email_api.dart

@@ -936,4 +936,30 @@ class EmailAPI with HandleSetErrorMixin, MailAPIMixin {
       throw NotParsableBlobIdToEmailException();
     }
   }
+
+  Future<void> addLabelToEmail(
+    AccountId accountId,
+    EmailId emailId,
+    KeyWordIdentifier labelKeyword,
+  ) async {
+    final method = SetEmailMethod(accountId)
+      ..addUpdates({emailId.id: labelKeyword.generateLabelActionPath()});
+
+    final builder = JmapRequestBuilder(_httpClient, ProcessingInvocation());
+    final invocation = builder.invocation(method);
+
+    final result =
+        await (builder..usings(method.requiredCapabilities)).build().execute();
+
+    final response = result.parse<SetEmailResponse>(
+      invocation.methodCallId,
+      SetEmailResponse.deserialize,
+    );
+
+    final emailIdsUpdated = response?.updated?.keys ?? <Id>[];
+
+    if (emailIdsUpdated.isEmpty || !emailIdsUpdated.contains(emailId.id)) {
+      throw parseErrorForSetResponse(response, emailId.id);
+    }
+  }
 }

lib/features/email/data/repository/email_repository_impl.dart

@@ -13,6 +13,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' as jmap;
 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_content.dart';
 import 'package:model/email/mark_star_action.dart';
 import 'package:model/email/read_actions.dart';
@@ -479,4 +480,17 @@ class EmailRepositoryImpl extends EmailRepository {
   Future<String> generateEntireMessageAsDocument(ViewEntireMessageRequest entireMessageRequest) {
     return emailDataSource[DataSourceType.local]!.generateEntireMessageAsDocument(entireMessageRequest);
   }
+
+  @override
+  Future<void> addLabelToEmail(
+    AccountId accountId,
+    EmailId emailId,
+    KeyWordIdentifier labelKeyword,
+  ) {
+    return emailDataSource[DataSourceType.network]!.addLabelToEmail(
+      accountId,
+      emailId,
+      labelKeyword,
+    );
+  }
 }

lib/features/email/domain/repository/email_repository.dart

@@ -11,6 +11,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' as jmap;
 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_content.dart';
 import 'package:model/email/mark_star_action.dart';
 import 'package:model/email/read_actions.dart';
@@ -160,4 +161,10 @@ abstract class EmailRepository {
   Future<void> printEmail(EmailPrint emailPrint);
 
   Future<String> generateEntireMessageAsDocument(ViewEntireMessageRequest entireMessageRequest);
+
+  Future<void> addLabelToEmail(
+    AccountId accountId,
+    EmailId emailId,
+    KeyWordIdentifier labelKeyword,
+  );
 }

lib/features/email/domain/state/add_a_label_to_an_email_state.dart

@@ -0,0 +1,29 @@
+import 'package:core/presentation/state/failure.dart';
+import 'package:core/presentation/state/success.dart';
+import 'package:jmap_dart_client/jmap/mail/email/email.dart';
+import 'package:jmap_dart_client/jmap/mail/email/keyword_identifier.dart';
+
+class AddingALabelToAnEmail extends LoadingState {}
+
+class AddALabelToAnEmailSuccess extends UIState {
+  final EmailId emailId;
+  final KeyWordIdentifier labelKeyword;
+  final String labelDisplay;
+
+  AddALabelToAnEmailSuccess(this.emailId, this.labelKeyword, this.labelDisplay);
+
+  @override
+  List<Object> get props => [emailId, labelKeyword, labelDisplay];
+}
+
+class AddALabelToAnEmailFailure extends FeatureFailure {
+  final String labelDisplay;
+
+  AddALabelToAnEmailFailure({
+    dynamic exception,
+    required this.labelDisplay,
+  }) : super(exception: exception);
+
+  @override
+  List<Object?> get props => [...super.props, labelDisplay];
+}

lib/features/email/domain/usecases/add_a_label_to_an_email_interactor.dart

@@ -0,0 +1,40 @@
+import 'package:core/presentation/state/failure.dart';
+import 'package:core/presentation/state/success.dart';
+import 'package:dartz/dartz.dart';
+import 'package:jmap_dart_client/jmap/account_id.dart';
+import 'package:jmap_dart_client/jmap/mail/email/email.dart';
+import 'package:jmap_dart_client/jmap/mail/email/keyword_identifier.dart';
+import 'package:tmail_ui_user/features/email/domain/repository/email_repository.dart';
+import 'package:tmail_ui_user/features/email/domain/state/add_a_label_to_an_email_state.dart';
+
+class AddALabelToAnEmailInteractor {
+  final EmailRepository _emailRepository;
+
+  AddALabelToAnEmailInteractor(this._emailRepository);
+
+  Stream<Either<Failure, Success>> execute(
+    AccountId accountId,
+    EmailId emailId,
+    KeyWordIdentifier labelKeyword,
+    String labelDisplay,
+  ) async* {
+    try {
+      yield Right(AddingALabelToAnEmail());
+      await _emailRepository.addLabelToEmail(
+        accountId,
+        emailId,
+        labelKeyword,
+      );
+      yield Right(AddALabelToAnEmailSuccess(
+        emailId,
+        labelKeyword,
+        labelDisplay,
+      ));
+    } catch (e) {
+      yield Left(AddALabelToAnEmailFailure(
+        exception: e,
+        labelDisplay: labelDisplay,
+      ));
+    }
+  }
+}

lib/features/email/presentation/bindings/email_interactor_bindings.dart

@@ -16,6 +16,7 @@ import 'package:tmail_ui_user/features/email/data/local/html_analyzer.dart';
 import 'package:tmail_ui_user/features/email/data/network/email_api.dart';
 import 'package:tmail_ui_user/features/email/data/repository/email_repository_impl.dart';
 import 'package:tmail_ui_user/features/email/domain/repository/email_repository.dart';
+import 'package:tmail_ui_user/features/email/domain/usecases/add_a_label_to_an_email_interactor.dart';
 import 'package:tmail_ui_user/features/email/domain/usecases/get_email_content_interactor.dart';
 import 'package:tmail_ui_user/features/email/domain/usecases/get_entire_message_as_document_interactor.dart';
 import 'package:tmail_ui_user/features/email/domain/usecases/get_stored_email_state_interactor.dart';
@@ -117,6 +118,9 @@ class EmailInteractorBindings extends InteractorsBindings {
         Get.find<EmailRepository>(),
       ));
     }
+    Get.lazyPut(
+      () => AddALabelToAnEmailInteractor(Get.find<EmailRepository>()),
+    );
   }
 
   @override

lib/features/email/presentation/extensions/presentation_email_extension.dart

@@ -4,7 +4,6 @@ import 'package:model/email/email_action_type.dart';
 import 'package:model/email/presentation_email.dart';
 import 'package:model/extensions/list_email_address_extension.dart';
 import 'package:tmail_ui_user/features/email/presentation/utils/email_utils.dart';
-import 'package:tmail_ui_user/features/thread/data/extensions/list_keyword_identifier_extension.dart';
 import 'package:tmail_ui_user/features/thread/data/extensions/map_keywords_extension.dart';
 
 extension PresentationEmailExtension on PresentationEmail {
@@ -160,15 +159,13 @@ extension PresentationEmailExtension on PresentationEmail {
   List<Label> getLabelList(List<Label> labels) {
     if (keywords?.isNotEmpty != true || labels.isEmpty) return const [];
 
-    final enabledKeywordListString =
-        keywords!.enabledKeywords.keywordListString;
+    final enabledKeywords = keywords!.enabledKeywords;
 
-    if (enabledKeywordListString.isEmpty) return const [];
+    if (enabledKeywords.isEmpty) return const [];
 
     return labels
         .where((label) =>
-            label.keyword != null &&
-            enabledKeywordListString.contains(label.keyword))
+            label.keyword != null && enabledKeywords.contains(label.keyword))
         .toList();
   }
 }

lib/features/labels/domain/exceptions/label_exceptions.dart

@@ -0,0 +1,3 @@
+class LabelInteractorIsNull implements Exception {}
+
+class LabelKeywordIsNull implements Exception {}

model/lib/extensions/keyword_identifier_extension.dart

@@ -7,37 +7,28 @@ extension KeyWordIdentifierExtension on KeyWordIdentifier {
   static final unsubscribeMail = KeyWordIdentifier('\$unsubscribe');
   static final needsActionMail = KeyWordIdentifier('\$needs-action');
 
-  String generatePath() {
-    return '${PatchObject.keywordsProperty}/$value';
+  String generatePath() => '${PatchObject.keywordsProperty}/$value';
+
+  /// General helper to generate a boolean patch.
+  PatchObject _boolPatch(bool? flag) {
+    return PatchObject({generatePath(): flag});
   }
 
-  PatchObject generateReadActionPath(ReadActions readActions) {
-    return PatchObject({
-      generatePath(): readActions == ReadActions.markAsRead ? true : null
-    });
+  PatchObject generateReadActionPath(ReadActions action) {
+    final isRead = action == ReadActions.markAsRead;
+    return _boolPatch(isRead ? true : null);
   }
 
-  PatchObject generateMarkStarActionPath(MarkStarAction markStarAction) {
-    return PatchObject({
-      generatePath(): markStarAction == MarkStarAction.markStar ? true : null
-    });
+  PatchObject generateMarkStarActionPath(MarkStarAction action) {
+    final isStar = action == MarkStarAction.markStar;
+    return _boolPatch(isStar ? true : null);
   }
 
-  PatchObject generateAnsweredActionPath() {
-    return PatchObject({
-      generatePath(): true
-    });
-  }
+  PatchObject generateAnsweredActionPath() => _boolPatch(true);
 
-  PatchObject generateForwardedActionPath() {
-    return PatchObject({
-      generatePath(): true
-    });
-  }
+  PatchObject generateForwardedActionPath() => _boolPatch(true);
 
-  PatchObject generateUnsubscribeActionPath() {
-    return PatchObject({
-      generatePath(): true
-    });
-  }
+  PatchObject generateUnsubscribeActionPath() => _boolPatch(true);
+
+  PatchObject generateLabelActionPath() => _boolPatch(true);
 }

test/model/lib/extensions/get_label_list_in_keyword_email_test.dart

@@ -8,7 +8,7 @@ void main() {
   group('getLabelList', () {
     test('returns empty when keywords is null', () {
       final email = PresentationEmail(keywords: null);
-      final labels = [Label(keyword: KeyWordIdentifier.emailFlagged.value)];
+      final labels = [Label(keyword: KeyWordIdentifier.emailFlagged)];
 
       final result = email.getLabelList(labels);
 
@@ -17,7 +17,7 @@ void main() {
 
     test('returns empty when keywords is empty', () {
       final email = PresentationEmail(keywords: {});
-      final labels = [Label(keyword: KeyWordIdentifier.emailFlagged.value)];
+      final labels = [Label(keyword: KeyWordIdentifier.emailFlagged)];
 
       final result = email.getLabelList(labels);
 
@@ -41,8 +41,8 @@ void main() {
       });
 
       final labels = [
-        Label(keyword: KeyWordIdentifier.emailFlagged.value),
-        Label(keyword: KeyWordIdentifier.emailDraft.value),
+        Label(keyword: KeyWordIdentifier.emailFlagged),
+        Label(keyword: KeyWordIdentifier.emailDraft),
       ];
 
       final result = email.getLabelList(labels);
@@ -58,9 +58,9 @@ void main() {
       });
 
       final labels = [
-        Label(keyword: KeyWordIdentifier.emailFlagged.value),
-        Label(keyword: KeyWordIdentifier.emailSeen.value),
-        Label(keyword: KeyWordIdentifier.emailDraft.value),
+        Label(keyword: KeyWordIdentifier.emailFlagged),
+        Label(keyword: KeyWordIdentifier.emailSeen),
+        Label(keyword: KeyWordIdentifier.emailDraft),
       ];
 
       final result = email.getLabelList(labels);
@@ -68,15 +68,15 @@ void main() {
       expect(result.length, 2);
       expect(
         result.map((l) => l.keyword),
-        contains(KeyWordIdentifier.emailFlagged.value),
+        contains(KeyWordIdentifier.emailFlagged),
       );
       expect(
         result.map((l) => l.keyword),
-        contains(KeyWordIdentifier.emailDraft.value),
+        contains(KeyWordIdentifier.emailDraft),
       );
       expect(
         result.map((l) => l.keyword),
-        isNot(contains(KeyWordIdentifier.emailSeen.value)),
+        isNot(contains(KeyWordIdentifier.emailSeen)),
       );
     });
 
@@ -87,13 +87,13 @@ void main() {
 
       final labels = [
         Label(),
-        Label(keyword: KeyWordIdentifier.emailFlagged.value),
+        Label(keyword: KeyWordIdentifier.emailFlagged),
       ];
 
       final result = email.getLabelList(labels);
 
       expect(result.length, 1);
-      expect(result.first.keyword, KeyWordIdentifier.emailFlagged.value);
+      expect(result.first.keyword, KeyWordIdentifier.emailFlagged);
     });
   });
 }