fl_view_test.cc

Go to the documentation of this file.

// Copyright 2013 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.
 
#include "flutter/shell/platform/linux/public/flutter_linux/fl_view.h"
 
#include <memory>
 
#include "flutter/shell/platform/embedder/test_utils/proc_table_replacement.h"
#include "flutter/shell/platform/linux/fl_engine_private.h"
#include "flutter/shell/platform/linux/fl_text_input_handler.h"
#include "flutter/shell/platform/linux/fl_view_private.h"
#include "flutter/shell/platform/linux/testing/fl_test.h"
#include "flutter/shell/platform/linux/testing/fl_test_gtk_logs.h"
#include "flutter/shell/platform/linux/testing/mock_gtk.h"
 
#include "flutter/shell/platform/linux/testing/linux_test.h"
#include "gtest/gtest.h"
 
// FIXME(robert-ancell): Disabled, see below.
#if 0
static void first_frame_cb(FlView* view, gboolean* first_frame_emitted) {
  *first_frame_emitted = TRUE;
}
#endif
 
class FlViewTest : public flutter::testing::LinuxTest {};
 
TEST_F(FlViewTest, GetEngine) {
  FlView* view = fl_view_new(project);
 
  // Check the engine is immediately available (i.e. before the widget is
  // realized).
  FlEngine* engine = fl_view_get_engine(view);
  EXPECT_NE(engine, nullptr);
}
 
TEST_F(FlViewTest, StateUpdateDoesNotHappenInInit) {
  FlView* view = fl_view_new(project);
  // Check that creating a view doesn't try to query the window state in
  // initialization, causing a critical log to be issued.
  EXPECT_EQ(
      flutter::testing::fl_get_received_gtk_log_levels() & G_LOG_LEVEL_CRITICAL,
      (GLogLevelFlags)0x0);
 
  (void)view;
}
 
// Disposing a view that holds the text input focus clears the handler's
// widget pointer so it does not dangle.
// https://github.com/flutter/flutter/issues/188657
TEST_F(FlViewTest, DisposeClearsTextInputWidget) {
  FlView* view = fl_view_new(project);
  g_object_ref_sink(view);
  g_autoptr(FlEngine) engine =
      FL_ENGINE(g_object_ref(fl_view_get_engine(view)));
  StartEngine(engine);
  FlTextInputHandler* handler = fl_engine_get_text_input_handler(engine);
 
  // Give the view text input focus.
  fl_text_input_handler_set_widget(handler, GTK_WIDGET(view));
  EXPECT_EQ(fl_text_input_handler_get_widget(handler), GTK_WIDGET(view));
 
  // Destroy the view while the engine and handler persist.
  g_object_unref(view);
 
  EXPECT_EQ(fl_text_input_handler_get_widget(handler), nullptr);
}
 
// FIXME(robert-ancell): Disabling this test as it requires the FlView
// to be realized to work after some refactoring. This is proving to be
// very difficult to mock. Following PRs will change this code so enable the
// test again after that.
#if 0
TEST_F(FlViewTest, FirstFrameSignal) {
  FlView* view = fl_view_new(project);
  gboolean first_frame_emitted = FALSE;
  g_signal_connect(view, "first-frame", G_CALLBACK(first_frame_cb),
                   &first_frame_emitted);
 
  EXPECT_FALSE(first_frame_emitted);
 
  fl_renderable_present_layers(FL_RENDERABLE(view), nullptr, 0);
 
  // Signal is emitted in idle, clear the main loop.
  while (g_main_context_iteration(g_main_context_default(), FALSE)) {
    // Repeat until nothing to iterate on.
  }
 
  // Check view has detected frame.
  EXPECT_TRUE(first_frame_emitted);
}
#endif
 
// Check semantics update applied
TEST_F(FlViewTest, SemanticsUpdate) {
  FlView* view = fl_view_new(project);
 
  FlEngine* engine = fl_view_get_engine(view);
  StartEngine(engine);
 
  FlutterSemanticsFlags flags = {};
  FlutterSemanticsNode2 root_node = {
      .id = 0, .label = "root", .flags2 = &flags};
  FlutterSemanticsNode2* nodes[1] = {&root_node};
  FlutterSemanticsUpdate2 update = {
      .node_count = 1, .nodes = nodes, .view_id = 0};
  g_signal_emit_by_name(engine, "update-semantics", &update);
 
  FlViewAccessible* accessible = fl_view_get_accessible(view);
  EXPECT_EQ(atk_object_get_n_accessible_children(ATK_OBJECT(accessible)), 1);
  AtkObject* root_object =
      atk_object_ref_accessible_child(ATK_OBJECT(accessible), 0);
  EXPECT_STREQ(atk_object_get_name(root_object), "root");
}
 
// Check semantics update ignored for other view
TEST_F(FlViewTest, SemanticsUpdateOtherView) {
  FlView* view = fl_view_new(project);
 
  FlEngine* engine = fl_view_get_engine(view);
  StartEngine(engine);
 
  FlutterSemanticsFlags flags = {};
  FlutterSemanticsNode2 root_node = {
      .id = 0, .label = "root", .flags2 = &flags};
  FlutterSemanticsNode2* nodes[1] = {&root_node};
  FlutterSemanticsUpdate2 update = {
      .node_count = 1, .nodes = nodes, .view_id = 99};
  g_signal_emit_by_name(engine, "update-semantics", &update);
 
  FlViewAccessible* accessible = fl_view_get_accessible(view);
  EXPECT_EQ(atk_object_get_n_accessible_children(ATK_OBJECT(accessible)), 0);
}
 
// Check secondary view is registered with engine.
TEST_F(FlViewTest, SecondaryView) {
  FlView* implicit_view = fl_view_new(project);
 
  FlEngine* engine = fl_view_get_engine(implicit_view);
 
  auto view_id = std::make_shared<FlutterViewId>(-1);
  fl_engine_get_embedder_api(engine)->AddView = MOCK_ENGINE_PROC(
      AddView, ([view_id](auto engine, const FlutterAddViewInfo* info) {
        *view_id = info->view_id;
        FlutterAddViewResult result = {
            .struct_size = sizeof(FlutterAddViewResult),
            .added = true,
            .user_data = info->user_data};
        info->add_view_callback(&result);
        return kSuccess;
      }));
 
  StartEngine(engine);
 
  FlView* secondary_view = fl_view_new_for_engine(engine);
  EXPECT_EQ(*view_id, fl_view_get_id(secondary_view));
}
 
// Check secondary view that fails registration.
TEST_F(FlViewTest, SecondaryViewError) {
  FlView* implicit_view = fl_view_new(project);
 
  FlEngine* engine = fl_view_get_engine(implicit_view);
 
  auto view_id = std::make_shared<FlutterViewId>(-1);
  fl_engine_get_embedder_api(engine)->AddView = MOCK_ENGINE_PROC(
      AddView, ([view_id](auto engine, const FlutterAddViewInfo* info) {
        *view_id = info->view_id;
        return kInvalidArguments;
      }));
 
  StartEngine(engine);
 
  FlView* secondary_view = fl_view_new_for_engine(engine);
  EXPECT_EQ(*view_id, fl_view_get_id(secondary_view));
}
 
// Check views are deregistered on destruction.
TEST_F(FlViewTest, ViewDestroy) {
  FlView* implicit_view = fl_view_new(project);
 
  FlEngine* engine = fl_view_get_engine(implicit_view);
 
  g_autoptr(GPtrArray) removed_views = g_ptr_array_new();
  fl_engine_get_embedder_api(engine)->RemoveView = MOCK_ENGINE_PROC(
      RemoveView,
      ([removed_views](auto engine, const FlutterRemoveViewInfo* info) {
        g_ptr_array_add(removed_views, GINT_TO_POINTER(info->view_id));
        return kSuccess;
      }));
 
  StartEngine(engine);
 
  FlView* secondary_view = fl_view_new_for_engine(engine);
 
  int64_t implicit_view_id = fl_view_get_id(implicit_view);
  int64_t secondary_view_id = fl_view_get_id(secondary_view);
 
  fl_gtk_widget_destroy(GTK_WIDGET(secondary_view));
  fl_gtk_widget_destroy(GTK_WIDGET(implicit_view));
 
  EXPECT_EQ(removed_views->len, 2u);
  EXPECT_EQ(GPOINTER_TO_INT(g_ptr_array_index(removed_views, 0)),
            secondary_view_id);
  EXPECT_EQ(GPOINTER_TO_INT(g_ptr_array_index(removed_views, 1)),
            implicit_view_id);
}
 
// Check views deregistered with errors works.
TEST_F(FlViewTest, ViewDestroyError) {
  FlView* implicit_view = fl_view_new(project);
 
  FlEngine* engine = fl_view_get_engine(implicit_view);
 
  fl_engine_get_embedder_api(engine)->RemoveView = MOCK_ENGINE_PROC(
      RemoveView, ([](auto engine, const FlutterRemoveViewInfo* info) {
        return kInvalidArguments;
      }));
 
  StartEngine(engine);
 
  FlView* secondary_view = fl_view_new_for_engine(engine);
 
  fl_gtk_widget_destroy(GTK_WIDGET(secondary_view));
  fl_gtk_widget_destroy(GTK_WIDGET(implicit_view));
}
 
// Check can create a view that is sized to the content.
TEST_F(FlViewTest, SizedToContent) {
  FlView* implicit_view = fl_view_new(project);
 
  FlEngine* engine = fl_view_get_engine(implicit_view);
 
  fl_engine_get_embedder_api(engine)->RemoveView = MOCK_ENGINE_PROC(
      RemoveView, ([](auto engine, const FlutterRemoveViewInfo* info) {
        return kInvalidArguments;
      }));
 
  StartEngine(engine);
 
  FlView* secondary_view = fl_view_new_sized_to_content(engine);
 
  fl_gtk_widget_destroy(GTK_WIDGET(secondary_view));
  fl_gtk_widget_destroy(GTK_WIDGET(implicit_view));
}