feat: add support for custom HttpClient configuration

donemerson · jumperchen · commit b80a08ff01c2 · 2025-03-28T09:53:39.000+08:00
diff --git a/lib/socket_io_client.dart b/lib/socket_io_client.dart
@@ -21,6 +21,7 @@ import 'package:socket_io_client/src/manager.dart';
 
 export 'package:socket_io_client/src/socket.dart';
 export 'package:socket_io_client/src/darty.dart';
+export 'package:socket_io_client/src/engine/transport/http_client_adapter.dart';
 
 // Protocol version
 final protocol = parser.protocol;
diff --git a/lib/src/darty.dart b/lib/src/darty.dart
@@ -3,6 +3,7 @@
 // Author: jumperchen<jumperchen@potix.com>
 
 import 'package:socket_io_client/socket_io_client.dart';
+import 'package:socket_io_client/src/engine/transport/http_client_adapter.dart';
 import 'package:socket_io_common/socket_io_common.dart';
 import 'package:socket_io_common/src/util/event_emitter.dart';
 
@@ -286,6 +287,11 @@ class OptionBuilder {
     return this;
   }
 
+  OptionBuilder setHttpClientAdapter(HttpClientAdapter httpClientAdapter) {
+    _opts['httpClientAdapter'] = httpClientAdapter;
+    return this;
+  }
+
   /// Build the options map.
   Map<String, dynamic> build() => _opts;
 }
diff --git a/lib/src/engine/transport/html_http_client_adapter.dart b/lib/src/engine/transport/html_http_client_adapter.dart
@@ -0,0 +1,13 @@
+import 'dart:html';
+import 'http_client_adapter.dart';
+
+class HtmlHttpClientAdapter implements HttpClientAdapter {
+  @override
+  Future<WebSocket> connect(String uri, {Map<String, dynamic>? headers}) {
+    return Future.value(WebSocket(uri));
+  }
+}
+
+HttpClientAdapter makePlatformHttpClientAdapter() {
+  return HtmlHttpClientAdapter();
+}
diff --git a/lib/src/engine/transport/http_client_adapter.dart b/lib/src/engine/transport/http_client_adapter.dart
@@ -0,0 +1,3 @@
+abstract class HttpClientAdapter {
+  Future<dynamic> connect(String uri, {Map<String, dynamic>? headers});
+}
diff --git a/lib/src/engine/transport/http_client_adapter_factory.dart b/lib/src/engine/transport/http_client_adapter_factory.dart
@@ -0,0 +1,9 @@
+import 'package:socket_io_client/src/engine/transport/http_client_adapter.dart';
+
+import 'unknown_http_client_adapter.dart'
+    if (dart.library.io) 'io_http_client_adapter.dart'
+    if (dart.library.html) 'html_http_client_adapter.dart';
+
+HttpClientAdapter createPlatformHttpClientAdapter() {
+  return makePlatformHttpClientAdapter();
+}
diff --git a/lib/src/engine/transport/io_http_client_adapter.dart b/lib/src/engine/transport/io_http_client_adapter.dart
@@ -0,0 +1,22 @@
+import 'dart:io';
+import 'http_client_adapter.dart';
+
+class IOHttpClientAdapter implements HttpClientAdapter {
+  final HttpClient _httpClient;
+
+  IOHttpClientAdapter([HttpClient? httpClient])
+      : _httpClient = httpClient ?? HttpClient();
+
+  @override
+  Future<WebSocket> connect(String uri, {Map<String, dynamic>? headers}) {
+    return WebSocket.connect(
+      uri,
+      headers: headers,
+      customClient: _httpClient,
+    );
+  }
+}
+
+HttpClientAdapter makePlatformHttpClientAdapter() {
+  return IOHttpClientAdapter();
+}
diff --git a/lib/src/engine/transport/io_websocket_transport.dart b/lib/src/engine/transport/io_websocket_transport.dart
@@ -7,6 +7,9 @@ import 'dart:io';
 import 'dart:typed_data';
 import 'package:logging/logging.dart';
 import 'package:socket_io_client/src/engine/transport.dart';
+import 'package:socket_io_client/src/engine/transport/http_client_adapter.dart';
+import 'package:socket_io_client/src/engine/transport/http_client_adapter_factory.dart'
+    as httpClientAdapterFactory;
 import 'package:socket_io_common/src/engine/parser/parser.dart';
 
 class IOWebSocketTransport extends Transport {
@@ -20,8 +23,11 @@ class IOWebSocketTransport extends Transport {
   Map? perMessageDeflate;
   Map<String, dynamic>? extraHeaders;
   WebSocket? ws;
-
-  IOWebSocketTransport(Map opts) : super(opts) {
+  HttpClientAdapter httpClientAdapter;
+  IOWebSocketTransport(Map opts)
+      : httpClientAdapter = opts['httpClientAdapter'] ??
+            httpClientAdapterFactory.createPlatformHttpClientAdapter(),
+        super(opts) {
     var forceBase64 = opts['forceBase64'] ?? false;
     supportsBinary = !forceBase64;
     perMessageDeflate = opts['perMessageDeflate'];
@@ -32,21 +38,11 @@ class IOWebSocketTransport extends Transport {
   @override
   void doOpen() async {
     var uri = this.uri();
-    var protocols = this.protocols;
-
     try {
-      ws = await WebSocket.connect(uri,
-          protocols: protocols, headers: extraHeaders);
+      ws = await httpClientAdapter.connect(uri, headers: extraHeaders);
     } catch (err) {
       return emit('error', err);
     }
-
-//    if (this.ws?.binaryType == null) {
-//      this.supportsBinary = false;
-//    }
-//
-//    this.ws?.binaryType = 'arraybuffer';
-
     addEventListeners();
   }
 
diff --git a/lib/src/engine/transport/unknown_http_client_adapter.dart b/lib/src/engine/transport/unknown_http_client_adapter.dart
@@ -0,0 +1,6 @@
+import 'package:socket_io_client/src/engine/transport/http_client_adapter.dart';
+
+HttpClientAdapter makePlatformHttpClientAdapter() {
+  throw UnimplementedError(
+      'createPlatformHttpClientAdapter() is not implemented for this platform.');
+}
diff --git a/lib/src/manager.dart b/lib/src/manager.dart
@@ -11,6 +11,9 @@ import 'package:socket_io_client/src/on.dart';
 import 'package:socket_io_client/src/socket.dart';
 import 'package:socket_io_client/src/engine/socket.dart' as engine_socket;
 import 'package:socket_io_client/src/on.dart' as util;
+import 'package:socket_io_client/src/engine/transport/http_client_adapter.dart';
+import 'package:socket_io_client/src/engine/transport/http_client_adapter_factory.dart'
+    show createPlatformHttpClientAdapter;
 
 final Logger _logger = Logger('socket_io_client:Manager');
 
@@ -26,6 +29,7 @@ class Manager extends EventEmitter {
   Map<String, Socket> nsps = {};
   List subs = [];
   late Map? options;
+  final HttpClientAdapter _httpClientAdapter;
 
   ///
   /// Sets the `reconnection` config.
@@ -74,8 +78,16 @@ class Manager extends EventEmitter {
   late bool autoConnect;
   bool? skipReconnect;
 
-  Manager({uri, Map? options}) {
+  Manager({uri, Map? options})
+      : _httpClientAdapter = createPlatformHttpClientAdapter(),
+        super() {
     options = options ?? <dynamic, dynamic>{};
+    options['transportOptions'] = {
+      'websocket': {
+        'httpClientAdapter': options['httpClientAdapter'] ?? _httpClientAdapter
+      },
+      ...?options['transportOptions'],
+    };
 
     options['path'] ??= '/socket.io';
     // ignore: prefer_initializing_formals
diff --git a/pubspec.yaml b/pubspec.yaml
@@ -18,6 +18,7 @@ dev_dependencies:
   test: ">=1.3.0 <2.0.0"
   build_runner: any
   build_web_compilers: any
+  mocktail: ^1.0.4
 #  socket_io: any // support Socket.io v2.* only
 
   
diff --git a/test/http_client_adapter_test.dart b/test/http_client_adapter_test.dart
@@ -0,0 +1,31 @@
+import 'package:test/test.dart';
+import 'package:mocktail/mocktail.dart';
+import 'package:socket_io_client/src/engine/transport/http_client_adapter.dart';
+import 'package:socket_io_client/src/engine/transport/http_client_adapter_factory.dart'
+    show createPlatformHttpClientAdapter;
+
+class MockHttpClientAdapter extends Mock implements HttpClientAdapter {}
+
+void main() {
+  group('HttpClientAdapter', () {
+    test('Should create the correct platform-specific adapter', () {
+      final adapter = createPlatformHttpClientAdapter();
+      expect(adapter, isA<HttpClientAdapter>());
+    });
+
+    test('Should call connect on the adapter with correct parameters',
+        () async {
+      final mockAdapter = MockHttpClientAdapter();
+      const uri = 'wss://example.com/socket.io/';
+      final headers = {'Authorization': 'Bearer token'};
+
+      when(() => mockAdapter.connect(uri, headers: headers))
+          .thenAnswer((_) async => 'Mock WebSocket Connection');
+
+      final result = await mockAdapter.connect(uri, headers: headers);
+
+      expect(result, equals('Mock WebSocket Connection'));
+      verify(() => mockAdapter.connect(uri, headers: headers)).called(1);
+    });
+  });
+}
diff --git a/test/io_websocket_transport_test.dart b/test/io_websocket_transport_test.dart
@@ -0,0 +1,52 @@
+import 'package:test/test.dart';
+import 'package:mocktail/mocktail.dart';
+import 'package:socket_io_client/src/engine/transport/io_websocket_transport.dart';
+import 'package:socket_io_client/src/engine/transport/http_client_adapter.dart';
+
+class MockHttpClientAdapter extends Mock implements HttpClientAdapter {}
+
+class MockWebSocket extends Mock {}
+
+void main() {
+  group('IOWebSocketTransport', () {
+    test('Should use the custom HttpClientAdapter if provided', () async {
+      final mockAdapter = MockHttpClientAdapter();
+      final options = {
+        'httpClientAdapter': mockAdapter,
+        'secure': true,
+        'hostname': 'example.com',
+        'port': 443,
+        'path': '/socket.io/',
+        'timestampRequests': true,
+        'timestampParam': 't',
+      };
+
+      final transport = IOWebSocketTransport(options);
+
+      when(() => mockAdapter.connect(any(), headers: any(named: 'headers')))
+          .thenAnswer((_) async => MockWebSocket());
+
+      transport.doOpen();
+
+      verify(() => mockAdapter.connect(any(), headers: any(named: 'headers')))
+          .called(1);
+    });
+
+    test('Should generate the URI correctly', () {
+      final options = {
+        'secure': true,
+        'hostname': 'localhost',
+        'port': 3000,
+        'path': '/socket.io/',
+        'timestampRequests': true,
+        'timestampParam': 't',
+      };
+
+      final transport = IOWebSocketTransport(options);
+      final uri = transport.uri();
+
+      expect(uri, startsWith('wss://localhost:3000/socket.io/'));
+      expect(uri, contains('t='));
+    });
+  });
+}
diff --git a/test/manager_test.dart b/test/manager_test.dart
@@ -0,0 +1,33 @@
+import 'package:test/test.dart';
+import 'package:mocktail/mocktail.dart';
+import 'package:socket_io_client/src/manager.dart';
+import 'package:socket_io_client/src/engine/transport/http_client_adapter.dart';
+
+class MockHttpClientAdapter extends Mock implements HttpClientAdapter {}
+
+void main() {
+  group('Manager', () {
+    test('Should pass the custom HttpClientAdapter to transport options', () {
+      final mockAdapter = MockHttpClientAdapter();
+      final manager = Manager(
+        uri: 'http://localhost:3000',
+        options: {'httpClientAdapter': mockAdapter},
+      );
+
+      final transportOptions = manager.options?['transportOptions'];
+      expect(transportOptions, isNotNull);
+      expect(transportOptions['websocket']['httpClientAdapter'],
+          equals(mockAdapter));
+    });
+
+    test('Should use the default HttpClientAdapter if none is provided', () {
+      final manager = Manager(uri: 'http://localhost:3000');
+
+      final transportOptions = manager.options?['transportOptions'];
+      expect(transportOptions, isNotNull);
+      expect(transportOptions['websocket']['httpClientAdapter'], isNotNull);
+      expect(transportOptions['websocket']['httpClientAdapter'],
+          isA<HttpClientAdapter>());
+    });
+  });
+}
diff --git a/test/option_builder_test.dart b/test/option_builder_test.dart
@@ -0,0 +1,21 @@
+import 'package:socket_io_client/src/engine/transport/http_client_adapter_factory.dart';
+import 'package:test/test.dart';
+import 'package:socket_io_client/src/darty.dart';
+
+void main() {
+  group('OptionBuilder', () {
+    test('Should configure the custom HttpClientAdapter', () {
+      final customHttpClientAdapter = createPlatformHttpClientAdapter();
+      final options =
+          OptionBuilder().setHttpClientAdapter(customHttpClientAdapter).build();
+
+      expect(options['httpClientAdapter'], equals(customHttpClientAdapter));
+    });
+
+    test('Should build options correctly without HttpClientAdapter', () {
+      final options = OptionBuilder().build();
+
+      expect(options.containsKey('httpClientAdapter'), isFalse);
+    });
+  });
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+abstract class HttpClientAdapter {`
	`2`	`+ Future<dynamic> connect(String uri, {Map<String, dynamic>? headers});`
	`3`	`+}`