Skip to content

Commit 0d2859d

Browse files
robert-ancellDanTup
authored andcommitted
[Linux] Handle FlView being destroyed before rendering is complete. (flutter#193268)
Hold a reference to the child widgets in case there are destroyed externally from FlView. If destroyed, drop any frames. Fixes flutter#192873
1 parent e447022 commit 0d2859d

6 files changed

Lines changed: 93 additions & 0 deletions

File tree

‎engine/src/flutter/shell/platform/linux/BUILD.gn‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,7 @@ executable("flutter_linux_unittests") {
284284
"fl_touch_manager_test.cc",
285285
"fl_value_test.cc",
286286
"fl_view_accessible_test.cc",
287+
"fl_view_renderer_opengl_test.cc",
287288
"fl_view_renderer_software_test.cc",
288289
"fl_view_renderer_subsurface_test.cc",
289290
"fl_view_test.cc",

‎engine/src/flutter/shell/platform/linux/fl_view.cc‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -260,6 +260,12 @@ static void fl_view_present_layers(FlRenderable* renderable,
260260
size_t layers_count) {
261261
FlView* self = FL_VIEW(renderable);
262262

263+
// If widget was destroyed then dispose will have been called and the
264+
// renderer will be null.
265+
if (self->renderer == nullptr) {
266+
return;
267+
}
268+
263269
fl_view_renderer_present_layers(self->renderer, layers, layers_count);
264270
}
265271

@@ -570,6 +576,7 @@ static void fl_view_dispose(GObject* object) {
570576
nullptr);
571577
}
572578

579+
g_clear_object(&self->renderer);
573580
g_clear_object(&self->engine);
574581
g_clear_object(&self->window_state_monitor);
575582
g_clear_object(&self->scrolling_manager);
@@ -704,6 +711,7 @@ static void setup_engine(FlView* self) {
704711
}
705712
break;
706713
}
714+
g_object_ref_sink(self->renderer);
707715
gtk_widget_show(GTK_WIDGET(self->renderer));
708716
gtk_container_add(GTK_CONTAINER(self->event_box), GTK_WIDGET(self->renderer));
709717
g_signal_connect_swapped(self->renderer, "realize", G_CALLBACK(realize_cb),
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
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+
5+
// Included first as it collides with the X11 headers.
6+
#include "flutter/shell/platform/linux/testing/linux_test.h"
7+
#include "gtest/gtest.h"
8+
9+
#include "flutter/shell/platform/embedder/test_utils/proc_table_replacement.h"
10+
#include "flutter/shell/platform/linux/fl_engine_private.h"
11+
#include "flutter/shell/platform/linux/fl_view_renderer.h"
12+
#include "flutter/shell/platform/linux/fl_view_renderer_opengl.h"
13+
#include "flutter/shell/platform/linux/testing/mock_gtk.h"
14+
15+
// MOCK_ENGINE_PROC is leaky by design
16+
// NOLINTBEGIN(clang-analyzer-core.StackAddressEscape)
17+
18+
class FlViewRendererOpenGLTest : public flutter::testing::LinuxTest {
19+
protected:
20+
// GTK queries the window state when widgets are realized.
21+
::testing::NiceMock<flutter::testing::MockGtk> gtk;
22+
};
23+
24+
TEST_F(FlViewRendererOpenGLTest, New) {
25+
g_autoptr(FlViewRendererOpenGL) renderer =
26+
fl_view_renderer_opengl_new(engine, FALSE);
27+
ASSERT_NE(renderer, nullptr);
28+
g_object_ref_sink(renderer);
29+
EXPECT_TRUE(FL_IS_VIEW_RENDERER(renderer));
30+
EXPECT_TRUE(GTK_IS_WIDGET(renderer));
31+
}
32+
33+
TEST_F(FlViewRendererOpenGLTest, PresentLayersAfterDestroy) {
34+
// Create a renderer and destroy it.
35+
FlViewRendererOpenGL* renderer = fl_view_renderer_opengl_new(engine, FALSE);
36+
g_object_ref_sink(renderer);
37+
fl_gtk_widget_destroy(GTK_WIDGET(renderer));
38+
39+
// Present a frame on a destroyed widget.
40+
fl_view_renderer_present_layers(FL_VIEW_RENDERER(renderer), nullptr, 0);
41+
42+
g_object_unref(renderer);
43+
}
44+
45+
// NOLINTEND(clang-analyzer-core.StackAddressEscape)

‎engine/src/flutter/shell/platform/linux/fl_view_renderer_software_test.cc‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,17 @@ TEST_F(FlViewRendererSoftwareTest, RealizeSchedulesFrame) {
5555
gtk_widget_destroy(window);
5656
}
5757

58+
TEST_F(FlViewRendererSoftwareTest, PresentLayersAfterDestroy) {
59+
// Create a renderer and destroy it.
60+
FlViewRendererSoftware* renderer =
61+
fl_view_renderer_software_new(engine, FALSE);
62+
g_object_ref_sink(renderer);
63+
fl_gtk_widget_destroy(GTK_WIDGET(renderer));
64+
65+
// Present a frame on a destroyed widget.
66+
fl_view_renderer_present_layers(FL_VIEW_RENDERER(renderer), nullptr, 0);
67+
68+
g_object_unref(renderer);
69+
}
70+
5871
// NOLINTEND(clang-analyzer-core.StackAddressEscape)

‎engine/src/flutter/shell/platform/linux/fl_view_renderer_subsurface_test.cc‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,16 @@ TEST_F(FlViewRendererSubsurfaceTest, RealizeWithoutWayland) {
6868
// Unrealizing a widget that has no subsurface must not fail.
6969
gtk_widget_destroy(window);
7070
}
71+
72+
TEST_F(FlViewRendererSubsurfaceTest, PresentLayersAfterDestroy) {
73+
// Create a renderer and destroy it.
74+
FlViewRendererSubsurface* renderer =
75+
fl_view_renderer_subsurface_new(engine, FALSE);
76+
g_object_ref_sink(renderer);
77+
fl_gtk_widget_destroy(GTK_WIDGET(renderer));
78+
79+
// Present a frame on a destroyed widget.
80+
fl_view_renderer_present_layers(FL_VIEW_RENDERER(renderer), nullptr, 0);
81+
82+
g_object_unref(renderer);
83+
}

‎engine/src/flutter/shell/platform/linux/fl_view_test.cc‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88

99
#include "flutter/shell/platform/embedder/test_utils/proc_table_replacement.h"
1010
#include "flutter/shell/platform/linux/fl_engine_private.h"
11+
#include "flutter/shell/platform/linux/fl_renderable.h"
1112
#include "flutter/shell/platform/linux/fl_text_input_handler.h"
1213
#include "flutter/shell/platform/linux/fl_view_private.h"
1314
#include "flutter/shell/platform/linux/testing/fl_test.h"
@@ -66,6 +67,18 @@ TEST_F(FlViewTest, DisposeClearsTextInputWidget) {
6667
EXPECT_EQ(fl_text_input_handler_get_widget(handler), nullptr);
6768
}
6869

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+
6982
// FIXME(robert-ancell): Disabling this test as it requires the FlView
7083
// to be realized to work after some refactoring. This is proving to be
7184
// very difficult to mock. Following PRs will change this code so enable the

0 commit comments

Comments
 (0)