Flutter Linux Embedder
fl_view_test.cc
Go to the documentation of this file.
1 // Copyright 2013 The Flutter Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4 
6 
7 #include <memory>
8 
9 #include "flutter/shell/platform/embedder/test_utils/proc_table_replacement.h"
14 #include "flutter/shell/platform/linux/testing/fl_test.h"
15 #include "flutter/shell/platform/linux/testing/fl_test_gtk_logs.h"
16 #include "flutter/shell/platform/linux/testing/mock_gtk.h"
17 
18 #include "flutter/shell/platform/linux/testing/linux_test.h"
19 #include "gtest/gtest.h"
20 
21 // FIXME(robert-ancell): Disabled, see below.
22 #if 0
23 static void first_frame_cb(FlView* view, gboolean* first_frame_emitted) {
24  *first_frame_emitted = TRUE;
25 }
26 #endif
27 
28 class FlViewTest : public flutter::testing::LinuxTest {};
29 
30 TEST_F(FlViewTest, GetEngine) {
31  FlView* view = fl_view_new(project);
32 
33  // Check the engine is immediately available (i.e. before the widget is
34  // realized).
35  FlEngine* engine = fl_view_get_engine(view);
36  EXPECT_NE(engine, nullptr);
37 }
38 
39 TEST_F(FlViewTest, StateUpdateDoesNotHappenInInit) {
40  FlView* view = fl_view_new(project);
41  // Check that creating a view doesn't try to query the window state in
42  // initialization, causing a critical log to be issued.
43  EXPECT_FALSE(
44  flutter::testing::fl_has_received_gtk_log_level(G_LOG_LEVEL_CRITICAL));
45 
46  (void)view;
47 }
48 
49 // Disposing a view that holds the text input focus clears the handler's
50 // widget pointer so it does not dangle.
51 // https://github.com/flutter/flutter/issues/188657
52 TEST_F(FlViewTest, DisposeClearsTextInputWidget) {
53  FlView* view = fl_view_new(project);
54  g_object_ref_sink(view);
55  g_autoptr(FlEngine) engine =
56  FL_ENGINE(g_object_ref(fl_view_get_engine(view)));
57  StartEngine(engine);
58  FlTextInputHandler* handler = fl_engine_get_text_input_handler(engine);
59 
60  // Give the view text input focus.
61  fl_text_input_handler_set_widget(handler, GTK_WIDGET(view));
62  EXPECT_EQ(fl_text_input_handler_get_widget(handler), GTK_WIDGET(view));
63 
64  // Destroy the view while the engine and handler persist.
65  g_object_unref(view);
66 
67  EXPECT_EQ(fl_text_input_handler_get_widget(handler), nullptr);
68 }
69 
70 TEST_F(FlViewTest, PresentLayersAfterDestroy) {
71  // Create a view and destroy it.
72  FlView* view = fl_view_new(project);
73  g_object_ref_sink(view);
74  fl_gtk_widget_destroy(GTK_WIDGET(view));
75 
76  // Present a frame on a destroyed widget.
77  fl_renderable_present_layers(FL_RENDERABLE(view), nullptr, 0);
78 
79  g_object_unref(view);
80 }
81 
82 // FIXME(robert-ancell): Disabling this test as it requires the FlView
83 // to be realized to work after some refactoring. This is proving to be
84 // very difficult to mock. Following PRs will change this code so enable the
85 // test again after that.
86 #if 0
87 TEST_F(FlViewTest, FirstFrameSignal) {
88  FlView* view = fl_view_new(project);
89  gboolean first_frame_emitted = FALSE;
90  g_signal_connect(view, "first-frame", G_CALLBACK(first_frame_cb),
91  &first_frame_emitted);
92 
93  EXPECT_FALSE(first_frame_emitted);
94 
95  fl_renderable_present_layers(FL_RENDERABLE(view), nullptr, 0);
96 
97  // Signal is emitted in idle, clear the main loop.
98  while (g_main_context_iteration(g_main_context_default(), FALSE)) {
99  // Repeat until nothing to iterate on.
100  }
101 
102  // Check view has detected frame.
103  EXPECT_TRUE(first_frame_emitted);
104 }
105 #endif
106 
107 // Check semantics update applied
108 TEST_F(FlViewTest, SemanticsUpdate) {
109  FlView* view = fl_view_new(project);
110 
111  FlEngine* engine = fl_view_get_engine(view);
112  StartEngine(engine);
113 
114  FlutterSemanticsFlags flags = {};
115  FlutterSemanticsNode2 root_node = {
116  .id = 0, .label = "root", .flags2 = &flags};
117  FlutterSemanticsNode2* nodes[1] = {&root_node};
118  FlutterSemanticsUpdate2 update = {
119  .node_count = 1, .nodes = nodes, .view_id = 0};
120  g_signal_emit_by_name(engine, "update-semantics", &update);
121 
122  FlViewAccessible* accessible = fl_view_get_accessible(view);
123  EXPECT_EQ(atk_object_get_n_accessible_children(ATK_OBJECT(accessible)), 1);
124  AtkObject* root_object =
125  atk_object_ref_accessible_child(ATK_OBJECT(accessible), 0);
126  EXPECT_STREQ(atk_object_get_name(root_object), "root");
127 }
128 
129 // Check semantics update ignored for other view
130 TEST_F(FlViewTest, SemanticsUpdateOtherView) {
131  FlView* view = fl_view_new(project);
132 
133  FlEngine* engine = fl_view_get_engine(view);
134  StartEngine(engine);
135 
136  FlutterSemanticsFlags flags = {};
137  FlutterSemanticsNode2 root_node = {
138  .id = 0, .label = "root", .flags2 = &flags};
139  FlutterSemanticsNode2* nodes[1] = {&root_node};
140  FlutterSemanticsUpdate2 update = {
141  .node_count = 1, .nodes = nodes, .view_id = 99};
142  g_signal_emit_by_name(engine, "update-semantics", &update);
143 
144  FlViewAccessible* accessible = fl_view_get_accessible(view);
145  EXPECT_EQ(atk_object_get_n_accessible_children(ATK_OBJECT(accessible)), 0);
146 }
147 
148 // Check secondary view is registered with engine.
149 TEST_F(FlViewTest, SecondaryView) {
150  FlView* implicit_view = fl_view_new(project);
151 
152  FlEngine* engine = fl_view_get_engine(implicit_view);
153 
154  auto view_id = std::make_shared<FlutterViewId>(-1);
155  fl_engine_get_embedder_api(engine)->AddView = MOCK_ENGINE_PROC(
156  AddView, ([view_id](auto engine, const FlutterAddViewInfo* info) {
157  *view_id = info->view_id;
158  FlutterAddViewResult result = {
159  .struct_size = sizeof(FlutterAddViewResult),
160  .added = true,
161  .user_data = info->user_data};
162  info->add_view_callback(&result);
163  return kSuccess;
164  }));
165 
166  StartEngine(engine);
167 
168  FlView* secondary_view = fl_view_new_for_engine(engine);
169  EXPECT_EQ(*view_id, fl_view_get_id(secondary_view));
170 }
171 
172 // Check secondary view that fails registration.
173 TEST_F(FlViewTest, SecondaryViewError) {
174  FlView* implicit_view = fl_view_new(project);
175 
176  FlEngine* engine = fl_view_get_engine(implicit_view);
177 
178  auto view_id = std::make_shared<FlutterViewId>(-1);
179  fl_engine_get_embedder_api(engine)->AddView = MOCK_ENGINE_PROC(
180  AddView, ([view_id](auto engine, const FlutterAddViewInfo* info) {
181  *view_id = info->view_id;
182  return kInvalidArguments;
183  }));
184 
185  StartEngine(engine);
186 
187  FlView* secondary_view = fl_view_new_for_engine(engine);
188  EXPECT_EQ(*view_id, fl_view_get_id(secondary_view));
189 }
190 
191 // Check views are deregistered on destruction.
192 TEST_F(FlViewTest, ViewDestroy) {
193  FlView* implicit_view = fl_view_new(project);
194 
195  FlEngine* engine = fl_view_get_engine(implicit_view);
196 
197  g_autoptr(GPtrArray) removed_views = g_ptr_array_new();
198  fl_engine_get_embedder_api(engine)->RemoveView = MOCK_ENGINE_PROC(
199  RemoveView,
200  ([removed_views](auto engine, const FlutterRemoveViewInfo* info) {
201  g_ptr_array_add(removed_views, GINT_TO_POINTER(info->view_id));
202  return kSuccess;
203  }));
204 
205  StartEngine(engine);
206 
207  FlView* secondary_view = fl_view_new_for_engine(engine);
208 
209  int64_t implicit_view_id = fl_view_get_id(implicit_view);
210  int64_t secondary_view_id = fl_view_get_id(secondary_view);
211 
212  fl_gtk_widget_destroy(GTK_WIDGET(secondary_view));
213  fl_gtk_widget_destroy(GTK_WIDGET(implicit_view));
214 
215  EXPECT_EQ(removed_views->len, 2u);
216  EXPECT_EQ(GPOINTER_TO_INT(g_ptr_array_index(removed_views, 0)),
217  secondary_view_id);
218  EXPECT_EQ(GPOINTER_TO_INT(g_ptr_array_index(removed_views, 1)),
219  implicit_view_id);
220 }
221 
222 // Check views deregistered with errors works.
223 TEST_F(FlViewTest, ViewDestroyError) {
224  FlView* implicit_view = fl_view_new(project);
225 
226  FlEngine* engine = fl_view_get_engine(implicit_view);
227 
228  fl_engine_get_embedder_api(engine)->RemoveView = MOCK_ENGINE_PROC(
229  RemoveView, ([](auto engine, const FlutterRemoveViewInfo* info) {
230  return kInvalidArguments;
231  }));
232 
233  StartEngine(engine);
234 
235  FlView* secondary_view = fl_view_new_for_engine(engine);
236 
237  fl_gtk_widget_destroy(GTK_WIDGET(secondary_view));
238  fl_gtk_widget_destroy(GTK_WIDGET(implicit_view));
239 }
240 
241 // Check can create a view that is sized to the content.
242 TEST_F(FlViewTest, SizedToContent) {
243  FlView* implicit_view = fl_view_new(project);
244 
245  FlEngine* engine = fl_view_get_engine(implicit_view);
246 
247  fl_engine_get_embedder_api(engine)->RemoveView = MOCK_ENGINE_PROC(
248  RemoveView, ([](auto engine, const FlutterRemoveViewInfo* info) {
249  return kInvalidArguments;
250  }));
251 
252  StartEngine(engine);
253 
254  FlView* secondary_view = fl_view_new_sized_to_content(engine);
255 
256  fl_gtk_widget_destroy(GTK_WIDGET(secondary_view));
257  fl_gtk_widget_destroy(GTK_WIDGET(implicit_view));
258 }
FlViewAccessible * accessible
FlView * view
g_autoptr(FlEngine) engine
const char FlTextDirection FlAssertiveness gpointer user_data
FlutterEngineProcTable * fl_engine_get_embedder_api(FlEngine *self)
Definition: fl_engine.cc:942
FlTextInputHandler * fl_engine_get_text_input_handler(FlEngine *self)
Definition: fl_engine.cc:1633
void fl_renderable_present_layers(FlRenderable *self, const FlutterLayer **layers, size_t layers_count)
void fl_text_input_handler_set_widget(FlTextInputHandler *self, GtkWidget *widget)
GtkWidget * fl_text_input_handler_get_widget(FlTextInputHandler *self)
FlViewAccessible * fl_view_get_accessible(FlView *self)
Definition: fl_view.cc:843
G_MODULE_EXPORT FlView * fl_view_new(FlDartProject *project)
Definition: fl_view.cc:778
G_MODULE_EXPORT FlView * fl_view_new_sized_to_content(FlEngine *engine)
Definition: fl_view.cc:808
G_MODULE_EXPORT FlView * fl_view_new_for_engine(FlEngine *engine)
Definition: fl_view.cc:792
G_MODULE_EXPORT FlEngine * fl_view_get_engine(FlView *self)
Definition: fl_view.cc:826
G_MODULE_EXPORT int64_t fl_view_get_id(FlView *self)
Definition: fl_view.cc:832
G_BEGIN_DECLS FlutterViewId view_id
static void first_frame_cb(FlViewMonitor *self)
TEST_F(FlViewTest, GetEngine)
Definition: fl_view_test.cc:30