Add frame number and widget location map service extension #148702

helin24 · 2024-05-20T19:15:40Z

This helps us add widget rebuild counts to the DevTools performance page: flutter/devtools#4564

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, including Features we expect every widget to implement.
I signed the CLA.
I listed at least one issue that this PR fixes in the description above.
I updated/added relevant documentation (doc comments with ///).
I added new tests to check the change I am making, or this PR is test-exempt.
I followed the breaking change policy and added Data Driven Fixes where supported.
All existing and new tests are passing.

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

Copied from flutter@56352b6

kenzieschmoll · 2024-05-20T21:00:41Z

packages/flutter/lib/src/widgets/widget_inspector.dart

@@ -1114,6 +1114,14 @@ mixin WidgetInspectorService {
        registerExtension: registerExtension,
      );

+      _registerSignalServiceExtension(


should this be using registerServiceExtension instead of _registerSignalServiceExtension?

I'm not sure, as I copied and pasted this - it looks like _registerSignalServiceExtension just calls registerServiceExtension but wraps the result properly, so I figured it's a convenience function. Do you know more about what a "signal service" should be?

sg to use _registerSignalServiceExtension then

packages/flutter/lib/src/widgets/widget_inspector.dart

packages/flutter/test/widgets/widget_inspector_test.dart

kenzieschmoll · 2024-05-20T21:05:12Z

packages/flutter/test/widgets/widget_inspector_test.dart

+        <String, String>{},
+      ))! as Map<String, Object?>;
+
+      final Map<String, Object?> widgetTestLocations = locationMapJson[file]! as Map<String, Object?>;


will the content of this map be stable? If so, can we just assert the raw content of the map is what we expect?

There's some content in here that depends on specific locations related to the sample ClockDemo code (e.g. lines and columns are literally locations in the test file and dependent widgets), so they could change as the test file changes. I think just verifying that counts match up and a few widget names match is good enough to validate the format of the map.

helin24 · 2024-05-21T01:26:03Z

Hmm any advice on how to resolve the tests? The details don't seem to explain what's wrong, and I'm not sure if this link (https://github.com/flutter/flutter/wiki/Understanding-a-LUCI-build-failure) is relevant.

christopherfujino · 2024-05-21T23:02:11Z

@andrewkolos PTAL

…lutter/flutter#148702)

flutter/flutter@73bf206...8d955cd 2024-05-23 nate.w5687@gmail.com Update `FocusManager` platform check to include iOS (flutter/flutter#148612) 2024-05-23 matej.knopp@gmail.com [iOS] fix hot restart with native assets (flutter/flutter#148752) 2024-05-23 engine-flutter-autoroll@skia.org Roll Flutter Engine from b8b82454e302 to 964f087f288c (8 revisions) (flutter/flutter#148943) 2024-05-23 104349824+huycozy@users.noreply.github.com Fix DecoratedSliver sample code to reflect the description (flutter/flutter#148621) 2024-05-23 82763757+NobodyForNothing@users.noreply.github.com Test raw autocomplete api examples (flutter/flutter#148234) 2024-05-23 32538273+ValentinVignal@users.noreply.github.com Add test for scaffold.0.dart and scaffold.2.dart (flutter/flutter#148166) 2024-05-23 sokolovskyi.konstantin@gmail.com Add tests for restorable_value.0.dart API example. (flutter/flutter#148676) 2024-05-23 engine-flutter-autoroll@skia.org Roll Flutter Engine from 8b094fbb94d8 to b8b82454e302 (6 revisions) (flutter/flutter#148919) 2024-05-22 31859944+LongCatIsLooong@users.noreply.github.com Allow `RenderObject.getTransformTo` to take an arbitrary RenderObject in the same tree (flutter/flutter#148897) 2024-05-22 kevinjchisholm@google.com 3.22.1 changelog updates (flutter/flutter#148895) 2024-05-22 helinx@google.com Add frame number and widget location map service extension (flutter/flutter#148702) 2024-05-22 31859944+LongCatIsLooong@users.noreply.github.com Remove an assert with false positives (flutter/flutter#148795) 2024-05-22 rmolivares@renzo-olivares.dev Revert "Fix the second TextFormField to trigger onTapOutside" (flutter/flutter#148909) 2024-05-22 katelovett@google.com [wiki migration] Remaining pages under docs/about/ (flutter/flutter#148782) 2024-05-22 engine-flutter-autoroll@skia.org Roll Flutter Engine from b6971cdf14f8 to 8b094fbb94d8 (3 revisions) (flutter/flutter#148883) 2024-05-22 42757204+wyqlxf@users.noreply.github.com Fix the second TextFormField to trigger onTapOutside (flutter/flutter#148206) 2024-05-22 34871572+gmackall@users.noreply.github.com Try removing robolectric from `integration_test` tests (flutter/flutter#148803) 2024-05-22 victoreronmosele@gmail.com Prevent test folder deletion on running `flutter create --empty` on an existing app project (flutter/flutter#147160) 2024-05-22 katelovett@google.com [wiki migration] Tool team pages (flutter/flutter#148779) 2024-05-22 engine-flutter-autoroll@skia.org Roll Flutter Engine from c89defa55801 to b6971cdf14f8 (6 revisions) (flutter/flutter#148819) 2024-05-22 dacoharkes@google.com [native_assets] Add support for link hooks (flutter/flutter#148474) 2024-05-22 engine-flutter-autoroll@skia.org Roll Packages from ba19b24 to 6525441 (12 revisions) (flutter/flutter#148864) 2024-05-22 36861262+QuncCccccc@users.noreply.github.com Update tokens to 4.0.0 (flutter/flutter#148789) 2024-05-22 zanderso@users.noreply.github.com Move Linux web_long_running_tests_2_5 to bringup (flutter/flutter#148854) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC rmistry@google.com,stuartmorgan@google.com,tarrinneal@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Packages: 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

…48702) This helps us add widget rebuild counts to the DevTools performance page: flutter/devtools#4564

#149345) This pull request is created by [automatic cherry pick workflow](https://github.com/flutter/flutter/wiki/Flutter-Cherrypick-Process#automatically-creates-a-cherry-pick-request) Please fill in the form below, and a flutter domain expert will evaluate this cherry pick request. ### Issue Link: What is the link to the issue this cherry-pick is addressing? DevTools release 2.36.0: https://dart-review.googlesource.com/c/sdk/+/368762 ### Changelog Description: This change adds a service extension that DevTools uses to support a "Track widget build counts" feature. This feature is first included in DevTools 2.36.0. ### Impact Description: This service extension is required for DevTools 2.36.0, which needs to be [cherry-picked](https://dart-review.googlesource.com/c/sdk/+/368762) into the Dart SDK. This beta release of DevTools missed the code cutoff because we were targeting the date listed on go/dash-team-releases (5/29). Since the beta release went out early, we missed the cut off and need to cherry-pick. Since this DevTools release depended on the changes from #148702, we also need to cherry pick those changes into the flutter beta channel. ### Workaround: No. This is required for DevTools 2.36.0 to work properly: https://dart-review.googlesource.com/c/sdk/+/368762. ### Risk: What is the risk level of this cherry-pick? ### Test Coverage: Are you confident that your fix is well-tested by automated tests? ### Validation Steps: What are the steps to validate that this fix works? With this change, a flutter app connecting to DevTools 2.36.0 (already on the Dart SDK main branch and trying to CP into the Dart SDK beta branch) will be able to use the "Track widget build counts" feature in DevTools.

flutter/flutter@73bf206...8d955cd 2024-05-23 nate.w5687@gmail.com Update `FocusManager` platform check to include iOS (flutter/flutter#148612) 2024-05-23 matej.knopp@gmail.com [iOS] fix hot restart with native assets (flutter/flutter#148752) 2024-05-23 engine-flutter-autoroll@skia.org Roll Flutter Engine from b8b82454e302 to 964f087f288c (8 revisions) (flutter/flutter#148943) 2024-05-23 104349824+huycozy@users.noreply.github.com Fix DecoratedSliver sample code to reflect the description (flutter/flutter#148621) 2024-05-23 82763757+NobodyForNothing@users.noreply.github.com Test raw autocomplete api examples (flutter/flutter#148234) 2024-05-23 32538273+ValentinVignal@users.noreply.github.com Add test for scaffold.0.dart and scaffold.2.dart (flutter/flutter#148166) 2024-05-23 sokolovskyi.konstantin@gmail.com Add tests for restorable_value.0.dart API example. (flutter/flutter#148676) 2024-05-23 engine-flutter-autoroll@skia.org Roll Flutter Engine from 8b094fbb94d8 to b8b82454e302 (6 revisions) (flutter/flutter#148919) 2024-05-22 31859944+LongCatIsLooong@users.noreply.github.com Allow `RenderObject.getTransformTo` to take an arbitrary RenderObject in the same tree (flutter/flutter#148897) 2024-05-22 kevinjchisholm@google.com 3.22.1 changelog updates (flutter/flutter#148895) 2024-05-22 helinx@google.com Add frame number and widget location map service extension (flutter/flutter#148702) 2024-05-22 31859944+LongCatIsLooong@users.noreply.github.com Remove an assert with false positives (flutter/flutter#148795) 2024-05-22 rmolivares@renzo-olivares.dev Revert "Fix the second TextFormField to trigger onTapOutside" (flutter/flutter#148909) 2024-05-22 katelovett@google.com [wiki migration] Remaining pages under docs/about/ (flutter/flutter#148782) 2024-05-22 engine-flutter-autoroll@skia.org Roll Flutter Engine from b6971cdf14f8 to 8b094fbb94d8 (3 revisions) (flutter/flutter#148883) 2024-05-22 42757204+wyqlxf@users.noreply.github.com Fix the second TextFormField to trigger onTapOutside (flutter/flutter#148206) 2024-05-22 34871572+gmackall@users.noreply.github.com Try removing robolectric from `integration_test` tests (flutter/flutter#148803) 2024-05-22 victoreronmosele@gmail.com Prevent test folder deletion on running `flutter create --empty` on an existing app project (flutter/flutter#147160) 2024-05-22 katelovett@google.com [wiki migration] Tool team pages (flutter/flutter#148779) 2024-05-22 engine-flutter-autoroll@skia.org Roll Flutter Engine from c89defa55801 to b6971cdf14f8 (6 revisions) (flutter/flutter#148819) 2024-05-22 dacoharkes@google.com [native_assets] Add support for link hooks (flutter/flutter#148474) 2024-05-22 engine-flutter-autoroll@skia.org Roll Packages from ba19b24 to 6525441 (12 revisions) (flutter/flutter#148864) 2024-05-22 36861262+QuncCccccc@users.noreply.github.com Update tokens to 4.0.0 (flutter/flutter#148789) 2024-05-22 zanderso@users.noreply.github.com Move Linux web_long_running_tests_2_5 to bringup (flutter/flutter#148854) If this roll has caused a breakage, revert this CL and stop the roller using the controls here: https://autoroll.skia.org/r/flutter-packages Please CC rmistry@google.com,stuartmorgan@google.com,tarrinneal@google.com on the revert to ensure that a human is aware of the problem. To file a bug in Packages: 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

…lutter/flutter#148702)

helin24 added 3 commits May 20, 2024 11:51

Add frame number, ext for widget location map

056ea1d

Copied from flutter@56352b6

Add test for widget location map

a6763e0

Check frame number in rebuilds and repaints

3a6541d

github-actions bot added the framework flutter/packages/flutter repository. See also f: labels. label May 20, 2024

helin24 added 2 commits May 20, 2024 12:16

Merge remote-tracking branch 'upstream/master' into widget-rebuilds

f5c7638

Add type for empty map

111471d

helin24 requested a review from kenzieschmoll May 20, 2024 20:51

kenzieschmoll reviewed May 20, 2024

View reviewed changes

packages/flutter/lib/src/widgets/widget_inspector.dart Outdated Show resolved Hide resolved

kenzieschmoll reviewed May 20, 2024

View reviewed changes

packages/flutter/lib/src/widgets/widget_inspector.dart Outdated Show resolved Hide resolved

kenzieschmoll reviewed May 20, 2024

View reviewed changes

packages/flutter/test/widgets/widget_inspector_test.dart Outdated Show resolved Hide resolved

kenzieschmoll reviewed May 20, 2024

View reviewed changes

Formatting cleanup

f090b51

helin24 added 7 commits May 21, 2024 09:22

Clean up tests

ef65336

Add type in test

f5d2103

Fix tests

efeeb59

Fix other service extension test

b363188

Revert other count change

05de6ba

Fix test for both widget creation tracked statuses

99a6cdc

Skip map test when not tracking widget creation

8af5b50

helin24 requested a review from christopherfujino May 21, 2024 22:41

christopherfujino requested review from andrewkolos and removed request for christopherfujino May 21, 2024 23:02

kenzieschmoll approved these changes May 22, 2024

View reviewed changes

kenzieschmoll added the autosubmit Merge PR when tree becomes green via auto submit App label May 22, 2024

auto-submit bot merged commit edf312d into flutter:master May 22, 2024
73 checks passed

engine-flutter-autoroll mentioned this pull request May 23, 2024

Roll Flutter from 73bf206f35e7 to c14d55c4d225 (22 revisions) flutter/packages#6783

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 23, 2024

edf312d Add frame number and widget location map service extension (f…

1df877f

…lutter/flutter#148702)

engine-flutter-autoroll mentioned this pull request May 23, 2024

Roll Flutter from 73bf206f35e7 to 02d5286e02e4 (23 revisions) flutter/packages#6785

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 23, 2024

edf312d Add frame number and widget location map service extension (f…

2d87f18

…lutter/flutter#148702)

engine-flutter-autoroll mentioned this pull request May 23, 2024

Roll Flutter from 73bf206f35e7 to 8d955cdd644e (24 revisions) flutter/packages#6786

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request May 23, 2024

edf312d Add frame number and widget location map service extension (f…

f4e7e29

…lutter/flutter#148702)

kenzieschmoll added the cp: beta cherry pick this pull request to beta release candidate branch label May 30, 2024

kenzieschmoll mentioned this pull request May 30, 2024

[CP-stable] Add frame number and widget location map service extension #149345

Merged

5 tasks

victorsanni pushed a commit to victorsanni/flutter that referenced this pull request May 31, 2024

Add frame number and widget location map service extension (flutter#1…

1d42e39

…48702) This helps us add widget rebuild counts to the DevTools performance page: flutter/devtools#4564

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Aug 6, 2024

edf312d Add frame number and widget location map service extension (f…

2a462f6

…lutter/flutter#148702)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add frame number and widget location map service extension #148702

Add frame number and widget location map service extension #148702

helin24 commented May 20, 2024 •

edited

Loading

kenzieschmoll May 20, 2024

helin24 May 21, 2024

kenzieschmoll May 22, 2024

kenzieschmoll May 20, 2024

helin24 May 21, 2024

helin24 commented May 21, 2024

christopherfujino commented May 21, 2024

Add frame number and widget location map service extension #148702

Add frame number and widget location map service extension #148702

Conversation

helin24 commented May 20, 2024 • edited Loading

Pre-launch Checklist

kenzieschmoll May 20, 2024

Choose a reason for hiding this comment

helin24 May 21, 2024

Choose a reason for hiding this comment

kenzieschmoll May 22, 2024

Choose a reason for hiding this comment

kenzieschmoll May 20, 2024

Choose a reason for hiding this comment

helin24 May 21, 2024

Choose a reason for hiding this comment

helin24 commented May 21, 2024

christopherfujino commented May 21, 2024

helin24 commented May 20, 2024 •

edited

Loading