eduvia/workavia-mail-front
11
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

TF-3157 Remove unnecessary background service worker

Browse Source
This commit is contained in:
DatDang
2024-11-04 16:28:13 +07:00
committed by Dat H. Pham
parent 7d59982cc9
commit b76e8bb725
20 changed files with 151 additions and 447 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/features/push_notification/data/datasource/web_socket_datasource.dart
+4 -1
View File
@@ -1,6 +1,9 @@
import 'package:jmap_dart_client/jmap/account_id.dart';
import 'package:jmap_dart_client/jmap/core/session/session.dart';
import 'package:web_socket_channel/web_socket_channel.dart';
abstract class WebSocketDatasource {
Stream<dynamic> getWebSocketChannel(Session session, AccountId accountId);
Future<WebSocketChannel> getWebSocketChannel(
Session session,
AccountId accountId);
}
lib/features/push_notification/data/datasource_impl/web_socket_datasource_impl.dart
+14 -42
View File
@@ -1,21 +1,17 @@
import 'package:core/data/constants/constant.dart';
import 'package:core/utils/app_logger.dart';
import 'package:core/utils/broadcast_channel/broadcast_channel.dart';
import 'dart:async';
import 'package:jmap_dart_client/jmap/account_id.dart';
import 'package:jmap_dart_client/jmap/core/capability/capability_identifier.dart';
import 'package:jmap_dart_client/jmap/core/capability/websocket_capability.dart';
import 'package:jmap_dart_client/jmap/core/session/session.dart';
import 'package:model/extensions/session_extension.dart';
import 'package:rxdart/transformers.dart';
import 'package:tmail_ui_user/features/push_notification/data/datasource/web_socket_datasource.dart';
import 'package:tmail_ui_user/features/push_notification/data/model/connect_web_socket_message.dart';
import 'package:tmail_ui_user/features/push_notification/data/network/web_socket_api.dart';
import 'package:tmail_ui_user/features/push_notification/domain/exceptions/web_socket_exceptions.dart';
import 'package:tmail_ui_user/features/push_notification/domain/model/web_socket_action.dart';
import 'package:tmail_ui_user/main/error/capability_validator.dart';
import 'package:tmail_ui_user/main/exceptions/exception_thrower.dart';
import 'package:universal_html/html.dart';
import 'package:web_socket_channel/web_socket_channel.dart';
class WebSocketDatasourceImpl implements WebSocketDatasource {
final WebSocketApi _webSocketApi;
@@ -23,35 +19,21 @@ class WebSocketDatasourceImpl implements WebSocketDatasource {
const WebSocketDatasourceImpl(this._webSocketApi, this._exceptionThrower);
static const String _webSocketClosed = 'webSocketClosed';
@override
Stream getWebSocketChannel(Session session, AccountId accountId) {
return Stream
.castFrom(_getWebSocketChannel(session, accountId))
.doOnError(_exceptionThrower.throwException);
}
Stream _getWebSocketChannel(
Session session,
AccountId accountId,
) async* {
final broadcastChannel = BroadcastChannel(Constant.wsServiceWorkerBroadcastChannel);
try {
Future<WebSocketChannel> getWebSocketChannel(Session session, AccountId accountId) {
return Future.sync(() async {
_verifyWebSocketCapabilities(session, accountId);
final webSocketTicket = await _webSocketApi.getWebSocketTicket(session, accountId);
final webSocketUri = _getWebSocketUri(session, accountId);
window.navigator.serviceWorker?.controller?.postMessage(ConnectWebSocketMessage(
webSocketAction: WebSocketAction.connect,
webSocketUrl: webSocketUri.toString(),
webSocketTicket: webSocketTicket
).toJson());
yield* _webSocketListener(broadcastChannel);
} catch (e) {
logError('RemoteWebSocketDatasourceImpl::getWebSocketChannel():error: $e');
rethrow;
}
final webSocketChannel = WebSocketChannel.connect(
Uri.parse('$webSocketUri?ticket=$webSocketTicket'),
protocols: ["jmap"],
);
await webSocketChannel.ready;
return webSocketChannel;
}).catchError(_exceptionThrower.throwException);
}
void _verifyWebSocketCapabilities(Session session, AccountId accountId) {
@@ -77,14 +59,4 @@ class WebSocketDatasourceImpl implements WebSocketDatasource {
return webSocketUri;
}
Stream _webSocketListener(BroadcastChannel broadcastChannel) {
return broadcastChannel.onMessage.map((event) {
if (event.data == _webSocketClosed) {
throw WebSocketClosedException();
}
return event.data;
});
}
}
lib/features/push_notification/data/model/web_socket_echo.dart
-31
View File
@@ -1,31 +0,0 @@
import 'package:json_annotation/json_annotation.dart';
part 'web_socket_echo.g.dart';
@JsonSerializable(includeIfNull: false)
class WebSocketEcho {
@JsonKey(name: '@type')
final String? type;
final String? requestId;
final List<List<dynamic>>? methodResponses;
WebSocketEcho({
this.type,
this.requestId,
this.methodResponses,
});
factory WebSocketEcho.fromJson(Map<String, dynamic> json) => _$WebSocketEchoFromJson(json);
Map<String, dynamic> toJson() => _$WebSocketEchoToJson(this);
static bool isValid(Map<String, dynamic> json) {
try {
final webSocketEcho = WebSocketEcho.fromJson(json);
final listResponses = webSocketEcho.methodResponses?.firstOrNull;
return listResponses?.contains('Core/echo') ?? false;
} catch (_) {
return false;
}
}
}
lib/features/push_notification/data/model/web_socket_echo_request.dart
+19
View File
@@ -0,0 +1,19 @@
import 'package:jmap_dart_client/jmap/core/capability/capability_identifier.dart';
import 'package:tmail_ui_user/features/push_notification/data/model/web_socket_request.dart';
class WebSocketEchoRequest extends WebSocketRequest {
static const String type = 'Request';
static const String id = 'R1';
static final CapabilityIdentifier usingCapability = CapabilityIdentifier.jmapCore;
static const String method = 'Core/echo';
@override
Map<String, dynamic> toJson() {
return {
'@type': type,
'id': id,
'using': [usingCapability.value.toString()],
'methodCalls': [[method, {}, 'c0']],
};
}
}
lib/features/push_notification/data/model/web_socket_push_enable_request.dart
+14
View File
@@ -0,0 +1,14 @@
import 'package:fcm/model/type_name.dart';
class WebSocketPushEnableRequest {
static const String type = 'WebSocketPushEnable';
static Map<String, dynamic> toJson({
required List<TypeName> dataTypes,
}) {
return {
'@type': type,
'dataTypes': dataTypes.map((typeName) => typeName.value).toList(),
};
}
}
lib/features/push_notification/data/model/web_socket_request.dart
+5
View File
@@ -0,0 +1,5 @@
abstract class WebSocketRequest {
const WebSocketRequest();
Map<String, dynamic> toJson();
}
lib/features/push_notification/data/repository/web_socket_repository_impl.dart
+5 -2
View File
@@ -2,6 +2,7 @@ import 'package:jmap_dart_client/jmap/account_id.dart';
import 'package:jmap_dart_client/jmap/core/session/session.dart';
import 'package:tmail_ui_user/features/push_notification/data/datasource/web_socket_datasource.dart';
import 'package:tmail_ui_user/features/push_notification/domain/repository/web_socket_repository.dart';
import 'package:web_socket_channel/web_socket_channel.dart';
class WebSocketRepositoryImpl implements WebSocketRepository {
final WebSocketDatasource _webSocketDatasource;
@@ -9,6 +10,8 @@ class WebSocketRepositoryImpl implements WebSocketRepository {
WebSocketRepositoryImpl(this._webSocketDatasource);
@override
Stream getWebSocketChannel(Session session, AccountId accountId)
=> _webSocketDatasource.getWebSocketChannel(session, accountId);
Future<WebSocketChannel> getWebSocketChannel(
Session session,
AccountId accountId
) => _webSocketDatasource.getWebSocketChannel(session, accountId);
}
lib/features/push_notification/domain/repository/web_socket_repository.dart
+4 -1
View File
@@ -1,6 +1,9 @@
import 'package:jmap_dart_client/jmap/account_id.dart';
import 'package:jmap_dart_client/jmap/core/session/session.dart';
import 'package:web_socket_channel/web_socket_channel.dart';
abstract class WebSocketRepository {
Stream getWebSocketChannel(Session session, AccountId accountId);
Future<WebSocketChannel> getWebSocketChannel(
Session session,
AccountId accountId);
}
lib/features/push_notification/domain/state/web_socket_push_state.dart
+5 -5
View File
@@ -1,16 +1,16 @@
import 'package:core/presentation/state/failure.dart';
import 'package:core/presentation/state/success.dart';
import 'package:jmap_dart_client/jmap/push/state_change.dart';
import 'package:web_socket_channel/web_socket_channel.dart';
class InitializingWebSocketPushChannel extends LoadingState {}
class WebSocketPushStateReceived extends UIState {
final StateChange? stateChange;
class WebSocketConnectionSuccess extends UIState {
final WebSocketChannel webSocketChannel;
WebSocketPushStateReceived(this.stateChange);
WebSocketConnectionSuccess(this.webSocketChannel);
@override
List<Object?> get props => [stateChange];
List<Object?> get props => [webSocketChannel];
}
class WebSocketConnectionFailed extends FeatureFailure {
lib/features/push_notification/domain/usecases/connect_web_socket_interactor.dart
+4 -26
View File
@@ -1,13 +1,9 @@
import 'dart:convert';
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:jmap_dart_client/jmap/account_id.dart';
import 'package:jmap_dart_client/jmap/core/session/session.dart';
import 'package:jmap_dart_client/jmap/push/state_change.dart';
import 'package:tmail_ui_user/features/push_notification/data/model/web_socket_echo.dart';
import 'package:tmail_ui_user/features/push_notification/domain/repository/web_socket_repository.dart';
import 'package:tmail_ui_user/features/push_notification/domain/state/web_socket_push_state.dart';
@@ -22,31 +18,13 @@ class ConnectWebSocketInteractor {
) async* {
try {
yield Right(InitializingWebSocketPushChannel());
yield* _webSocketRepository
.getWebSocketChannel(session, accountId)
.map(_toStateChange);
final webSocketChannel = await _webSocketRepository.getWebSocketChannel(
session,
accountId);
yield Right(WebSocketConnectionSuccess(webSocketChannel));
} catch (e) {
logError('ConnectWebSocketInteractor::execute: $e');
yield Left(WebSocketConnectionFailed(exception: e));
}
}
Either<Failure, Success> _toStateChange(dynamic data) {
StateChange? possibleStateChange;
try {
if (data is String) {
data = jsonDecode(data);
}
possibleStateChange = StateChange.fromJson(data);
return Right(WebSocketPushStateReceived(possibleStateChange));
} catch (e) {
logError('ConnectWebSocketInteractor::_toStateChange: '
'websocket message is not StateChange: $data');
final dataIsWebSocketEcho = WebSocketEcho.isValid(data);
if (dataIsWebSocketEcho) {
return Right(WebSocketPushStateReceived(null));
}
return Left(WebSocketConnectionFailed(exception: e));
}
}
}
lib/features/push_notification/presentation/controller/push_base_controller.dart
+1 -8
View File
@@ -19,10 +19,8 @@ abstract class PushBaseController {
Session? session;
AccountId? accountId;
StreamSubscription<Either<Failure, Success>>? _stateStreamSubscription;
void consumeState(Stream<Either<Failure, Success>> newStateStream) {
_stateStreamSubscription = newStateStream.listen(
newStateStream.listen(
_handleStateStream,
onError: handleErrorViewState,
);
@@ -40,11 +38,6 @@ abstract class PushBaseController {
logError('PushBaseController::handleErrorViewState():error: $error | stackTrace: $stackTrace');
}
void cancelStateStreamSubscription() {
_stateStreamSubscription?.cancel();
_stateStreamSubscription = null;
}
void initialize({AccountId? accountId, Session? session}) {
this.accountId = accountId;
this.session = session;
lib/features/push_notification/presentation/controller/web_socket_controller.dart
+73 -21
View File
@@ -1,9 +1,15 @@
import 'dart:async';
import 'dart:convert';
import 'package:core/presentation/state/failure.dart';
import 'package:core/presentation/state/success.dart';
import 'package:core/utils/app_logger.dart';
import 'package:fcm/model/type_name.dart';
import 'package:jmap_dart_client/jmap/account_id.dart';
import 'package:jmap_dart_client/jmap/core/session/session.dart';
import 'package:tmail_ui_user/features/push_notification/domain/exceptions/web_socket_exceptions.dart';
import 'package:jmap_dart_client/jmap/push/state_change.dart';
import 'package:tmail_ui_user/features/push_notification/data/model/web_socket_echo_request.dart';
import 'package:tmail_ui_user/features/push_notification/data/model/web_socket_push_enable_request.dart';
import 'package:tmail_ui_user/features/push_notification/domain/state/web_socket_push_state.dart';
import 'package:tmail_ui_user/features/push_notification/domain/usecases/connect_web_socket_interactor.dart';
import 'package:tmail_ui_user/features/push_notification/presentation/controller/push_base_controller.dart';
@@ -11,6 +17,7 @@ import 'package:tmail_ui_user/features/push_notification/presentation/extensions
import 'package:tmail_ui_user/features/push_notification/presentation/listener/email_change_listener.dart';
import 'package:tmail_ui_user/features/push_notification/presentation/listener/mailbox_change_listener.dart';
import 'package:tmail_ui_user/main/routes/route_navigation.dart';
import 'package:web_socket_channel/web_socket_channel.dart';
class WebSocketController extends PushBaseController {
WebSocketController._internal();
@@ -22,11 +29,16 @@ class WebSocketController extends PushBaseController {
ConnectWebSocketInteractor? _connectWebSocketInteractor;
int _retryRemained = 3;
WebSocketChannel? _webSocketChannel;
Timer? _webSocketPingTimer;
StreamSubscription? _webSocketSubscription;
@override
void handleFailureViewState(Failure failure) {
logError('WebSocketController::handleFailureViewState():Failure $failure');
cancelStateStreamSubscription();
_webSocketSubscription?.cancel();
_webSocketChannel = null;
_webSocketPingTimer?.cancel();
if (failure is WebSocketConnectionFailed) {
_handleWebSocketConnectionRetry();
}
@@ -35,18 +47,15 @@ class WebSocketController extends PushBaseController {
@override
void handleSuccessViewState(Success success) {
log('WebSocketController::handleSuccessViewState():Success $success');
if (success is WebSocketPushStateReceived) {
_handleWebSocketPushStateReceived(success);
if (success is WebSocketConnectionSuccess) {
_handleWebSocketConnectionSuccess(success);
}
}
@override
void handleErrorViewState(Object error, StackTrace stackTrace) {
super.handleErrorViewState(error, stackTrace);
cancelStateStreamSubscription();
if (error is WebSocketClosedException) {
_handleWebSocketConnectionRetry();
}
handleFailureViewState(WebSocketConnectionFailed());
}
@override
@@ -65,26 +74,69 @@ class WebSocketController extends PushBaseController {
consumeState(_connectWebSocketInteractor!.execute(session, accountId));
}
void _handleWebSocketPushStateReceived(WebSocketPushStateReceived success) {
log('WebSocketController::_handleWebSocketPushStateReceived(): $success');
void _handleWebSocketConnectionSuccess(WebSocketConnectionSuccess success) {
log('WebSocketController::_handleWebSocketConnectionSuccess(): $success');
_retryRemained = 3;
if (accountId == null || session == null) return;
final stateChange = success.stateChange;
if (stateChange == null) return;
final mapTypeState = stateChange.getMapTypeState(accountId!);
mappingTypeStateToAction(
mapTypeState,
accountId!,
emailChangeListener: EmailChangeListener.instance,
mailboxChangeListener: MailboxChangeListener.instance,
session!.username,
session: session);
_webSocketChannel = success.webSocketChannel;
_enableWebSocketPush();
_pingWebSocket();
_listenToWebSocket();
}
void _handleWebSocketConnectionRetry() {
_webSocketSubscription?.cancel();
_webSocketChannel = null;
_webSocketPingTimer?.cancel();
if (_retryRemained > 0) {
_retryRemained--;
_connectWebSocket(accountId, session);
}
}
void _enableWebSocketPush() {
_webSocketChannel?.sink.add(jsonEncode(WebSocketPushEnableRequest.toJson(
dataTypes: [TypeName.emailType, TypeName.mailboxType]
)));
}
void _pingWebSocket() {
_webSocketPingTimer = Timer.periodic(const Duration(seconds: 10), (_) {
_webSocketChannel?.sink.add(jsonEncode(WebSocketEchoRequest().toJson()));
});
}
void _listenToWebSocket() {
_webSocketSubscription = _webSocketChannel?.stream.listen(
(data) {
log('WebSocketController::_listenToWebSocket(): $data');
if (session == null || accountId == null) return;
if (data is String) {
data = jsonDecode(data);
}
try {
final stateChange = StateChange.fromJson(data);
final mapTypeState = stateChange.getMapTypeState(accountId!);
mappingTypeStateToAction(
mapTypeState,
accountId!,
emailChangeListener: EmailChangeListener.instance,
mailboxChangeListener: MailboxChangeListener.instance,
session!.username,
session: session);
} catch (e) {
logError('WebSocketController::_listenToWebSocket(): Data is not StateChange');
}
},
cancelOnError: true,
onError: (error) {
logError('WebSocketController::_listenToWebSocket():Error: $error');
handleFailureViewState(WebSocketConnectionFailed(exception: error));
},
onDone: () {
log('WebSocketController::_listenToWebSocket():onDone');
_handleWebSocketConnectionRetry();
},
);
}
}
lib/features/push_notification/presentation/services/fcm_receiver.dart
+2 -48
View File
@@ -1,11 +1,7 @@
import 'package:core/utils/app_logger.dart';
import 'package:core/utils/broadcast_channel/broadcast_channel.dart';
import 'package:core/utils/platform_info.dart';
import 'package:firebase_messaging/firebase_messaging.dart';
import 'package:tmail_ui_user/features/push_notification/presentation/controller/fcm_message_controller.dart';
import 'package:tmail_ui_user/features/push_notification/presentation/services/fcm_service.dart';
import 'package:tmail_ui_user/main/utils/app_config.dart';
import 'package:universal_html/html.dart' as html show MessageEvent, DomException;
@pragma('vm:entry-point')
Future<void> handleFirebaseBackgroundMessage(RemoteMessage message) async {
@@ -23,32 +19,11 @@ class FcmReceiver {
static const int MAX_COUNT_RETRY_TO_GET_FCM_TOKEN = 3;
int _countRetryToGetFcmToken = 0;
Future onInitialFcmListener() async {
_countRetryToGetFcmToken = 0;
_onForegroundMessage();
_onBackgroundMessage();
if (PlatformInfo.isWeb) {
_onMessageBroadcastChannel();
await _requestNotificationPermissionOnWeb();
} else {
await _onHandleFcmToken();
}
}
Future<void> _requestNotificationPermissionOnWeb() async {
NotificationSettings notificationSetting = await FirebaseMessaging.instance.getNotificationSettings();
log('FcmReceiver::_requestNotificationPermissionOnWeb: authorizationStatus = ${notificationSetting.authorizationStatus}');
if (notificationSetting.authorizationStatus != AuthorizationStatus.authorized) {
notificationSetting = await FirebaseMessaging.instance.requestPermission();
if (notificationSetting.authorizationStatus == AuthorizationStatus.authorized) {
await _onHandleFcmToken();
}
} else {
await _onHandleFcmToken();
}
await _onHandleFcmToken();
}
void _onForegroundMessage() {
@@ -59,38 +34,17 @@ class FcmReceiver {
FirebaseMessaging.onBackgroundMessage(handleFirebaseBackgroundMessage);
}
void _onMessageBroadcastChannel() {
final broadcast = BroadcastChannel('background-message');
broadcast.onMessage.listen((event) {
if (event is html.MessageEvent) {
FcmService.instance.handleMessageEventBroadcastChannel(event);
}
});
}
Future<String?> _getInitialToken() async {
try {
final vapidKey = PlatformInfo.isWeb ? AppConfig.fcmVapidPublicKeyWeb : null;
final token = await FirebaseMessaging.instance.getToken(vapidKey: vapidKey);
final token = await FirebaseMessaging.instance.getToken();
log('FcmReceiver::_getInitialToken:token: $token');
return token;
} catch (e) {
logError('FcmReceiver::_getInitialToken: TYPE = ${e.runtimeType} | Exception = $e');
if (PlatformInfo.isWeb
&& e is html.DomException
&& _countRetryToGetFcmToken < MAX_COUNT_RETRY_TO_GET_FCM_TOKEN) {
return await _retryGetToken();
}
return null;
}
}
Future<String?> _retryGetToken() async {
_countRetryToGetFcmToken++;
log('FcmReceiver::_retryGetToken: CountRetry = $_countRetryToGetFcmToken');
return await _getInitialToken();
}
Future _onHandleFcmToken() async {
final token = await _getInitialToken();
FcmService.instance.handleToken(token);