feat: add screen loading manual & automatic approaches

.circleci/config.yml

@@ -321,4 +321,4 @@ workflows:
             - hold_release
           filters:
             branches:
-              only: master
+              only: master

android/src/main/AndroidManifest.xml

@@ -1,3 +1,10 @@
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
   package="com.instabug.flutter">
+
+  <application>
+    <meta-data
+      android:name="com.instabug.library.ibg_platform"
+      android:value="FLUTTER" />
+  </application>
+
 </manifest>

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

@@ -1,15 +1,23 @@
 package com.instabug.flutter.modules;
 
 import android.util.Log;
+
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
+
 import com.instabug.apm.APM;
+import com.instabug.apm.InternalAPM;
+import com.instabug.apm.configuration.cp.APMFeature;
+import com.instabug.apm.configuration.cp.FeatureAvailabilityCallback;
 import com.instabug.apm.model.ExecutionTrace;
 import com.instabug.apm.networking.APMNetworkLogger;
 import com.instabug.flutter.generated.ApmPigeon;
 import com.instabug.flutter.util.Reflection;
 import com.instabug.flutter.util.ThreadManager;
+
 import io.flutter.plugin.common.BinaryMessenger;
+
+import org.jetbrains.annotations.NotNull;
 import org.json.JSONObject;
 
 import java.lang.reflect.Method;
@@ -213,4 +221,71 @@ public void networkLogAndroid(@NonNull Map<String, Object> data) {
             e.printStackTrace();
         }
     }
+
+
+    @Override
+    public void startCpUiTrace(@NonNull String screenName, @NonNull Long microTimeStamp, @NonNull Long traceId) {
+        try {
+            InternalAPM._startUiTraceCP(screenName, microTimeStamp, traceId);
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
+
+    @Override
+    public void reportScreenLoadingCP(@NonNull Long startTimeStampMicro, @NonNull Long durationMicro, @NonNull Long uiTraceId) {
+        try {
+            InternalAPM._reportScreenLoadingCP(startTimeStampMicro, durationMicro, uiTraceId);
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
+
+    @Override
+    public void endScreenLoadingCP(@NonNull Long timeStampMicro, @NonNull Long uiTraceId) {
+        try {
+            InternalAPM._endScreenLoadingCP(timeStampMicro, uiTraceId);
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
+
+    @Override
+    public void isEndScreenLoadingEnabled(@NonNull ApmPigeon.Result<Boolean> result) {
+        isScreenLoadingEnabled(result);
+    }
+
+    @Override
+    public void isEnabled(@NonNull ApmPigeon.Result<Boolean> result) {
+        try {
+            // TODO: replace true with an actual implementation of APM.isEnabled once implemented
+            // in the Android SDK.
+            result.success(true);
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
+
+    @Override
+    public void isScreenLoadingEnabled(@NonNull ApmPigeon.Result<Boolean> result) {
+        try {
+            InternalAPM._isFeatureEnabledCP(APMFeature.SCREEN_LOADING, "InstabugCaptureScreenLoading", new FeatureAvailabilityCallback() {
+                @Override
+                public void invoke(boolean isFeatureAvailable) {
+                    result.success(isFeatureAvailable);
+                }
+            });
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
+
+    @Override
+    public void setScreenLoadingEnabled(@NonNull Boolean isEnabled) {
+        try {
+            APM.setScreenLoadingEnabled(isEnabled);
+        } catch (Exception e) {
+            e.printStackTrace();
+        }
+    }
 }

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

@@ -6,27 +6,22 @@
 import android.graphics.BitmapFactory;
 import android.net.Uri;
 import android.util.Log;
-
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 import androidx.annotation.VisibleForTesting;
-
-import com.instabug.flutter.util.ArgsRegistry;
 import com.instabug.flutter.generated.InstabugPigeon;
+import com.instabug.flutter.util.ArgsRegistry;
 import com.instabug.flutter.util.Reflection;
 import com.instabug.flutter.util.ThreadManager;
-import com.instabug.library.Feature;
-import com.instabug.library.Instabug;
-import com.instabug.library.InstabugColorTheme;
-import com.instabug.library.InstabugCustomTextPlaceHolder;
-import com.instabug.library.IssueType;
-import com.instabug.library.Platform;
-import com.instabug.library.ReproConfigurations;
+import com.instabug.library.*;
 import com.instabug.library.internal.module.InstabugLocale;
 import com.instabug.library.invocation.InstabugInvocationEvent;
 import com.instabug.library.model.NetworkLog;
 import com.instabug.library.ui.onboarding.WelcomeMessage;
-
+import io.flutter.FlutterInjector;
+import io.flutter.embedding.engine.loader.FlutterLoader;
+import io.flutter.plugin.common.BinaryMessenger;
+import org.jetbrains.annotations.NotNull;
 import org.json.JSONObject;
 
 import java.io.File;
@@ -39,10 +34,6 @@
 import java.util.Map;
 import java.util.concurrent.Callable;
 
-import io.flutter.FlutterInjector;
-import io.flutter.plugin.common.BinaryMessenger;
-import io.flutter.embedding.engine.loader.FlutterLoader;
-
 public class InstabugApi implements InstabugPigeon.InstabugHostApi {
     private final String TAG = InstabugApi.class.getName();
     private final Context context;
@@ -85,6 +76,16 @@ public void setEnabled(@NonNull Boolean isEnabled) {
         }
     }
 
+    @NotNull
+    @Override
+    public Boolean isEnabled() {
+        return Instabug.isEnabled();
+    }
+
+    @NotNull
+    @Override
+    public Boolean isBuilt() { return Instabug.isBuilt(); }
+
     @Override
     public void init(@NonNull String token, @NonNull List<String> invocationEvents, @NonNull String debugLogsLevel) {
         setCurrentPlatform();

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

@@ -1,12 +1,8 @@
 package com.instabug.flutter.modules;
 
 import androidx.annotation.NonNull;
-import androidx.annotation.Nullable;
-
 import com.instabug.flutter.generated.SessionReplayPigeon;
-import com.instabug.library.OnSessionReplayLinkReady;
 import com.instabug.library.sessionreplay.SessionReplay;
-
 import io.flutter.plugin.common.BinaryMessenger;
 
 public class SessionReplayApi implements SessionReplayPigeon.SessionReplayHostApi {

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

@@ -1,25 +1,18 @@
 package com.instabug.flutter;
 
-import static com.instabug.flutter.util.GlobalMocks.reflected;
-import static com.instabug.flutter.util.MockResult.makeResult;
-import static org.junit.Assert.assertEquals;
-import static org.mockito.ArgumentMatchers.any;
-import static org.mockito.ArgumentMatchers.anyInt;
-import static org.mockito.ArgumentMatchers.eq;
-import static org.mockito.Mockito.mock;
-import static org.mockito.Mockito.mockConstruction;
-import static org.mockito.Mockito.mockStatic;
-import static org.mockito.Mockito.verify;
-import static org.mockito.Mockito.when;
-
 import com.instabug.apm.APM;
+import com.instabug.apm.InternalAPM;
+import com.instabug.apm.configuration.cp.APMFeature;
+import com.instabug.apm.configuration.cp.FeatureAvailabilityCallback;
 import com.instabug.apm.model.ExecutionTrace;
 import com.instabug.apm.networking.APMNetworkLogger;
 import com.instabug.flutter.generated.ApmPigeon;
 import com.instabug.flutter.modules.ApmApi;
 import com.instabug.flutter.util.GlobalMocks;
 import com.instabug.flutter.util.MockReflected;
 
+import io.flutter.plugin.common.BinaryMessenger;
+
 import org.json.JSONObject;
 import org.junit.After;
 import org.junit.Assert;
@@ -31,23 +24,32 @@
 import java.util.HashMap;
 import java.util.Map;
 
-import io.flutter.plugin.common.BinaryMessenger;
+import static com.instabug.flutter.util.GlobalMocks.reflected;
+import static com.instabug.flutter.util.MockResult.makeResult;
+import static org.junit.Assert.assertEquals;
+import static org.mockito.ArgumentMatchers.*;
+import static org.mockito.Mockito.*;
 
 
 public class ApmApiTest {
+
+    private final BinaryMessenger mMessenger = mock(BinaryMessenger.class);
     private final ApmApi api = new ApmApi();
     private MockedStatic<APM> mAPM;
+    private MockedStatic<InternalAPM> mInternalApmStatic;
     private MockedStatic<ApmPigeon.ApmHostApi> mHostApi;
 
     @Before
     public void setUp() throws NoSuchMethodException {
         mAPM = mockStatic(APM.class);
+        mInternalApmStatic = mockStatic(InternalAPM.class);
         mHostApi = mockStatic(ApmPigeon.ApmHostApi.class);
         GlobalMocks.setUp();
     }
 
     @After
     public void cleanUp() {
+        mInternalApmStatic.close();
         mAPM.close();
         mHostApi.close();
         GlobalMocks.close();
@@ -266,4 +268,108 @@ public void testNetworkLogAndroid() {
         mAPMNetworkLogger.close();
         mJSONObject.close();
     }
+
+    @Test
+    public void testStartUiTraceCP() {
+        String screenName = "screen-name";
+        long microTimeStamp = System.currentTimeMillis() / 1000;
+        long traceId = System.currentTimeMillis();
+
+
+        api.startCpUiTrace(screenName, microTimeStamp, traceId);
+
+        mInternalApmStatic.verify(() -> InternalAPM._startUiTraceCP(screenName, microTimeStamp, traceId));
+        mInternalApmStatic.verifyNoMoreInteractions();
+    }
+
+    @Test
+    public void testReportScreenLoadingCP() {
+        long startTimeStampMicro = System.currentTimeMillis() / 1000;
+        long durationMicro = System.currentTimeMillis() / 1000;
+        long uiTraceId = System.currentTimeMillis();
+
+        api.reportScreenLoadingCP(startTimeStampMicro, durationMicro, uiTraceId);
+
+        mInternalApmStatic.verify(() -> InternalAPM._reportScreenLoadingCP(startTimeStampMicro, durationMicro, uiTraceId));
+        mInternalApmStatic.verifyNoMoreInteractions();
+    }
+
+    @Test
+    public void testEndScreenLoading() {
+        long timeStampMicro = System.currentTimeMillis() / 1000;
+        long uiTraceId = System.currentTimeMillis();
+
+        api.endScreenLoadingCP(timeStampMicro, uiTraceId);
+
+        mInternalApmStatic.verify(() -> InternalAPM._endScreenLoadingCP(timeStampMicro, uiTraceId));
+        mInternalApmStatic.verifyNoMoreInteractions();
+    }
+
+    @Test
+    public void testIsEnabled() {
+        boolean expected = true;
+        ApmPigeon.Result<Boolean> result = spy(makeResult((actual) -> assertEquals(expected, actual)));
+        mInternalApmStatic.when(() -> InternalAPM._isFeatureEnabledCP(eq(APMFeature.SCREEN_LOADING), any(), any(FeatureAvailabilityCallback.class))).thenAnswer(invocation -> {
+            FeatureAvailabilityCallback callback = invocation.getArgument(1);
+            callback.invoke(expected);
+            return null;
+        });
+
+        api.isEnabled(result);
+
+        verify(result).success(expected);
+    }
+
+    @Test
+    public void testIsScreenLoadingEnabled() {
+        boolean expected = true;
+        ApmPigeon.Result<Boolean> result = spy(makeResult((actual) -> assertEquals(expected, actual)));
+
+        mInternalApmStatic.when(() -> InternalAPM._isFeatureEnabledCP(any(), any(), any())).thenAnswer(
+                invocation -> {
+                    FeatureAvailabilityCallback callback = (FeatureAvailabilityCallback) invocation.getArguments()[2];
+                    callback.invoke(expected);
+                    return null;
+                });
+
+
+        api.isScreenLoadingEnabled(result);
+
+        mInternalApmStatic.verify(() -> InternalAPM._isFeatureEnabledCP(any(), any(), any()));
+        mInternalApmStatic.verifyNoMoreInteractions();
+
+        verify(result).success(expected);
+    }
+
+    @Test
+    public void testIsEndScreenLoadingEnabled() {
+        boolean expected = true;
+        ApmPigeon.Result<Boolean> result = spy(makeResult((actual) -> assertEquals(expected, actual)));
+
+        mInternalApmStatic.when(() -> InternalAPM._isFeatureEnabledCP(any(), any(), any())).thenAnswer(
+                invocation -> {
+                    FeatureAvailabilityCallback callback = (FeatureAvailabilityCallback) invocation.getArguments()[2];
+                    callback.invoke(expected);
+                    return null;
+                });
+
+
+        api.isEndScreenLoadingEnabled(result);
+
+        mInternalApmStatic.verify(() -> InternalAPM._isFeatureEnabledCP(any(), any(), any()));
+        mInternalApmStatic.verifyNoMoreInteractions();
+
+        verify(result).success(expected);
+
+    }
+
+
+    @Test
+    public void testSetScreenLoadingMonitoringEnabled() {
+        boolean isEnabled = false;
+
+        api.setScreenLoadingEnabled(isEnabled);
+
+        mAPM.verify(() -> APM.setScreenLoadingEnabled(isEnabled));
+    }
 }

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

@@ -57,6 +57,7 @@
 import java.util.concurrent.Callable;
 
 import io.flutter.plugin.common.BinaryMessenger;
+import org.mockito.verification.VerificationMode;
 
 public class InstabugApiTest {
     private final Callable<Bitmap> screenshotProvider = () -> mock(Bitmap.class);
@@ -155,6 +156,20 @@ public void testSetEnabledGivenFalse() {
         mInstabug.verify(Instabug::disable);
     }
 
+    @Test
+    public void testIsEnabled() {
+        api.isEnabled();
+
+        mInstabug.verify(Instabug::isEnabled);
+    }
+
+    @Test
+    public void testIsBuilt() {
+        api.isBuilt();
+
+        mInstabug.verify(Instabug::isBuilt);
+    }
+
     @Test
     public void testShow() {
         api.show();