TF-1311: set subscribeMailbox in UseCase and implement in Repository

lib/features/mailbox/data/datasource/mailbox_datasource.dart

@@ -16,6 +16,7 @@ import 'package:tmail_ui_user/features/mailbox/domain/model/create_new_mailbox_r
 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';
 
 abstract class MailboxDataSource {
   Future<MailboxResponse> getAllMailbox(Session session, AccountId accountId, {Properties? properties});
@@ -39,4 +40,6 @@ abstract class MailboxDataSource {
       MailboxId mailboxId,
       int totalEmailUnread,
       StreamController<dartz.Either<Failure, Success>> onProgressController);
+
+  Future<bool> subscribeMailbox(AccountId accountId, SubscribeMailboxRequest request);
 }

lib/features/mailbox/data/datasource_impl/mailbox_cache_datasource_impl.dart

@@ -18,6 +18,7 @@ import 'package:tmail_ui_user/features/mailbox/domain/model/create_new_mailbox_r
 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/main/exceptions/exception_thrower.dart';
 
 class MailboxCacheDataSourceImpl extends MailboxDataSource {
@@ -84,4 +85,9 @@ class MailboxCacheDataSourceImpl extends MailboxDataSource {
       StreamController<dartz.Either<Failure, Success>> onProgressController) {
     throw UnimplementedError();
   }
+
+  @override
+  Future<bool> subscribeMailbox(AccountId accountId, SubscribeMailboxRequest request) {
+    throw UnimplementedError();
+  }
 }

lib/features/mailbox/data/datasource_impl/mailbox_datasource_impl.dart

@@ -19,6 +19,7 @@ import 'package:tmail_ui_user/features/mailbox/domain/model/create_new_mailbox_r
 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/main/exceptions/exception_thrower.dart';
 
 class MailboxDataSourceImpl extends MailboxDataSource {
@@ -109,4 +110,13 @@ class MailboxDataSourceImpl extends MailboxDataSource {
       _exceptionThrower.throwException(error);
     });
   }
+
+  @override
+  Future<bool> subscribeMailbox(AccountId accountId, SubscribeMailboxRequest request) {
+    return Future.sync(() async {
+      return await mailboxAPI.subscribeMailbox(accountId, request);
+    }).catchError((error) {
+      _exceptionThrower.throwException(error);
+    });
+  }
 }

lib/features/mailbox/data/network/mailbox_api.dart

@@ -28,8 +28,10 @@ import 'package:tmail_ui_user/features/base/mixin/handle_error_mixin.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/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';
+import 'package:tmail_ui_user/features/mailbox/domain/model/subscribe_mailbox_request.dart';
 import 'package:tmail_ui_user/main/error/capability_validator.dart';
 
 class MailboxAPI with HandleSetErrorMixin {
@@ -289,4 +291,32 @@ class MailboxAPI with HandleSetErrorMixin {
       throw error;
     });
   }
+
+  Future<bool> subscribeMailbox(AccountId accountId, SubscribeMailboxRequest request) async {
+    final setMailboxMethod = SetMailboxMethod(accountId)
+      ..addUpdates({
+        request.mailboxId.id : PatchObject({
+          'isSubscribed': request.newState == MailboxSubscribeState.disabled ? true : false
+        })
+      });
+
+    final requestBuilder = JmapRequestBuilder(httpClient, ProcessingInvocation());
+
+    final setMailboxInvocation = requestBuilder.invocation(setMailboxMethod);
+
+    final response = await (requestBuilder
+        ..usings(setMailboxMethod.requiredCapabilities))
+      .build()
+      .execute();
+
+    final setMailboxResponse = response.parse<SetMailboxResponse>(
+        setMailboxInvocation.methodCallId,
+        SetMailboxResponse.deserialize);
+
+    return Future.sync(() async {
+      return setMailboxResponse?.updated?.isNotEmpty == true;
+    }).catchError((error) {
+      throw error;
+    });
+  }
 }

lib/features/mailbox/data/repository/mailbox_repository_impl.dart

@@ -22,6 +22,7 @@ import 'package:tmail_ui_user/features/mailbox/domain/model/create_new_mailbox_r
 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/repository/mailbox_repository.dart';
 
 class MailboxRepositoryImpl extends MailboxRepository {
@@ -188,4 +189,9 @@ class MailboxRepositoryImpl extends MailboxRepository {
   Future<State?> getMailboxState() {
     return stateDataSource.getState(StateType.mailbox);
   }
+
+  @override
+  Future<bool> subscribeMailbox(AccountId accountId, SubscribeMailboxRequest request) {
+    return mapDataSource[DataSourceType.network]!.subscribeMailbox(accountId, request);
+  }
 }

lib/features/mailbox/domain/model/mailbox_subscribe_state.dart

@@ -0,0 +1,13 @@
+enum MailboxSubscribeState {
+  enabled,
+  disabled;
+  
+  String get keyValue {
+      switch(this) {
+          case MailboxSubscribeState.enabled:
+            return 'enabled';
+          case MailboxSubscribeState.disabled:
+            return 'disabled';
+    }
+  }
+}

lib/features/mailbox/domain/model/subscribe_mailbox_request.dart

@@ -0,0 +1,14 @@
+import 'package:equatable/equatable.dart';
+import 'package:jmap_dart_client/jmap/mail/mailbox/mailbox.dart';
+import 'package:tmail_ui_user/features/mailbox/domain/model/mailbox_subscribe_state.dart';
+
+class SubscribeMailboxRequest with EquatableMixin {
+
+  final MailboxId mailboxId;
+  final MailboxSubscribeState newState;
+
+  SubscribeMailboxRequest(this.mailboxId, this.newState);
+  
+  @override
+  List<Object?> get props => [mailboxId, newState];
+}

lib/features/mailbox/domain/repository/mailbox_repository.dart

@@ -15,6 +15,7 @@ import 'package:tmail_ui_user/features/mailbox/domain/model/create_new_mailbox_r
 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';
 
 abstract class MailboxRepository {
   Stream<MailboxResponse> getAllMailbox(Session session, AccountId accountId, {Properties? properties});
@@ -36,4 +37,6 @@ abstract class MailboxRepository {
   Future<bool> moveMailbox(AccountId accountId, MoveMailboxRequest request);
 
   Future<State?> getMailboxState();
+
+  Future<bool> subscribeMailbox(AccountId accountId, SubscribeMailboxRequest request);
 }

lib/features/mailbox/domain/state/subscribe_mailbox_state.dart

@@ -0,0 +1,22 @@
+import 'package:core/core.dart';
+
+class LoadingSubscribeMailbox extends UIState {}
+
+class SubscribeMailboxSuccess extends UIState {
+
+  final bool subscribeMailbox;
+
+  SubscribeMailboxSuccess(this.subscribeMailbox);
+
+  @override
+  List<Object?> get props => [subscribeMailbox];
+}
+
+class SubscribeMailboxFailure extends FeatureFailure {
+  final dynamic exception;
+
+  SubscribeMailboxFailure(this.exception);
+
+  @override
+  List<Object> get props => [exception];
+}

lib/features/mailbox/domain/usecases/subscribe_mailbox_interactor.dart

@@ -0,0 +1,25 @@
+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:tmail_ui_user/features/mailbox/domain/model/subscribe_mailbox_request.dart';
+import 'package:tmail_ui_user/features/mailbox/domain/repository/mailbox_repository.dart';
+import 'package:tmail_ui_user/features/mailbox/domain/state/subscribe_mailbox_state.dart';
+
+class SearchMailboxInteractor {
+  final MailboxRepository _mailboxRepository;
+
+  SearchMailboxInteractor(this._mailboxRepository);
+
+  Stream<Either<Failure, Success>> execute(AccountId accountId, SubscribeMailboxRequest request) async* {
+    try {
+      yield Right<Failure, Success>(LoadingSubscribeMailbox());
+
+      final resultList = await _mailboxRepository.subscribeMailbox(accountId, request);
+
+      yield Right<Failure, Success>(SubscribeMailboxSuccess(resultList));
+    } catch (exception) {
+      yield Left<Failure, Success>(SubscribeMailboxFailure(exception));
+    }
+  }
+}