[WIP] TF-3157 Implement web socket push

contact/pubspec.lock

@@ -651,11 +651,11 @@ packages:
     dependency: "direct main"
     description:
       path: "."
-      ref: main
-      resolved-ref: f55a1862c1486197ea6a79feac31776ebeddc66c
+      ref: "enhancement/web-socket-ticket-capability"
+      resolved-ref: "6b3eccb4dabb496cfd7d9d9cee422457281c9cc9"
       url: "https://github.com/linagora/jmap-dart-client.git"
     source: git
-    version: "0.2.2"
+    version: "0.2.3"
   js:
     dependency: transitive
     description:

contact/pubspec.yaml

@@ -18,7 +18,7 @@ dependencies:
   jmap_dart_client:
     git:
       url: https://github.com/linagora/jmap-dart-client.git
-      ref: main
+      ref: enhancement/web-socket-ticket-capability
 
   ### Dependencies from pub.dev ###
   equatable: 2.0.5

email_recovery/pubspec.lock

@@ -295,11 +295,11 @@ packages:
     dependency: "direct main"
     description:
       path: "."
-      ref: main
-      resolved-ref: f55a1862c1486197ea6a79feac31776ebeddc66c
+      ref: "enhancement/web-socket-ticket-capability"
+      resolved-ref: "6b3eccb4dabb496cfd7d9d9cee422457281c9cc9"
       url: "https://github.com/linagora/jmap-dart-client.git"
     source: git
-    version: "0.2.2"
+    version: "0.2.3"
   js:
     dependency: transitive
     description:

email_recovery/pubspec.yaml

@@ -15,7 +15,7 @@ dependencies:
   jmap_dart_client:
     git:
       url: https://github.com/linagora/jmap-dart-client.git
-      ref: main
+      ref: enhancement/web-socket-ticket-capability
 
   ### Dependencies from pub.dev ###
   equatable: 2.0.5

fcm/pubspec.lock

@@ -295,11 +295,11 @@ packages:
     dependency: "direct main"
     description:
       path: "."
-      ref: main
-      resolved-ref: f55a1862c1486197ea6a79feac31776ebeddc66c
+      ref: "enhancement/web-socket-ticket-capability"
+      resolved-ref: "6b3eccb4dabb496cfd7d9d9cee422457281c9cc9"
       url: "https://github.com/linagora/jmap-dart-client.git"
     source: git
-    version: "0.2.2"
+    version: "0.2.3"
   js:
     dependency: transitive
     description:

fcm/pubspec.yaml

@@ -15,7 +15,7 @@ dependencies:
   jmap_dart_client:
     git:
       url: https://github.com/linagora/jmap-dart-client.git
-      ref: main
+      ref: enhancement/web-socket-ticket-capability
 
   ### Dependencies from pub.dev ###
   equatable: 2.0.5

forward/pubspec.lock

@@ -295,11 +295,11 @@ packages:
     dependency: "direct main"
     description:
       path: "."
-      ref: main
-      resolved-ref: f55a1862c1486197ea6a79feac31776ebeddc66c
+      ref: "enhancement/web-socket-ticket-capability"
+      resolved-ref: "6b3eccb4dabb496cfd7d9d9cee422457281c9cc9"
       url: "https://github.com/linagora/jmap-dart-client.git"
     source: git
-    version: "0.2.2"
+    version: "0.2.3"
   js:
     dependency: transitive
     description:

forward/pubspec.yaml

@@ -15,7 +15,7 @@ dependencies:
   jmap_dart_client:
     git:
       url: https://github.com/linagora/jmap-dart-client.git
-      ref: main
+      ref: enhancement/web-socket-ticket-capability
 
   ### Dependencies from pub.dev ###
   equatable: 2.0.5

lib/features/base/action/ui_action.dart

@@ -7,11 +7,9 @@ abstract class Action with EquatableMixin {}
 
 abstract class UIAction extends Action {}
 
-abstract class FcmAction extends Action {}
-
-abstract class FcmStateChangeAction extends FcmAction {
+abstract class PushNotificationStateChangeAction extends UIAction {
   final TypeName typeName;
   final jmap.State newState;
 
-  FcmStateChangeAction(this.typeName, this.newState);
+  PushNotificationStateChangeAction(this.typeName, this.newState);
 }

lib/features/base/base_controller.dart

@@ -49,9 +49,11 @@ import 'package:tmail_ui_user/features/push_notification/domain/state/get_stored
 import 'package:tmail_ui_user/features/push_notification/domain/usecases/destroy_firebase_registration_interactor.dart';
 import 'package:tmail_ui_user/features/push_notification/domain/usecases/get_stored_firebase_registration_interactor.dart';
 import 'package:tmail_ui_user/features/push_notification/presentation/bindings/fcm_interactor_bindings.dart';
+import 'package:tmail_ui_user/features/push_notification/presentation/bindings/web_socket_interactor_bindings.dart';
 import 'package:tmail_ui_user/features/push_notification/presentation/config/fcm_configuration.dart';
 import 'package:tmail_ui_user/features/push_notification/presentation/controller/fcm_message_controller.dart';
 import 'package:tmail_ui_user/features/push_notification/presentation/controller/fcm_token_controller.dart';
+import 'package:tmail_ui_user/features/push_notification/presentation/controller/web_socket_controller.dart';
 import 'package:tmail_ui_user/features/push_notification/presentation/notification/local_notification_manager.dart';
 import 'package:tmail_ui_user/features/push_notification/presentation/services/fcm_receiver.dart';
 import 'package:tmail_ui_user/features/push_notification/presentation/services/fcm_service.dart';
@@ -372,6 +374,23 @@ abstract class BaseController extends GetxController
     }
   }
 
+  void injectWebSocket(Session? session, AccountId? accountId) {
+    try {
+      requireCapability(
+        session!,
+        accountId!,
+        [
+          CapabilityIdentifier.jmapWebSocket,
+          CapabilityIdentifier.jmapWebSocketTicket
+        ]
+      );
+      WebSocketInteractorBindings().dependencies();
+      WebSocketController.instance.initialize(accountId: accountId, session: session);
+    } catch(e) {
+      logError('$runtimeType::injectWebSocket(): exception: $e');
+    }
+  }
+
   AuthenticationType get authenticationType => authorizationInterceptors.authenticationType;
 
   bool get isAuthenticatedWithOidc => authenticationType == AuthenticationType.oidc;

lib/features/mailbox_dashboard/presentation/controller/mailbox_dashboard_controller.dart

@@ -570,7 +570,11 @@ class MailboxDashBoardController extends ReloadableController with UserSettingPo
     injectAutoCompleteBindings(session, currentAccountId);
     injectRuleFilterBindings(session, currentAccountId);
     injectVacationBindings(session, currentAccountId);
-    injectFCMBindings(session, currentAccountId);
+    if (PlatformInfo.isWeb) {
+      injectWebSocket(session, currentAccountId);
+    } else {
+      injectFCMBindings(session, currentAccountId);
+    }
 
     _getVacationResponse();
     spamReportController.getSpamReportStateAction();

lib/features/push_notification/data/datasource/web_socket_datasource.dart

@@ -0,0 +1,6 @@
+import 'package:jmap_dart_client/jmap/account_id.dart';
+import 'package:jmap_dart_client/jmap/core/session/session.dart';
+
+abstract class WebSocketDatasource {
+  Stream<dynamic> getWebSocketChannel(Session session, AccountId accountId);
+}

lib/features/push_notification/data/datasource_impl/remote_web_socket_datasource_impl.dart

@@ -0,0 +1,93 @@
+import 'dart:convert';
+
+import 'package:core/utils/app_logger.dart';
+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/web_socket_ticket_capability.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/network/web_socket_api.dart';
+import 'package:tmail_ui_user/features/push_notification/domain/exceptions/web_socket_exceptions.dart';
+import 'package:tmail_ui_user/main/error/capability_validator.dart';
+import 'package:tmail_ui_user/main/exceptions/exception_thrower.dart';
+import 'package:web_socket_channel/web_socket_channel.dart';
+
+class RemoteWebSocketDatasourceImpl implements WebSocketDatasource {
+  final WebSocketApi _webSocketApi;
+  final ExceptionThrower _exceptionThrower;
+
+  RemoteWebSocketDatasourceImpl(this._webSocketApi, this._exceptionThrower);
+
+  int _webSocketRetryRemained = 3;
+
+  @override
+  Stream getWebSocketChannel(Session session, AccountId accountId) {
+    return Stream
+      .castFrom(_getWebSocketChannel(session, accountId))
+      .doOnError(_exceptionThrower.throwException);
+  }
+
+  Stream _getWebSocketChannel(Session session, AccountId accountId) async* {
+    try {
+      _verifyWebSocketCapabilities(session, accountId);
+      final webSocketTicket = await _generateWebSocketTicket(session, accountId);
+      final webSocketUri = _getWebSocketUri(session, accountId);
+
+      final webSocketChannel = WebSocketChannel.connect(
+        Uri.parse('$webSocketUri?ticket=$webSocketTicket'),
+        protocols: ['jmap']);
+      await webSocketChannel.ready;
+      webSocketChannel.sink.add(jsonEncode({"@type": "WebSocketPushEnable"}));
+
+      yield* webSocketChannel.stream;
+    } catch (e) {
+      log('RemoteWebSocketDatasourceImpl::getWebSocketChannel():error: $e');
+      if (_webSocketRetryRemained > 0) {
+        _webSocketRetryRemained--;
+        yield* _getWebSocketChannel(session, accountId);
+      } else {
+        rethrow;
+      }
+    }
+  }
+
+  void _verifyWebSocketCapabilities(Session session, AccountId accountId) {
+    requireCapability(
+      session,
+      accountId,
+      [
+        CapabilityIdentifier.jmapWebSocket,
+        CapabilityIdentifier.jmapWebSocketTicket
+      ]
+    );
+  }
+
+  Future<String> _generateWebSocketTicket(Session session, AccountId accountId) async {
+    final webSocketTicketCapability = session.getCapabilityProperties<WebSocketTicketCapability>(
+      accountId,
+      CapabilityIdentifier.jmapWebSocketTicket);
+
+    final webSocketTicketGenerationUrl = webSocketTicketCapability?.generationEndpoint;
+    if (webSocketTicketGenerationUrl == null) throw WebSocketTicketUnavailableException();
+    final webSocketTicket = await _webSocketApi.getWebSocketTicket('$webSocketTicketGenerationUrl');
+    if (webSocketTicket.ticket == null) throw WebSocketTicketUnavailableException();
+
+    return webSocketTicket.ticket!;
+  }
+
+  Uri _getWebSocketUri(Session session, AccountId accountId) {
+    final webSocketCapability = session.getCapabilityProperties<WebSocketCapability>(
+      accountId,
+      CapabilityIdentifier.jmapWebSocket);
+    if (webSocketCapability?.supportsPush != true) {
+      throw WebSocketPushNotSupportedException();
+    }
+    final webSocketUri = webSocketCapability?.url;
+    if (webSocketUri == null) throw WebSocketUriUnavailableException();
+
+    return webSocketUri;
+  }
+}

lib/features/push_notification/data/model/web_socket_ticket.dart

@@ -0,0 +1,29 @@
+import 'package:equatable/equatable.dart';
+import 'package:json_annotation/json_annotation.dart';
+
+part 'web_socket_ticket.g.dart';
+
+@JsonSerializable(includeIfNull: false)
+class WebSocketTicket with EquatableMixin {
+  final String? ticket;
+  final String? clientAddress;
+  final DateTime? generatedOn;
+  final DateTime? validUntil;
+
+  WebSocketTicket({
+    required this.ticket,
+    required this.clientAddress,
+    required this.generatedOn,
+    required this.validUntil,
+  });
+
+  factory WebSocketTicket.fromJson(Map<String, dynamic> json) => _$WebSocketTicketFromJson(json);
+  Map<String, dynamic> toJson() => _$WebSocketTicketToJson(this);
+
+  @override
+  List<Object?> get props => [
+    ticket,
+    clientAddress,
+    generatedOn,
+    validUntil];
+}

lib/features/push_notification/data/network/web_socket_api.dart

@@ -0,0 +1,15 @@
+import 'dart:convert';
+
+import 'package:core/data/network/dio_client.dart';
+import 'package:tmail_ui_user/features/push_notification/data/model/web_socket_ticket.dart';
+
+class WebSocketApi {
+  final DioClient _dioClient;
+
+  WebSocketApi(this._dioClient);
+
+  Future<WebSocketTicket> getWebSocketTicket(String url) async {
+    final response = await _dioClient.post(url);
+    return WebSocketTicket.fromJson(jsonDecode(response.data));
+  }
+}

lib/features/push_notification/data/repository/web_socket_repository_impl.dart

@@ -0,0 +1,14 @@
+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';
+
+class WebSocketRepositoryImpl implements WebSocketRepository {
+  final WebSocketDatasource _webSocketDatasource;
+
+  WebSocketRepositoryImpl(this._webSocketDatasource);
+
+  @override
+  Stream getWebSocketChannel(Session session, AccountId accountId)
+    => _webSocketDatasource.getWebSocketChannel(session, accountId);
+}

lib/features/push_notification/domain/exceptions/web_socket_exceptions.dart

@@ -0,0 +1,5 @@
+class WebSocketPushNotSupportedException implements Exception {}
+
+class WebSocketUriUnavailableException implements Exception {}
+
+class WebSocketTicketUnavailableException implements Exception {}

lib/features/push_notification/domain/repository/web_socket_repository.dart

@@ -0,0 +1,6 @@
+import 'package:jmap_dart_client/jmap/account_id.dart';
+import 'package:jmap_dart_client/jmap/core/session/session.dart';
+
+abstract class WebSocketRepository {
+  Stream getWebSocketChannel(Session session, AccountId accountId);
+}

lib/features/push_notification/domain/state/web_socket_push_state.dart

@@ -0,0 +1,19 @@
+import 'package:core/presentation/state/failure.dart';
+import 'package:core/presentation/state/success.dart';
+import 'package:jmap_dart_client/jmap/push/state_change.dart';
+
+class InitializingWebSocketPushChannel extends LoadingState {}
+
+class WebSocketPushStateReceived extends UIState {
+  final StateChange stateChange;
+
+  WebSocketPushStateReceived(this.stateChange);
+
+  @override
+  List<Object?> get props => [stateChange];
+}
+
+class WebSocketConnectionFailed extends FeatureFailure {
+
+  WebSocketConnectionFailed({super.exception});
+}