[Feature] - Crash Reporting (#127)

* crash reporting

* crash reporting

* updates readme

* updates readme

* Add manual crash reporting

* Add enable API

* Add unit test for new API

* ci

* Add unit test for crash reporting API

* Update changelog

* ci

* revert pod file changes

* Update native iOS API

* revert runner changes

* Pushing iOS custom branch for CI to pass, will be reversed once merged

* Prefixing Log statemenet

* Rename `setCurrentPlatform` args

* Adds android custom branch

* fixing incorrect platform

* Add native android SDK

* remove custom iOS snapshot

* Bump to version 9.1.6

* update readme

Author: alyezz

.circleci/config.yml

@@ -104,6 +104,9 @@ jobs:
       - run: 
           name: Flutter build
           command: cd ..; flutter build aot
+      - run:
+          name: Update CocoaPods
+          command: pod update
       - run:
           name: Install CocoaPods
           command: pod install --repo-update

CHANGELOG.md

@@ -1,9 +1,9 @@
-## Master
+## v9.1.6 (2020-07-13)
 
+* Adds CrashReporting
 * Adds setShakingThresholdForiPhone, setShakingThresholdForiPad and setShakingThresholdForAndroid APIs
 * Added Proguard rules to protect Flutter bridge class and method names from getting obfuscated when the minifyEnabled flag is set to true.
 
-
 ## v9.1.0 (2020-03-19)
 
 * Bump Native SDKs to v9.1

README.md

@@ -9,14 +9,13 @@ A Flutter plugin for [Instabug](https://instabug.com/).
 |      Feature                                              | Status  |
 |:---------------------------------------------------------:|:-------:|
 | [Bug Reporting](https://instabug.com/bug-reporting)       |    ✅   |
-| [Crash Reporting](https://instabug.com/crash-reporting)   |    ⚠    |
+| [Crash Reporting](https://instabug.com/crash-reporting)   |    ✅   |
 | [In-App Chat](https://instabug.com/in-app-chat)           |    ✅   |
 | [In-App Surveys](https://instabug.com/in-app-surveys)     |    ✅   |
 | [Feature Requests](https://instabug.com/feature-requests) |    ✅   |
 
 * ✅ Stable
 * ⚙️ Under active development
-* ⚠ Not available yet
 
 ## Integration
 
@@ -27,7 +26,7 @@ A Flutter plugin for [Instabug](https://instabug.com/).
 
 ```yaml
 dependencies:
-    instabug_flutter:
+      instabug_flutter:
 ```
 
 2. Install the package by running the following command.
@@ -81,21 +80,43 @@ invocationEvents.add(InstabugFlutterPlugin.INVOCATION_EVENT_SHAKE);
 new InstabugFlutterPlugin().start(CustomFlutterApplication.this, "APP_TOKEN", invocationEvents);
 ```
 
-## Microphone and Photo Library Usage Description (iOS Only)
+## Crash reporting
 
-Instabug needs access to the microphone and photo library to be able to let users add audio and video attachments. Starting from iOS 10, apps that don’t provide a usage description for those 2 permissions would be rejected when submitted to the App Store.
+Instabug automatically captures every crash of your app and sends relevant details to the crashes page of your dashboard. Crashes are reported only when the app is running in release mode
 
-For your app not to be rejected, you’ll need to add the following 2 keys to your app’s info.plist file with text explaining to the user why those permissions are needed:
+1. To start using Crash reporting, import the following into your `main.dart`. 
 
-* `NSMicrophoneUsageDescription`
-* `NSPhotoLibraryUsageDescription`
-
-If your app doesn’t already access the microphone or photo library, we recommend using a usage description like:
+```dart
+import 'package:instabug_flutter/CrashReporting.dart';
+```
 
-* "`<app name>` needs access to the microphone to be able to attach voice notes."
-* "`<app name>` needs access to your photo library for you to be able to attach images."
+2. Replace `void main() => runApp(MyApp());` with the following snippet:
+```dart
+void main() async {
+  FlutterError.onError = (FlutterErrorDetails details) {
+    Zone.current.handleUncaughtError(details.exception, details.stack);
+  };
+  runZoned<Future<void>>(() async {
+    runApp(MyApp());
+  }, onError: (dynamic error, StackTrace stackTrace) {
+    CrashReporting.reportCrash(error, stackTrace);
+  });
+}
+```
 
-**The permission alert for accessing the microphone/photo library will NOT appear unless users attempt to attach a voice note/photo while using Instabug.**
+With Flutter 1.17 use this snipped instead:
+```dart
+void main() async {
+  FlutterError.onError = (FlutterErrorDetails details) {
+    Zone.current.handleUncaughtError(details.exception, details.stack);
+  };
+  runZonedGuarded<Future<void>>(() async {
+  runApp(CrashyApp());
+    }, (Object error, StackTrace stackTrace) {
+        CrashReporting.reportCrash(error, stackTrace);
+    });
+}
+```
 
 ## 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:
@@ -111,4 +132,20 @@ client.getUrl(Uri.parse(URL)).then((request) async {
 });
 ```
 
-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.
+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.
+
+## Microphone and Photo Library Usage Description (iOS Only)
+
+Instabug needs access to the microphone and photo library to be able to let users add audio and video attachments. Starting from iOS 10, apps that don’t provide a usage description for those 2 permissions would be rejected when submitted to the App Store.
+
+For your app not to be rejected, you’ll need to add the following 2 keys to your app’s info.plist file with text explaining to the user why those permissions are needed:
+
+* `NSMicrophoneUsageDescription`
+* `NSPhotoLibraryUsageDescription`
+
+If your app doesn’t already access the microphone or photo library, we recommend using a usage description like:
+
+* "`<app name>` needs access to the microphone to be able to attach voice notes."
+* "`<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.**

android/src/main/java/com/instabug/instabugflutter/InstabugFlutterPlugin.java

@@ -11,6 +11,7 @@
 import com.instabug.bug.invocation.Option;
 import com.instabug.chat.Chats;
 import com.instabug.chat.Replies;
+import com.instabug.crash.CrashReporting;
 import com.instabug.featuresrequest.FeatureRequests;
 import com.instabug.library.Feature;
 import com.instabug.library.Instabug;
@@ -38,6 +39,7 @@
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.Iterator;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
@@ -897,12 +899,53 @@ public void networkLog(HashMap<String, Object> jsonObject) throws JSONException
     }
 
     /**
-     * Reports that the screen has been changed (Repro Steps) the screen sent to
-     * this method will be the 'current view' on the dashboard
+     * Enables and disables automatic crash reporting.
+     * 
+     * @param {boolean} isEnabled
+     */
+    public void setCrashReportingEnabled(final boolean isEnabled) {
+        new Handler(Looper.getMainLooper()).post(new Runnable() {
+            @Override
+            public void run() {
+                if (isEnabled) {
+                    CrashReporting.setState(Feature.State.ENABLED);
+                } else {
+                    CrashReporting.setState(Feature.State.DISABLED);
+                }
+            }
+        });
+    }
+
+    public void sendJSCrashByReflection(final String map, final boolean isHandled) {
+        new Handler(Looper.getMainLooper()).post(new Runnable() {
+            @Override
+            public void run() {
+                try {
+                    final JSONObject exceptionObject = new JSONObject(map);
+                    Method method = getMethod(Class.forName("com.instabug.crash.CrashReporting"), "reportException",
+                            JSONObject.class, boolean.class);
+                    if (method != null) {
+                        method.invoke(null, exceptionObject, isHandled);
+                        Log.e("IBG-Flutter", exceptionObject.toString());
+                    }
+                } catch (Exception e) {
+                    e.printStackTrace();
+                }
+            }
+        });
+    }
+
+    /*
+     * 
+     * Reports that the screen has been
+     * 
+     * changed (Repro Steps) the screen sent to this method will be the 'current
+     * view' on the dashboard
      *
      * @param screenName string containing the screen name
      *
      */
+
     public void reportScreenChange(String screenName) {
         try {
             Method method = getMethod(Class.forName("com.instabug.library.Instabug"), "reportScreenChange",
@@ -930,10 +973,10 @@ public void setReproStepsMode(String reproStepsMode) {
     }
 
     /**
-     * Sets the threshold value of the shake gesture for android devices.
-     * Default for android is an integer value equals 350.
-     * you could increase the shaking difficulty level by
-     * increasing the `350` value and vice versa
+     * Sets the threshold value of the shake gesture for android devices. Default
+     * for android is an integer value equals 350. you could increase the shaking
+     * difficulty level by increasing the `350` value and vice versa
+     * 
      * @param androidThreshold Threshold for android devices.
      */
     public void setShakingThresholdForAndroid(int androidThreshold) {

example/android/app/build.gradle

@@ -39,6 +39,7 @@ android {
         versionCode flutterVersionCode.toInteger()
         versionName flutterVersionName
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+        multiDexEnabled true
     }
 
     buildTypes {
@@ -59,6 +60,7 @@ flutter {
 
 dependencies {
     testImplementation 'junit:junit:4.12'
+    implementation 'com.android.support:multidex:1.0.3'
     androidTestImplementation 'androidx.test.ext:junit:1.1.1'
     androidTestImplementation 'androidx.test:rules:1.1.1'
     androidTestImplementation 'androidx.test.espresso:espresso-core:3.1.0'

example/android/app/src/debug/AndroidManifest.xml

@@ -0,0 +1,7 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.instabug.instabugflutterexample">
+    <!-- Flutter needs it to communicate with the running application
+         to allow setting breakpoints, to provide hot reload, etc.
+    -->
+    <uses-permission android:name="android.permission.INTERNET"/>
+</manifest>

example/android/app/src/main/java/com/instabug/instabugflutterexample/CustomFlutterApplication.java

@@ -12,7 +12,7 @@ public void onCreate() {
     ArrayList<String> invocation_events = new ArrayList<>();
     invocation_events.add(InstabugFlutterPlugin.INVOCATION_EVENT_FLOATING_BUTTON);
     InstabugFlutterPlugin instabug = new InstabugFlutterPlugin();
-    instabug.start(CustomFlutterApplication.this, "efa41f402620b5654f2af2b86e387029", invocation_events);
+    instabug.start(CustomFlutterApplication.this, "2d355f559ea67051a56fce82603f8e41", invocation_events);
     instabug.setWelcomeMessageMode("WelcomeMessageMode.disabled");
   }
 }

example/android/app/src/profile/AndroidManifest.xml

@@ -0,0 +1,7 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="com.instabug.instabugflutterexample">
+    <!-- Flutter needs it to communicate with the running application
+         to allow setting breakpoints, to provide hot reload, etc.
+    -->
+    <uses-permission android:name="android.permission.INTERNET"/>
+</manifest>

example/ios/Flutter/Flutter.podspec

@@ -0,0 +1,18 @@
+#
+# NOTE: This podspec is NOT to be published. It is only used as a local source!
+#
+
+Pod::Spec.new do |s|
+  s.name             = 'Flutter'
+  s.version          = '1.0.0'
+  s.summary          = 'High-performance, high-fidelity mobile apps.'
+  s.description      = <<-DESC
+Flutter provides an easy and productive way to build and deploy high-performance mobile apps for Android and iOS.
+                       DESC
+  s.homepage         = 'https://flutter.io'
+  s.license          = { :type => 'MIT' }
+  s.author           = { 'Flutter Dev Team' => '[email protected]' }
+  s.source           = { :git => 'https://github.com/flutter/engine', :tag => s.version.to_s }
+  s.ios.deployment_target = '8.0'
+  s.vendored_frameworks = 'Flutter.framework'
+end

example/ios/Podfile

@@ -17,16 +17,16 @@ def parse_KV_file(file, separator='=')
   pods_ary = []
   skip_line_start_symbols = ["#", "/"]
   File.foreach(file_abs_path) { |line|
-      next if skip_line_start_symbols.any? { |symbol| line =~ /^\s*#{symbol}/ }
-      plugin = line.split(pattern=separator)
-      if plugin.length == 2
-        podname = plugin[0].strip()
-        path = plugin[1].strip()
-        podpath = File.expand_path("#{path}", file_abs_path)
-        pods_ary.push({:name => podname, :path => podpath});
+    next if skip_line_start_symbols.any? { |symbol| line =~ /^\s*#{symbol}/ }
+    plugin = line.split(pattern=separator)
+    if plugin.length == 2
+      podname = plugin[0].strip()
+      path = plugin[1].strip()
+      podpath = File.expand_path("#{path}", file_abs_path)
+      pods_ary.push({:name => podname, :path => podpath});
       else
-        puts "Invalid plugin specification: #{line}"
-      end
+      puts "Invalid plugin specification: #{line}"
+    end
   }
   return pods_ary
 end
@@ -36,7 +36,7 @@ target 'Runner' do
   # referring to absolute paths on developers' machines.
   system('rm -rf .symlinks')
   system('mkdir -p .symlinks/plugins')
-
+  
   # Flutter Pods
   generated_xcode_build_settings = parse_KV_file('./Flutter/Generated.xcconfig')
   if generated_xcode_build_settings.empty?
@@ -49,7 +49,7 @@ target 'Runner' do
       pod 'Flutter', :path => File.join(symlink, File.basename(p[:path]))
     end
   }
-
+  
   # Plugin Pods
   plugin_pods = parse_KV_file('../.flutter-plugins')
   plugin_pods.map { |p|
@@ -95,4 +95,4 @@ post_install do |installer|
   end
 end
 
-  pod 'OCMock', '~> 3.4'
+pod 'OCMock', '~> 3.4'

example/ios/Podfile.lock

@@ -0,0 +1,33 @@
+PODS:
+  - Flutter (1.0.0)
+  - Instabug (9.1.4)
+  - instabug_flutter (0.0.1):
+    - Flutter
+    - Instabug (= 9.1.4)
+  - OCMock (3.6)
+
+DEPENDENCIES:
+  - Flutter (from `.symlinks/flutter/ios`)
+  - instabug_flutter (from `.symlinks/plugins/instabug_flutter/ios`)
+  - OCMock (~> 3.4)
+
+SPEC REPOS:
+  trunk:
+    - Instabug
+    - OCMock
+
+EXTERNAL SOURCES:
+  Flutter:
+    :path: ".symlinks/flutter/ios"
+  instabug_flutter:
+    :path: ".symlinks/plugins/instabug_flutter/ios"
+
+SPEC CHECKSUMS:
+  Flutter: 0e3d915762c693b495b44d77113d4970485de6ec
+  Instabug: 6d8d38c329b8ae0a88bba4d148280e24bc0cf000
+  instabug_flutter: 904f8ae866249364e68e2d0ca05fc903f2fb7573
+  OCMock: 5ea90566be239f179ba766fd9fbae5885040b992
+
+PODFILE CHECKSUM: 8a47551d4cb50d1be73b4b5bed8629d9a9468757
+
+COCOAPODS: 1.9.1