Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

[Windows] Add/remove view failures should not hang #52164

Merged
merged 3 commits into from
Apr 17, 2024

Conversation

loic-sharma
Copy link
Member

If the embedder API's FlutterEngineAddView and FlutterEngineRemoveView don't return kSuccess, their callbacks won't be invoked. See: flutter.dev/go/multi-view-embedder-apis.

Previously, the Windows embedder would hang in this scenario as it blocks until the callbacks are invoked. Now, the Windows embedder only blocks if these embedder APIs return kSuccess.

Kudos to @dkwingsmt for catching this!

Part of flutter/flutter#144810
Part of flutter/flutter#142845

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the Flutter Style Guide and the C++, Objective-C, Java style guides.
  • I listed at least one issue that this PR fixes in the description above.
  • I added new tests to check the change I am making or feature I am adding, or the PR is test-exempt. See testing the engine for instructions on writing and running engine tests.
  • I updated/added relevant documentation (doc comments with ///).
  • I signed the CLA.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Copy link
Member

@cbracken cbracken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM stamp from a Japanese personal seal

Nice catch @dkwingsmt!

FlutterEngineResult result = embedder_api_.RemoveView(engine_, &info);
if (result != kSuccess) {
// Starting the remove view operation failed. This is unexpected and
// indicates a bug in the Windows embedder.
Copy link
Contributor

@dkwingsmt dkwingsmt Apr 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If failures indicate bugs of the Windows embedder (impossible with any user input), should we just assert it?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the fence on this one. I was going to make the same comment exactly -- at least in debug mode, but I can see the argument for either approach depending on how severe the repercussions of the failure are.

Copy link
Contributor

@dkwingsmt dkwingsmt Apr 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It feels unease to me that if somehow this branch is triggered due to a bug (for example, we somehow removed the outer check), the bug can exist on for months unreported because it's just a harmless log in the user's app, and the user might think "oh, right, I shouldn't add an implicit view again". It's not the severity of the failure that matters the most.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I switched to assertions for the result value. The engine does basic spot checks here (is it an implicit view ID? Did you provide invalid arguments?) that the Windows embedder should never fail.

@loic-sharma loic-sharma marked this pull request as ready for review April 16, 2024 17:32
Copy link
Contributor

@dkwingsmt dkwingsmt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, EXPECT_DEBUG_DEATH is something new to me!

@loic-sharma loic-sharma added the autosubmit Merge PR when tree becomes green via auto submit App label Apr 17, 2024
@auto-submit auto-submit bot merged commit f8ecbc0 into flutter:main Apr 17, 2024
29 checks passed
@loic-sharma loic-sharma deleted the windows_multi_view_polish branch April 17, 2024 16:44
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Apr 17, 2024
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Apr 17, 2024
…146930)

flutter/engine@818191d...bc6382e

2024-04-17 [email protected] [web] move AccessibilityAnnouncements into SemanticsOwner (flutter/engine#52138)
2024-04-17 [email protected] [Windows] Add/remove view failures should not hang (flutter/engine#52164)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-engine-flutter-autoroll
Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
gilnobrega pushed a commit to gilnobrega/flutter that referenced this pull request Apr 22, 2024
…lutter#146930)

flutter/engine@818191d...bc6382e

2024-04-17 [email protected] [web] move AccessibilityAnnouncements into SemanticsOwner (flutter/engine#52138)
2024-04-17 [email protected] [Windows] Add/remove view failures should not hang (flutter/engine#52164)

If this roll has caused a breakage, revert this CL and stop the roller
using the controls here:
https://autoroll.skia.org/r/flutter-engine-flutter-autoroll
Please CC [email protected],[email protected],[email protected] on the revert to ensure that a human
is aware of the problem.

To file a bug in Flutter: https://github.com/flutter/flutter/issues/new/choose

To report a problem with the AutoRoller itself, please file a bug:
https://issues.skia.org/issues/new?component=1389291&template=1850622

Documentation for the AutoRoller is here:
https://skia.googlesource.com/buildbot/+doc/main/autoroll/README.md
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects: desktop autosubmit Merge PR when tree becomes green via auto submit App platform-windows
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants