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

Conversation

@cbracken
Copy link
Member

@cbracken cbracken commented Oct 17, 2023

Developers working their app's runner code or in the native parts of
plugins are often required to call methods from the platform thread, or
face a crash.

Makes a minor improvement to fml::ThreadChecker's
IsCreationThreadCurrent log message.

This patch originally proposed to emit a much more specific error
message when calling methods that must be called on the platform thread
(typically originating in calls from plugins), however, given that we
don't ship debug engines as part of the SDK, this is really only going
to be useful to engine developpers, or people brave enough to run with
their own local engine build, in any case.

Issue: flutter/flutter#135345

No changed tests since no functional change, just an error message cleanup.

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.

@cbracken cbracken requested a review from chinmaygarde October 17, 2023 20:04
@flutter-dashboard
Copy link

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie or stuartmorgan on the #hackers channel in Chat (don't just cc them here, they won't see it! Use Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

Copy link
Member

@chinmaygarde chinmaygarde left a comment

Choose a reason for hiding this comment

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

LGTM but do we really distribute unopt engines? Wonder how many folks will actually see this message.

Developers working their app's runner code or in the native parts of
plugins are often required to call methods from the platform thread, or
face a crash.

Makes a minor improvement to fml::ThreadChecker's
IsCreationThreadCurrent log message.

This patch originally proposed to emit a much more specific error
message when calling methods that must be called on the platform thread
(typically originating in calls from plugins), however, given that we
don't ship debug engines as part of the SDK, this is really only going
to be useful to engine developpers, or people brave enough to run with
their own local engine build, in any case.

Issue: flutter/flutter#135345
@cbracken
Copy link
Member Author

On further discussion; reverting the embedder_engine part of the patch and landing just the improved error message.

@cbracken cbracken merged commit 9019122 into flutter:main Oct 17, 2023
@cbracken cbracken deleted the thread-check-logging branch October 17, 2023 22:32
engine-flutter-autoroll added a commit to engine-flutter-autoroll/flutter that referenced this pull request Oct 18, 2023
auto-submit bot pushed a commit to flutter/flutter that referenced this pull request Oct 18, 2023
…136774)

flutter/engine@5df7af3...2eef9b4

2023-10-17 [email protected] Move imgui from buildroot to flutter third_party (flutter/engine#47031)
2023-10-17 [email protected] [Impeller] Rework Vulkan GPUTracker to decorate existing cmd buffers. (flutter/engine#46963)
2023-10-17 [email protected] [fml][embedder] Improve thread-check logging (flutter/engine#47020)
2023-10-17 [email protected] Roll Dart SDK from 99ce477503f8 to da48c75b73b1 (1 revision) (flutter/engine#47027)

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
harryterkelsen pushed a commit that referenced this pull request Oct 23, 2023
Developers working their app's runner code or in the native parts of
plugins are often required to call methods from the platform thread, or
face a crash.
Makes a minor improvement to fml::ThreadChecker's
IsCreationThreadCurrent log message.
This patch originally proposed to emit a much more specific error
message when calling methods that must be called on the platform thread
(typically originating in calls from plugins), however, given that we
don't ship debug engines as part of the SDK, this is really only going
to be useful to engine developpers, or people brave enough to run with
their own local engine build, in any case. 

Issue: flutter/flutter#135345

No changed tests since no functional change, just an error message
cleanup.

## 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] and the [C++,
Objective-C, Java style guides].
- [X] 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.
- [X] I updated/added relevant documentation (doc comments with `///`).
- [X] I signed the [CLA].
- [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/wiki/Tree-hygiene#overview
[Tree Hygiene]: https://github.com/flutter/flutter/wiki/Tree-hygiene
[test-exempt]:
https://github.com/flutter/flutter/wiki/Tree-hygiene#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/wiki/Style-guide-for-Flutter-repo
[C++, Objective-C, Java style guides]:
https://github.com/flutter/engine/blob/main/CONTRIBUTING.md#style
[testing the engine]:
https://github.com/flutter/flutter/wiki/Testing-the-engine
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/wiki/Tree-hygiene#handling-breaking-changes
[Discord]: https://github.com/flutter/flutter/wiki/Chat
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants