feat: enhance non-fatals support (#461)

* feat: add non fatal api

* feat:add-non-fatal-api

* feat:add-non-fatal-api

* fix: conflict issue

* fix: conflict issue

* fix: conflict issue

* add example app

* add example app

* add example app

* fix: PR comments

* Update CHANGELOG.md

Co-authored-by: Ahmed Mahmoud <[email protected]>

* fix: PR comments

* fix: syntax error

* fix: syntax error

* docs: fix changeLog

* docs: fix changeLog

* resolve conflict issues

* fix:ios

* fix:ios

* fix:ios

* fix:ios

---------

Co-authored-by: Ahmed Mahmoud <[email protected]>

Author: ahmedAlaaInstabug

.circleci/config.yml

@@ -47,7 +47,7 @@ commands:
           steps:
             - run:
                 name: Install XCUITest Driver
-                command: appium driver install xcuitest@7.14.0
+                command: appium driver install xcuitest@4.35.0
       - when:
           condition:
             equal:

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## [Unreleased](https://github.com/Instabug/Instabug-Flutter/compare/v13.0.0...dev)
 
+### Added
+- Add support for passing a grouping fingerprint, error level, and user attributes to the `CrashReporting.reportHandledCrash` non-fatals API ([#461](https://github.com/Instabug/Instabug-Flutter/pull/461)).
+
 ### Changed
 
 - Bump Instabug iOS SDK to v13.1.0 ([#1227](https://github.com/Instabug/Instabug-Flutter/pull/1227)). [See release notes](https://github.com/Instabug/Instabug-iOS/releases/tag/13.1.0).

android/src/main/java/com/instabug/flutter/modules/CrashReportingApi.java

@@ -1,17 +1,21 @@
 package com.instabug.flutter.modules;
 
-import android.util.Log;
+import static com.instabug.crash.CrashReporting.getFingerprintObject;
 
 import androidx.annotation.NonNull;
+import androidx.annotation.Nullable;
 
 import com.instabug.crash.CrashReporting;
+import com.instabug.crash.models.IBGNonFatalException;
 import com.instabug.flutter.generated.CrashReportingPigeon;
+import com.instabug.flutter.util.ArgsRegistry;
 import com.instabug.flutter.util.Reflection;
 import com.instabug.library.Feature;
 
 import org.json.JSONObject;
 
 import java.lang.reflect.Method;
+import java.util.Map;
 
 import io.flutter.plugin.common.BinaryMessenger;
 
@@ -46,4 +50,24 @@ public void send(@NonNull String jsonCrash, @NonNull Boolean isHandled) {
         }
     }
 
+    @Override
+    public void sendNonFatalError(@NonNull String jsonCrash, @Nullable Map<String, String> userAttributes, @Nullable String fingerprint, @NonNull String nonFatalExceptionLevel) {
+        try {
+            Method method = Reflection.getMethod(Class.forName("com.instabug.crash.CrashReporting"), "reportException", JSONObject.class, boolean.class,
+                    Map.class, JSONObject.class, IBGNonFatalException.Level.class);
+            final JSONObject exceptionObject = new JSONObject(jsonCrash);
+
+            JSONObject fingerprintObj = null;
+            if (fingerprint != null) {
+                fingerprintObj = getFingerprintObject(fingerprint);
+            }
+            IBGNonFatalException.Level nonFatalExceptionLevelType = ArgsRegistry.nonFatalExceptionLevel.get(nonFatalExceptionLevel);
+            if (method != null) {
+                method.invoke(null, exceptionObject, true, userAttributes, fingerprintObj, nonFatalExceptionLevelType);
+            }
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
+
 }

android/src/main/java/com/instabug/flutter/util/ArgsRegistry.java

@@ -2,6 +2,7 @@
 
 import androidx.annotation.NonNull;
 
+import com.instabug.crash.models.IBGNonFatalException;
 import com.instabug.library.LogLevel;
 import com.instabug.bug.BugReporting;
 import com.instabug.bug.invocation.Option;
@@ -56,7 +57,12 @@ public T get(Object key) {
         put("ColorTheme.light", InstabugColorTheme.InstabugColorThemeLight);
         put("ColorTheme.dark", InstabugColorTheme.InstabugColorThemeDark);
     }};
-
+   public static ArgsMap<IBGNonFatalException.Level> nonFatalExceptionLevel = new ArgsMap<IBGNonFatalException.Level>() {{
+        put("NonFatalExceptionLevel.critical", IBGNonFatalException.Level.CRITICAL);
+        put("NonFatalExceptionLevel.error", IBGNonFatalException.Level.ERROR);
+        put("NonFatalExceptionLevel.warning", IBGNonFatalException.Level.WARNING);
+        put("NonFatalExceptionLevel.info", IBGNonFatalException.Level.INFO);
+    }};
     public static final ArgsMap<InstabugFloatingButtonEdge> floatingButtonEdges = new ArgsMap<InstabugFloatingButtonEdge>() {{
         put("FloatingButtonEdge.left", InstabugFloatingButtonEdge.LEFT);
         put("FloatingButtonEdge.right", InstabugFloatingButtonEdge.RIGHT);

android/src/test/java/com/instabug/flutter/CrashReportingApiTest.java

@@ -1,14 +1,17 @@
 package com.instabug.flutter;
 
+import static com.instabug.crash.CrashReporting.getFingerprintObject;
 import static com.instabug.flutter.util.GlobalMocks.reflected;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.mockStatic;
 
 import com.instabug.crash.CrashReporting;
+import com.instabug.crash.models.IBGNonFatalException;
 import com.instabug.flutter.generated.CrashReportingPigeon;
 import com.instabug.flutter.modules.CrashReportingApi;
+import com.instabug.flutter.util.ArgsRegistry;
 import com.instabug.flutter.util.GlobalMocks;
 import com.instabug.flutter.util.MockReflected;
 import com.instabug.library.Feature;
@@ -19,6 +22,9 @@
 import org.junit.Test;
 import org.mockito.MockedStatic;
 
+import java.util.HashMap;
+import java.util.Map;
+
 import io.flutter.plugin.common.BinaryMessenger;
 
 
@@ -77,4 +83,19 @@ public void testSend() {
 
         reflected.verify(() -> MockReflected.crashReportException(any(JSONObject.class), eq(isHandled)));
     }
+
+    @Test
+    public void testSendNonFatalError() {
+        String jsonCrash = "{}";
+        boolean isHandled = true;
+        String fingerPrint = "test";
+
+        Map<String, String> expectedUserAttributes = new HashMap<>();
+        String level = ArgsRegistry.nonFatalExceptionLevel.keySet().iterator().next();
+        JSONObject expectedFingerprint = getFingerprintObject(fingerPrint);
+        IBGNonFatalException.Level expectedLevel = ArgsRegistry.nonFatalExceptionLevel.get(level);
+        api.sendNonFatalError(jsonCrash, expectedUserAttributes, fingerPrint, level);
+
+        reflected.verify(() -> MockReflected.crashReportException(any(JSONObject.class), eq(isHandled), eq(expectedUserAttributes), eq(expectedFingerprint), eq(expectedLevel)));
+    }
 }

android/src/test/java/com/instabug/flutter/util/GlobalMocks.java

@@ -8,12 +8,15 @@
 import android.net.Uri;
 import android.util.Log;
 
+import com.instabug.crash.models.IBGNonFatalException;
+
 import org.json.JSONObject;
 import org.mockito.MockedStatic;
 import org.mockito.invocation.InvocationOnMock;
 import org.mockito.stubbing.Answer;
 
 import java.lang.reflect.Method;
+import java.util.Map;
 
 public class GlobalMocks {
     public static MockedStatic<ThreadManager> threadManager;
@@ -75,6 +78,15 @@ public static void setUp() throws NoSuchMethodException {
                         JSONObject.class, boolean.class))
                 .thenReturn(mCrashReportException);
 
+        Method mCrashReportNonFatalException = MockReflected.class.getDeclaredMethod("crashReportException", JSONObject.class, boolean.class,
+                Map.class, JSONObject.class, IBGNonFatalException.Level.class);
+        mCrashReportNonFatalException.setAccessible(true);
+        reflection
+                .when(() -> Reflection.getMethod(Class.forName("com.instabug.crash.CrashReporting"), "reportException",
+                        JSONObject.class, boolean.class,
+                        Map.class, JSONObject.class, IBGNonFatalException.Level.class))
+                .thenReturn(mCrashReportNonFatalException);
+
         uri = mockStatic(Uri.class);
         uri.when(() -> Uri.fromFile(any())).thenReturn(mock(Uri.class));
     }

android/src/test/java/com/instabug/flutter/util/MockReflected.java

@@ -4,8 +4,12 @@
 
 import androidx.annotation.Nullable;
 
+import com.instabug.crash.models.IBGNonFatalException;
+
 import org.json.JSONObject;
 
+import java.util.Map;
+
 /**
  * Includes fake implementations of methods called by reflection.
  * Used to verify whether or not a private methods was called.
@@ -36,4 +40,6 @@ public static void apmNetworkLog(long requestStartTime, long requestDuration, St
      * CrashReporting.reportException
      */
     public static void crashReportException(JSONObject exception, boolean isHandled) {}
+    public static void crashReportException(JSONObject exception, boolean isHandled, Map<String,String> userAttributes, JSONObject fingerPrint, IBGNonFatalException.Level level) {}
+
 }

e2e/BugReportingTests.cs

@@ -113,7 +113,7 @@ public void ManualInvocation()
   [Fact]
   public void MultipleScreenshotsInReproSteps()
   {
-    ScrollDown();
+    ScrollDownLittle();
 
     captain.FindByText("Enter screen name").Tap();
     captain.Type("My Screen");

example/ios/Flutter/AppFrameworkInfo.plist

@@ -21,6 +21,6 @@
   <key>CFBundleVersion</key>
   <string>1.0</string>
   <key>MinimumOSVersion</key>
-  <string>11.0</string>
+  <string>12.0</string>
 </dict>
 </plist>

example/ios/InstabugTests/CrashReportingApiTests.m

@@ -4,12 +4,13 @@
 #import "Instabug/IBGCrashReporting.h"
 #import "Instabug/Instabug.h"
 #import "Util/Instabug+Test.h"
+#import "Util/IBGCrashReporting+CP.h"
 
 @interface CrashReportingApiTests : XCTestCase
 
-@property (nonatomic, strong) id mCrashReporting;
-@property (nonatomic, strong) id mInstabug;
-@property (nonatomic, strong) CrashReportingApi *api;
+@property(nonatomic, strong) id mCrashReporting;
+@property(nonatomic, strong) id mInstabug;
+@property(nonatomic, strong) CrashReportingApi *api;
 
 @end
 
@@ -24,20 +25,42 @@ - (void)setUp {
 - (void)testSetEnabled {
     NSNumber *isEnabled = @1;
     FlutterError *error;
-
+    
     [self.api setEnabledIsEnabled:isEnabled error:&error];
-
+    
     OCMVerify([self.mCrashReporting setEnabled:YES]);
 }
 
 - (void)testSend {
     NSString *jsonCrash = @"{}";
     NSNumber *isHandled = @0;
     FlutterError *error;
-
+    
     [self.api sendJsonCrash:jsonCrash isHandled:isHandled error:&error];
+    
+    OCMVerify([self.mCrashReporting cp_reportFatalCrashWithStackTrace:@{}]);
+}
 
-    OCMVerify([self.mInstabug reportCrashWithStackTrace:@{} handled:isHandled]);
+
+- (void)testSendNonFatalErrorJsonCrash {
+    NSString *jsonCrash = @"{}";
+    NSString *fingerPrint = @"fingerprint";
+    NSDictionary *userAttributes = @{@"key": @"value",};
+    NSString *ibgNonFatalLevel = @"NonFatalExceptionLevel.error";
+    
+    FlutterError *error;
+    
+    [self.api sendNonFatalErrorJsonCrash:jsonCrash
+                          userAttributes:userAttributes
+                             fingerprint:fingerPrint
+                  nonFatalExceptionLevel:ibgNonFatalLevel
+                                   error:&error];
+    
+    OCMVerify([self.mCrashReporting cp_reportNonFatalCrashWithStackTrace:@{}
+                level:IBGNonFatalLevelError
+                groupingString:fingerPrint
+                userAttributes:userAttributes
+              ]);
 }
 
 @end