Skip to content

Commit 89d9e9a

Browse files
hbatagelomaheshj01
authored andcommitted
Fix crash when closing a window with Alt+F4 in multi-win Flutter on Windows (flutter#161375)
Reopened from flutter/engine#56501. Fixes [flutter#158450](flutter#158450). As mentioned in [flutter#158450](flutter#158450), the crash occurs because a destroyed object may be accessed if the window and view have already been destroyed by the time `KeyEventCallback` is called. This issue is not limited to the `Alt+F4` system key; it may also occur if the window is closed using other key presses, such as pressing `Enter` after navigating to a dialog's "Close" button. This PR proposes a fix that checks whether the view ID is still valid when the callback is invoked. If the view is invalid, the event is skipped for that view. A unit test has been added to assert that the `KeyEventCallback` is invoked when the associated view is valid and not invoked when the view is destroyed. ## Pre-launch Checklist - [x] I read the [Contributor Guide] and followed the process outlined there for submitting PRs. - [x] I read the [Tree Hygiene] wiki page, which explains my responsibilities. - [x] I read and followed the [Flutter Style Guide], including [Features we expect every widget to implement]. - [x] I signed the [CLA]. - [x] I listed at least one issue that this PR fixes in the description above. - [ ] I updated/added relevant documentation (doc comments with `///`). - [x] I added new tests to check the change I am making, or this PR is [test-exempt]. - [x] I followed the [breaking change policy] and added [Data Driven Fixes] where supported. - [x] All existing and new tests are passing. If you need help, consider asking for advice on the #hackers-new channel on [Discord]. <!-- Links --> [Contributor Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview [Tree Hygiene]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md [test-exempt]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests [Flutter Style Guide]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md [Features we expect every widget to implement]: https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement [CLA]: https://cla.developers.google.com/ [flutter/tests]: https://github.com/flutter/tests [breaking change policy]: https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes [Discord]: https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md [Data Driven Fixes]: https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md
1 parent fd50a1b commit 89d9e9a

File tree

2 files changed

+35
-3
lines changed

2 files changed

+35
-3
lines changed

engine/src/flutter/shell/platform/windows/flutter_windows_view.cc

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -536,12 +536,15 @@ void FlutterWindowsView::SendKey(int key,
536536
KeyEventCallback callback) {
537537
engine_->keyboard_key_handler()->KeyboardHook(
538538
key, scancode, action, character, extended, was_down,
539-
[=, callback = std::move(callback)](bool handled) {
539+
[engine = engine_, view_id = view_id_, key, scancode, action, character,
540+
extended, was_down, callback = std::move(callback)](bool handled) {
540541
if (!handled) {
541-
engine_->text_input_plugin()->KeyboardHook(
542+
engine->text_input_plugin()->KeyboardHook(
542543
key, scancode, action, character, extended, was_down);
543544
}
544-
callback(handled);
545+
if (engine->view(view_id)) {
546+
callback(handled);
547+
}
545548
});
546549
}
547550

engine/src/flutter/shell/platform/windows/flutter_windows_view_unittests.cc

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -306,6 +306,35 @@ TEST(FlutterWindowsViewTest, KeySequence) {
306306
key_event_logs.clear();
307307
}
308308

309+
TEST(FlutterWindowsViewTest, KeyEventCallback) {
310+
std::unique_ptr<FlutterWindowsEngine> engine = GetTestEngine();
311+
312+
std::unique_ptr<FlutterWindowsView> view = engine->CreateView(
313+
std::make_unique<NiceMock<MockWindowBindingHandler>>());
314+
315+
class MockCallback {
316+
public:
317+
MOCK_METHOD(void, Call, ());
318+
};
319+
320+
NiceMock<MockCallback> callback_with_valid_view;
321+
NiceMock<MockCallback> callback_with_invalid_view;
322+
323+
auto trigger_key_event = [&](NiceMock<MockCallback>& callback) {
324+
view->OnKey(kVirtualKeyA, kScanCodeKeyA, WM_KEYDOWN, 'a', false, false,
325+
[&](bool) { callback.Call(); });
326+
};
327+
328+
EXPECT_CALL(callback_with_valid_view, Call()).Times(1);
329+
EXPECT_CALL(callback_with_invalid_view, Call()).Times(0);
330+
331+
trigger_key_event(callback_with_valid_view);
332+
engine->RemoveView(view->view_id());
333+
trigger_key_event(callback_with_invalid_view);
334+
335+
key_event_logs.clear();
336+
}
337+
309338
TEST(FlutterWindowsViewTest, EnableSemantics) {
310339
std::unique_ptr<FlutterWindowsEngine> engine = GetTestEngine();
311340
EngineModifier modifier(engine.get());

0 commit comments

Comments
 (0)