[Android] HC++ wire up dart platform channel code and integration test. (#162751)

Use the PlatformViewController2 to register a platform view, allow the
dart side platform view logic to opt into this new platform view. Wires
up an integration test with android_engine_test.

Author: Jonah Williams

dev/bots/suite_runners/run_android_engine_tests.dart

@@ -57,7 +57,7 @@ Future<void> runAndroidEngineTests({required ImpellerBackend impellerBackend}) a
     // TODO(matanlurey): Enable once `flutter drive` retains error logs.
     // final RegExp impellerStdoutPattern = RegExp('Using the Imepller rendering backend (.*)');
 
-    for (final FileSystemEntity file in mains) {
+    Future<void> runTest(FileSystemEntity file) async {
       final CommandResult result = await runCommand(
         'flutter',
         <String>[
@@ -77,7 +77,7 @@ Future<void> runAndroidEngineTests({required ImpellerBackend impellerBackend}) a
       final String? stdout = result.flattenedStdout;
       if (stdout == null) {
         foundError(<String>['No stdout produced.']);
-        continue;
+        return;
       }
 
       // TODO(matanlurey): Enable once `flutter drive` retains error logs.
@@ -86,23 +86,51 @@ Future<void> runAndroidEngineTests({required ImpellerBackend impellerBackend}) a
       // final Match? stdoutMatch = impellerStdoutPattern.firstMatch(stdout);
       // if (stdoutMatch == null) {
       //   foundError(<String>['Could not find pattern ${impellerStdoutPattern.pattern}.', stdout]);
-      //   continue;
+      //   return;
       // }
 
       // final String reportedBackend = stdoutMatch.group(1)!.toLowerCase();
       // if (reportedBackend != impellerBackend.name) {
       //   foundError(<String>[
       //     'Reported Imepller backend was $reportedBackend, expected ${impellerBackend.name}',
       //   ]);
-      //   continue;
+      //   return;
       // }
     }
+
+    for (final FileSystemEntity file in mains) {
+      if (file.path.contains('hcpp')) {
+        continue;
+      }
+      await runTest(file);
+    }
+
+    // Test HCPP Platform Views on Vulkan.
+    if (impellerBackend == ImpellerBackend.vulkan) {
+      androidManifestXml.writeAsStringSync(
+        androidManifestXml.readAsStringSync().replaceFirst(
+          kSurfaceControlMetadataDisabled,
+          kSurfaceControlMetadataEnabled,
+        ),
+      );
+      for (final FileSystemEntity file in mains) {
+        if (!file.path.contains('hcpp')) {
+          continue;
+        }
+        await runTest(file);
+      }
+    }
   } finally {
     // Restore original contents.
     androidManifestXml.writeAsStringSync(androidManifestContents);
   }
 }
 
+const String kSurfaceControlMetadataDisabled =
+    '<meta-data android:name="io.flutter.embedding.android.UseSurfaceControl" android:value="false" />';
+const String kSurfaceControlMetadataEnabled =
+    '<meta-data android:name="io.flutter.embedding.android.UseSurfaceControl" android:value="true" />';
+
 String _impellerBackendMetadata({required String value}) {
   return '<meta-data android:name="io.flutter.embedding.android.ImpellerBackend" android:value="$value" />';
 }

dev/integration_tests/android_engine_test/android/app/src/main/AndroidManifest.xml

@@ -21,19 +21,20 @@ found in the LICENSE file. -->
                  while the Flutter UI initializes. After that, this theme continues
                  to determine the Window background behind the Flutter UI. -->
             <meta-data
-              android:name="io.flutter.embedding.android.NormalTheme"
-              android:resource="@style/NormalTheme"
-              />
+                android:name="io.flutter.embedding.android.NormalTheme"
+                android:resource="@style/NormalTheme"
+            />
             <intent-filter>
-                <action android:name="android.intent.action.MAIN"/>
-                <category android:name="android.intent.category.LAUNCHER"/>
+                <action android:name="android.intent.action.MAIN" />
+                <category android:name="android.intent.category.LAUNCHER" />
             </intent-filter>
         </activity>
         <!-- Don't delete the meta-data below.
              This is used by the Flutter tool to generate GeneratedPluginRegistrant.java -->
         <meta-data android:name="flutterEmbedding" android:value="2" />
         <meta-data android:name="io.flutter.embedding.android.EnableImpeller" android:value="true" />
         <meta-data android:name="io.flutter.embedding.android.ImpellerBackend" android:value="vulkan" />
+        <meta-data android:name="io.flutter.embedding.android.EnableSurfaceControl" android:value="false" />
     </application>
     <!-- Required to query activities that can process text, see:
          https://developer.android.com/training/package-visibility and

dev/integration_tests/android_engine_test/android/app/src/main/kotlin/com/example/native_driver_test/MainActivity.kt

@@ -13,6 +13,7 @@ import androidx.core.view.WindowInsetsControllerCompat
 import com.example.android_engine_test.extensions.NativeDriverSupportPlugin
 import com.example.android_engine_test.fixtures.BlueOrangeGradientPlatformViewFactory
 import com.example.android_engine_test.fixtures.BlueOrangeGradientSurfaceViewPlatformViewFactory
+import com.example.android_engine_test.fixtures.BoxPlatformViewFactory
 import com.example.android_engine_test.fixtures.ChangingColorButtonPlatformViewFactory
 import com.example.android_engine_test.fixtures.OtherFaceTexturePlugin
 import com.example.android_engine_test.fixtures.SmileyFaceTexturePlugin
@@ -31,13 +32,25 @@ class MainActivity : FlutterActivity() {
                 add(NativeDriverSupportPlugin())
             }
 
+        // TODO(jonahwilliams): make platform view controllers share platform view registry.
+        flutterEngine
+            .platformViewsController2
+            .registry
+            .apply {
+                registerViewFactory("blue_orange_gradient_platform_view", BlueOrangeGradientPlatformViewFactory())
+                registerViewFactory("blue_orange_gradient_surface_view_platform_view", BlueOrangeGradientSurfaceViewPlatformViewFactory())
+                registerViewFactory("changing_color_button_platform_view", ChangingColorButtonPlatformViewFactory())
+                registerViewFactory("box_platform_view", BoxPlatformViewFactory())
+            }
+
         flutterEngine
             .platformViewsController
             .registry
             .apply {
                 registerViewFactory("blue_orange_gradient_platform_view", BlueOrangeGradientPlatformViewFactory())
                 registerViewFactory("blue_orange_gradient_surface_view_platform_view", BlueOrangeGradientSurfaceViewPlatformViewFactory())
                 registerViewFactory("changing_color_button_platform_view", ChangingColorButtonPlatformViewFactory())
+                registerViewFactory("box_platform_view", BoxPlatformViewFactory())
             }
     }
 

dev/integration_tests/android_engine_test/android/app/src/main/kotlin/com/example/native_driver_test/fixtures/BoxPlatformViewFactory.kt

@@ -0,0 +1,58 @@
+// Copyright 2014 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+@file:Suppress("PackageName")
+
+package com.example.android_engine_test.fixtures
+
+import android.content.Context
+import android.graphics.Canvas
+import android.graphics.Color
+import android.graphics.Paint
+import android.view.View
+import android.view.ViewGroup
+import io.flutter.plugin.platform.PlatformView
+import io.flutter.plugin.platform.PlatformViewFactory
+
+class BoxPlatformViewFactory : PlatformViewFactory(null) {
+    override fun create(
+        context: Context,
+        viewId: Int,
+        args: Any?
+    ): PlatformView = BoxPlatformView(context)
+}
+
+private class BoxPlatformView(
+    context: Context
+) : View(context),
+    PlatformView {
+    val paint = Paint()
+
+    init {
+        layoutParams =
+            ViewGroup.LayoutParams(
+                ViewGroup.LayoutParams.MATCH_PARENT,
+                ViewGroup.LayoutParams.MATCH_PARENT
+            )
+    }
+
+    override fun getView(): View = this
+
+    override fun dispose() {}
+
+    override fun onDraw(canvas: Canvas) {
+        canvas.drawRect(0f, 0f, width.toFloat(), height.toFloat(), paint)
+        super.onDraw(canvas)
+    }
+
+    override fun onSizeChanged(
+        w: Int,
+        h: Int,
+        oldw: Int,
+        oldh: Int
+    ) {
+        paint.color = Color.rgb(0x41, 0x69, 0xE1)
+        super.onSizeChanged(w, h, oldw, oldh)
+    }
+}

dev/integration_tests/android_engine_test/lib/hcpp/platform_view_main.dart

@@ -0,0 +1,78 @@
+// Copyright 2014 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:android_driver_extensions/extension.dart';
+import 'package:flutter/foundation.dart';
+import 'package:flutter/gestures.dart';
+import 'package:flutter/material.dart';
+import 'package:flutter/rendering.dart';
+import 'package:flutter/services.dart';
+import 'package:flutter_driver/driver_extension.dart';
+
+import '../src/allow_list_devices.dart';
+
+void main() async {
+  ensureAndroidDevice();
+  enableFlutterDriverExtension(commands: <CommandExtension>[nativeDriverCommands]);
+
+  // Run on full screen.
+  await SystemChrome.setEnabledSystemUIMode(SystemUiMode.immersive);
+  runApp(const MainApp());
+}
+
+final class MainApp extends StatelessWidget {
+  const MainApp({super.key});
+
+  // This should appear as the yellow line over a blue box. The
+  // red box should not be visible unless the platform view has not loaded yet.
+  @override
+  Widget build(BuildContext context) {
+    return const MaterialApp(
+      debugShowCheckedModeBanner: false,
+      home: Stack(
+        alignment: AlignmentDirectional.center,
+        children: <Widget>[
+          SizedBox(width: 190, height: 190, child: ColoredBox(color: Colors.red)),
+          SizedBox(
+            width: 200,
+            height: 200,
+            child: _HybridCompositionAndroidPlatformView(viewType: 'box_platform_view'),
+          ),
+          SizedBox(width: 800, height: 25, child: ColoredBox(color: Colors.yellow)),
+        ],
+      ),
+    );
+  }
+}
+
+final class _HybridCompositionAndroidPlatformView extends StatelessWidget {
+  const _HybridCompositionAndroidPlatformView({required this.viewType});
+
+  final String viewType;
+
+  // TODO(jonahwilliams): swap this out with new platform view APIs.
+  @override
+  Widget build(BuildContext context) {
+    return PlatformViewLink(
+      viewType: viewType,
+      surfaceFactory: (BuildContext context, PlatformViewController controller) {
+        return AndroidViewSurface(
+          controller: controller as AndroidViewController,
+          gestureRecognizers: const <Factory<OneSequenceGestureRecognizer>>{},
+          hitTestBehavior: PlatformViewHitTestBehavior.opaque,
+        );
+      },
+      onCreatePlatformView: (PlatformViewCreationParams params) {
+        return PlatformViewsService.initHybridAndroidView(
+            id: params.id,
+            viewType: viewType,
+            layoutDirection: TextDirection.ltr,
+            creationParamsCodec: const StandardMessageCodec(),
+          )
+          ..addOnPlatformViewCreatedListener(params.onPlatformViewCreated)
+          ..create();
+      },
+    );
+  }
+}

dev/integration_tests/android_engine_test/test_driver/hcpp/platform_view_main_test.dart

@@ -0,0 +1,66 @@
+// Copyright 2014 The Flutter Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+import 'package:android_driver_extensions/native_driver.dart';
+import 'package:android_driver_extensions/skia_gold.dart';
+import 'package:flutter_driver/flutter_driver.dart';
+import 'package:test/test.dart';
+
+import '../_luci_skia_gold_prelude.dart';
+
+/// For local debugging, a (local) golden-file is required as a baseline:
+///
+/// ```sh
+/// # Checkout HEAD, i.e. *before* changes you want to test.
+/// UPDATE_GOLDENS=1 flutter drive lib/platform_view/hcpp/platform_view_main.dart
+///
+/// # Make your changes.
+///
+/// # Run the test against baseline.
+/// flutter drive lib/platform_view/hcpp/platform_view_main.dart
+/// ```
+///
+/// For a convenient way to deflake a test, see `tool/deflake.dart`.
+void main() async {
+  const String goldenPrefix = 'hybrid_composition_pp_platform_view';
+
+  late final FlutterDriver flutterDriver;
+  late final NativeDriver nativeDriver;
+
+  setUpAll(() async {
+    if (isLuci) {
+      await enableSkiaGoldComparator(namePrefix: 'android_engine_test$goldenVariant');
+    }
+    flutterDriver = await FlutterDriver.connect();
+    nativeDriver = await AndroidNativeDriver.connect(flutterDriver);
+    await nativeDriver.configureForScreenshotTesting();
+    await flutterDriver.waitUntilFirstFrameRasterized();
+  });
+
+  tearDownAll(() async {
+    await nativeDriver.close();
+    await flutterDriver.close();
+  });
+
+  test('should screenshot an HCPP platform view', () async {
+    await expectLater(
+      nativeDriver.screenshot(),
+      matchesGoldenFile('$goldenPrefix.platform_view.png'),
+    );
+  }, timeout: Timeout.none);
+
+  test('should rotate landscape and screenshot the platform view', () async {
+    await nativeDriver.rotateToLandscape();
+    await expectLater(
+      nativeDriver.screenshot(),
+      matchesGoldenFile('$goldenPrefix.platform_view_landscape_rotated.png'),
+    );
+
+    await nativeDriver.rotateResetDefault();
+    await expectLater(
+      nativeDriver.screenshot(),
+      matchesGoldenFile('$goldenPrefix.platform_view_portait_rotated_back.png'),
+    );
+  }, timeout: Timeout.none);
+}

engine/src/flutter/shell/platform/android/android_shell_holder_unittests.cc

@@ -110,6 +110,7 @@ class MockPlatformViewAndroidJNI : public PlatformViewAndroidJNI {
                int32_t viewHeight,
                MutatorsStack mutators_stack),
               (override));
+  MOCK_METHOD(void, onEndFrame2, (), (override));
   MOCK_METHOD(std::unique_ptr<std::vector<std::string>>,
               FlutterViewComputePlatformResolvedLocale,
               (std::vector<std::string> supported_locales_data),