hamed/add_debug_mode_to_websocket_connection (#250)

- add debug mode to websocket connection

Author: hamed-rezaee

lib/services/connection/api_manager/base_api.dart

@@ -1,4 +1,3 @@
-import 'package:flutter/material.dart';
 import 'package:flutter_deriv_api/api/models/enums.dart';
 import 'package:flutter_deriv_api/basic_api/generated/forget_all_receive.dart';
 import 'package:flutter_deriv_api/basic_api/generated/forget_receive.dart';
@@ -8,15 +7,18 @@ import 'package:flutter_deriv_api/services/connection/api_manager/connection_inf
 import 'package:flutter_deriv_api/services/connection/call_manager/base_call_manager.dart';
 
 /// Callbacks for websocket connection.
-typedef ConnectionCallback = void Function(UniqueKey uniqueKey);
+typedef ConnectionCallback = void Function(String key);
 
 /// Base class for handling API connection and calling APIs.
 abstract class BaseAPI {
   /// Initializes base api.
-  BaseAPI({required this.uniqueKey});
+  BaseAPI({required this.key, this.enableDebug = false});
 
-  /// A key to check the `onDone` function is called from the same instance.
-  final UniqueKey uniqueKey;
+  /// A key to check the connect callback function is called from the same instance.
+  final String key;
+
+  /// A flag to enable debug mode.
+  final bool enableDebug;
 
   /// Connects to API.
   Future<void> connect(

lib/services/connection/api_manager/binary_api.dart

@@ -22,14 +22,16 @@ import 'package:flutter_deriv_api/services/connection/call_manager/subscription_
 
 /// This class is for handling Binary API connection and calling Binary APIs.
 class BinaryAPI extends BaseAPI {
-  /// Initializes binary api.
-  BinaryAPI({UniqueKey? uniqueKey})
-      : super(uniqueKey: uniqueKey ?? UniqueKey());
+  /// Initializes [BinaryAPI] instance.
+  BinaryAPI({String? key, bool enableDebug = false})
+      : super(key: key ?? '${UniqueKey()}', enableDebug: enableDebug);
 
   static const Duration _disconnectTimeOut = Duration(seconds: 5);
   static const Duration _websocketConnectTimeOut = Duration(seconds: 10);
 
-  /// Represents the active web socket connection.
+  /// Represents the active websocket connection.
+  ///
+  /// This is used to send and receive data from the websocket server.
   IOWebSocketChannel? _webSocketChannel;
 
   /// Stream subscription to API data.
@@ -69,11 +71,11 @@ class BinaryAPI extends BaseAPI {
       },
     );
 
-    dev.log('$runtimeType $uniqueKey connecting to $uri.');
+    _logDebugInfo('connecting to $uri.');
 
     await _setUserAgent();
 
-    // Initialize connection to web socket server.
+    // Initialize connection to websocket server.
     _webSocketChannel = IOWebSocketChannel.connect(
       '$uri',
       pingInterval: _websocketConnectTimeOut,
@@ -83,27 +85,28 @@ class BinaryAPI extends BaseAPI {
         .map<Map<String, dynamic>?>((Object? result) => jsonDecode('$result'))
         .listen(
       (Map<String, dynamic>? message) {
-        onOpen?.call(uniqueKey);
+        onOpen?.call(key);
 
         if (message != null) {
           _handleResponse(message, printResponse: printResponse);
         }
       },
       onDone: () async {
-        dev.log('$runtimeType $uniqueKey web socket is closed.');
+        _logDebugInfo('the websocket is closed.');
 
-        onDone?.call(uniqueKey);
+        onDone?.call(key);
       },
       onError: (Object error) {
-        dev.log(
-          '$runtimeType $uniqueKey the web socket connection is closed: $error.',
+        _logDebugInfo(
+          'the websocket connection is closed with error.',
+          error: error,
         );
 
-        onError?.call(uniqueKey);
+        onError?.call(key);
       },
     );
 
-    dev.log('$runtimeType $uniqueKey send initial message.');
+    _logDebugInfo('send initial message.');
   }
 
   void _resetCallManagers() {
@@ -116,8 +119,8 @@ class BinaryAPI extends BaseAPI {
     try {
       _webSocketChannel?.sink.add(utf8.encode(jsonEncode(request)));
       // ignore: avoid_catches_without_on_clauses
-    } catch (e) {
-      dev.log('$runtimeType $uniqueKey error while adding to channel: $e');
+    } catch (error) {
+      _logDebugInfo('error while adding to channel.', error: error);
     }
   }
 
@@ -170,7 +173,7 @@ class BinaryAPI extends BaseAPI {
           );
       // ignore: avoid_catches_without_on_clauses
     } catch (e) {
-      dev.log('$runtimeType $uniqueKey disconnect error', error: e);
+      _logDebugInfo('disconnect error.', error: e);
     } finally {
       _webSocketListener = null;
       _webSocketChannel = null;
@@ -184,21 +187,19 @@ class BinaryAPI extends BaseAPI {
     required bool printResponse,
   }) {
     try {
-      dev.log('$runtimeType $uniqueKey web socket is connected.');
+      _logDebugInfo('the websocket is connected.');
 
       // Make sure that the received message is a map and it's parsable otherwise it throws an exception.
       final Map<String, dynamic> message = Map<String, dynamic>.from(response);
 
       if (printResponse) {
-        dev.log('$runtimeType $uniqueKey api response: $message.');
+        _logDebugInfo('api response: $message.');
       }
 
       if (message.containsKey('req_id')) {
         final int requestId = message['req_id'];
 
-        if (printResponse) {
-          dev.log('$runtimeType $uniqueKey have request id: $requestId.');
-        }
+        _logDebugInfo('have request id: $requestId.');
 
         if (_callManager?.contains(requestId) ?? false) {
           _callManager!.handleResponse(
@@ -211,18 +212,15 @@ class BinaryAPI extends BaseAPI {
             response: message,
           );
         } else {
-          dev.log(
+          _logDebugInfo(
             '$runtimeType $requestId, does not match anything in our pending queue.',
           );
         }
       } else {
-        dev.log('$runtimeType $uniqueKey no req_id, ignoring.');
+        _logDebugInfo('no req_id, ignoring.');
       }
     } on Exception catch (e) {
-      dev.log(
-        '$runtimeType $uniqueKey failed to process $response - $e',
-        error: e,
-      );
+      _logDebugInfo('failed to process $response.', error: e);
     }
   }
 
@@ -233,4 +231,10 @@ class BinaryAPI extends BaseAPI {
       WebSocket.userAgent = userAgent;
     }
   }
+
+  void _logDebugInfo(String message, {Object? error}) {
+    if (enableDebug) {
+      dev.log('$runtimeType $key $message', error: error);
+    }
+  }
 }

lib/services/connection/api_manager/mock_api.dart

@@ -2,6 +2,7 @@ import 'dart:async';
 import 'dart:convert';
 
 import 'package:flutter/material.dart';
+
 import 'package:flutter_deriv_api/api/models/enums.dart';
 import 'package:flutter_deriv_api/basic_api/generated/forget_all_receive.dart';
 import 'package:flutter_deriv_api/basic_api/generated/forget_receive.dart';
@@ -109,7 +110,7 @@ import 'mock_data/user/verify_email_response.dart';
 /// This class is for handling mock API connection and calling mock APIs
 class MockAPI extends BaseAPI {
   /// Initializes
-  MockAPI({UniqueKey? uniqueKey}) : super(uniqueKey: uniqueKey ?? UniqueKey());
+  MockAPI({String? key}) : super(key: key ?? '${UniqueKey()}');
 
   @override
   Future<void> connect(

lib/state/connection/connection_cubit.dart

@@ -21,9 +21,12 @@ class ConnectionCubit extends Cubit<ConnectionState> {
   ConnectionCubit(
     ConnectionInformation connectionInformation, {
     BaseAPI? api,
+    this.enableDebug = false,
     this.printResponse = false,
   }) : super(const ConnectionInitialState()) {
-    APIInitializer().initialize(api: api ?? BinaryAPI(uniqueKey: _uniqueKey));
+    APIInitializer().initialize(
+      api: api ?? BinaryAPI(key: _key, enableDebug: enableDebug),
+    );
 
     _api = Injector()<BaseAPI>();
 
@@ -38,13 +41,20 @@ class ConnectionCubit extends Cubit<ConnectionState> {
     _connect(_connectionInformation);
   }
 
-  /// Prints API response to console.
-  final bool printResponse;
-
-  final UniqueKey _uniqueKey = UniqueKey();
+  final String _key = '${UniqueKey()}';
 
   late final BaseAPI? _api;
 
+  /// Enables debug mode.
+  ///
+  /// Default value is `false`.
+  final bool enableDebug;
+
+  /// Prints API response to console, only works if [enableDebug] is `true`.
+  ///
+  /// Default value is `false`.
+  final bool printResponse;
+
   // In some devices like Samsung J6 or Huawei Y7, the call manager doesn't response to the ping call less than 5 sec.
   final Duration _pingTimeout = const Duration(seconds: 5);
 
@@ -95,21 +105,21 @@ class ConnectionCubit extends Cubit<ConnectionState> {
 
     await _api!.connect(
       _connectionInformation,
-      printResponse: printResponse,
-      onOpen: (UniqueKey uniqueKey) {
-        if (_uniqueKey == uniqueKey) {
+      printResponse: enableDebug && printResponse,
+      onOpen: (String key) {
+        if (_key == key) {
           emit(const ConnectionConnectedState());
         }
       },
-      onDone: (UniqueKey uniqueKey) async {
-        if (_uniqueKey == uniqueKey) {
+      onDone: (String key) async {
+        if (_key == key) {
           await _api!.disconnect();
 
           emit(const ConnectionDisconnectedState());
         }
       },
-      onError: (UniqueKey uniqueKey) {
-        if (_uniqueKey == uniqueKey) {
+      onError: (String key) {
+        if (_key == key) {
           emit(const ConnectionDisconnectedState());
         }
       },