Feature/network logging (#82)

salmamali · web-flow · commit e95907d4b789 · 2019-07-22T16:30:12.000+02:00
* ✨ network logging for HttpClient

* ⬆️ update native android version to 8.5.0.1

* Update readme with details on network logging

* 📝 Update changelog
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+## Version 1.0.0-beta.5 (2019-07-22)
+
+* Adds Network logging feature for the dart:io package HttpClient.
+
 ## Version 1.0.0-beta.4 (2019-06-25)
 
 * Fixes crash on Android on launching the sample app.
diff --git a/README.md b/README.md
@@ -201,3 +201,19 @@ If your app doesn’t already access the microphone or photo library, we recomme
 * "`<app name>` needs access to your photo library for you to be able to attach images."
 
 **The permission alert for accessing the microphone/photo library will NOT appear unless users attempt to attach a voice note/photo while using Instabug.**
+
+## Network Logging
+You can choose to attach all your network requests to the reports being sent to the dashboard. To enable the feature when using the `dart:io` package `HttpClient`, use the custom Instabug client:
+```
+InstabugCustomHttpClient client = InstabugCustomHttpClient();
+```
+
+and continue to use the package normally to make your network requests:
+
+```
+client.getUrl(Uri.parse(URL)).then((request) async {
+      var response = await request.close();
+});
+```
+
+We also support the packages `http` and `dio`. For details on how to enable network logging for these external packages, refer to the [Instabug Dart Http Adapter](https://github.com/Instabug/Instabug-Dart-http-Adapter) and the [Instabug Dio Interceptor](https://github.com/Instabug/Instabug-Dio-Interceptor) repositories.
diff --git a/android/build.gradle b/android/build.gradle
@@ -34,6 +34,6 @@ android {
 }
 
 dependencies {
-    implementation 'com.instabug.library:instabug:8.4.0.2'
+    implementation 'com.instabug.library:instabug:8.5.0.1'
     testImplementation 'junit:junit:4.12'
 }
diff --git a/android/src/main/java/com/instabug/instabugflutter/InstabugFlutterPlugin.java b/android/src/main/java/com/instabug/instabugflutter/InstabugFlutterPlugin.java
@@ -20,12 +20,16 @@
 import com.instabug.library.invocation.InstabugInvocationEvent;
 import com.instabug.library.invocation.OnInvokeCallback;
 import com.instabug.library.logging.InstabugLog;
+import com.instabug.library.model.NetworkLog;
 import com.instabug.library.ui.onboarding.WelcomeMessage;
 import com.instabug.survey.OnDismissCallback;
 import com.instabug.survey.OnShowCallback;
 import com.instabug.survey.Survey;
 import com.instabug.survey.Surveys;
 
+import org.json.JSONException;
+import org.json.JSONObject;
+
 import java.io.File;
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
@@ -855,4 +859,27 @@ public void setEnableInAppNotificationSound(boolean shouldPlaySound) {
             Replies.setInAppNotificationSound(shouldPlaySound);
     }
 
+    /**
+     * Extracts HTTP connection properties. Request method, Headers, Date, Url and Response code
+     *
+     * @param jsonObject the JSON object containing all HTTP connection properties
+     */
+    public void networkLog(HashMap<String, Object> jsonObject)  throws JSONException {
+
+            int responseCode = 0;
+
+            NetworkLog networkLog = new NetworkLog();
+            String date = System.currentTimeMillis()+"";
+            networkLog.setDate(date);
+            networkLog.setUrl((String)jsonObject.get("url"));
+            networkLog.setRequest((String)jsonObject.get("requestBody"));
+            networkLog.setResponse((String)jsonObject.get("responseBody"));
+            networkLog.setMethod((String) jsonObject.get("method"));
+            networkLog.setResponseCode((Integer) jsonObject.get("responseCode"));
+            networkLog.setRequestHeaders((new JSONObject((HashMap<String, String>)jsonObject.get("requestHeaders"))).toString(4));
+            networkLog.setResponseHeaders((new JSONObject((HashMap<String, String>)jsonObject.get("responseHeaders"))).toString(4));
+            networkLog.setTotalDuration(((Number) jsonObject.get("duration")).longValue());
+            networkLog.insert();
+    }
+
 }
diff --git a/ios/Classes/InstabugFlutterPlugin.h b/ios/Classes/InstabugFlutterPlugin.h
@@ -417,4 +417,8 @@
   * @param isEnabled whether chat notification is reburied or not
   */
 - (void)setChatNotificationEnabled:(NSNumber *)isEnabled ;
+
++ (void)networkLog:(NSDictionary *) networkData ;
+
+
 @end
diff --git a/ios/Classes/InstabugFlutterPlugin.m b/ios/Classes/InstabugFlutterPlugin.m
@@ -707,6 +707,54 @@ + (void)setChatNotificationEnabled:(NSNumber *)isEnabled {
    IBGReplies.inAppNotificationsEnabled = boolValue;
 }
 
+/**
+ * Extracts HTTP connection properties. Request method, Headers, Date, Url and Response code
+ *
+ * @param networkData the NSDictionary containing all HTTP connection properties
+ */
++ (void)networkLog:(NSDictionary *) networkData {
+    [IBGLog clearAllLogs];
+
+    NSString* url = networkData[@"url"];
+    NSString* method = networkData[@"method"];
+    NSString* requestBody = networkData[@"requestBody"];
+    NSString* responseBody = networkData[@"responseBody"];
+    int32_t responseCode = [networkData[@"responseCode"] integerValue];
+    NSDictionary* requestHeaders = networkData[@"requestHeaders"];
+    if ([requestHeaders count] == 0) {
+        requestHeaders = @{};
+    }
+    NSDictionary* responseHeaders = networkData[@"responseHeaders"];
+    NSString* contentType = @"application/json";
+    double duration = [networkData[@"duration"] doubleValue];
+
+    for(NSString *key in [requestHeaders allKeys]) {
+        NSLog(@"key: %@", key);
+        NSLog(@"value: %@",[requestHeaders objectForKey:key]);
+    }
+    
+    SEL networkLogSEL = NSSelectorFromString(@"addNetworkLogWithUrl:method:requestBody:responseBody:responseCode:requestHeaders:responseHeaders:contentType:duration:");
+
+    if([[IBGNetworkLogger class] respondsToSelector:networkLogSEL]) {
+        NSInvocation *inv = [NSInvocation invocationWithMethodSignature:[[IBGNetworkLogger class] methodSignatureForSelector:networkLogSEL]];
+        [inv setSelector:networkLogSEL];
+        [inv setTarget:[IBGNetworkLogger class]];
+
+        [inv setArgument:&(url) atIndex:2];
+        [inv setArgument:&(method) atIndex:3];
+        [inv setArgument:&(requestBody) atIndex:4];
+        [inv setArgument:&(responseBody) atIndex:5];
+        [inv setArgument:&(responseCode) atIndex:6];
+        [inv setArgument:&(requestHeaders) atIndex:7];
+        [inv setArgument:&(responseHeaders) atIndex:8];
+        [inv setArgument:&(contentType) atIndex:9];
+        [inv setArgument:&(duration) atIndex:10];
+
+        [inv invoke];
+    }
+}
+
+
 
 + (NSDictionary *)constants {
   return @{
diff --git a/lib/NetworkLogger.dart b/lib/NetworkLogger.dart
@@ -0,0 +1,20 @@
+import 'dart:async';
+import 'dart:io';
+import 'package:flutter/services.dart';
+import 'package:instabug/models/network_data.dart';
+
+class NetworkLogger {
+
+  static const MethodChannel _channel = MethodChannel('instabug_flutter');
+
+  static Future<String> get platformVersion async {
+    final String version = await _channel.invokeMethod('getPlatformVersion');
+    return version;
+  }
+
+  static Future<bool> networkLog(NetworkData data) async {
+    final List<dynamic> params = <dynamic>[data.toMap()];
+    return await _channel.invokeMethod<Object>('networkLog:', params);
+  }
+
+}
diff --git a/lib/instabug_custom_http_client.dart b/lib/instabug_custom_http_client.dart
@@ -0,0 +1,232 @@
+import 'dart:io';
+
+import 'package:instabug/utils/http_client_logger.dart';
+import 'package:meta/meta.dart';
+
+class InstabugCustomHttpClient extends HttpClientLogger implements HttpClient {
+  InstabugCustomHttpClient() {
+    client = HttpClient();
+
+    logger = this;
+  }
+
+  @override
+  set autoUncompress(bool au) => client.autoUncompress = au;
+
+  @override
+  set connectionTimeout(Duration ct) => client.connectionTimeout = ct;
+
+  @override
+  set idleTimeout(Duration it) => client.idleTimeout = it;
+
+  @override
+  set maxConnectionsPerHost(int mcph) => client.maxConnectionsPerHost = mcph;
+
+  @override
+  set userAgent (String ua) => client.userAgent = ua;
+
+  @override
+  bool get autoUncompress => client.autoUncompress;
+
+  @override
+  Duration get connectionTimeout => client.connectionTimeout;
+
+  @override
+  Duration get idleTimeout => client.idleTimeout;
+
+  @override
+  int get maxConnectionsPerHost => client.maxConnectionsPerHost;
+
+  @override
+  String get userAgent => client.userAgent;
+
+  @visibleForTesting
+  HttpClient client;
+
+  @visibleForTesting
+  HttpClientLogger logger;
+
+  @override
+  void addCredentials(
+      Uri url, String realm, HttpClientCredentials credentials) {
+    client.addCredentials(url, realm, credentials);
+  }
+
+  @override
+  void addProxyCredentials(
+      String host, int port, String realm, HttpClientCredentials credentials) {
+    client.addProxyCredentials(host, port, realm, credentials);
+  }
+
+  @override
+  void set authenticate(
+      Future<bool> Function(Uri url, String scheme, String realm) f) {
+    client.authenticate = f;
+  }
+
+  @override
+  void set authenticateProxy(
+      Future<bool> Function(String host, int port, String scheme, String realm)
+          f) {
+    client.authenticateProxy = f;
+  }
+
+  @override
+  void set badCertificateCallback(
+      bool Function(X509Certificate cert, String host, int port) callback) {
+    client.badCertificateCallback = callback;
+  }
+
+  @override
+  void close({bool force = false}) {
+    client.close(force: force);
+  }
+
+  @override
+  Future<HttpClientRequest> delete(String host, int port, String path) {
+    return client.delete(host, port, path).then((HttpClientRequest request) async {
+      logger.onRequest(request);
+      final HttpClientResponse response = await request.close();
+      logger.onResponse(response, request);
+      return request;
+    });
+  }
+
+  @override
+  Future<HttpClientRequest> deleteUrl(Uri url) {
+    return client.deleteUrl(url).then((HttpClientRequest request) async {
+      logger.onRequest(request);
+      final HttpClientResponse response = await request.close();
+      logger.onResponse(response, request);
+      return request;
+    });
+  }
+
+  @override
+  void set findProxy(String Function(Uri url) f) {
+    client.findProxy = f;
+  }
+
+  @override
+  Future<HttpClientRequest> get(String host, int port, String path) {
+    return client.get(host, port, path).then((HttpClientRequest request) async {
+      logger.onRequest(request);
+      final HttpClientResponse response = await request.close();
+      logger.onResponse(response, request);
+      return request;
+    });
+  }
+
+  @override
+  Future<HttpClientRequest> getUrl(Uri url) {
+    return client.getUrl(url).then((HttpClientRequest request) async {
+      logger.onRequest(request);
+      final HttpClientResponse response = await request.close();
+      logger.onResponse(response, request);
+      return request;
+    });
+  }
+
+  @override
+  Future<HttpClientRequest> head(String host, int port, String path) {
+    return client.head(host, port, path).then((HttpClientRequest request) async {
+      logger.onRequest(request);
+      final HttpClientResponse response = await request.close();
+      logger.onResponse(response, request);
+      return request;
+    });
+  }
+
+  @override
+  Future<HttpClientRequest> headUrl(Uri url) {
+    return client.headUrl(url).then((HttpClientRequest request) async {
+      logger.onRequest(request);
+      final HttpClientResponse response = await request.close();
+      logger.onResponse(response, request);
+      return request;
+    });
+  }
+
+  @override
+  Future<HttpClientRequest> open(
+      String method, String host, int port, String path) {
+    return client.open(method, host, port, path).then((HttpClientRequest request) async {
+      logger.onRequest(request);
+      final HttpClientResponse response = await request.close();
+      logger.onResponse(response, request);
+      return request;
+    });
+  }
+
+  @override
+  Future<HttpClientRequest> openUrl(String method, Uri url) {
+    return client.openUrl(method, url).then((HttpClientRequest request) async {
+      logger.onRequest(request);
+      final HttpClientResponse response = await request.close();
+      logger.onResponse(response, request);
+      return request;
+    });
+  }
+
+  @override
+  Future<HttpClientRequest> patch(String host, int port, String path) {
+    return client.patch(host, port, path).then((HttpClientRequest request) async {
+      logger.onRequest(request);
+      final HttpClientResponse response = await request.close();
+      logger.onResponse(response, request);
+      return request;
+    });
+  }
+
+  @override
+  Future<HttpClientRequest> patchUrl(Uri url) {
+    return client.patchUrl(url).then((HttpClientRequest request) async {
+      logger.onRequest(request);
+      final HttpClientResponse response = await request.close();
+      logger.onResponse(response, request);
+      return request;
+    });
+  }
+
+  @override
+  Future<HttpClientRequest> post(String host, int port, String path) {
+    return client.post(host, port, path).then((HttpClientRequest request) async {
+      logger.onRequest(request);
+      final HttpClientResponse response = await request.close();
+      logger.onResponse(response, request);
+      return request;
+    });
+  }
+
+  @override
+  Future<HttpClientRequest> postUrl(Uri url) {
+    return client.postUrl(url).then((HttpClientRequest request) async {
+      logger.onRequest(request);
+      final HttpClientResponse response = await request.close();
+      logger.onResponse(response, request);
+      return request;
+    });
+  }
+
+  @override
+  Future<HttpClientRequest> put(String host, int port, String path) {
+    return client.put(host, port, path).then((HttpClientRequest request) async {
+      logger.onRequest(request);
+      final HttpClientResponse response = await request.close();
+      logger.onResponse(response, request);
+      return request;
+    });
+  }
+
+  @override
+  Future<HttpClientRequest> putUrl(Uri url) {
+    return client.putUrl(url).then((HttpClientRequest request) async {
+      logger.onRequest(request);
+      final HttpClientResponse response = await request.close();
+      logger.onResponse(response, request);
+      return request;
+    });
+  }
+
+  
+}
diff --git a/lib/models/network_data.dart b/lib/models/network_data.dart
diff --git a/lib/utils/http_client_logger.dart b/lib/utils/http_client_logger.dart
diff --git a/pubspec.yaml b/pubspec.yaml
diff --git a/test/network_logger_test.dart b/test/network_logger_test.dart

Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,6 @@ android {`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`dependencies {`
`37`		`- implementation 'com.instabug.library:instabug:8.4.0.2'`
	`37`	`+ implementation 'com.instabug.library:instabug:8.5.0.1'`
`38`	`38`	`testImplementation 'junit:junit:4.12'`
`39`	`39`	`}`