Merge pull request #8 from Instabug/dio4-support

[MOB-5941] - Upgrade Instabug Dio Interceptor to null safety

Author: ymabdallah

.gitignore

@@ -24,6 +24,7 @@
 .dart_tool/
 .flutter-plugins
 .packages
+.flutter-plugins-dependencies
 .pub-cache/
 .pub/
 build/

analysis_options.yaml

@@ -51,7 +51,6 @@ linter:
     - always_specify_types
     - annotate_overrides
     # - avoid_annotating_with_dynamic # conflicts with always_specify_types
-    - avoid_as
     # - avoid_bool_literals_in_conditional_expressions # not yet tested
     # - avoid_catches_without_on_clauses # we do this commonly
     # - avoid_catching_errors # we do this commonly

lib/instabug_dio_interceptor.dart

@@ -6,44 +6,58 @@ class InstabugDioInterceptor extends Interceptor {
   static final Map<int, NetworkData> _requests = <int, NetworkData>{};
 
   @override
-  dynamic onRequest(RequestOptions options) {
-    final NetworkData data = NetworkData();
-    data.startTime = DateTime.now();
+  void onRequest(RequestOptions options, RequestInterceptorHandler handler) {
+    final NetworkData data = NetworkData(
+        startTime: DateTime.now(),
+        url: options.uri.toString(),
+        method: options.method);
     _requests[options.hashCode] = data;
+    handler.next(options);
   }
 
   @override
-  dynamic onResponse(Response response) {
-    NetworkLogger.networkLog(_map(response));
+  void onResponse(
+      Response<dynamic> response, ResponseInterceptorHandler handler) {
+    final NetworkData data = _map(response);
+    NetworkLogger.networkLog(data);
+    handler.next(response);
   }
 
   @override
-  dynamic onError(DioError err) {
-    NetworkLogger.networkLog(_map(err.response));
+  void onError(DioError err, ErrorInterceptorHandler handler) {
+    if (err.response != null) {
+      final NetworkData data = _map(err.response!);
+      NetworkLogger.networkLog(data);
+    }
+
+    handler.next(err);
   }
 
   static NetworkData _getRequestData(int requestHashCode) {
-    if (_requests[requestHashCode] != null) {
-      return _requests.remove(requestHashCode);
-    }
-    return null;
+    final NetworkData data = _requests[requestHashCode]!;
+    _requests.remove(requestHashCode);
+    return data;
   }
 
-  NetworkData _map(Response response) {
-    final NetworkData data = _getRequestData(response.request.hashCode);
-    data.endTime = DateTime.now();
-    data.duration = data.endTime.millisecondsSinceEpoch -
-        data.startTime.millisecondsSinceEpoch;
+  NetworkData _map(Response<dynamic> response) {
+    final NetworkData data = _getRequestData(response.requestOptions.hashCode);
     final Map<String, dynamic> responseHeaders = <String, dynamic>{};
-    response.headers.forEach((name, value) => responseHeaders[name] = value);
-    data.url = response.request.uri.toString();
-    data.method = response.request.method;
-    data.requestBody = response.request.data;
-    data.requestHeaders = response.request.headers;
-    data.contentType = response.request.contentType.toString();
-    data.status = response.statusCode;
-    data.responseBody = response.data;
-    data.responseHeaders = responseHeaders;
-    return data;
+    response.headers
+        .forEach((String name, dynamic value) => responseHeaders[name] = value);
+    return data.copyWith(
+      endTime: DateTime.now(),
+      duration: data.endTime != null
+          ? data.endTime!.millisecondsSinceEpoch -
+              data.startTime.millisecondsSinceEpoch
+          : 0,
+      url: response.requestOptions.uri.toString(),
+      method: response.requestOptions.method,
+      requestBody: response.requestOptions.data.toString(),
+      requestHeaders: response.requestOptions.headers,
+      contentType: response.requestOptions.contentType,
+      status: response.statusCode,
+      responseBody: response.data.toString(),
+      responseHeaders: responseHeaders,
+    );
   }
 }

pubspec.yaml

@@ -1,22 +1,21 @@
 name: instabug_dio_interceptor
 description: This package is an add on to instabug_flutter. It intercepts any requests performed 
             with Dio Package and sends them to the report that will be sent to the dashboard.
-version: 1.0.0
+version: 2.0.0
 author: Instabug <support@instabug.com>
 homepage: https://github.com/Instabug/Instabug-Flutter#readme 
 
 environment:
-  sdk: ">=2.1.0 <3.0.0"
+  sdk: ">=2.12.0 <3.0.0"
 
 dependencies:
+  dio: ^4.0.0
   flutter:
     sdk: flutter
-  dio: ^2.1.7
-  instabug_flutter: ^1.0.0
+  instabug_flutter: ^10.8.0
 dev_dependencies:
   flutter_test:
     sdk: flutter
-  mockito:
 
 # For information on the generic Dart part of this file, see the
 # following page: https://dart.dev/tools/pub/pubspec

test/instabug_dio_interceptor_test.dart

@@ -1,50 +1,96 @@
 import 'package:dio/dio.dart';
-import 'package:mockito/mockito.dart';
-import 'package:instabug_dio_interceptor/instabug_dio_interceptor.dart';
+import 'package:flutter/material.dart';
+import 'package:flutter/services.dart';
 import 'package:flutter_test/flutter_test.dart';
+import 'package:instabug_dio_interceptor/instabug_dio_interceptor.dart';
+import 'package:instabug_flutter/Instabug.dart';
+
+import 'mock_adapter.dart';
 
+class MyInterceptor extends InstabugDioInterceptor {
+  int requestCount = 0;
+  int resposneCount = 0;
+  int errorCount = 0;
 
-class MockInstabugDioInterceptor extends Mock implements InstabugDioInterceptor {}
+  @override
+  void onRequest(RequestOptions options, RequestInterceptorHandler handler) {
+    requestCount++;
+    super.onRequest(options, handler);
+  }
+
+  @override
+  void onResponse(
+      Response<dynamic> response, ResponseInterceptorHandler handler) {
+    resposneCount++;
+    super.onResponse(response, handler);
+  }
+
+  @override
+  void onError(DioError err, ErrorInterceptorHandler handler) {
+    errorCount++;
+    super.onError(err, handler);
+  }
+}
 
 void main() {
-  test('onResponse Test', () async {
-    final MockInstabugDioInterceptor instabugDioInterceptor = MockInstabugDioInterceptor();
-    final Dio dio = Dio();
+  TestWidgetsFlutterBinding.ensureInitialized();
+  WidgetsFlutterBinding.ensureInitialized();
+  late Dio dio;
+  late MyInterceptor instabugDioInterceptor;
+  const String appToken = '068ba9a8c3615035e163dc5f829c73be';
+  setUpAll(() async {
+    const MethodChannel('instabug_flutter')
+        .setMockMethodCallHandler((MethodCall methodCall) async {
+      switch (methodCall.method) {
+        case 'getTags':
+          return <String>['tag1', 'tag2'];
+        default:
+          return null;
+      }
+    });
+  });
+  setUp(() {
+    dio = Dio();
+    dio.options.baseUrl = MockAdapter.mockBase;
+    dio.httpClientAdapter = MockAdapter();
+    final List<InvocationEvent> events = <InvocationEvent>[];
+    instabugDioInterceptor = MyInterceptor();
     dio.interceptors.add(instabugDioInterceptor);
-    when<dynamic>(instabugDioInterceptor.onRequest(any)).thenReturn(null);
-    when<dynamic>(instabugDioInterceptor.onResponse(any)).thenReturn(null);
+    Instabug.start(appToken, events);
+  });
+
+  test('onResponse Test', () async {
     try {
-      await dio.get<dynamic>("http://dummy.restapiexample.com/api/v1/employees");
-    } on DioError { }
-     verify<dynamic>(instabugDioInterceptor.onRequest(any));
-     verify<dynamic>(instabugDioInterceptor.onResponse(any));
+      await dio.get<dynamic>('/test');
+    } on DioError {
+      // ignor
+    }
+
+    expect(instabugDioInterceptor.requestCount, 1);
+    expect(instabugDioInterceptor.resposneCount, 1);
+    expect(instabugDioInterceptor.errorCount, 0);
   });
 
   test('onError Test', () async {
-    final MockInstabugDioInterceptor instabugDioInterceptor = MockInstabugDioInterceptor();
-    final Dio dio = Dio();
-    dio.interceptors.add(instabugDioInterceptor);
-    when<dynamic>(instabugDioInterceptor.onRequest(any)).thenReturn(null);
-    when<dynamic>(instabugDioInterceptor.onError(any)).thenReturn(null);
     try {
-      await dio.get<dynamic>("http://dummy.restapiexample.com/api/v1/employee");
-    } on DioError { }
-     verify<dynamic>(instabugDioInterceptor.onRequest(any));
-     verify<dynamic>(instabugDioInterceptor.onError(any));
+      await dio.get<dynamic>('/test-error');
+    } on DioError {
+      // ignor
+    }
+
+    expect(instabugDioInterceptor.requestCount, 1);
+    expect(instabugDioInterceptor.resposneCount, 0);
+    expect(instabugDioInterceptor.errorCount, 1);
   });
 
   test('Stress Test', () async {
-    final MockInstabugDioInterceptor instabugDioInterceptor = MockInstabugDioInterceptor();
-    final Dio dio = Dio();
-    dio.interceptors.add(instabugDioInterceptor);
-    when<dynamic>(instabugDioInterceptor.onRequest(any)).thenReturn(null);
-    when<dynamic>(instabugDioInterceptor.onResponse(any)).thenReturn(null);
     for (int i = 0; i < 1000; i++) {
       try {
-       dio.get<dynamic>("http://dummy.restapiexample.com/api/v1/employees");
-      } on DioError { }
+        await dio.get<dynamic>('/test');
+      } on DioError {
+        // ignor
+      }
     }
-     verify<dynamic>(instabugDioInterceptor.onRequest(any)).called(1000);
+    expect(instabugDioInterceptor.requestCount, 1000);
   });
 }
-

test/mock_adapter.dart

@@ -0,0 +1,39 @@
+import 'dart:async';
+import 'dart:convert';
+import 'dart:typed_data';
+import 'package:dio/dio.dart';
+import 'package:dio/adapter.dart';
+
+class MockAdapter extends HttpClientAdapter {
+  static const String mockHost = 'mockserver';
+  static const String mockBase = 'http://$mockHost';
+  final DefaultHttpClientAdapter _adapter = DefaultHttpClientAdapter();
+
+  @override
+  Future<ResponseBody> fetch(RequestOptions options,
+      Stream<Uint8List>? requestStream, Future<dynamic>? cancelFuture) async {
+    final Uri uri = options.uri;
+
+    if (uri.host == mockHost) {
+      switch (uri.path) {
+        case '/test':
+          return ResponseBody.fromString(
+            jsonEncode(<String, dynamic>{
+              'errCode': 0,
+              'data': <String, dynamic>{'path': uri.path}
+            }),
+            200,
+          );
+
+        default:
+          return ResponseBody.fromString('', 404);
+      }
+    }
+    return _adapter.fetch(options, requestStream, cancelFuture);
+  }
+
+  @override
+  void close({bool force = false}) {
+    _adapter.close(force: force);
+  }
+}