Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Reland: Create PlatformView instance right after method channel call from Dart #20568

Merged
blasten merged 4 commits into from
Aug 17, 2020
Merged

Reland: Create PlatformView instance right after method channel call from Dart #20568

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1ee0285
Revert "Revert "Create PlatformView instance right after method chann…
Aug 17, 2020
ed148a8
Fix crash
Aug 17, 2020
dddc42a
Retry LUCI job
Aug 17, 2020
4232932
Nit
Aug 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 46 additions & 30 deletions shell/platform/android/io/flutter/plugin/platform/PlatformViewsController.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,20 @@ public class PlatformViewsController implements PlatformViewsAccessibilityDelega
// it is associated with(e.g if a platform view creates other views in the same virtual display.
private final HashMap<Context, View> contextToPlatformView;

// The view returned by `PlatformView#getView()`.
Copy link
Contributor

@cyanglaz cyanglaz Aug 17, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nits: views

Copy link
Author

@blasten blasten Aug 17, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

//
// This only applies to hybrid composition.
private final SparseArray<View> platformViews;
private final SparseArray<FlutterMutatorView> mutatorViews;

// The platform view parent that is appended to `FlutterView`.
// If an entry in `platformViews` doesn't have an entry in this array, the platform view isn't
// in the view hierarchy.
//
// This view provides a wrapper that applies scene builder operations to the platform view.
// For example, a transform matrix, or setting opacity on the platform view layer.
//
// This is only applies to hybrid composition.
private final SparseArray<FlutterMutatorView> platformViewParent;

// Map of unique IDs to views that render overlay layers.
private final SparseArray<FlutterImageView> overlayLayerViews;
Expand Down Expand Up @@ -146,12 +158,17 @@ public void createAndroidViewForPlatformView(
public void disposeAndroidViewForPlatformView(int viewId) {
// Hybrid view.
final View platformView = platformViews.get(viewId);
final FlutterMutatorView parentView = platformViewParent.get(viewId);
if (platformView != null) {
final FlutterMutatorView mutatorView = mutatorViews.get(viewId);
mutatorView.removeView(platformView);
((FlutterView) flutterView).removeView(mutatorView);
if (parentView != null) {
parentView.removeView(platformView);
}
platformViews.remove(viewId);
mutatorViews.remove(viewId);
}

if (parentView != null) {
((FlutterView) flutterView).removeView(parentView);
platformViewParent.remove(viewId);
}
}

Expand Down Expand Up @@ -405,7 +422,7 @@ public PlatformViewsController() {
currentFrameUsedPlatformViewIds = new HashSet<>();

platformViews = new SparseArray<>();
mutatorViews = new SparseArray<>();
platformViewParent = new SparseArray<>();

motionEventTracker = MotionEventTracker.getInstance();
}
Expand Down Expand Up @@ -681,15 +698,15 @@ void initializePlatformViewIfNeeded(int viewId) {
throw new IllegalStateException(
"Platform view hasn't been initialized from the platform view channel.");
}
if (mutatorViews.get(viewId) != null) {
if (platformViewParent.get(viewId) != null) {
return;
}
final FlutterMutatorView mutatorView =
final FlutterMutatorView parentView =
new FlutterMutatorView(
context, context.getResources().getDisplayMetrics().density, androidTouchProcessor);
mutatorViews.put(viewId, mutatorView);
mutatorView.addView(view);
((FlutterView) flutterView).addView(mutatorView);
platformViewParent.put(viewId, parentView);
parentView.addView(view);
((FlutterView) flutterView).addView(parentView);
}

public void attachToFlutterRenderer(FlutterRenderer flutterRenderer) {
Expand All @@ -708,13 +725,14 @@ public void onDisplayPlatformView(
initializeRootImageViewIfNeeded();
initializePlatformViewIfNeeded(viewId);

FlutterMutatorView mutatorView = mutatorViews.get(viewId);
mutatorView.readyToDisplay(mutatorsStack, x, y, width, height);
mutatorView.setVisibility(View.VISIBLE);
mutatorView.bringToFront();
final FlutterMutatorView parentView = platformViewParent.get(viewId);
parentView.readyToDisplay(mutatorsStack, x, y, width, height);
parentView.setVisibility(View.VISIBLE);
parentView.bringToFront();

FrameLayout.LayoutParams layoutParams = new FrameLayout.LayoutParams(viewWidth, viewHeight);
View platformView = platformViews.get(viewId);
final FrameLayout.LayoutParams layoutParams =
new FrameLayout.LayoutParams(viewWidth, viewHeight);
final View platformView = platformViews.get(viewId);
platformView.setLayoutParams(layoutParams);
platformView.bringToFront();
currentFrameUsedPlatformViewIds.add(viewId);
Expand All @@ -723,7 +741,7 @@ public void onDisplayPlatformView(
public void onDisplayOverlaySurface(int id, int x, int y, int width, int height) {
initializeRootImageViewIfNeeded();

FlutterImageView overlayView = overlayLayerViews.get(id);
final FlutterImageView overlayView = overlayLayerViews.get(id);
if (overlayView.getParent() == null) {
((FlutterView) flutterView).addView(overlayView);
}
Expand Down Expand Up @@ -766,19 +784,19 @@ public void onEndFrame() {
// If one of the surfaces doesn't have an image, the frame may be incomplete and must be
// dropped.
// For example, a toolbar widget painted by Flutter may not be rendered.
boolean isFrameRenderedUsingImageReaders =
final boolean isFrameRenderedUsingImageReaders =
flutterViewConvertedToImageView && view.acquireLatestImageViewFrame();
finishFrame(isFrameRenderedUsingImageReaders);
}

private void finishFrame(boolean isFrameRenderedUsingImageReaders) {
for (int i = 0; i < overlayLayerViews.size(); i++) {
int overlayId = overlayLayerViews.keyAt(i);
FlutterImageView overlayView = overlayLayerViews.valueAt(i);
final int overlayId = overlayLayerViews.keyAt(i);
final FlutterImageView overlayView = overlayLayerViews.valueAt(i);

if (currentFrameUsedOverlayLayerIds.contains(overlayId)) {
((FlutterView) flutterView).attachOverlaySurfaceToRender(overlayView);
boolean didAcquireOverlaySurfaceImage = overlayView.acquireLatestImage();
final boolean didAcquireOverlaySurfaceImage = overlayView.acquireLatestImage();
isFrameRenderedUsingImageReaders &= didAcquireOverlaySurfaceImage;
} else {
// If the background surface isn't rendered by the image view, then the
Expand All @@ -792,22 +810,20 @@ private void finishFrame(boolean isFrameRenderedUsingImageReaders) {
}
}

for (int i = 0; i < platformViews.size(); i++) {
int viewId = platformViews.keyAt(i);
View platformView = platformViews.get(viewId);
View mutatorView = mutatorViews.get(viewId);
for (int i = 0; i < platformViewParent.size(); i++) {
final int viewId = platformViewParent.keyAt(i);
final View parentView = platformViewParent.get(viewId);
Copy link
Member

@gaaclarke gaaclarke Aug 17, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible parentView will be null?

Copy link
Author

@blasten blasten Aug 17, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not possible. This is iterating over the existing entries, and the code never puts null in the dictionary.


// Show platform views only if the surfaces have images available in this frame,
// and if the platform view is rendered in this frame.
// The platform view is appended to a mutator view.
//
// Otherwise, hide the platform view, but don't remove it from the view hierarchy yet as
// they are removed when the framework diposes the platform view widget.
if (isFrameRenderedUsingImageReaders && currentFrameUsedPlatformViewIds.contains(viewId)) {
platformView.setVisibility(View.VISIBLE);
mutatorView.setVisibility(View.VISIBLE);
parentView.setVisibility(View.VISIBLE);
} else {
platformView.setVisibility(View.GONE);
mutatorView.setVisibility(View.GONE);
parentView.setVisibility(View.GONE);
}
}
}
Expand Down
78 changes: 77 additions & 1 deletion shell/platform/android/test/io/flutter/plugin/platform/PlatformViewsControllerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,6 +445,80 @@ public void onEndFrame__destroysOverlaySurfaceAfterFrameOnFlutterSurfaceView() {
verify(overlayImageView, times(1)).detachFromRenderer();
}

@Test
@Config(shadows = {ShadowFlutterSurfaceView.class, ShadowFlutterJNI.class})
public void onEndFrame__removesPlatformView() {
final PlatformViewsController platformViewsController = new PlatformViewsController();

final int platformViewId = 0;
assertNull(platformViewsController.getPlatformViewById(platformViewId));

final PlatformViewFactory viewFactory = mock(PlatformViewFactory.class);
final PlatformView platformView = mock(PlatformView.class);
final View androidView = mock(View.class);
when(platformView.getView()).thenReturn(androidView);
when(viewFactory.create(any(), eq(platformViewId), any())).thenReturn(platformView);

platformViewsController.getRegistry().registerViewFactory("testType", viewFactory);

final FlutterJNI jni = new FlutterJNI();
jni.attachToNative(false);
attach(jni, platformViewsController);

jni.onFirstFrame();

// Simulate create call from the framework.
createPlatformView(jni, platformViewsController, platformViewId, "testType");

// Simulate first frame from the framework.
jni.onFirstFrame();
platformViewsController.onBeginFrame();

platformViewsController.onEndFrame();
verify(androidView, never()).setVisibility(View.GONE);

final ViewParent parentView = mock(ViewParent.class);
when(androidView.getParent()).thenReturn(parentView);
}

@Test
@Config(shadows = {ShadowFlutterSurfaceView.class, ShadowFlutterJNI.class})
public void onEndFrame__removesPlatformViewParent() {
final PlatformViewsController platformViewsController = new PlatformViewsController();

final int platformViewId = 0;
assertNull(platformViewsController.getPlatformViewById(platformViewId));

final PlatformViewFactory viewFactory = mock(PlatformViewFactory.class);
final PlatformView platformView = mock(PlatformView.class);
final View androidView = mock(View.class);
when(platformView.getView()).thenReturn(androidView);
when(viewFactory.create(any(), eq(platformViewId), any())).thenReturn(platformView);

platformViewsController.getRegistry().registerViewFactory("testType", viewFactory);

final FlutterJNI jni = new FlutterJNI();
jni.attachToNative(false);

final FlutterView flutterView = attach(jni, platformViewsController);

jni.onFirstFrame();

// Simulate create call from the framework.
createPlatformView(jni, platformViewsController, platformViewId, "testType");
platformViewsController.initializePlatformViewIfNeeded(platformViewId);
assertEquals(flutterView.getChildCount(), 2);

// Simulate first frame from the framework.
jni.onFirstFrame();
platformViewsController.onBeginFrame();
platformViewsController.onEndFrame();

// Simulate dispose call from the framework.
disposePlatformView(jni, platformViewsController, platformViewId);
assertEquals(flutterView.getChildCount(), 1);
}

private static byte[] encodeMethodCall(MethodCall call) {
final ByteBuffer buffer = StandardMethodCodec.INSTANCE.encodeMethodCall(call);
buffer.rewind();
Expand Down Expand Up @@ -484,7 +558,8 @@ private static void disposePlatformView(
"flutter/platform_views", encodeMethodCall(platformDisposeMethodCall), /*replyId=*/ 0);
}

private static void attach(FlutterJNI jni, PlatformViewsController platformViewsController) {
private static FlutterView attach(
FlutterJNI jni, PlatformViewsController platformViewsController) {
final DartExecutor executor = new DartExecutor(jni, mock(AssetManager.class));
executor.onAttachedToJNI();

Expand Down Expand Up @@ -515,6 +590,7 @@ public FlutterImageView createImageView() {

view.attachToFlutterEngine(engine);
platformViewsController.attachToView(view);
return view;
}

@Implements(FlutterJNI.class)
Expand Down