Move renderer config to EmbedderTestContext (#56699)

Moves all backend-specific renderer configuration out of `EmbedderConfigBuilder` and into the backend-specific subclasses of `EmbedderTestContext`. `EmbedderTestContext` is already backend-specific and as of recent patches, also houses compositor configuration, making it the natural home of this code.

As a result, we no longer need backend-specific methods such as `SetSoftwareRendererConfig`, `SetMetalRendererConfig`, `SetOpenGLRendererConfig`, `SetVulkanRendererConfig`. Nor do we need manual backend initialisation in `EmbedderConfigBuilder`. Nor does that initialisation any longer require relying on internal backend-specific code within `EmbedderTestContext`, since we now do that initialisation in the `EmbedderTestContext` constructor.

Since the bulk of the work previously done by this method now occurs in the `EmbedderTestContext` constructor, the only work remaining in these methods is surface creation. Further, since this is all now implemented in backend-specific `EmbedderTestContext` subclasses, they have all been renamed to a single method: `SetSurface`.

Previously, all of these methods took a surface_size parameter, with two exceptions:
* `SetVulkanRendererConfig` also took an optional `FlutterVulkanInstanceProcAddressCallback` parameter. This has been extracted to a separate method `SetVulkanInstanceProcAddressCallback` on `EmbedderTestContextVulkan`.
* `SetSoftwareRendererConfig` defaulted the parameter to a size of (1, 1). For consistency, this is no longer defaulted, and all call sites have been updated, consistent with other backends.

Lastly, one nice benefit is that because the render config is initialised in the `EmbedderTestContext` constructor, there's no longer a requirement to call `Set*RendererConfig` prior modifying any specific properties on the config, nor is it problematic to call the (replacement) `SetSurface` method after modifying the config. Where the renderer config was being customised in embedder unit tests, I've pushed that customisation up to the top of the test where the rest of the test context is configured.

This eliminates nearly all remaining `#ifdef SHELL_ENABLE_$BACKEND` blocks in the EmbedderTest infrastructure.

Issue: flutter/flutter#158998

[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style

Author: cbracken

shell/platform/embedder/BUILD.gn

@@ -315,7 +315,6 @@ if (enable_unittests) {
 
     if (test_enable_gl) {
       sources += [
-        "tests/embedder_config_builder_gl.cc",
         "tests/embedder_test_backingstore_producer_gl.cc",
         "tests/embedder_test_backingstore_producer_gl.h",
         "tests/embedder_test_compositor_gl.cc",
@@ -333,7 +332,6 @@ if (enable_unittests) {
 
     if (test_enable_metal) {
       sources += [
-        "tests/embedder_config_builder_metal.mm",
         "tests/embedder_test_backingstore_producer_metal.h",
         "tests/embedder_test_backingstore_producer_metal.mm",
         "tests/embedder_test_compositor_metal.h",
@@ -348,7 +346,6 @@ if (enable_unittests) {
 
     if (test_enable_vulkan) {
       sources += [
-        "tests/embedder_config_builder_vulkan.cc",
         "tests/embedder_test_backingstore_producer_vulkan.cc",
         "tests/embedder_test_backingstore_producer_vulkan.h",
         "tests/embedder_test_compositor_vulkan.cc",

shell/platform/embedder/tests/embedder_a11y_unittests.cc

@@ -35,7 +35,7 @@ TEST_F(EmbedderTest, CannotProvideMultipleSemanticsCallbacks) {
   {
     EmbedderConfigBuilder builder(
         GetEmbedderContext(EmbedderTestContextType::kSoftwareContext));
-    builder.SetSoftwareRendererConfig();
+    builder.SetSurface(SkISize::Make(1, 1));
     builder.GetProjectArgs().update_semantics_callback =
         [](const FlutterSemanticsUpdate* update, void* user_data) {};
     builder.GetProjectArgs().update_semantics_callback2 =
@@ -48,7 +48,7 @@ TEST_F(EmbedderTest, CannotProvideMultipleSemanticsCallbacks) {
   {
     EmbedderConfigBuilder builder(
         GetEmbedderContext(EmbedderTestContextType::kSoftwareContext));
-    builder.SetSoftwareRendererConfig();
+    builder.SetSurface(SkISize::Make(1, 1));
     builder.GetProjectArgs().update_semantics_callback2 =
         [](const FlutterSemanticsUpdate2* update, void* user_data) {};
     builder.GetProjectArgs().update_semantics_node_callback =
@@ -63,7 +63,7 @@ TEST_F(EmbedderTest, CannotProvideMultipleSemanticsCallbacks) {
   {
     EmbedderConfigBuilder builder(
         GetEmbedderContext(EmbedderTestContextType::kSoftwareContext));
-    builder.SetSoftwareRendererConfig();
+    builder.SetSurface(SkISize::Make(1, 1));
     builder.GetProjectArgs().update_semantics_callback =
         [](const FlutterSemanticsUpdate* update, void* user_data) {};
     builder.GetProjectArgs().update_semantics_node_callback =
@@ -78,7 +78,7 @@ TEST_F(EmbedderTest, CannotProvideMultipleSemanticsCallbacks) {
   {
     EmbedderConfigBuilder builder(
         GetEmbedderContext(EmbedderTestContextType::kSoftwareContext));
-    builder.SetSoftwareRendererConfig();
+    builder.SetSurface(SkISize::Make(1, 1));
     builder.GetProjectArgs().update_semantics_callback2 =
         [](const FlutterSemanticsUpdate2* update, void* user_data) {};
     builder.GetProjectArgs().update_semantics_callback =
@@ -171,7 +171,7 @@ TEST_F(EmbedderA11yTest, A11yTreeIsConsistentUsingV3Callbacks) {
       });
 
   EmbedderConfigBuilder builder(context);
-  builder.SetSoftwareRendererConfig();
+  builder.SetSurface(SkISize::Make(1, 1));
   builder.SetDartEntrypoint("a11y_main");
 
   auto engine = builder.LaunchEngine();
@@ -375,7 +375,7 @@ TEST_F(EmbedderA11yTest, A11yStringAttributes) {
       });
 
   EmbedderConfigBuilder builder(context);
-  builder.SetSoftwareRendererConfig();
+  builder.SetSurface(SkISize::Make(1, 1));
   builder.SetDartEntrypoint("a11y_string_attributes");
 
   auto engine = builder.LaunchEngine();
@@ -468,7 +468,7 @@ TEST_F(EmbedderA11yTest, A11yTreeIsConsistentUsingV2Callbacks) {
   });
 
   EmbedderConfigBuilder builder(context);
-  builder.SetSoftwareRendererConfig();
+  builder.SetSurface(SkISize::Make(1, 1));
   builder.SetDartEntrypoint("a11y_main");
 
   auto engine = builder.LaunchEngine();
@@ -662,7 +662,7 @@ TEST_F(EmbedderA11yTest, A11yTreeIsConsistentUsingV1Callbacks) {
       });
 
   EmbedderConfigBuilder builder(context);
-  builder.SetSoftwareRendererConfig();
+  builder.SetSurface(SkISize::Make(1, 1));
   builder.SetDartEntrypoint("a11y_main");
 
   auto engine = builder.LaunchEngine();

shell/platform/embedder/tests/embedder_config_builder.cc

@@ -8,7 +8,6 @@
 #include "flutter/runtime/dart_vm.h"
 #include "flutter/shell/platform/embedder/embedder.h"
 #include "tests/embedder_test_context.h"
-#include "third_party/skia/include/core/SkBitmap.h"
 #include "third_party/skia/include/core/SkImage.h"
 
 namespace flutter::testing {
@@ -27,28 +26,6 @@ EmbedderConfigBuilder::EmbedderConfigBuilder(
 
   custom_task_runners_.struct_size = sizeof(FlutterCustomTaskRunners);
 
-  InitializeGLRendererConfig();
-  InitializeMetalRendererConfig();
-  InitializeVulkanRendererConfig();
-
-  software_renderer_config_.struct_size = sizeof(FlutterSoftwareRendererConfig);
-  software_renderer_config_.surface_present_callback =
-      [](void* context, const void* allocation, size_t row_bytes,
-         size_t height) {
-        auto image_info =
-            SkImageInfo::MakeN32Premul(SkISize::Make(row_bytes / 4, height));
-        SkBitmap bitmap;
-        if (!bitmap.installPixels(image_info, const_cast<void*>(allocation),
-                                  row_bytes)) {
-          FML_LOG(ERROR) << "Could not copy pixels for the software "
-                            "composition from the engine.";
-          return false;
-        }
-        bitmap.setImmutable();
-        return reinterpret_cast<EmbedderTestContextSoftware*>(context)->Present(
-            SkImages::RasterFromBitmap(bitmap));
-      };
-
   // The first argument is always the executable name. Don't make tests have to
   // do this manually.
   AddCommandLineArgument("embedder_unittest");
@@ -79,30 +56,6 @@ FlutterProjectArgs& EmbedderConfigBuilder::GetProjectArgs() {
   return project_args_;
 }
 
-void EmbedderConfigBuilder::SetSoftwareRendererConfig(SkISize surface_size) {
-  renderer_config_.type = FlutterRendererType::kSoftware;
-  renderer_config_.software = software_renderer_config_;
-  context_.SetupSurface(surface_size);
-}
-
-void EmbedderConfigBuilder::SetRendererConfig(EmbedderTestContextType type,
-                                              SkISize surface_size) {
-  switch (type) {
-    case EmbedderTestContextType::kOpenGLContext:
-      SetOpenGLRendererConfig(surface_size);
-      break;
-    case EmbedderTestContextType::kMetalContext:
-      SetMetalRendererConfig(surface_size);
-      break;
-    case EmbedderTestContextType::kVulkanContext:
-      SetVulkanRendererConfig(surface_size);
-      break;
-    case EmbedderTestContextType::kSoftwareContext:
-      SetSoftwareRendererConfig(surface_size);
-      break;
-  }
-}
-
 void EmbedderConfigBuilder::SetAssetsPath() {
   project_args_.assets_path = context_.GetAssetsPath().c_str();
 }
@@ -217,10 +170,6 @@ void EmbedderConfigBuilder::SetupVsyncCallback() {
   };
 }
 
-FlutterRendererConfig& EmbedderConfigBuilder::GetRendererConfig() {
-  return renderer_config_;
-}
-
 void EmbedderConfigBuilder::SetRenderTaskRunner(
     const FlutterTaskRunnerDescription* runner) {
   if (runner == nullptr) {
@@ -336,11 +285,12 @@ UniqueEngine EmbedderConfigBuilder::SetupEngine(bool run) const {
     project_args.dart_entrypoint_argc = 0;
   }
 
-  auto result =
-      run ? FlutterEngineRun(FLUTTER_ENGINE_VERSION, &renderer_config_,
-                             &project_args, &context_, &engine)
-          : FlutterEngineInitialize(FLUTTER_ENGINE_VERSION, &renderer_config_,
-                                    &project_args, &context_, &engine);
+  auto result = run ? FlutterEngineRun(FLUTTER_ENGINE_VERSION,
+                                       &context_.GetRendererConfig(),
+                                       &project_args, &context_, &engine)
+                    : FlutterEngineInitialize(
+                          FLUTTER_ENGINE_VERSION, &context_.GetRendererConfig(),
+                          &project_args, &context_, &engine);
 
   if (result != kSuccess) {
     return {};
@@ -349,52 +299,4 @@ UniqueEngine EmbedderConfigBuilder::SetupEngine(bool run) const {
   return UniqueEngine{engine};
 }
 
-#ifndef SHELL_ENABLE_GL
-// OpenGL fallback implementations.
-// See: flutter/shell/platform/embedder/tests/embedder_config_builder_gl.cc.
-
-void EmbedderConfigBuilder::InitializeGLRendererConfig() {
-  // no-op.
-}
-
-void EmbedderConfigBuilder::SetOpenGLFBOCallBack() {
-  FML_LOG(FATAL) << "OpenGL is not enabled in this build.";
-}
-
-void EmbedderConfigBuilder::SetOpenGLPresentCallBack() {
-  FML_LOG(FATAL) << "OpenGL is not enabled in this build.";
-}
-
-void EmbedderConfigBuilder::SetOpenGLRendererConfig(SkISize surface_size) {
-  FML_LOG(FATAL) << "OpenGL is not enabled in this build.";
-}
-#endif
-#ifndef SHELL_ENABLE_METAL
-// Metal fallback implementations.
-// See: flutter/shell/platform/embedder/tests/embedder_config_builder_metal.mm.
-
-void EmbedderConfigBuilder::InitializeMetalRendererConfig() {
-  // no-op.
-}
-
-void EmbedderConfigBuilder::SetMetalRendererConfig(SkISize surface_size) {
-  FML_LOG(FATAL) << "Metal is not enabled in this build.";
-}
-#endif
-#ifndef SHELL_ENABLE_VULKAN
-// Vulkan fallback implementations.
-// See: flutter/shell/platform/embedder/tests/embedder_config_builder_vulkan.cc.
-
-void EmbedderConfigBuilder::InitializeVulkanRendererConfig() {
-  // no-op.
-}
-
-void EmbedderConfigBuilder::SetVulkanRendererConfig(
-    SkISize surface_size,
-    std::optional<FlutterVulkanInstanceProcAddressCallback>
-        instance_proc_address_callback) {
-  FML_LOG(FATAL) << "Vulkan is not enabled in this build.";
-}
-#endif
-
 }  // namespace flutter::testing

shell/platform/embedder/tests/embedder_config_builder.h

@@ -44,31 +44,6 @@ class EmbedderConfigBuilder {
 
   FlutterProjectArgs& GetProjectArgs();
 
-  void SetRendererConfig(EmbedderTestContextType type, SkISize surface_size);
-
-  void SetSoftwareRendererConfig(SkISize surface_size = SkISize::Make(1, 1));
-
-  void SetOpenGLRendererConfig(SkISize surface_size);
-
-  void SetMetalRendererConfig(SkISize surface_size);
-
-  void SetVulkanRendererConfig(
-      SkISize surface_size,
-      std::optional<FlutterVulkanInstanceProcAddressCallback>
-          instance_proc_address_callback = {});
-
-  // Used to explicitly set an `open_gl.fbo_callback`. Using this method will
-  // cause your test to fail since the ctor for this class sets
-  // `open_gl.fbo_callback_with_frame_info`. This method exists as a utility to
-  // explicitly test this behavior.
-  void SetOpenGLFBOCallBack();
-
-  // Used to explicitly set an `open_gl.present`. Using this method will cause
-  // your test to fail since the ctor for this class sets
-  // `open_gl.present_with_info`. This method exists as a utility to explicitly
-  // test this behavior.
-  void SetOpenGLPresentCallBack();
-
   void SetAssetsPath();
 
   void SetSnapshots();
@@ -109,7 +84,7 @@ class EmbedderConfigBuilder {
 
   FlutterCompositor& GetCompositor();
 
-  FlutterRendererConfig& GetRendererConfig();
+  void SetSurface(SkISize surface_size) { context_.SetSurface(surface_size); }
 
   void SetRenderTargetType(
       EmbedderTestBackingStoreProducer::RenderTargetType type,
@@ -125,23 +100,8 @@ class EmbedderConfigBuilder {
   void SetupVsyncCallback();
 
  private:
-  void InitializeGLRendererConfig();
-  void InitializeVulkanRendererConfig();
-  void InitializeMetalRendererConfig();
-
   EmbedderTestContext& context_;
   FlutterProjectArgs project_args_ = {};
-  FlutterRendererConfig renderer_config_ = {};
-  FlutterSoftwareRendererConfig software_renderer_config_ = {};
-#ifdef SHELL_ENABLE_GL
-  FlutterOpenGLRendererConfig opengl_renderer_config_ = {};
-#endif
-#ifdef SHELL_ENABLE_METAL
-  FlutterMetalRendererConfig metal_renderer_config_ = {};
-#endif
-#ifdef SHELL_ENABLE_VULKAN
-  FlutterVulkanRendererConfig vulkan_renderer_config_ = {};
-#endif
   std::string dart_entrypoint_;
   FlutterCustomTaskRunners custom_task_runners_ = {};
   FlutterCompositor compositor_ = {};