feat: support masking private views

CHANGELOG.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## [13.4.0](https://github.com/Instabug/Instabug-Flutter/compare/v13.3.0...v13.4.0) (September 29, 2024)
+## [Unreleased](https://github.com/Instabug/Instabug-Flutter/compare/v13.4.0...dev)
 
 ### Added
 

android/build.gradle

@@ -22,7 +22,7 @@ rootProject.allprojects {
 apply plugin: 'com.android.library'
 
 android {
-    compileSdkVersion 28
+    compileSdkVersion 33
 
     compileOptions {
         sourceCompatibility JavaVersion.VERSION_1_8
@@ -41,10 +41,10 @@ android {
 }
 
 dependencies {
-    api 'com.instabug.library:instabug:13.4.1'
-
+    api 'com.instabug.library:instabug:13.4.1.6295791-SNAPSHOT'
+    testImplementation 'org.robolectric:robolectric:4.12.2'
     testImplementation 'junit:junit:4.13.2'
-    testImplementation "org.mockito:mockito-inline:3.12.1"
+    testImplementation "org.mockito:mockito-inline:5.0.0"
 }
 
 // add upload_symbols task

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

@@ -10,6 +10,7 @@
 import androidx.annotation.NonNull;
 import androidx.annotation.Nullable;
 
+import com.instabug.flutter.generated.InstabugPrivateViewPigeon;
 import com.instabug.flutter.modules.ApmApi;
 import com.instabug.flutter.modules.BugReportingApi;
 import com.instabug.flutter.modules.CrashReportingApi;
@@ -19,31 +20,36 @@
 import com.instabug.flutter.modules.RepliesApi;
 import com.instabug.flutter.modules.SessionReplayApi;
 import com.instabug.flutter.modules.SurveysApi;
-
-import java.util.concurrent.Callable;
+import com.instabug.flutter.util.privateViews.BoundryCaptureManager;
+import com.instabug.flutter.util.privateViews.PixelCopyCaptureManager;
+import com.instabug.flutter.util.privateViews.PrivateViewManager;
+import com.instabug.library.internal.crossplatform.InternalCore;
 
 import io.flutter.embedding.engine.plugins.FlutterPlugin;
 import io.flutter.embedding.engine.plugins.activity.ActivityAware;
 import io.flutter.embedding.engine.plugins.activity.ActivityPluginBinding;
 import io.flutter.embedding.engine.renderer.FlutterRenderer;
 import io.flutter.plugin.common.BinaryMessenger;
-import io.flutter.plugin.common.PluginRegistry.Registrar;
+import io.flutter.plugin.common.PluginRegistry;
 
 public class InstabugFlutterPlugin implements FlutterPlugin, ActivityAware {
     private static final String TAG = InstabugFlutterPlugin.class.getName();
 
     @SuppressLint("StaticFieldLeak")
     private static Activity activity;
 
+    PrivateViewManager privateViewManager;
+
     /**
      * Embedding v1
      */
     @SuppressWarnings("deprecation")
-    public static void registerWith(Registrar registrar) {
+    public static void registerWith(PluginRegistry.Registrar registrar) {
         activity = registrar.activity();
         register(registrar.context().getApplicationContext(), registrar.messenger(), (FlutterRenderer) registrar.textures());
     }
 
+
     @Override
     public void onAttachedToEngine(@NonNull FlutterPluginBinding binding) {
         register(binding.getApplicationContext(), binding.getBinaryMessenger(), (FlutterRenderer) binding.getTextureRegistry());
@@ -57,55 +63,44 @@ public void onDetachedFromEngine(@NonNull FlutterPluginBinding binding) {
     @Override
     public void onAttachedToActivity(@NonNull ActivityPluginBinding binding) {
         activity = binding.getActivity();
+        if (privateViewManager != null) {
+            privateViewManager.setActivity(activity);
+        }
+
     }
 
     @Override
     public void onDetachedFromActivityForConfigChanges() {
         activity = null;
+        privateViewManager.setActivity(null);
+
     }
 
     @Override
     public void onReattachedToActivityForConfigChanges(@NonNull ActivityPluginBinding binding) {
         activity = binding.getActivity();
+        privateViewManager.setActivity(activity);
+
     }
 
     @Override
     public void onDetachedFromActivity() {
         activity = null;
+        privateViewManager.setActivity(null);
+
     }
 
     private static void register(Context context, BinaryMessenger messenger, FlutterRenderer renderer) {
-        final Callable<Bitmap> screenshotProvider = new Callable<Bitmap>() {
-            @Override
-            public Bitmap call() {
-                return takeScreenshot(renderer);
-            }
-        };
-
         ApmApi.init(messenger);
         BugReportingApi.init(messenger);
         CrashReportingApi.init(messenger);
         FeatureRequestsApi.init(messenger);
-        InstabugApi.init(messenger, context, screenshotProvider);
+        privateViewManager = new PrivateViewManager(new InstabugPrivateViewPigeon.InstabugPrivateViewApi(messenger), new PixelCopyCaptureManager(), new BoundryCaptureManager(renderer));
+        InstabugApi.init(messenger, context, privateViewManager, InternalCore.INSTANCE);
         InstabugLogApi.init(messenger);
         RepliesApi.init(messenger);
         SessionReplayApi.init(messenger);
         SurveysApi.init(messenger);
     }
 
-    @Nullable
-    private static Bitmap takeScreenshot(FlutterRenderer renderer) {
-        try {
-            final View view = activity.getWindow().getDecorView().getRootView();
-
-            view.setDrawingCacheEnabled(true);
-            final Bitmap bitmap = renderer.getBitmap();
-            view.setDrawingCacheEnabled(false);
-
-            return bitmap;
-        } catch (Exception e) {
-            Log.e(TAG, "Failed to take screenshot using " + renderer.toString() + ". Cause: " + e);
-            return null;
-        }
-    }
 }

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

@@ -13,6 +13,7 @@
 import com.instabug.flutter.util.ArgsRegistry;
 import com.instabug.flutter.util.Reflection;
 import com.instabug.flutter.util.ThreadManager;
+import com.instabug.flutter.util.privateViews.PrivateViewManager;
 import com.instabug.library.Feature;
 import com.instabug.library.Instabug;
 import com.instabug.library.InstabugColorTheme;
@@ -21,13 +22,14 @@
 import com.instabug.library.Platform;
 import com.instabug.library.ReproConfigurations;
 import com.instabug.library.featuresflags.model.IBGFeatureFlag;
+import com.instabug.library.internal.crossplatform.InternalCore;
 import com.instabug.library.internal.module.InstabugLocale;
 import com.instabug.library.invocation.InstabugInvocationEvent;
 import com.instabug.library.model.NetworkLog;
+import com.instabug.library.screenshot.ScreenshotCaptor;
+import com.instabug.library.screenshot.instacapture.ScreenshotRequest;
 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;
 
@@ -40,22 +42,27 @@
 import java.util.List;
 import java.util.Locale;
 import java.util.Map;
-import java.util.concurrent.Callable;
+
+import io.flutter.FlutterInjector;
+import io.flutter.embedding.engine.loader.FlutterLoader;
+import io.flutter.plugin.common.BinaryMessenger;
 
 public class InstabugApi implements InstabugPigeon.InstabugHostApi {
     private final String TAG = InstabugApi.class.getName();
     private final Context context;
-    private final Callable<Bitmap> screenshotProvider;
     private final InstabugCustomTextPlaceHolder placeHolder = new InstabugCustomTextPlaceHolder();
+    private final PrivateViewManager privateViewManager;
+    private final InternalCore internalCore;
 
-    public static void init(BinaryMessenger messenger, Context context, Callable<Bitmap> screenshotProvider) {
-        final InstabugApi api = new InstabugApi(context, screenshotProvider);
+    public static void init(BinaryMessenger messenger, Context context, PrivateViewManager privateViewManager, InternalCore internalCore) {
+        final InstabugApi api = new InstabugApi(context, privateViewManager, internalCore);
         InstabugPigeon.InstabugHostApi.setup(messenger, api);
     }
 
-    public InstabugApi(Context context, Callable<Bitmap> screenshotProvider) {
+    public InstabugApi(Context context, PrivateViewManager privateViewManager, InternalCore internalCore) {
         this.context = context;
-        this.screenshotProvider = screenshotProvider;
+        this.privateViewManager = privateViewManager;
+        this.internalCore = internalCore;
     }
 
     @VisibleForTesting
@@ -112,7 +119,13 @@ public void init(@NonNull String token, @NonNull List<String> invocationEvents,
                 .setSdkDebugLogsLevel(parsedLogLevel)
                 .build();
 
-        Instabug.setScreenshotProvider(screenshotProvider);
+        internalCore._setScreenshotCaptor(new ScreenshotCaptor() {
+            @Override
+            public void capture(@NonNull ScreenshotRequest screenshotRequest) {
+                privateViewManager.mask(screenshotRequest.getListener());
+            }
+        });
+
     }
 
     @Override

android/src/main/java/com/instabug/flutter/util/privateViews/BoundryCaptureManager.java

@@ -0,0 +1,42 @@
+package com.instabug.flutter.util.privateViews;
+
+import android.app.Activity;
+import android.graphics.Bitmap;
+import android.util.DisplayMetrics;
+import android.view.View;
+
+import com.instabug.flutter.util.ThreadManager;
+
+import io.flutter.embedding.engine.renderer.FlutterRenderer;
+
+public class BoundryCaptureManager implements CaptureManager {
+    FlutterRenderer renderer;
+
+    public BoundryCaptureManager(FlutterRenderer renderer) {
+        this.renderer = renderer;
+    }
+
+    @Override
+    public void capture(Activity activity, ScreenshotResultCallback screenshotResultCallback) {
+        ThreadManager.runOnMainThread(new Runnable() {
+            @Override
+            public void run() {
+                try {
+                    if (activity == null) {
+                        screenshotResultCallback.onError();
+                        return;
+                    }
+                    View rootView = activity.getWindow().getDecorView().getRootView();
+                    rootView.setDrawingCacheEnabled(true);
+                    Bitmap bitmap = renderer.getBitmap();
+                    rootView.setDrawingCacheEnabled(false);
+                    DisplayMetrics displayMetrics = activity.getResources().getDisplayMetrics();
+                    screenshotResultCallback.onScreenshotResult(new ScreenshotResult(displayMetrics.density, bitmap));
+
+                } catch (Exception e) {
+                    screenshotResultCallback.onError();
+                }
+            }
+        });
+    }
+}

android/src/main/java/com/instabug/flutter/util/privateViews/CaptureManager.java

@@ -0,0 +1,7 @@
+package com.instabug.flutter.util.privateViews;
+
+import android.app.Activity;
+
+public interface CaptureManager {
+    void capture(Activity activity, ScreenshotResultCallback screenshotResultCallback);
+}

android/src/main/java/com/instabug/flutter/util/privateViews/PixelCopyCaptureManager.java

@@ -0,0 +1,85 @@
+package com.instabug.flutter.util.privateViews;
+
+import android.app.Activity;
+import android.graphics.Bitmap;
+import android.os.Build;
+import android.os.Handler;
+import android.os.Looper;
+import android.util.DisplayMetrics;
+import android.view.PixelCopy;
+import android.view.SurfaceView;
+
+import androidx.annotation.RequiresApi;
+
+import com.instabug.library.util.memory.MemoryUtils;
+
+import io.flutter.embedding.android.FlutterActivity;
+import io.flutter.embedding.android.FlutterFragment;
+import io.flutter.embedding.android.FlutterView;
+
+public class PixelCopyCaptureManager implements CaptureManager {
+
+    @RequiresApi(api = Build.VERSION_CODES.N)
+    @Override
+    public void capture(Activity activity, ScreenshotResultCallback screenshotResultCallback) {
+        FlutterView flutterView = getFlutterView(activity);
+        if (flutterView == null || !isValidFlutterView(flutterView)) {
+            screenshotResultCallback.onError();
+            return;
+        }
+
+        SurfaceView surfaceView = (SurfaceView) flutterView.getChildAt(0);
+        Bitmap bitmap = createBitmapFromSurface(surfaceView);
+
+        if (bitmap == null) {
+            screenshotResultCallback.onError();
+            return;
+        }
+
+        PixelCopy.request(surfaceView, bitmap, copyResult -> {
+            if (copyResult == PixelCopy.SUCCESS) {
+                DisplayMetrics displayMetrics = activity.getResources().getDisplayMetrics();
+                screenshotResultCallback.onScreenshotResult(new ScreenshotResult(displayMetrics.density, bitmap));
+            } else {
+                screenshotResultCallback.onError();
+            }
+        }, new Handler(Looper.getMainLooper()));
+    }
+
+    private FlutterView getFlutterView(Activity activity) {
+        FlutterView flutterViewInActivity = activity.findViewById(FlutterActivity.FLUTTER_VIEW_ID);
+        FlutterView flutterViewInFragment = activity.findViewById(FlutterFragment.FLUTTER_VIEW_ID);
+        return flutterViewInActivity != null ? flutterViewInActivity : flutterViewInFragment;
+    }
+
+    private boolean isValidFlutterView(FlutterView flutterView) {
+        boolean hasChildren = flutterView.getChildCount() > 0;
+        boolean isSurfaceView = flutterView.getChildAt(0) instanceof SurfaceView;
+        return hasChildren && isSurfaceView;
+    }
+
+    private Bitmap createBitmapFromSurface(SurfaceView surfaceView) {
+        int width = surfaceView.getWidth();
+        int height = surfaceView.getHeight();
+
+        if (width <= 0 || height <= 0) {
+            return null;
+        }
+        Bitmap bitmap;
+        try {
+            if (((long) width * height * 4) < MemoryUtils.getFreeMemory(surfaceView.getContext())) {
+                // ARGB_8888 store each pixel in 4 bytes
+                bitmap = Bitmap.createBitmap(width, height, Bitmap.Config.ARGB_8888);
+            } else {
+                // RGB_565 store each pixel in 2 bytes
+                bitmap = Bitmap.createBitmap(width, height, Bitmap.Config.RGB_565);
+            }
+
+        } catch (IllegalArgumentException | OutOfMemoryError e) {
+            bitmap = Bitmap.createBitmap(width, height, Bitmap.Config.RGB_565);
+        }
+
+
+        return bitmap;
+    }
+}