feat: user steps

.circleci/config.yml

@@ -278,7 +278,7 @@ jobs:
           command: flutter build ios --simulator
       - run:
           name: Run E2E Tests
-          no_output_timeout: 30m
+          no_output_timeout: 20m
           working_directory: e2e
           command: dotnet test
 

e2e/BugReportingTests.cs

@@ -59,6 +59,8 @@ public void ShakeInvocationEvent()
   {
     if (!Platform.IsIOS) return;
 
+
+       ScrollUp();
     captain.FindByText("Shake").Tap();
 
     captain.Shake();
@@ -69,7 +71,9 @@ public void ShakeInvocationEvent()
   [Fact]
   public void TwoFingersSwipeLeftInvocationEvent()
   {
+   if (!Platform.IsIOS){
     ScrollUp();
+    }
     captain.FindByText("Two Fingers Swipe Left").Tap();
 
     Thread.Sleep(500);
@@ -113,8 +117,8 @@ public void ManualInvocation()
   [Fact]
   public void MultipleScreenshotsInReproSteps()
   {
+    Dispose();
     ScrollDownLittle();
-
     captain.FindByText("Enter screen name").Tap();
     captain.Type("My Screen");
     captain.HideKeyboard();

e2e/InstabugTests.cs

@@ -11,6 +11,13 @@ public class InstabugTests : CaptainTest
   [Fact]
   public void ChangePrimaryColor()
   {
+    ScrollUp();
+    ScrollUp();
+ScrollUp();
+    ScrollUp();
+ScrollUp();
+    ScrollUp();
+
     var color = "#FF0000";
     var expected = Color.FromArgb(255, 0, 0);
 

e2e/Utils/CaptainTest.cs

@@ -32,7 +32,7 @@ protected void ScrollDown()
   {
     captain.Swipe(
         start: new Point(captain.Window.Size.Width / 2, captain.Window.Size.Height - 200),
-        end: new Point(captain.Window.Size.Width / 2, 250)
+        end: new Point(captain.Window.Size.Width / 2, 300)
     );
   }
 
@@ -41,14 +41,14 @@ protected void ScrollDownLittle()
   {
     captain.Swipe(
         start: new Point(captain.Window.Size.Width / 2, captain.Window.Size.Height - 200),
-        end: new Point(captain.Window.Size.Width / 2, captain.Window.Size.Height - 220)
+        end: new Point(captain.Window.Size.Width / 2, captain.Window.Size.Height - 250)
     );
   }
 
   protected void ScrollUp()
   {
     captain.Swipe(
-        start: new Point(captain.Window.Size.Width / 2, 250),
+        start: new Point(captain.Window.Size.Width / 2, 300),
         end: new Point(captain.Window.Size.Width / 2, captain.Window.Size.Height - 200)
     );
   }

packages/instabug_flutter/android/build.gradle

@@ -16,6 +16,13 @@ rootProject.allprojects {
     repositories {
         google()
         mavenCentral()
+        maven {
+			url "https://mvn.instabug.com/nexus/repository/instabug-internal/"
+			credentials {
+			  username "instabug"
+			  password System.getenv('INSTABUG_REPOSITORY_PASSWORD')
+			}
+		}
     }
 }
 
@@ -44,7 +51,8 @@ android {
 }
 
 dependencies {
-    api 'com.instabug.library:instabug:14.1.0'
+    api 'com.instabug.library:instabug:14.2.0.6611053-SNAPSHOT'
+
     testImplementation 'junit:junit:4.13.2'
     testImplementation "org.mockito:mockito-inline:3.12.1"
     testImplementation "io.mockk:mockk:1.13.13"

packages/instabug_flutter/android/src/main/java/com/instabug/flutter/modules/InstabugApi.java

@@ -44,6 +44,7 @@
 import java.io.InputStream;
 import java.lang.reflect.Method;
 import java.util.ArrayList;
+import java.util.Date;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Locale;
@@ -126,6 +127,16 @@ public void init(@NonNull String token, @NonNull List<String> invocationEvents,
                 .build();
 
         Instabug.setScreenshotProvider(screenshotProvider);
+
+        try{
+            Class<?> myClass = Class.forName("com.instabug.library.Instabug");
+            // Enable/Disable native user steps capturing
+            Method method = myClass.getDeclaredMethod("shouldDisableNativeUserStepsCapturing", boolean.class);
+            method.setAccessible(true);
+            method.invoke(null,true);
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
     }
 
     @Override
@@ -159,6 +170,33 @@ public void logOut() {
         Instabug.logoutUser();
     }
 
+    @Override
+    public void setEnableUserSteps(@NonNull Boolean isEnabled) {
+        Instabug.setTrackingUserStepsState(isEnabled ? Feature.State.ENABLED : Feature.State.DISABLED);
+    }
+
+    @Override
+
+    public void logUserSteps(@NonNull String gestureType, @NonNull String message,@Nullable String viewName) {
+        try {
+            final String stepType = ArgsRegistry.gestureStepType.get(gestureType);
+            final long timeStamp = System.currentTimeMillis();
+            String view = "";
+
+            Method method = Reflection.getMethod(Class.forName("com.instabug.library.Instabug"), "addUserStep",
+                    long.class, String.class, String.class, String.class, String.class);
+            if (method != null) {
+                if (viewName != null){
+                    view = viewName;
+                }
+
+                method.invoke(null, timeStamp, stepType, message, null, view);
+            }
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
+
     @Override
     public void setLocale(@NonNull String locale) {
         final InstabugLocale resolvedLocale = ArgsRegistry.locales.get(locale);
@@ -362,6 +400,13 @@ public void reportScreenChange(@NonNull String screenName) {
             if (method != null) {
                 method.invoke(null, null, screenName);
             }
+
+            Method reportViewChange = Reflection.getMethod(Class.forName("com.instabug.library.Instabug"), "reportCurrentViewChange",
+                    String.class);
+            if (reportViewChange != null) {
+                reportViewChange.invoke(null,screenName);
+            }
+
         } catch (Exception e) {
             e.printStackTrace();
         }
@@ -497,7 +542,7 @@ public void willRedirectToStore() {
         Instabug.willRedirectToStore();
     }
 
-    public static void setScreenshotCaptor(ScreenshotCaptor screenshotCaptor,InternalCore internalCore) {
+    public static void setScreenshotCaptor(ScreenshotCaptor screenshotCaptor, InternalCore internalCore) {
         internalCore._setScreenshotCaptor(new com.instabug.library.screenshot.ScreenshotCaptor() {
             @Override
             public void capture(@NonNull ScreenshotRequest screenshotRequest) {

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

@@ -16,6 +16,7 @@
 import com.instabug.library.invocation.InstabugInvocationEvent;
 import com.instabug.library.invocation.util.InstabugFloatingButtonEdge;
 import com.instabug.library.invocation.util.InstabugVideoRecordingButtonPosition;
+import com.instabug.library.model.StepType;
 import com.instabug.library.ui.onboarding.WelcomeMessage;
 
 import java.util.HashMap;
@@ -53,11 +54,12 @@ public T get(Object key) {
         put("InvocationOption.disablePostSendingDialog", Option.DISABLE_POST_SENDING_DIALOG);
     }};
 
+
     public static final ArgsMap<InstabugColorTheme> colorThemes = new ArgsMap<InstabugColorTheme>() {{
         put("ColorTheme.light", InstabugColorTheme.InstabugColorThemeLight);
         put("ColorTheme.dark", InstabugColorTheme.InstabugColorThemeDark);
     }};
-   public static ArgsMap<IBGNonFatalException.Level> nonFatalExceptionLevel = new ArgsMap<IBGNonFatalException.Level>() {{
+    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);
@@ -206,4 +208,13 @@ public T get(Object key) {
         put("CustomTextPlaceHolderKey.messagesNotificationAndOthers", Key.CHATS_MULTIPLE_MESSAGE_NOTIFICATION);
         put("CustomTextPlaceHolderKey.insufficientContentMessage", Key.COMMENT_FIELD_INSUFFICIENT_CONTENT);
     }};
+
+    public static final ArgsMap<String> gestureStepType = new ArgsMap<String>() {{
+        put("GestureType.swipe", StepType.SWIPE);
+        put("GestureType.scroll", StepType.SCROLL);
+        put("GestureType.tap", StepType.TAP);
+        put("GestureType.pinch", StepType.PINCH);
+        put("GestureType.longPress", StepType.LONG_PRESS);
+        put("GestureType.doubleTap", StepType.DOUBLE_TAP);
+    }};
 }

packages/instabug_flutter/android/src/test/java/com/instabug/flutter/InstabugApiTest.java

@@ -6,8 +6,10 @@
 import static org.junit.Assert.assertTrue;
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyInt;
+import static org.mockito.ArgumentMatchers.anyLong;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.ArgumentMatchers.eq;
+import static org.mockito.ArgumentMatchers.isNull;
 import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.mockConstruction;
@@ -30,6 +32,7 @@
 import com.instabug.bug.BugReporting;
 import com.instabug.flutter.generated.InstabugPigeon;
 import com.instabug.flutter.modules.InstabugApi;
+import com.instabug.flutter.util.ArgsRegistry;
 import com.instabug.flutter.util.GlobalMocks;
 import com.instabug.flutter.util.MockReflected;
 import com.instabug.library.Feature;
@@ -654,4 +657,36 @@ public void testSetScreenshotCaptor() {
         InstabugApi.setScreenshotCaptor(any(), internalCore);
         verify(internalCore)._setScreenshotCaptor(any(ScreenshotCaptor.class));
     }
+
+    @Test
+    public void testSetUserStepsEnabledGivenTrue() {
+        boolean isEnabled = true;
+
+        api.setEnableUserSteps(isEnabled);
+
+        mInstabug.verify(() -> Instabug.setTrackingUserStepsState(Feature.State.ENABLED));
+    }
+
+    @Test
+    public void testSetUserStepsEnabledGivenFalse() {
+        boolean isEnabled = false;
+
+        api.setEnableUserSteps(isEnabled);
+
+        mInstabug.verify(() -> Instabug.setTrackingUserStepsState(Feature.State.DISABLED));
+    }
+
+    @Test
+    public void testLogUserSteps() {
+
+        final String gestureType = "GestureType.tap";
+        final String message = "message";
+        final String view = "view";
+
+        api.logUserSteps(gestureType, message,view);
+
+        reflected.verify(() -> MockReflected.addUserStep(anyLong(), eq(ArgsRegistry.gestureStepType.get(gestureType)), eq(message), isNull(), eq(view)));
+
+    }
+
 }

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

@@ -106,6 +106,14 @@ public static void setUp() throws NoSuchMethodException {
         Method mEndScreenLoadingCP = MockReflected.class.getDeclaredMethod("endScreenLoadingCP", Long.class, Long.class);
         mEndScreenLoadingCP.setAccessible(true);
         reflection.when(() -> Reflection.getMethod(Class.forName("com.instabug.apm.APM"), "endScreenLoadingCP", Long.class, Long.class)).thenReturn(mEndScreenLoadingCP);
+
+
+        Method mAddUserStepCp = MockReflected.class.getDeclaredMethod("addUserStep",
+                long.class, String.class, String.class, String.class, String.class);
+        mAddUserStepCp.setAccessible(true);
+        reflection.when(() -> Reflection.getMethod(Class.forName("com.instabug.library.Instabug"), "addUserStep",
+                long.class, String.class, String.class, String.class, String.class)).thenReturn(mAddUserStepCp);;
+
     }
 
     public static void close() {

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

@@ -1,10 +1,12 @@
 package com.instabug.flutter.util;
 
 import android.graphics.Bitmap;
+
 import androidx.annotation.Nullable;
 
 import com.instabug.apm.networkinterception.cp.APMCPNetworkLog;
 import com.instabug.crash.models.IBGNonFatalException;
+import com.instabug.library.model.StepType;
 
 import org.json.JSONObject;
 
@@ -19,33 +21,46 @@ public class MockReflected {
     /**
      * Instabug.reportScreenChange
      */
-    public static void reportScreenChange(Bitmap screenshot, String name) {}
+    public static void reportScreenChange(Bitmap screenshot, String name) {
+    }
 
     /**
      * Instabug.setCustomBrandingImage
      */
-    public static void setCustomBrandingImage(Bitmap light, Bitmap dark) {}
+    public static void setCustomBrandingImage(Bitmap light, Bitmap dark) {
+    }
 
     /**
      * Instabug.setCurrentPlatform
      */
-    public static void setCurrentPlatform(int platform) {}
+    public static void setCurrentPlatform(int platform) {
+    }
 
     /**
      * APMNetworkLogger.log
      */
-    public static void apmNetworkLog(long requestStartTime, long requestDuration, String requestHeaders, String requestBody, long requestBodySize, String requestMethod, String requestUrl, String responseHeaders, String responseBody, String responseBodySize, long statusCode, int responseContentType, String errorMessage, String var18, @Nullable String gqlQueryName, @Nullable String serverErrorMessage, @Nullable APMCPNetworkLog.W3CExternalTraceAttributes w3CExternalTraceAttributes) {}
+    public static void apmNetworkLog(long requestStartTime, long requestDuration, String requestHeaders, String requestBody, long requestBodySize, String requestMethod, String requestUrl, String responseHeaders, String responseBody, String responseBodySize, long statusCode, int responseContentType, String errorMessage, String var18, @Nullable String gqlQueryName, @Nullable String serverErrorMessage, @Nullable APMCPNetworkLog.W3CExternalTraceAttributes w3CExternalTraceAttributes) {
+    }
 
     /**
      * 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) {}
+    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) {
+    }
+
 
+    public static void startUiTraceCP(String screenName, Long microTimeStamp, Long traceId) {
+    }
 
-    public static void startUiTraceCP(String screenName, Long microTimeStamp, Long traceId) {}
+    public static void reportScreenLoadingCP(Long startTimeStampMicro, Long durationMicro, Long uiTraceId) {
+    }
 
-    public static void reportScreenLoadingCP(Long startTimeStampMicro, Long durationMicro, Long uiTraceId) {}
+    public static void endScreenLoadingCP(Long timeStampMicro, Long uiTraceId) {
+    }
 
-    public static void endScreenLoadingCP(Long timeStampMicro, Long uiTraceId) {}
+    public static void addUserStep(long timestamp, @StepType String stepType, String message, String label, String viewType) {
+    }
 }

packages/instabug_flutter/example/android/build.gradle

@@ -15,6 +15,7 @@ allprojects {
     repositories {
         google()
         mavenCentral()
+
     }
 }
 

packages/instabug_flutter/example/ios/InstabugTests/ArgsRegistryTests.m

@@ -188,6 +188,21 @@ - (void)testLocales {
     }
 }
 
+- (void)testUserStepsGesture {
+    NSArray *values = @[
+        @(IBGUIEventTypeSwipe),
+        @(IBGUIEventTypeScroll),
+        @(IBGUIEventTypeTap),
+        @(IBGUIEventTypePinch),
+        @(IBGUIEventTypeLongPress),
+        @(IBGUIEventTypeDoubleTap),
+    ];
+
+    for (NSNumber *value in values) {
+        XCTAssertTrue([[ArgsRegistry.userStepsGesture allValues] containsObject:value]);
+    }
+}
+
 - (void)testPlaceholders {
     NSArray *values = @[
         kIBGShakeStartAlertTextStringName,