TF-3157 Implement web socket push

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,76 @@
+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/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;
+  
+  const RemoteWebSocketDatasourceImpl(this._webSocketApi, this._exceptionThrower);
+
+  @override
+  Stream getWebSocketChannel(Session session, AccountId accountId) {
+    return Stream
+      .castFrom(_getWebSocketChannel(session, accountId))
+      .doOnError(_exceptionThrower.throwException);
+  }
+
+  Stream _getWebSocketChannel(
+    Session session,
+    AccountId accountId,
+    [int retryRemained = 3]
+    ) async* {
+    try {
+      _verifyWebSocketCapabilities(session, accountId);
+      final webSocketTicket = await _webSocketApi.getWebSocketTicket(session, accountId);
+      final webSocketUri = _getWebSocketUri(session, accountId);
+      
+      final webSocketChannel = WebSocketChannel.connect(
+        Uri.parse('$webSocketUri?ticket=$webSocketTicket'));
+      await webSocketChannel.ready;
+      webSocketChannel.sink.add(jsonEncode({"@type": "WebSocketPushEnable"}));
+      
+      yield* webSocketChannel.stream;
+    } catch (e) {
+      logError('RemoteWebSocketDatasourceImpl::getWebSocketChannel():error: $e');
+      if (retryRemained > 0) {
+        yield* _getWebSocketChannel(session, accountId, retryRemained - 1);
+      } else {
+        rethrow;
+      }
+    }
+  }
+
+  void _verifyWebSocketCapabilities(Session session, AccountId accountId) {
+    if (!CapabilityIdentifier.jmapWebSocket.isSupported(session, accountId)
+      || !CapabilityIdentifier.jmapWebSocketTicket.isSupported(session, accountId)
+    ) {
+      throw WebSocketPushNotSupportedException();
+    }
+  }
+
+  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,33 @@
+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? value;
+  final String? clientAddress;
+  final DateTime? generatedOn;
+  final DateTime? validUntil;
+  final String? username;
+
+  WebSocketTicket({
+    required this.value,
+    required this.clientAddress,
+    required this.generatedOn,
+    required this.validUntil,
+    required this.username,
+  });
+
+  factory WebSocketTicket.fromJson(Map<String, dynamic> json) => _$WebSocketTicketFromJson(json);
+  Map<String, dynamic> toJson() => _$WebSocketTicketToJson(this);
+
+  @override
+  List<Object?> get props => [
+    value,
+    clientAddress,
+    generatedOn,
+    validUntil,
+    username,
+  ];
+}

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

@@ -0,0 +1,43 @@
+
+import 'package:core/data/network/dio_client.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/session/session.dart';
+import 'package:model/extensions/session_extension.dart';
+import 'package:tmail_ui_user/features/push_notification/data/model/web_socket_ticket.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';
+
+class WebSocketApi {
+  final DioClient _dioClient;
+
+  WebSocketApi(this._dioClient);
+
+  Future<String> getWebSocketTicket(
+    Session session,
+    AccountId accountId
+  ) async {
+    requireCapability(
+      session,
+      accountId,
+      [CapabilityIdentifier.jmapWebSocketTicket]);
+    final webSocketTicketCapability = session.getCapabilityProperties<WebSocketTicketCapability>(
+      accountId,
+      CapabilityIdentifier.jmapWebSocketTicket);
+    
+    final webSocketTicketGenerationUrl = webSocketTicketCapability?.generationEndpoint;
+    if (webSocketTicketGenerationUrl == null) {
+      throw WebSocketTicketUnavailableException();
+    }
+    final webSocketTicketGenerationResponse = await _dioClient.post(
+      '$webSocketTicketGenerationUrl');
+    final webSocketTicket = WebSocketTicket.fromJson(
+      webSocketTicketGenerationResponse);
+    if (webSocketTicket.value == null) {
+      throw WebSocketTicketUnavailableException();
+    }
+
+    return webSocketTicket.value!;
+  }
+}

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);
+}