Unified analytics events for doctor validators #136647

eliasyishak · 2023-10-16T15:13:50Z

Related to tracking issue:

☂️ package:unified_analytics implementation in flutter tool #128251

This PR sends analytic events for each of the doctor validators.

This PR below will need to land first in dart-lang/tools before this merges.

Enum + event constructors added for doctor events dart-lang/tools#178

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.
All existing and new tests are passing.

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

…ents-ga4

packages/flutter_tools/lib/src/doctor.dart

packages/flutter_tools/lib/src/doctor_validator.dart

packages/flutter_tools/test/commands.shard/hermetic/doctor_test.dart

eliasyishak · 2023-10-25T18:04:42Z

packages/flutter_tools/lib/src/doctor.dart

+        if (validator is GroupedValidator) {
+          for (int i = 0; i < validator.subValidators.length; i++) {
+            final DoctorValidator subValidator = validator.subValidators[i];
+            final ValidationResult subResult = validator.subResults[i];
+
+            _analytics.send(Event.doctorValidatorResult(
+              validatorName: subValidator.title,
+              result: subResult.typeStr,
+              statusInfo: subResult.statusInfo,
+              partOfGroupedValidator: true,
+              doctorInvocationId: analyticsTimestamp,
+            ));
+          }
+        } else {
+          _analytics.send(Event.doctorValidatorResult(
+            validatorName: validator.title,
+            result: result.typeStr,
+            statusInfo: result.statusInfo,
+            partOfGroupedValidator: false,
+            doctorInvocationId: analyticsTimestamp,
+          ));
+        }
+        // TODO(eliasyishak): remove this after migrating from package:usage


@vashworth This is really the only updates made to send the events.. everything else is either making changes to direct inject the necessary instances or test updates

vashworth · 2023-10-25T18:33:19Z

packages/flutter_tools/lib/src/doctor.dart

+        if (validator is GroupedValidator) {
+          for (int i = 0; i < validator.subValidators.length; i++) {
+            final DoctorValidator subValidator = validator.subValidators[i];
+            final ValidationResult subResult = validator.subResults[i];


Is there guaranteed to be a subResult for each subValidator? Seems like maybe a potential issue for out of index error

That's a good question, but yes, i believe that that the validator.subValidators and validators.subResults lists will be the same length because that's how we have been sending them to GA3 in the past

https://github.com/eliasyishak/flutter/blob/sending-doctor-events-ga4/packages/flutter_tools/lib/src/reporting/events.dart#L133-L137

Also this method seems to be what is responsible for merging the results for validators that are grouped

https://github.com/eliasyishak/flutter/blob/sending-doctor-events-ga4/packages/flutter_tools/lib/src/doctor_validator.dart#L109-L137

Looking at the first example you sent above, it does a check for if subResults is empty. Should we do the same here?

Another great catch, didn't realize the doctor validators could fail!

I actually think the grouped validators will always return those two lists to have the same length due to this code snippet below

https://github.com/eliasyishak/flutter/blob/sending-doctor-events-ga4/packages/flutter_tools/lib/src/doctor_validator.dart#L99-L102

But just incase, i have also added an additional conditional to ensure the lengths of the lists are the same before looping through the subvalidators

packages/flutter_tools/test/commands.shard/hermetic/doctor_test.dart

vashworth

LGTM

vashworth

Sorry, I just realized continuing will not print out details about the validator

packages/flutter_tools/lib/src/doctor.dart

vashworth

Thanks for making those changes! LGTM!

…er#136647)

Roll Flutter from c555599 to 5907c97 (45 revisions) flutter/flutter@c555599...5907c97 2023-10-27 gspencergoog@users.noreply.github.com Add `isLogicalKeyPressed` to `KeyEvent` (flutter/flutter#136856) 2023-10-27 98614782+auto-submit[bot]@users.noreply.github.com Reverts "Ensure `flutter build apk --release` optimizes+shrinks platform code" (flutter/flutter#137433) 2023-10-27 engine-flutter-autoroll@skia.org Roll Flutter Engine from bedc49efc85c to a198ad4e740d (20 revisions) (flutter/flutter#137429) 2023-10-27 31859944+LongCatIsLooong@users.noreply.github.com Make `SemanticsNode.isMergedIntoParent` Readonly (flutter/flutter#137304) 2023-10-27 engine-flutter-autoroll@skia.org Manual roll Flutter Engine from bedc49efc85c to 71e1a0430232 (16 revisions) (flutter/flutter#137422) 2023-10-27 engine-flutter-autoroll@skia.org Roll Packages from fea24c5 to 2af6954 (5 revisions) (flutter/flutter#137421) 2023-10-27 15619084+vashworth@users.noreply.github.com Run tests on either macOS 12 or 13 (flutter/flutter#137365) 2023-10-27 tessertaha@gmail.com Revert "Update `DataTable` test when data row is pressed for Material 3 (#137230)" (flutter/flutter#137407) 2023-10-27 tessertaha@gmail.com Revert "Reland - Update `OutlinedButton` tests for Material 3 (#136809) (#137247)" (flutter/flutter#137406) 2023-10-27 kustermann@google.com Ensure `flutter build apk --release` optimizes+shrinks platform code (flutter/flutter#136880) 2023-10-27 tessertaha@gmail.com Update `DataTable` test when data row is pressed for Material 3 (flutter/flutter#137230) 2023-10-27 tessertaha@gmail.com Reland - Update `OutlinedButton` tests for Material 3 (#136809) (flutter/flutter#137247) 2023-10-27 andrewrkolos@gmail.com update asset manifest file name referenced in `WebServiceWorker` (flutter/flutter#135954) 2023-10-27 andrewrkolos@gmail.com give `throwsToolExit` a more useful description (flutter/flutter#136694) 2023-10-27 tvolkert@users.noreply.github.com Add ConstrainedLayoutBuilder.updateShouldRebuild() (flutter/flutter#136691) 2023-10-27 41873024+droidbg@users.noreply.github.com Fix. typos (flutter/flutter#137325) 2023-10-27 engine-flutter-autoroll@skia.org Roll Flutter Engine from 87f384c2d70b to bedc49efc85c (1 revision) (flutter/flutter#137382) 2023-10-26 pateltirth454@gmail.com Fix Typos (flutter/flutter#137292) 2023-10-26 sokolovskyi.konstantin@gmail.com AnimationController should dispatch creation in constructor. (flutter/flutter#134839) 2023-10-26 engine-flutter-autoroll@skia.org Roll Flutter Engine from 9788bb9ff83e to 87f384c2d70b (4 revisions) (flutter/flutter#137380) 2023-10-26 engine-flutter-autoroll@skia.org Roll Flutter Engine from ce1c1ee54107 to 9788bb9ff83e (3 revisions) (flutter/flutter#137373) 2023-10-26 fluttergithubbot@gmail.com Marks Windows_arm64 windows_startup_test to be unflaky (flutter/flutter#137228) 2023-10-26 fluttergithubbot@gmail.com Marks Windows_arm64 flutter_tool_startup__windows to be unflaky (flutter/flutter#137229) 2023-10-26 fluttergithubbot@gmail.com Marks Windows_arm64 windows_home_scroll_perf__timeline_summary to be unflaky (flutter/flutter#137221) 2023-10-26 34871572+gmackall@users.noreply.github.com Declare dependency on copyFlutterAssetsTask in bundleAarTask (flutter/flutter#137370) 2023-10-26 fluttergithubbot@gmail.com Marks Windows_arm64 complex_layout_win_desktop__start_up to be unflaky (flutter/flutter#137225) 2023-10-26 engine-flutter-autoroll@skia.org Roll Flutter Engine from 394744d2c4d0 to ce1c1ee54107 (2 revisions) (flutter/flutter#137367) 2023-10-26 fluttergithubbot@gmail.com Marks Windows_arm64 hot_mode_dev_cycle_win_target__benchmark to be unflaky (flutter/flutter#137217) 2023-10-26 fluttergithubbot@gmail.com Marks Windows_arm64 flutter_view_win_desktop__start_up to be unflaky (flutter/flutter#137226) 2023-10-26 fluttergithubbot@gmail.com Marks Windows_arm64 platform_view_win_desktop__start_up to be unflaky (flutter/flutter#137227) 2023-10-26 fluttergithubbot@gmail.com Marks Windows_arm64 flutter_gallery_win_desktop__start_up to be unflaky (flutter/flutter#137224) 2023-10-26 fluttergithubbot@gmail.com Marks Windows_arm64 hello_world_win_desktop__compile to be unflaky (flutter/flutter#137222) 2023-10-26 fluttergithubbot@gmail.com Marks Windows_arm64 flutter_gallery_win_desktop__compile to be unflaky (flutter/flutter#137223) 2023-10-26 fluttergithubbot@gmail.com Marks Windows_arm64 run_release_test_windows to be unflaky (flutter/flutter#137220) 2023-10-26 greg@zulip.com Fix dislocated doc and comment on ThemeData localize cache (flutter/flutter#137315) 2023-10-26 fluttergithubbot@gmail.com Marks Windows_arm64 platform_channel_sample_test_windows to be unflaky (flutter/flutter#137218) 2023-10-26 engine-flutter-autoroll@skia.org Roll Flutter Engine from 7c5c8f587992 to 394744d2c4d0 (1 revision) (flutter/flutter#137364) 2023-10-26 engine-flutter-autoroll@skia.org Roll Flutter Engine from 9363fe6ba503 to 7c5c8f587992 (3 revisions) (flutter/flutter#137363) 2023-10-26 engine-flutter-autoroll@skia.org Roll Flutter Engine from 542f8bc4c019 to 9363fe6ba503 (2 revisions) (flutter/flutter#137354) 2023-10-26 42216813+eliasyishak@users.noreply.github.com Unified analytics events for doctor validators (flutter/flutter#136647) 2023-10-26 engine-flutter-autoroll@skia.org Roll Flutter Engine from d8132d5070bf to 542f8bc4c019 (2 revisions) (flutter/flutter#137349) 2023-10-26 fluttergithubbot@gmail.com Marks Windows_arm64 run_debug_test_windows to be unflaky (flutter/flutter#137219) 2023-10-26 engine-flutter-autoroll@skia.org Roll Flutter Engine from 0a6253dbfafd to d8132d5070bf (1 revision) (flutter/flutter#137347) 2023-10-26 engine-flutter-autoroll@skia.org Roll Flutter Engine from 5da115661f01 to 0a6253dbfafd (1 revision) (flutter/flutter#137341) 2023-10-26 engine-flutter-autoroll@skia.org Roll Flutter Engine from 61ae5ef94e9c to 5da115661f01 (1 revision) (flutter/flutter#137340) ...

Add code to send events

068b5b5

eliasyishak changed the title ~~Add code to send events~~ Unified analytics events for doctor validators Oct 16, 2023

github-actions bot added the tool Affects the "flutter" command-line tool. See also t: labels. label Oct 16, 2023

Merge remote-tracking branch 'upstream/master' into sending-doctor-ev…

522333e

…ents-ga4

eliasyishak mentioned this pull request Oct 16, 2023

☂️ package:unified_analytics implementation in flutter tool #128251

Closed

32 tasks

eliasyishak added 4 commits October 17, 2023 11:38

Update param for doctor invocation id

bcd6c9f

Fix tests for legacy analytics from label change

0ab3e62

Refactor to use common function to get fake analytics

714094b

Add todo as reminder to remove after migration

fee8ba8

christopherfujino reviewed Oct 18, 2023

View reviewed changes

packages/flutter_tools/lib/src/doctor.dart Outdated Show resolved Hide resolved

christopherfujino reviewed Oct 18, 2023

View reviewed changes

packages/flutter_tools/lib/src/doctor.dart Outdated Show resolved Hide resolved

christopherfujino reviewed Oct 18, 2023

View reviewed changes

packages/flutter_tools/lib/src/doctor.dart Outdated Show resolved Hide resolved

christopherfujino reviewed Oct 18, 2023

View reviewed changes

packages/flutter_tools/lib/src/doctor_validator.dart Outdated Show resolved Hide resolved

eliasyishak added 2 commits October 19, 2023 08:58

Add TODO to remove after migration completed

9463b50

Inject clock into Doctor + update relevant tests

ea0decd

github-actions bot added the a: text input Entering text in a text field or keyboard related problems label Oct 19, 2023

eliasyishak added 4 commits October 19, 2023 13:27

Revert typeStr so that success -> installed

0ce18aa

Fix tests after revert

539548b

Collect the futures into list and await at exit

3a75f07

Update tests to use list to find events

584a38a

christopherfujino reviewed Oct 19, 2023

View reviewed changes

packages/flutter_tools/test/commands.shard/hermetic/doctor_test.dart Outdated Show resolved Hide resolved

eliasyishak added 2 commits October 19, 2023 14:59

Refactor verbose event constructor + finish test migration

e563dc0

Injecting analytics into Doctor with default value

7f24be8

christopherfujino mentioned this pull request Oct 19, 2023

Ensure all events sent via package:unified_analytics are received #136926

Closed

eliasyishak mentioned this pull request Oct 20, 2023

Use futures list internally to manage send events dart-lang/tools#184

Merged

1 task

eliasyishak added 5 commits October 20, 2023 16:24

Add close statement on exitWithHooks

49b3806

Using git ref for analytics package for testing

a30f36c

Revert changes from futures list

e64062b

Properly suppress + added test

4226bea

Use a default value for DoctorText + update pubspec

5dd61c0

github-actions bot added the a: text input Entering text in a text field or keyboard related problems label Oct 24, 2023

Update doctor_test.dart

3eba989

eliasyishak requested a review from vashworth October 25, 2023 16:17

eliasyishak commented Oct 25, 2023

View reviewed changes

vashworth reviewed Oct 25, 2023

View reviewed changes

eliasyishak added 2 commits October 25, 2023 15:11

Update test to use context override

c8cfced

Add conditional check for grouped validators

9ba70be

vashworth approved these changes Oct 26, 2023

View reviewed changes

vashworth requested changes Oct 26, 2023

View reviewed changes

packages/flutter_tools/lib/src/doctor.dart Outdated Show resolved Hide resolved

eliasyishak added 2 commits October 26, 2023 11:13

Refactor conditional to skip on RangeError

ac15d6f

Test added for mismatch validator and results lists

178ede9

vashworth approved these changes Oct 26, 2023

View reviewed changes

Fix analyze errors

d21085f

eliasyishak added the autosubmit Merge PR when tree becomes green via auto submit App label Oct 26, 2023

auto-submit bot merged commit 56ae555 into flutter:master Oct 26, 2023

engine-flutter-autoroll mentioned this pull request Oct 27, 2023

Roll Flutter from c555599fbb4a to eba149fcc3dc (38 revisions) flutter/packages#5244

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Oct 27, 2023

56ae555 Unified analytics events for doctor validators (flutter/flutt…

8c1c8f9

…er#136647)

engine-flutter-autoroll mentioned this pull request Oct 27, 2023

Roll Flutter from c555599fbb4a to e75f85bffd46 (39 revisions) flutter/packages#5246

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Oct 27, 2023

56ae555 Unified analytics events for doctor validators (flutter/flutt…

bd3e96f

…er#136647)

engine-flutter-autoroll mentioned this pull request Oct 27, 2023

Roll Flutter from c555599fbb4a to 8cfa9c478c76 (40 revisions) flutter/packages#5247

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Oct 27, 2023

56ae555 Unified analytics events for doctor validators (flutter/flutt…

8ea0626

…er#136647)

engine-flutter-autoroll mentioned this pull request Oct 27, 2023

Roll Flutter from c555599fbb4a to 3ef84471c188 (41 revisions) flutter/packages#5249

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Oct 27, 2023

56ae555 Unified analytics events for doctor validators (flutter/flutt…

4976653

…er#136647)

engine-flutter-autoroll mentioned this pull request Oct 27, 2023

Roll Flutter from c555599fbb4a to 4cae1af41d13 (44 revisions) flutter/packages#5251

Closed

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Oct 27, 2023

56ae555 Unified analytics events for doctor validators (flutter/flutt…

a843ae3

…er#136647)

engine-flutter-autoroll mentioned this pull request Oct 27, 2023

Roll Flutter from c555599fbb4a to 5907c9757e3f (45 revisions) flutter/packages#5252

Merged

engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Oct 27, 2023

56ae555 Unified analytics events for doctor validators (flutter/flutt…

76a47de

…er#136647)

eliasyishak deleted the sending-doctor-events-ga4 branch October 27, 2023 22:00

Unified analytics events for doctor validators #136647

Unified analytics events for doctor validators #136647

Uh oh!

Conversation

eliasyishak commented Oct 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pre-launch Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

eliasyishak Oct 25, 2023

Choose a reason for hiding this comment

Uh oh!

vashworth Oct 25, 2023

Choose a reason for hiding this comment

Uh oh!

eliasyishak Oct 25, 2023

Choose a reason for hiding this comment

Uh oh!

vashworth Oct 25, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

eliasyishak Oct 26, 2023

Choose a reason for hiding this comment

Uh oh!

eliasyishak Oct 26, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vashworth left a comment

Choose a reason for hiding this comment

Uh oh!

vashworth left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

vashworth left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

eliasyishak commented Oct 16, 2023 •

edited

Loading

vashworth Oct 25, 2023 •

edited

Loading