Merge #266

266: Customize dio adapter r=brunoocasali a=ahmednfwela

Fixes #138

this adds a new `MeiliSearchClient.withCustomDio` which can customize adapter and interceptors

- [ ] Added Tests


Co-authored-by: Ahmed Fwela <ahmednfwela@bdaya-dev.com>

lib/src/client.dart

@@ -1,3 +1,4 @@
+import 'package:dio/dio.dart';
 import 'package:meilisearch/src/key.dart';
 import 'package:meilisearch/src/query_parameters/cancel_tasks_query.dart';
 import 'package:meilisearch/src/query_parameters/delete_tasks_query.dart';
@@ -15,8 +16,21 @@ import 'client_impl.dart';
 import 'stats.dart' show AllStats;
 
 abstract class MeiliSearchClient {
-  factory MeiliSearchClient(String serverUrl,
-      [String? apiKey, Duration? connectTimeout]) = MeiliSearchClientImpl;
+  factory MeiliSearchClient(
+    String serverUrl, [
+    String? apiKey,
+    Duration? connectTimeout,
+  ]) = MeiliSearchClientImpl;
+
+  factory MeiliSearchClient.withCustomDio(
+    String serverUrl, {
+    String? apiKey,
+    Duration? connectTimeout,
+    HttpClientAdapter? adapter,
+    List<Interceptor>? interceptors,
+  }) =>
+      MeiliSearchClientImpl(
+          serverUrl, apiKey, connectTimeout, adapter, interceptors);
 
   /// Http client instance.
   HttpRequest get http;
@@ -30,8 +44,12 @@ abstract class MeiliSearchClient {
   /// Timeout in milliseconds for opening a url.
   Duration? get connectTimeout;
 
-  String generateTenantToken(String uid, Object? searchRules,
-      {String? apiKey, DateTime? expiresAt});
+  String generateTenantToken(
+    String uid,
+    Object? searchRules, {
+    String? apiKey,
+    DateTime? expiresAt,
+  });
 
   /// Create an index object by given [uid].
   MeiliSearchIndex index(String uid);
@@ -77,12 +95,13 @@ abstract class MeiliSearchClient {
   Future<Key> getKey(String keyOrUid);
 
   /// Create a new key.
-  Future<Key> createKey(
-      {DateTime? expiresAt,
-      String? description,
-      String? uid,
-      required List<String> indexes,
-      required List<String> actions});
+  Future<Key> createKey({
+    DateTime? expiresAt,
+    String? description,
+    String? uid,
+    required List<String> indexes,
+    required List<String> actions,
+  });
 
   /// Update a key.
   Future<Key> updateKey(String key, {String? description, String? name});

lib/src/client_impl.dart

@@ -20,8 +20,19 @@ import 'key.dart';
 import 'stats.dart' show AllStats;
 
 class MeiliSearchClientImpl implements MeiliSearchClient {
-  MeiliSearchClientImpl(this.serverUrl, [this.apiKey, this.connectTimeout])
-      : http = HttpRequestImpl(serverUrl, apiKey, connectTimeout);
+  MeiliSearchClientImpl(
+    this.serverUrl, [
+    this.apiKey,
+    this.connectTimeout,
+    HttpClientAdapter? adapter,
+    List<Interceptor>? interceptors,
+  ]) : http = HttpRequestImpl(
+          serverUrl,
+          apiKey,
+          connectTimeout,
+          adapter,
+          interceptors,
+        );
 
   @override
   final String serverUrl;

lib/src/http_request.dart

@@ -2,8 +2,13 @@ import 'package:dio/dio.dart';
 import 'http_request_impl.dart';
 
 abstract class HttpRequest {
-  factory HttpRequest(String serverUrl, String apiKey,
-      [Duration connectTimeout]) = HttpRequestImpl;
+  factory HttpRequest(
+    String serverUrl,
+    String apiKey, [
+    Duration? connectTimeout,
+    HttpClientAdapter? adapter,
+    List<Interceptor>? interceptors,
+  ]) = HttpRequestImpl;
 
   /// Meilisearch server URL.
   String get serverUrl;

lib/src/http_request_impl.dart

@@ -6,8 +6,13 @@ import 'exception.dart';
 const bool _kIsWeb = bool.fromEnvironment('dart.library.js_util');
 
 class HttpRequestImpl implements HttpRequest {
-  HttpRequestImpl(this.serverUrl, this.apiKey, [this.connectTimeout])
-      : dio = Dio(
+  HttpRequestImpl(
+    this.serverUrl,
+    this.apiKey, [
+    this.connectTimeout,
+    HttpClientAdapter? adapter,
+    List<Interceptor>? interceptors,
+  ]) : dio = Dio(
           BaseOptions(
             baseUrl: serverUrl,
             headers: <String, Object>{
@@ -20,7 +25,17 @@ class HttpRequestImpl implements HttpRequest {
             responseType: ResponseType.json,
             connectTimeout: connectTimeout ?? Duration(seconds: 5),
           ),
-        );
+        ) {
+    if (adapter != null) {
+      dio.httpClientAdapter = adapter;
+    }
+
+    dio.interceptors.removeImplyContentTypeInterceptor();
+
+    if (interceptors != null) {
+      dio.interceptors.addAll(interceptors);
+    }
+  }
 
   @override
   final String serverUrl;

test/custom_dio_test.dart

@@ -0,0 +1,58 @@
+import 'dart:typed_data';
+
+import 'package:dio/dio.dart';
+import 'package:dio/io.dart';
+import 'package:meilisearch/meilisearch.dart';
+import 'package:test/test.dart';
+
+import 'utils/client.dart';
+
+class TestInterceptor extends Interceptor {
+  bool onRequestCalled = false;
+  @override
+  void onRequest(RequestOptions options, RequestInterceptorHandler handler) {
+    onRequestCalled = true;
+    super.onRequest(options, handler);
+  }
+}
+
+class TestAdapter extends IOHttpClientAdapter {
+  bool fetchCalled = false;
+  @override
+  Future<ResponseBody> fetch(RequestOptions options,
+      Stream<Uint8List>? requestStream, Future<void>? cancelFuture) {
+    fetchCalled = true;
+    return super.fetch(options, requestStream, cancelFuture);
+  }
+}
+
+void main() {
+  group('Custom dio', () {
+    test('Interceptor', () async {
+      final interceptor = TestInterceptor();
+      final client = MeiliSearchClient.withCustomDio(
+        testServer,
+        apiKey: "masterKey",
+        interceptors: [interceptor],
+      );
+
+      var health = await client.health();
+
+      expect(health, {'status': 'available'});
+      expect(interceptor.onRequestCalled, equals(true));
+    });
+    test("Adapter", () async {
+      final adapter = TestAdapter();
+      final client = MeiliSearchClient.withCustomDio(
+        testServer,
+        apiKey: "masterKey",
+        adapter: adapter,
+      );
+
+      var health = await client.health();
+
+      expect(health, {'status': 'available'});
+      expect(adapter.fetchCalled, equals(true));
+    });
+  });
+}

test/health_test.dart

@@ -8,14 +8,17 @@ void main() {
 
     test('of the server when the url is valid', () async {
       var health = await client.health();
+
       expect(health, {'status': 'available'});
     });
 
     test('of the server when the url is valid with isHealthy', () async {
       var health = await client.isHealthy();
+
       expect(health, true);
     });
   });
+
   group('Health Fail', () {
     setUpClientWithWrongUrl();
 
@@ -25,6 +28,7 @@ void main() {
 
     test('when the url is not valid with isHealthy', () async {
       var health = await client.isHealthy();
+
       expect(health, false);
     });
   });

test/utils/client.dart

@@ -33,8 +33,8 @@ Future<void> deleteAllKeys() async {
 void setUpClient() {
   setUp(() {
     final String server = testServer;
-
-    client = MeiliSearchClient(server, 'masterKey');
+    const masterKey = 'masterKey';
+    client = MeiliSearchClient(server, masterKey);
     random = Random();
   });
 
@@ -56,8 +56,9 @@ void setUpClientWithWrongUrl() {
   setUp(() {
     final String server = 'http://wrongurl:1234';
     final connectTimeout = Duration(milliseconds: 1000);
+    const masterKey = 'masterKey';
 
-    client = MeiliSearchClient(server, 'masterKey', connectTimeout);
+    client = MeiliSearchClient(server, masterKey, connectTimeout);
   });
 }