Allow profile widget builds in profile mode#30990
Merged
liyuqian merged 4 commits intoflutter:masterfrom Apr 15, 2019
Merged
Conversation
Previously, such function is only available in the debug mode. But the performance information is very noisy in debug mode with JIT. I feel that such function is as important and useful as the performance overlay and the `--trace-skia` option for the GPU thread. So we should give it the same ability to run in both profile and debug mode. I've tested it using flutter_gallery in the profile mode. There's no observable difference in the performance overlay between toggling widget build profiling.
liyuqian
added
c: contributor-productivity
| } | ||
|
|
||
| // Expose the ability to send Widget rebuilds as [Timeline] events. | ||
| registerBoolServiceExtension( |
Contributor
There was a problem hiding this comment.
This needs to be behind the kReleaseMode flag
Contributor
There was a problem hiding this comment.
It looks like this is outside of the flag still
Contributor
Author
There was a problem hiding this comment.
Oops, sending another patch.
| Timeline.startSync('${widget.runtimeType}', arguments: timelineWhitelistArguments); | ||
| return true; | ||
| }()); | ||
| if (debugProfileBuildsEnabled) |
Contributor
There was a problem hiding this comment.
This also needs to be behind the kReleaseModeFlag
| return true; | ||
| } else if (character == 'a') { | ||
| if (supportsServiceProtocol && isRunningDebug) { | ||
| if (supportsServiceProtocol && (isRunningDebug || isRunningProfile)) { |
Contributor
There was a problem hiding this comment.
this is equivalent to checking for supportsServiceProtocol
| printStatus('To dump the accessibility tree (debugDumpSemantics), press "S" (for traversal order) or "U" (for inverse hit test order).'); | ||
| } | ||
| printStatus('To display the performance overlay (WidgetsApp.showPerformanceOverlay), press "P".'); | ||
| if (isRunningProfile || isRunningDebug) { |
Contributor
There was a problem hiding this comment.
I believe this check not required, since these do not show up when running release?
liyuqian
commented
Apr 12, 2019
Contributor
Author
liyuqian
left a comment
liyuqian
left a comment
There was a problem hiding this comment.
Thanks @jonahwilliams for the comments!
| Timeline.startSync('${widget.runtimeType}', arguments: timelineWhitelistArguments); | ||
| return true; | ||
| }()); | ||
| if (debugProfileBuildsEnabled) |
| } | ||
|
|
||
| // Expose the ability to send Widget rebuilds as [Timeline] events. | ||
| registerBoolServiceExtension( |
| return true; | ||
| } else if (character == 'a') { | ||
| if (supportsServiceProtocol && isRunningDebug) { | ||
| if (supportsServiceProtocol && (isRunningDebug || isRunningProfile)) { |
| printStatus('To dump the accessibility tree (debugDumpSemantics), press "S" (for traversal order) or "U" (for inverse hit test order).'); | ||
| } | ||
| printStatus('To display the performance overlay (WidgetsApp.showPerformanceOverlay), press "P".'); | ||
| if (isRunningProfile || isRunningDebug) { |
Contributor
|
LGTM once Jonah's comments are addressed. |
Contributor
Author
|
@jonahwilliams : has the new patch addressed all your comments? |
| ); | ||
| } | ||
|
|
||
| // Expose the ability to send Widget rebuilds as [Timeline] events. |
Contributor
There was a problem hiding this comment.
Nit: place these with the extensions above.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Previously, such function is only available in the debug mode. But the
performance information is very noisy in debug mode with JIT. I feel
that such function is as important and useful as the performance overlay
and the
--trace-skiaoption for the GPU thread. So we should give itthe same ability to run in both profile and debug mode.
I've tested it using flutter_gallery in the profile mode. There's no
observable difference in the performance overlay between toggling widget
build profiling.
Related Issues
#30984
Tests
I haven't found any test for the keyboard command of
ResidentRunner. I'd love to add a test for it if someone could teach me how to write one.Checklist
Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (
[x]). This will ensure a smooth and quick review process.///).flutter analyze --flutter-repo) does not report any problems on my PR.Breaking Change
Does your PR require Flutter developers to manually update their apps to accommodate your change?