Add `commandHasTerminal` parameter + apple usage event + `sendException` events for `package:unified_analytics` #138806

eliasyishak · 2023-11-21T14:31:20Z

Relates to tracker issue:

☂️ package:unified_analytics implementation in flutter tool #128251

This PR includes 3 major updates:

Adding the commandHasTerminal parameter for Event.flutterCommandResult
- In packages/flutter_tools/lib/src/runner/flutter_command.dart
Adding the new event for sendException from package:usage to be Event.exception (this event can be used by all dash tools)
- In packages/flutter_tools/lib/runner.dart
Migrating the generic UsageEvent which was only used for Apple related workflows for iOS and macOS. I did an initial analysis in this sheet to identify all the call sites
- Found in several files, highlighted in the sheet above

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.

This update included updating the `Environment` class so it touches several files

…rt` completed

eliasyishak · 2023-11-21T14:43:28Z

@christopherfujino, this migration touched a lot more files than the previous PRs so to help make it easier i tried to migrate one file at a time in the commits if you wanted to review it step-by-step

I'm also pretty sure i'll need to get a g3fix out to update the package, working on that atm

EDIT: g3fix at cl/584355872

…vent

christopherfujino · 2023-11-21T21:40:05Z

packages/flutter_tools/lib/src/build_system/targets/ios.dart

          label: buildSuccess ? 'success' : 'fail',
          flutterUsage: environment.usage,
        ).send();
+        environment.analytics.send(Event.appleUsageEvent(


why is this called appleUsageEvent? or, why have a single enum for both ios and macos workflows?

i made a call to combine the leftover UsageEvent calls, they were all ungrouped so it may have been the wrong call to combine them all under appleUsageEvent instead of separate iosUsageEvent and macosUsageEvent.

We spoke offline about this but if you think this won't scale well if we have additional apple related events, i can definitely revert the original PR in dart-lang/tools

it's not a big deal, it just struck my eye as unusual. there has also been discussion about what to name the union of macOS and iOS in the codebase (many places in the tool we call it "Darwin", but others "Apple" ). let's leave this.

gotcha sounds good! i'll keep this in mind for future work

christopherfujino · 2023-11-21T22:29:35Z

packages/flutter_tools/lib/src/runner/flutter_command.dart

      commandPath: commandPath,
      result: commandResult.toString(),
      maxRss: maxRss,
+      commandHasTerminal: globals.stdio.hasTerminal,


with package:unified_analytics, are we only tracking this on command results, or will we have that data with every event? I'm still unclear on dart-lang/tools#197 (comment)

That's a good question, i was actually doing some digging and it doesn't seem like that boolean is getting sent with each event, only for the events that indicate which event was run.

It's not set at the session level

Ahh, but was this the only context we were providing the custom dimension with the legacy analytics? https://github.com/flutter/flutter/blob/master/packages/flutter_tools/lib/src/runner/flutter_command.dart#L1740

I believe so, I went through the code base to find any instances of the commandHasTerminal custom dimension. I also checked in the database for GA3 and didn't see it being sent with every event.

I believe the only two dimensions we send with every event is the channel and host os. Below is a snippet of the first record in the table

christopherfujino

LGTM

…dException` events for `package:unified_analytics` (flutter/flutter#138806)

Manual roll requested by [email protected] flutter/flutter@ab721f9...14549b3 2023-11-22 [email protected] make FakeView not send Scene and semantics to the engine (flutter/flutter#138849) 2023-11-22 [email protected] Update the default outline color for `OutlinedButton` (flutter/flutter#138768) 2023-11-22 [email protected] Roll Flutter Engine from c954a64c509b to 342fb003b11f (1 revision) (flutter/flutter#138903) 2023-11-22 [email protected] Roll Packages from c9933fc to 2102327 (3 revisions) (flutter/flutter#138895) 2023-11-22 [email protected] Marks Mac_build_test flutter_gallery__transition_perf_e2e_ios to be unflaky (flutter/flutter#138886) 2023-11-22 [email protected] Roll Flutter Engine from d55b673f895c to c954a64c509b (1 revision) (flutter/flutter#138894) 2023-11-22 [email protected] Add `commandHasTerminal` parameter + apple usage event + `sendException` events for `package:unified_analytics` (flutter/flutter#138806) 2023-11-22 [email protected] Roll Flutter Engine from 6c8f7b566a22 to d55b673f895c (1 revision) (flutter/flutter#138890) 2023-11-22 [email protected] Roll Flutter Engine from dda2499df48a to 6c8f7b566a22 (1 revision) (flutter/flutter#138875) 2023-11-22 [email protected] Roll Flutter Engine from 1ae1d5318257 to dda2499df48a (4 revisions) (flutter/flutter#138872) 2023-11-22 [email protected] Roll Flutter Engine from 7cf9d90d59e1 to 1ae1d5318257 (8 revisions) (flutter/flutter#138861) 2023-11-22 [email protected] Revert "Reland VelocityTracker update (again)" (flutter/flutter#138863) 2023-11-21 [email protected] In `flutter doctor -v`, when JRE is too out-of-date to run `sdkmanager`, print a helpful error message (flutter/flutter#138762) 2023-11-21 [email protected] Roll Flutter Engine from a8e9b8dd562b to 7cf9d90d59e1 (1 revision) (flutter/flutter#138847) 2023-11-21 [email protected] Roll Flutter Engine from 90d1ff04ae02 to a8e9b8dd562b (1 revision) (flutter/flutter#138846) 2023-11-21 [email protected] Reland VelocityTracker update (again) (flutter/flutter#138843) 2023-11-21 [email protected] Roll Flutter Engine from 31799868224d to 90d1ff04ae02 (2 revisions) (flutter/flutter#138844) 2023-11-21 [email protected] Fix M3 Tabs Specs links (flutter/flutter#138808) 2023-11-21 [email protected] Roll Flutter Engine from 0c2de1e8849c to 31799868224d (1 revision) (flutter/flutter#138840) 2023-11-21 [email protected] Roll Flutter Engine from 746697c27569 to 0c2de1e8849c (1 revision) (flutter/flutter#138834) 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 [email protected],[email protected],[email protected] 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

…on` events for `package:unified_analytics` (flutter#138806) Relates to tracker issue: - flutter#128251 This PR includes 3 major updates: - Adding the `commandHasTerminal` parameter for `Event.flutterCommandResult` - In `packages/flutter_tools/lib/src/runner/flutter_command.dart` - Adding the new event for `sendException` from package:usage to be `Event.exception` (this event can be used by all dash tools) - In `packages/flutter_tools/lib/runner.dart` - Migrating the generic `UsageEvent` which was only used for Apple related workflows for iOS and macOS. I did an initial analysis in this [sheet](https://docs.google.com/spreadsheets/d/11KJLkHXFpECMX7tw-trNkYSr5MHDG15XNGv6TgLjfQs/edit?resourcekey=0-j4qdvsOEEg3wQW79YlY1-g#gid=0) to identify all the call sites - Found in several files, highlighted in the sheet above

…dException` events for `package:unified_analytics` (flutter/flutter#138806)

eliasyishak added 9 commits November 20, 2023 11:11

Add the commandHasTerminal parameter

a0f2404

Migrated runner.dart + added test

d1481d5

Migration for ios.dart complete

b9e2dce

This update included updating the `Environment` class so it touches several files

Migration of macos.dart complete

de1b61e

Migration for mac.dart completed

c6457e7

Migration for cocoapods.dart completed

71f8366

Migration for `remove_macos_framework_link_and_embedding_migration.da…

b68237d

…rt` completed

Migration for xcdevice.dart completed

d93082b

Migration for mdns_discovery.dart completed

13e1059

eliasyishak requested a review from christopherfujino as a code owner November 21, 2023 14:31

github-actions bot added a: text input Entering text in a text field or keyboard related problems platform-ios iOS applications specifically tool Affects the "flutter" command-line tool. See also t: labels. a: desktop Running on desktop labels Nov 21, 2023

eliasyishak mentioned this pull request Nov 21, 2023

☂️ package:unified_analytics implementation in flutter tool #128251

Closed

32 tasks

eliasyishak added 2 commits November 21, 2023 13:05

Empty commit to trigger g3fix with cl/584355872

868bc9b

Merge branch 'master' into add-command-has-terminal-and-apple-usage-e…

d479280

…vent

christopherfujino reviewed Nov 21, 2023

View reviewed changes

christopherfujino approved these changes Nov 21, 2023

View reviewed changes

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

auto-submit bot merged commit 4818702 into flutter:master Nov 22, 2023

eliasyishak deleted the add-command-has-terminal-and-apple-usage-event branch November 22, 2023 14:15

engine-flutter-autoroll mentioned this pull request Nov 22, 2023

Roll Flutter from ab721f935ffc to 48187028c11c (14 revisions) flutter/packages#5462

Closed

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

4818702 Add commandHasTerminal parameter + apple usage event + `sen…

1b5ff3f

…dException` events for `package:unified_analytics` (flutter/flutter#138806)

engine-flutter-autoroll mentioned this pull request Nov 22, 2023

Roll Flutter from ab721f935ffc to 35a53b0b1adb (15 revisions) flutter/packages#5463

Closed

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

4818702 Add commandHasTerminal parameter + apple usage event + `sen…

3a88b39

…dException` events for `package:unified_analytics` (flutter/flutter#138806)

engine-flutter-autoroll mentioned this pull request Nov 22, 2023

Roll Flutter from ab721f935ffc to 721ee5749211 (17 revisions) flutter/packages#5464

Closed

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

4818702 Add commandHasTerminal parameter + apple usage event + `sen…

aee9b5b

…dException` events for `package:unified_analytics` (flutter/flutter#138806)

engine-flutter-autoroll mentioned this pull request Nov 22, 2023

Roll Flutter from ab721f935ffc to 843074c5bddd (18 revisions) flutter/packages#5465

Closed

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

4818702 Add commandHasTerminal parameter + apple usage event + `sen…

5c6c35c

…dException` events for `package:unified_analytics` (flutter/flutter#138806)

engine-flutter-autoroll mentioned this pull request Nov 22, 2023

Manual roll Flutter from ab721f935ffc to 14549b38891f (20 revisions) flutter/packages#5466

Merged

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

4818702 Add commandHasTerminal parameter + apple usage event + `sen…

929aed9

…dException` events for `package:unified_analytics` (flutter/flutter#138806)

engine-flutter-autoroll mentioned this pull request Nov 22, 2023

Manual roll Flutter from ab721f935ffc to 106667eb4bc1 (23 revisions) flutter/packages#5467

Closed

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

4818702 Add commandHasTerminal parameter + apple usage event + `sen…

9009c64

…dException` events for `package:unified_analytics` (flutter/flutter#138806)

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

4818702 Add commandHasTerminal parameter + apple usage event + `sen…

4af15b7

…dException` events for `package:unified_analytics` (flutter/flutter#138806)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add `commandHasTerminal` parameter + apple usage event + `sendException` events for `package:unified_analytics` #138806

Add `commandHasTerminal` parameter + apple usage event + `sendException` events for `package:unified_analytics` #138806

Uh oh!

eliasyishak commented Nov 21, 2023 •

edited

Loading

Uh oh!

eliasyishak commented Nov 21, 2023 •

edited

Loading

Uh oh!

christopherfujino Nov 21, 2023

Uh oh!

eliasyishak Nov 21, 2023

Uh oh!

christopherfujino Nov 21, 2023

Uh oh!

eliasyishak Nov 21, 2023

Uh oh!

christopherfujino Nov 21, 2023

Uh oh!

eliasyishak Nov 21, 2023

Uh oh!

christopherfujino Nov 21, 2023

Uh oh!

eliasyishak Nov 21, 2023

Uh oh!

christopherfujino Nov 21, 2023

Uh oh!

christopherfujino left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Add commandHasTerminal parameter + apple usage event + sendException events for package:unified_analytics #138806

Add commandHasTerminal parameter + apple usage event + sendException events for package:unified_analytics #138806

Uh oh!

Conversation

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

Uh oh!

Pre-launch Checklist

Uh oh!

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

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

christopherfujino left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Add `commandHasTerminal` parameter + apple usage event + `sendException` events for `package:unified_analytics` #138806

Add `commandHasTerminal` parameter + apple usage event + `sendException` events for `package:unified_analytics` #138806

eliasyishak commented Nov 21, 2023 •

edited

Loading

eliasyishak commented Nov 21, 2023 •

edited

Loading