From f1ccbe26e565ecd6acb13c218658dc8f682f0691 Mon Sep 17 00:00:00 2001 From: Dat PHAM HOANG Date: Fri, 3 Mar 2023 12:14:12 +0700 Subject: [PATCH] Move logout logic to BaseController to handle logout when BadCredentials for all cases --- lib/features/base/base_controller.dart | 97 +++++++++- .../reloadable/reloadable_controller.dart | 168 ++---------------- 2 files changed, 113 insertions(+), 152 deletions(-) diff --git a/lib/features/base/base_controller.dart b/lib/features/base/base_controller.dart index c060df79f..c60759463 100644 --- a/lib/features/base/base_controller.dart +++ b/lib/features/base/base_controller.dart @@ -70,6 +70,7 @@ abstract class BaseController extends GetxController final LogoutOidcInteractor logoutOidcInteractor = Get.find(); final DeleteAuthorityOidcInteractor deleteAuthorityOidcInteractor = Get.find(); final _fcmReceiver = FcmReceiver.instance; + bool _isFcmEnabled = false; GetFCMSubscriptionLocalInteractor? _getSubscriptionLocalInteractor; DestroySubscriptionInteractor? _destroySubscriptionInteractor; @@ -137,7 +138,6 @@ abstract class BaseController extends GetxController return true; } else if (failure.exception is BadCredentialsException) { _appToast.showErrorToast(AppLocalizations.of(currentContext!).badCredentials); - cleanAppAtTheEnd(); checkAuthenticationTypeWhenLogout(); return true; } @@ -260,4 +260,99 @@ abstract class BaseController extends GetxController logError('BaseController::injectFCMBindings(): exception: $e'); } } + + bool fcmEnabled(Session? session, AccountId? accountId) { + bool _fcmEnabled = false; + try { + requireCapability(session!, accountId!, [FirebaseCapability.fcmIdentifier]); + if (AppConfig.fcmAvailable) { + _fcmEnabled = true; + } else { + _fcmEnabled = false; + } + } catch (e) { + logError('BaseController::fcmEnabled(): exception: $e'); + } + return _fcmEnabled; + } + + void goToLogin({LoginArguments? arguments}) { + pushAndPopAll(AppRoutes.login, arguments: arguments); + } + + void logout(Session? session, AccountId? accountId) { + _isFcmEnabled = fcmEnabled(session, accountId); + if (_isFcmEnabled) { + final authenticationType = authorizationInterceptors.authenticationType; + if (authenticationType == AuthenticationType.oidc) { + consumeState(logoutOidcInteractor.execute()); + } else { + _getSubscriptionLocalAction(); + } + } else { + checkAuthenticationTypeWhenLogout(); + } + } + + void _destroySubscriptionAction(String subscriptionId) { + try { + _destroySubscriptionInteractor = Get.find(); + consumeState(_destroySubscriptionInteractor!.execute(subscriptionId)); + } catch(e) { + logError('ReloadableController::destroySubscriptionAction(): exception: $e'); + logoutAction(); + } + } + + Future _getSubscriptionLocalAction() { + try { + _getSubscriptionLocalInteractor = Get.find(); + consumeState(_getSubscriptionLocalInteractor!.execute()); + } catch (e) { + logError( + 'ReloadableController::getSubscriptionLocalAction(): exception: $e'); + logoutAction(); + } + return Future.value(); + } + + void checkAuthenticationTypeWhenLogout() { + final authenticationType = authorizationInterceptors.authenticationType; + if (authenticationType == AuthenticationType.oidc) { + _logoutOIDCAction(); + } else { + logoutAction(); + } + } + + void logoutAction() async { + await Future.wait([ + deleteCredentialInteractor.execute(), + cachingManager.clearAll(), + languageCacheManager.removeLanguage(), + ]); + authorizationInterceptors.clear(); + authorizationIsolateInterceptors.clear(); + if (_isFcmEnabled) { + _fcmReceiver.deleteFcmToken(); + } + await cachingManager.closeHive(); + goToLogin(arguments: LoginArguments(LoginFormType.credentialForm)); + } + + void _logoutOIDCAction() async { + log('ReloadableController::_logoutOIDCAction():'); + await Future.wait([ + deleteAuthorityOidcInteractor.execute(), + cachingManager.clearAll(), + languageCacheManager.removeLanguage(), + ]); + authorizationIsolateInterceptors.clear(); + authorizationInterceptors.clear(); + if (_isFcmEnabled) { + _fcmReceiver.deleteFcmToken(); + } + await cachingManager.closeHive(); + goToLogin(arguments: LoginArguments(LoginFormType.ssoForm)); + } } \ No newline at end of file diff --git a/lib/features/base/reloadable/reloadable_controller.dart b/lib/features/base/reloadable/reloadable_controller.dart index f576ff200..0f5d39521 100644 --- a/lib/features/base/reloadable/reloadable_controller.dart +++ b/lib/features/base/reloadable/reloadable_controller.dart @@ -3,7 +3,6 @@ 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'; -import 'package:fcm/model/firebase_capability.dart'; import 'package:get/get.dart'; import 'package:jmap_dart_client/jmap/account_id.dart'; import 'package:jmap_dart_client/jmap/core/capability/capability_identifier.dart'; @@ -11,56 +10,25 @@ import 'package:jmap_dart_client/jmap/core/session/session.dart'; import 'package:model/account/authentication_type.dart'; import 'package:model/oidc/token_oidc.dart'; import 'package:tmail_ui_user/features/base/base_controller.dart'; -import 'package:tmail_ui_user/features/caching/caching_manager.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/delete_authority_oidc_interactor.dart'; -import 'package:tmail_ui_user/features/login/domain/usecases/delete_credential_interactor.dart'; import 'package:tmail_ui_user/features/login/domain/usecases/get_authenticated_account_interactor.dart'; import 'package:tmail_ui_user/features/login/domain/usecases/update_authentication_account_interactor.dart'; import 'package:tmail_ui_user/features/login/presentation/login_form_type.dart'; import 'package:tmail_ui_user/features/login/presentation/model/login_arguments.dart'; -import 'package:tmail_ui_user/features/manage_account/data/local/language_cache_manager.dart'; -import 'package:tmail_ui_user/features/manage_account/domain/state/log_out_oidc_state.dart'; -import 'package:tmail_ui_user/features/manage_account/domain/usecases/log_out_oidc_interactor.dart'; import 'package:tmail_ui_user/features/manage_account/presentation/vacation/vacation_interactors_bindings.dart'; -import 'package:tmail_ui_user/features/push_notification/domain/state/destroy_subscription_state.dart'; -import 'package:tmail_ui_user/features/push_notification/domain/state/get_fcm_subscription_local.dart'; -import 'package:tmail_ui_user/features/push_notification/domain/usecases/destroy_subscription_interactor.dart'; -import 'package:tmail_ui_user/features/push_notification/domain/usecases/get_fcm_subscription_local_interactor.dart'; -import 'package:tmail_ui_user/features/push_notification/presentation/services/fcm_receiver.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/network/binding_tag.dart'; import 'package:tmail_ui_user/main/error/capability_validator.dart'; -import 'package:tmail_ui_user/main/routes/app_routes.dart'; -import 'package:tmail_ui_user/main/routes/route_navigation.dart'; -import 'package:tmail_ui_user/main/utils/app_config.dart'; abstract class ReloadableController extends BaseController { final DynamicUrlInterceptors _dynamicUrlInterceptors = Get.find(); - final AuthorizationInterceptors _authorizationInterceptors = Get.find(); - final AuthorizationInterceptors _authorizationIsolateInterceptors = Get.find(tag: BindingTag.isolateTag); final GetSessionInteractor _getSessionInteractor = Get.find(); - final DeleteCredentialInteractor _deleteCredentialInteractor = Get.find(); - final CachingManager _cachingManager = Get.find(); - final _languageCacheManager = Get.find(); - - final LogoutOidcInteractor _logoutOidcInteractor; - final DeleteAuthorityOidcInteractor _deleteAuthorityOidcInteractor; final GetAuthenticatedAccountInteractor _getAuthenticatedAccountInteractor; final UpdateAuthenticationAccountInteractor _updateAuthenticationAccountInteractor; - final _fcmReceiver = FcmReceiver.instance; - - GetFCMSubscriptionLocalInteractor? _getSubscriptionLocalInteractor; - DestroySubscriptionInteractor? _destroySubscriptionInteractor; - bool _isFcmEnabled = false; ReloadableController( - this._logoutOidcInteractor, - this._deleteAuthorityOidcInteractor, this._getAuthenticatedAccountInteractor, this._updateAuthenticationAccountInteractor ); @@ -71,20 +39,13 @@ abstract class ReloadableController extends BaseController { viewState.value.fold( (failure) { if (failure is GetCredentialFailure) { - _goToLogin(arguments: LoginArguments(LoginFormType.credentialForm)); + goToLogin(arguments: LoginArguments(LoginFormType.credentialForm)); } else if (failure is GetSessionFailure) { _handleGetSessionFailure(); - } else if (failure is LogoutOidcFailure) { - log('ReloadableController::onData(): LogoutOidcFailure: $failure'); - _getSubscriptionLocalAction(); } else if (failure is GetStoredTokenOidcFailure) { - _goToLogin(arguments: LoginArguments(LoginFormType.ssoForm)); + goToLogin(arguments: LoginArguments(LoginFormType.ssoForm)); } else if (failure is GetAuthenticatedAccountFailure || failure is NoAuthenticatedAccountFailure) { - _goToLogin(arguments: LoginArguments(LoginFormType.credentialForm)); - } else if (failure is GetFCMSubscriptionLocalFailure) { - _checkAuthenticationTypeWhenLogout(); - } else if (failure is DestroySubscriptionFailure) { - _checkAuthenticationTypeWhenLogout(); + goToLogin(arguments: LoginArguments(LoginFormType.credentialForm)); } }, (success) { @@ -92,16 +53,16 @@ abstract class ReloadableController extends BaseController { _handleGetCredentialSuccess(success); } else if (success is GetSessionSuccess) { _handleGetSessionSuccess(success); - } else if (success is LogoutOidcSuccess) { - log('ReloadableController::handleLogoutOidcSuccess(): $success'); - _getSubscriptionLocalAction(); } else if (success is GetStoredTokenOidcSuccess) { _handleGetStoredTokenOIDCSuccess(success); +<<<<<<< HEAD } else if (success is GetFCMSubscriptionLocalSuccess) { final subscriptionId = success.fcmSubscription.subscriptionId; _destroySubscriptionAction(subscriptionId); } else if (success is DestroySubscriptionSuccess) { _checkAuthenticationTypeWhenLogout(); +======= +>>>>>>> d49ace46 (Move logout logic to BaseController to handle logout when BadCredentials for all cases) } } ); @@ -118,17 +79,13 @@ abstract class ReloadableController extends BaseController { consumeState(_getAuthenticatedAccountInteractor.execute()); } - void _goToLogin({LoginArguments? arguments}) { - pushAndPopAll(AppRoutes.login, arguments: arguments); - } - void _setUpInterceptors(GetCredentialViewState credentialViewState) { _dynamicUrlInterceptors.changeBaseUrl(credentialViewState.baseUrl.origin); - _authorizationInterceptors.setBasicAuthorization( + authorizationInterceptors.setBasicAuthorization( credentialViewState.userName.userName, credentialViewState.password.value, ); - _authorizationIsolateInterceptors.setBasicAuthorization( + authorizationIsolateInterceptors.setBasicAuthorization( credentialViewState.userName.userName, credentialViewState.password.value, ); @@ -145,16 +102,16 @@ abstract class ReloadableController extends BaseController { void _handleGetSessionFailure() async { await Future.wait([ - _deleteCredentialInteractor.execute(), - _deleteAuthorityOidcInteractor.execute(), - _cachingManager.clearAll(), - _languageCacheManager.removeLanguage(), + deleteCredentialInteractor.execute(), + deleteAuthorityOidcInteractor.execute(), + cachingManager.clearAll(), + languageCacheManager.removeLanguage(), ]); - final authenticationType = _authorizationInterceptors.authenticationType; + final authenticationType = authorizationInterceptors.authenticationType; if (authenticationType == AuthenticationType.oidc) { - _goToLogin(arguments: LoginArguments(LoginFormType.ssoForm)); + goToLogin(arguments: LoginArguments(LoginFormType.ssoForm)); } else { - _goToLogin(arguments: LoginArguments(LoginFormType.credentialForm)); + goToLogin(arguments: LoginArguments(LoginFormType.credentialForm)); } } @@ -171,37 +128,6 @@ abstract class ReloadableController extends BaseController { void handleReloaded(Session session) {} - void logoutAction() async { - await Future.wait([ - _deleteCredentialInteractor.execute(), - _cachingManager.clearAll(), - _languageCacheManager.removeLanguage(), - ]); - _authorizationInterceptors.clear(); - _authorizationIsolateInterceptors.clear(); - if (_isFcmEnabled) { - _fcmReceiver.deleteFcmToken(); - } - await _cachingManager.closeHive(); - _goToLogin(arguments: LoginArguments(LoginFormType.credentialForm)); - } - - void _logoutOIDCAction() async { - log('ReloadableController::_logoutOIDCAction():'); - await Future.wait([ - _deleteAuthorityOidcInteractor.execute(), - _cachingManager.clearAll(), - _languageCacheManager.removeLanguage(), - ]); - _authorizationIsolateInterceptors.clear(); - _authorizationInterceptors.clear(); - if (_isFcmEnabled) { - _fcmReceiver.deleteFcmToken(); - } - await _cachingManager.closeHive(); - _goToLogin(arguments: LoginArguments(LoginFormType.ssoForm)); - } - void _handleGetStoredTokenOIDCSuccess(GetStoredTokenOidcSuccess tokenOidcSuccess) { _setUpInterceptorsOidc(tokenOidcSuccess); _getSessionAction(); @@ -209,10 +135,10 @@ abstract class ReloadableController extends BaseController { void _setUpInterceptorsOidc(GetStoredTokenOidcSuccess tokenOidcSuccess) { _dynamicUrlInterceptors.changeBaseUrl(tokenOidcSuccess.baseUrl.toString()); - _authorizationInterceptors.setTokenAndAuthorityOidc( + authorizationInterceptors.setTokenAndAuthorityOidc( newToken: tokenOidcSuccess.tokenOidc.toToken(), newConfig: tokenOidcSuccess.oidcConfiguration); - _authorizationIsolateInterceptors.setTokenAndAuthorityOidc( + authorizationIsolateInterceptors.setTokenAndAuthorityOidc( newToken: tokenOidcSuccess.tokenOidc.toToken(), newConfig: tokenOidcSuccess.oidcConfiguration); } @@ -226,66 +152,6 @@ abstract class ReloadableController extends BaseController { } } - Future _getSubscriptionLocalAction() { - try { - _getSubscriptionLocalInteractor = Get.find(); - consumeState(_getSubscriptionLocalInteractor!.execute()); - } catch (e) { - logError( - 'ReloadableController::getSubscriptionLocalAction(): exception: $e'); - logoutAction(); - } - return Future.value(); - } - - void _destroySubscriptionAction(String subscriptionId) { - try { - _destroySubscriptionInteractor = Get.find(); - consumeState(_destroySubscriptionInteractor!.execute(subscriptionId)); - } catch(e) { - logError('ReloadableController::destroySubscriptionAction(): exception: $e'); - logoutAction(); - } - } - - bool fcmEnabled(Session? session, AccountId? accountId) { - bool fcmEnabled = false; - try { - requireCapability(session!, accountId!, [FirebaseCapability.fcmIdentifier]); - if (AppConfig.fcmAvailable) { - fcmEnabled = true; - } else { - fcmEnabled = false; - } - } catch (e) { - logError('BaseController::fcmEnabled(): exception: $e'); - } - return fcmEnabled; - } - - void logout(Session? session, AccountId? accountId) { - _isFcmEnabled = fcmEnabled(session, accountId); - if (_isFcmEnabled) { - final authenticationType = _authorizationInterceptors.authenticationType; - if (authenticationType == AuthenticationType.oidc) { - consumeState(_logoutOidcInteractor.execute()); - } else { - _getSubscriptionLocalAction(); - } - } else { - _checkAuthenticationTypeWhenLogout(); - } - } - - void _checkAuthenticationTypeWhenLogout() { - final authenticationType = _authorizationInterceptors.authenticationType; - if (authenticationType == AuthenticationType.oidc) { - _logoutOIDCAction(); - } else { - logoutAction(); - } - } - void updateAuthenticationAccount(Session? session, AccountId? accountId) { final apiUrl = session?.apiUrl.toString() ?? ''; log('ReloadableController::updateAuthenticationAccount():apiUrl: $apiUrl');