TF-1933 Trigger to handle hive database in main isolate when work manager changed

(cherry picked from commit 714806a751859ec9d37416a51e48ad3300ac6f73)
2023-06-27 22:04:00 +07:00
parent 9b735ebf59
commit d5cac4058a
21 changed files with 318 additions and 312 deletions
@@ -0,0 +1,30 @@
+
+import 'package:tmail_ui_user/features/offline_mode/work_manager/work_request.dart';
+import 'package:workmanager/workmanager.dart';
+
+/// A WorkRequest for non-repeating work.
+class OneTimeWorkRequest extends WorkRequest {
+  OneTimeWorkRequest({
+    required String uniqueId,
+    required String taskId,
+    String? tag,
+    Map<String, dynamic>? inputData,
+    Duration initialDelay = Duration.zero,
+    Duration backoffPolicyDelay = Duration.zero,
+    ExistingWorkPolicy? existingWorkPolicy,
+    BackoffPolicy? backoffPolicy,
+    OutOfQuotaPolicy? outOfQuotaPolicy,
+    Constraints? constraints
+  }) : super(
+    uniqueId: uniqueId,
+    taskId: taskId,
+    tag: tag,
+    inputData: inputData,
+    initialDelay: initialDelay,
+    backoffPolicyDelay: backoffPolicyDelay,
+    existingWorkPolicy: existingWorkPolicy,
+    backoffPolicy: backoffPolicy,
+    outOfQuotaPolicy: outOfQuotaPolicy,
+    constraints: constraints
+  );
+}
@@ -0,0 +1,36 @@
+
+import 'package:tmail_ui_user/features/offline_mode/work_manager/work_request.dart';
+import 'package:workmanager/workmanager.dart';
+
+/// A WorkRequest for repeating work.
+class PeriodicWorkRequest extends WorkRequest {
+  final Duration? frequency;
+
+  PeriodicWorkRequest({
+    required String uniqueId,
+    required String taskId,
+    String? tag,
+    Map<String, dynamic>? inputData,
+    Duration initialDelay = Duration.zero,
+    Duration backoffPolicyDelay = Duration.zero,
+    ExistingWorkPolicy? existingWorkPolicy,
+    BackoffPolicy? backoffPolicy,
+    OutOfQuotaPolicy? outOfQuotaPolicy,
+    Constraints? constraints,
+    this.frequency
+  }) : super(
+    uniqueId: uniqueId,
+    taskId: taskId,
+    tag: tag,
+    inputData: inputData,
+    initialDelay: initialDelay,
+    backoffPolicyDelay: backoffPolicyDelay,
+    existingWorkPolicy: existingWorkPolicy,
+    backoffPolicy: backoffPolicy,
+    outOfQuotaPolicy: outOfQuotaPolicy,
+    constraints: constraints
+  );
+
+  @override
+  List<Object?> get props => [super.props, frequency];
+}
@@ -0,0 +1,247 @@
+import 'dart:async';
+import 'package:core/data/network/config/dynamic_url_interceptors.dart';
+import 'package:core/presentation/state/failure.dart';
+import 'package:core/presentation/state/success.dart';
+import 'package:core/utils/app_logger.dart';
+import 'package:jmap_dart_client/jmap/account_id.dart';
+import 'package:jmap_dart_client/jmap/core/session/session.dart';
+import 'package:jmap_dart_client/jmap/core/user_name.dart';
+import 'package:model/extensions/account_id_extensions.dart';
+import 'package:model/extensions/session_extension.dart';
+import 'package:model/oidc/token_oidc.dart';
+import 'package:tmail_ui_user/features/caching/config/hive_cache_config.dart';
+import 'package:tmail_ui_user/features/caching/utils/cache_utils.dart';
+import 'package:tmail_ui_user/features/composer/domain/state/send_email_state.dart';
+import 'package:tmail_ui_user/features/composer/domain/usecases/send_email_interactor.dart';
+import 'package:tmail_ui_user/features/login/data/network/config/authorization_interceptors.dart';
+import 'package:tmail_ui_user/features/login/domain/state/get_authenticated_account_state.dart';
+import 'package:tmail_ui_user/features/login/domain/state/get_credential_state.dart';
+import 'package:tmail_ui_user/features/login/domain/state/get_stored_token_oidc_state.dart';
+import 'package:tmail_ui_user/features/login/domain/usecases/get_authenticated_account_interactor.dart';
+import 'package:tmail_ui_user/features/mailbox/domain/model/create_new_mailbox_request.dart';
+import 'package:tmail_ui_user/features/offline_mode/bindings/sending_email_interactor_bindings.dart';
+import 'package:tmail_ui_user/features/offline_mode/manager/sending_email_cache_manager.dart';
+import 'package:tmail_ui_user/features/offline_mode/model/sending_state.dart';
+import 'package:tmail_ui_user/features/offline_mode/work_manager/worker.dart';
+import 'package:tmail_ui_user/features/sending_queue/domain/extensions/sending_email_extension.dart';
+import 'package:tmail_ui_user/features/sending_queue/domain/model/sending_email.dart';
+import 'package:tmail_ui_user/features/sending_queue/presentation/bindings/sending_queue_bindings.dart';
+import 'package:tmail_ui_user/features/sending_queue/presentation/bindings/sending_queue_interactor_bindings.dart';
+import 'package:tmail_ui_user/features/sending_queue/presentation/utils/sending_queue_isolate_manager.dart';
+import 'package:tmail_ui_user/features/session/domain/extensions/session_extensions.dart';
+import 'package:tmail_ui_user/features/session/domain/state/get_session_state.dart';
+import 'package:tmail_ui_user/features/session/domain/usecases/get_session_interactor.dart';
+import 'package:tmail_ui_user/main/bindings/main_bindings.dart';
+import 'package:tmail_ui_user/main/routes/route_navigation.dart';
+
+class SendingEmailWorker extends Worker {
+
+  SendEmailInteractor? _sendEmailInteractor;
+  GetAuthenticatedAccountInteractor? _getAuthenticatedAccountInteractor;
+  DynamicUrlInterceptors? _dynamicUrlInterceptors;
+  AuthorizationInterceptors? _authorizationInterceptors;
+  GetSessionInteractor? _getSessionInteractor;
+  SendingQueueIsolateManager? _sendingQueueIsolateManager;
+  SendingEmailCacheManager? _sendingEmailCacheManager;
+
+  late Completer<bool> _completer;
+  late SendingEmail _sendingEmail;
+
+  AccountId? _currentAccountId;
+  Session? _currentSession;
+
+  static SendingEmailWorker? _instance;
+
+  SendingEmailWorker._();
+
+  factory SendingEmailWorker() => _instance ??= SendingEmailWorker._();
+
+  @override
+  Future<bool> doWork(String taskId, Map<String, dynamic> inputData) {
+    _completer = Completer<bool>();
+    _sendingEmail = SendingEmail.fromJson(inputData);
+    log('SendingEmailObserver::observe():_sendingEmail: $_sendingEmail');
+    _updatingSendingStateToMainUI(
+      sendingId: _sendingEmail.sendingId,
+      sendingState: SendingState.running
+    );
+    _getAuthenticatedAccount();
+    return _completer.future;
+  }
+
+  @override
+  Future<void> bindDI() async {
+    await Future.wait([
+      MainBindings().dependencies(),
+      HiveCacheConfig().setUp()
+    ]);
+
+    SendingQueueInteractorBindings().dependencies();
+    SendEmailInteractorBindings().dependencies();
+    SendingQueueBindings().dependencies();
+
+    _getInteractorBindings();
+
+    await _sendingEmailCacheManager?.closeSendingEmailHiveCacheBox();
+  }
+
+  @override
+  void handleFailureViewState(Failure failure) {
+    log('SendingEmailObserver::_handleFailureViewState(): $failure');
+    if (failure is SendEmailFailure) {
+      _handleSendEmailFailure(failure);
+    } else if (failure is GetAuthenticatedAccountFailure ||
+        failure is NoAuthenticatedAccountFailure ||
+        failure is GetSessionFailure ||
+        failure is GetStoredTokenOidcFailure ||
+        failure is GetCredentialFailure) {
+      _handleTaskFailureInWorkManager();
+    }
+  }
+
+  @override
+  void handleSuccessViewState(Success success) {
+    log('SendingEmailObserver::handleSuccessViewState(): $success');
+    if (success is GetSessionSuccess) {
+      _handleGetSessionSuccess(success);
+    } else if (success is GetStoredTokenOidcSuccess) {
+      _handleGetAccountByOidcSuccess(success);
+    } else if (success is GetCredentialViewState) {
+      _handleGetAccountByBasicAuthSuccess(success);
+    } else if (success is SendEmailSuccess) {
+      _handleSendEmailSuccess(success);
+    }
+  }
+
+  @override
+  void handleOnError(Object? error, StackTrace stackTrace) {
+    super.handleOnError(error, stackTrace);
+    _handleTaskFailureInWorkManager();
+  }
+
+  void _getInteractorBindings() {
+    _getAuthenticatedAccountInteractor = getBinding<GetAuthenticatedAccountInteractor>();
+    _dynamicUrlInterceptors = getBinding<DynamicUrlInterceptors>();
+    _authorizationInterceptors = getBinding<AuthorizationInterceptors>();
+    _getSessionInteractor = getBinding<GetSessionInteractor>();
+    _sendEmailInteractor = getBinding<SendEmailInteractor>();
+    _sendingQueueIsolateManager = getBinding<SendingQueueIsolateManager>();
+    _sendingEmailCacheManager = getBinding<SendingEmailCacheManager>();
+  }
+
+  void _updatingSendingStateToMainUI({String? sendingId, SendingState? sendingState}) {
+    final eventAction = _generateEventAction(
+      sendingId ?? _sendingEmail.sendingId,
+      sendingState ?? _sendingEmail.sendingState,
+      accountId: _currentAccountId,
+      userName: _currentSession?.username
+    );
+    log('SendingEmailObserver::_updatingSendingStateToMainUI():eventAction: $eventAction');
+    _sendingQueueIsolateManager?.addEvent(eventAction);
+  }
+
+  void _getAuthenticatedAccount() {
+    consumeState(_getAuthenticatedAccountInteractor!.execute());
+  }
+
+  void _getSessionAction() {
+    consumeState(_getSessionInteractor!.execute());
+  }
+
+  void _handleGetSessionSuccess(GetSessionSuccess success) async {
+    _currentSession = success.session;
+    _currentAccountId = success.session.personalAccount.accountId;
+    final apiUrl = success.session.getQualifiedApiUrl(baseUrl: _dynamicUrlInterceptors?.jmapUrl);
+    if (apiUrl.isNotEmpty && _currentSession != null && _currentAccountId != null) {
+      _dynamicUrlInterceptors?.changeBaseUrl(apiUrl);
+      _sendEmailAction(_currentAccountId!, _currentSession!);
+    } else {
+      _handleTaskFailureInWorkManager();
+    }
+  }
+
+  void _handleGetAccountByBasicAuthSuccess(GetCredentialViewState credentialViewState) {
+    _dynamicUrlInterceptors?.setJmapUrl(credentialViewState.baseUrl.toString());
+    _authorizationInterceptors?.setBasicAuthorization(
+      credentialViewState.userName.value,
+      credentialViewState.password.value,
+    );
+    _dynamicUrlInterceptors?.changeBaseUrl(credentialViewState.baseUrl.toString());
+    _getSessionAction();
+  }
+
+  void _sendEmailAction(AccountId accountId, Session session) {
+    consumeState(
+      _sendEmailInteractor!.execute(
+        session,
+        accountId,
+        _sendingEmail.toEmailRequest(),
+        mailboxRequest: _getMailboxRequest()
+      )
+    );
+  }
+
+  CreateNewMailboxRequest? _getMailboxRequest() {
+    if (_sendingEmail.mailboxNameRequest != null &&
+        _sendingEmail.creationIdRequest != null) {
+      return CreateNewMailboxRequest(
+        _sendingEmail.creationIdRequest!,
+        _sendingEmail.mailboxNameRequest!);
+    } else {
+      return null;
+    }
+  }
+
+  void _handleGetAccountByOidcSuccess(GetStoredTokenOidcSuccess storedTokenOidcSuccess) {
+    _dynamicUrlInterceptors?.setJmapUrl(storedTokenOidcSuccess.baseUrl.toString());
+    _authorizationInterceptors?.setTokenAndAuthorityOidc(
+      newToken: storedTokenOidcSuccess.tokenOidc.toToken(),
+      newConfig: storedTokenOidcSuccess.oidcConfiguration
+    );
+    _dynamicUrlInterceptors?.changeBaseUrl(storedTokenOidcSuccess.baseUrl.toString());
+    _getSessionAction();
+  }
+
+  void _handleSendEmailSuccess(SendEmailSuccess success) {
+    _updatingSendingStateToMainUI(sendingState: SendingState.success);
+    _handleTaskSuccessInWorkManager();
+  }
+
+  void _handleSendEmailFailure(SendEmailFailure failure) {
+    _updatingSendingStateToMainUI(sendingState: SendingState.error);
+    _handleTaskErrorInWorkManager(failure.exception);
+  }
+
+  void _handleTaskFailureInWorkManager() async {
+    log('SendingEmailObserver::_handleTaskFailureInWorkManager():');
+    await Future.delayed(
+      const Duration(milliseconds: 1000),
+      () => _completer.complete(false)
+    );
+  }
+
+  void _handleTaskErrorInWorkManager(dynamic error) async {
+    log('SendingEmailObserver::_handleTaskErrorInWorkManager():');
+    await Future.delayed(
+      const Duration(milliseconds: 1000),
+      () => _completer.completeError(error)
+    );
+  }
+
+  void _handleTaskSuccessInWorkManager() async {
+    log('SendingEmailObserver::_handleTaskSuccessInWorkManager():');
+    await Future.delayed(
+      const Duration(milliseconds: 1000),
+      () => _completer.complete(true)
+    );
+  }
+
+  String _generateEventAction(
+    String sendingId,
+    SendingState sendingState,
+    {
+      AccountId? accountId,
+      UserName? userName
+    }
+  ) => TupleKey(sendingId, sendingState.name, accountId?.asString, userName?.value).toString();
+}
@@ -0,0 +1,8 @@
+
+import 'package:tmail_ui_user/features/offline_mode/controller/work_manager_controller.dart';
+import 'package:workmanager/workmanager.dart';
+
+@pragma('vm:entry-point')
+void callbackDispatcher() {
+  Workmanager().executeTask(WorkManagerController().handleBackgroundTask);
+}
@@ -0,0 +1,44 @@
+
+import 'package:equatable/equatable.dart';
+import 'package:workmanager/workmanager.dart';
+
+/// Represents the scheduling of requests
+abstract class WorkRequest with EquatableMixin {
+  final String uniqueId;
+  final String taskId;
+  final String? tag;
+  final Map<String, dynamic>? inputData;
+  final Duration initialDelay;
+  final Duration backoffPolicyDelay;
+  final ExistingWorkPolicy? existingWorkPolicy;
+  final BackoffPolicy? backoffPolicy;
+  final OutOfQuotaPolicy? outOfQuotaPolicy;
+  final Constraints? constraints;
+
+  WorkRequest( {
+    required this.uniqueId,
+    required this.taskId,
+    this.tag,
+    this.inputData,
+    this.initialDelay = Duration.zero,
+    this.backoffPolicyDelay = Duration.zero,
+    this.existingWorkPolicy,
+    this.backoffPolicy,
+    this.outOfQuotaPolicy,
+    this.constraints
+  });
+
+  @override
+  List<Object?> get props => [
+    uniqueId,
+    taskId,
+    tag,
+    inputData,
+    initialDelay,
+    backoffPolicyDelay,
+    existingWorkPolicy,
+    backoffPolicy,
+    outOfQuotaPolicy,
+    constraints
+  ];
+}
@@ -0,0 +1,30 @@
+import 'dart:async';
+import 'package:core/presentation/state/failure.dart';
+import 'package:core/presentation/state/success.dart';
+import 'package:core/utils/app_logger.dart';
+import 'package:dartz/dartz.dart';
+
+abstract class Worker {
+  Future<void> bindDI();
+
+  Future<bool> doWork(String taskId, Map<String, dynamic> inputData);
+
+  void consumeState(Stream<Either<Failure, Success>> newStateStream) {
+    newStateStream.listen(
+      _handleStateStream,
+      onError: handleOnError
+    );
+  }
+
+  void _handleStateStream(Either<Failure, Success> newState) {
+    newState.fold(handleFailureViewState, handleSuccessViewState);
+  }
+
+  void handleFailureViewState(Failure failure) {}
+
+  void handleSuccessViewState(Success success) {}
+
+  void handleOnError(Object? error, StackTrace stackTrace) {
+    logError('WorkObserver::handleOnError():error: $error | stackTrace: $stackTrace');
+  }
+}
@@ -0,0 +1,22 @@
+
+import 'package:tmail_ui_user/features/offline_mode/config/work_manager_constants.dart';
+import 'package:tmail_ui_user/features/offline_mode/work_manager/sending_email_worker.dart';
+import 'package:tmail_ui_user/features/offline_mode/work_manager/worker.dart';
+
+enum WorkerType {
+  sendingEmail;
+
+  Worker getWorker() {
+    switch(this) {
+      case WorkerType.sendingEmail:
+        return SendingEmailWorker();
+    }
+  }
+
+  String get iOSUniqueId {
+    switch(this) {
+      case WorkerType.sendingEmail:
+        return WorkManagerConstants.sendingEmailUniqueId;
+    }
+  }
+}