[flutter_tool] Re-work analytics events to use labels and values (#42016)

packages/flutter_tools/lib/src/reporting/disabled_usage.dart

@@ -27,7 +27,13 @@ class DisabledUsage implements Usage {
   void sendCommand(String command, { Map<String, String> parameters }) { }
 
   @override
-  void sendEvent(String category, String parameter, { String label, Map<String, String> parameters }) { }
+  void sendEvent(
+    String category,
+    String parameter, {
+    String label,
+    int value,
+    Map<String, String> parameters,
+  }) { }
 
   @override
   void sendTiming(String category, String variableName, Duration duration, { String label }) { }

packages/flutter_tools/lib/src/reporting/events.dart

@@ -11,14 +11,16 @@ part of reporting;
 class UsageEvent {
   UsageEvent(this.category, this.parameter, {
     this.label,
+    this.value,
   });
 
   final String category;
   final String parameter;
   final String label;
+  final int value;
 
   void send() {
-    flutterUsage.sendEvent(category, parameter, label: label);
+    flutterUsage.sendEvent(category, parameter, label: label, value: value);
   }
 }
 
@@ -95,8 +97,11 @@ class DoctorResultEvent extends UsageEvent {
   DoctorResultEvent({
     @required this.validator,
     @required this.result,
-  }) : super('doctorResult.${validator.runtimeType}',
-             result.typeStr);
+  }) : super(
+    'doctor-result',
+    '${validator.runtimeType}',
+    label: result.typeStr,
+  );
 
   final DoctorValidator validator;
   final ValidationResult result;
@@ -116,24 +121,29 @@ class DoctorResultEvent extends UsageEvent {
   }
 }
 
-/// An event that reports success or failure of a pub get.
+/// An event that reports on the result of a pub invocation.
 class PubResultEvent extends UsageEvent {
   PubResultEvent({
     @required String context,
     @required String result,
-  }) : super('pub', context, label: result);
+  }) : super('pub-result', context, label: result);
 }
 
 /// An event that reports something about a build.
 class BuildEvent extends UsageEvent {
-  BuildEvent(String parameter, {
+  BuildEvent(String label, {
     this.command,
     this.settings,
     this.eventError,
   }) : super(
-    'build' +
-      (FlutterCommand.current == null ? '' : '-${FlutterCommand.current.name}'),
-    parameter);
+    // category
+    'build',
+    // parameter
+    FlutterCommand.current == null ?
+      'unspecified' :
+      '${FlutterCommand.current.name}',
+    label: label,
+  );
 
   final String command;
   final String settings;
@@ -149,7 +159,12 @@ class BuildEvent extends UsageEvent {
       if (eventError != null)
         CustomDimensions.buildEventError: eventError,
     });
-    flutterUsage.sendEvent(category, parameter, parameters: parameters);
+    flutterUsage.sendEvent(
+      category,
+      parameter,
+      label: label,
+      parameters: parameters,
+    );
   }
 }
 
@@ -160,17 +175,27 @@ class CommandResultEvent extends UsageEvent {
 
   @override
   void send() {
-    int maxRss;
+    // An event for the command result.
+    flutterUsage.sendEvent(
+      'tool-command-result',
+      category,
+      label: parameter,
+    );
+
+    // A separate event for the memory highwater mark. This is a separate event
+    // so that we can get the command result even if trying to grab maxRss
+    // throws an exception.
     try {
-      maxRss = processInfo.maxRss;
-    } catch (e) {
-      // If grabbing the maxRss fails for some reason, just leave it off the
-      // event.
+      final int maxRss = processInfo.maxRss;
+      flutterUsage.sendEvent(
+        'tool-command-max-rss',
+        category,
+        label: parameter,
+        value: maxRss,
+      );
+    } catch (error) {
+      // If grabbing the maxRss fails for some reason, just don't send an event.
+      printTrace('Querying maxRss failed with error: $error');
     }
-    final Map<String, String> parameters = _useCdKeys(<CustomDimensions, String>{
-      if (maxRss != null)
-        CustomDimensions.commandResultEventMaxRss: maxRss.toString(),
-    });
-    flutterUsage.sendEvent(category, parameter, parameters: parameters);
   }
 }

packages/flutter_tools/lib/src/reporting/usage.dart

@@ -125,6 +125,7 @@ abstract class Usage {
     String category,
     String parameter, {
     String label,
+    int value,
     Map<String, String> parameters,
   });
 
@@ -264,6 +265,7 @@ class _DefaultUsage implements Usage {
     String category,
     String parameter, {
     String label,
+    int value,
     Map<String, String> parameters,
   }) {
     if (suppressAnalytics) {
@@ -279,6 +281,7 @@ class _DefaultUsage implements Usage {
       category,
       parameter,
       label: label,
+      value: value,
       parameters: paramsWithLocalTime,
     );
   }

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

@@ -226,9 +226,9 @@ void main() {
 
       expect(
         verify(mockUsage.sendEvent(
-          'doctorResult.PassingValidator',
-          captureAny,
-          label: anyNamed('label'),
+          'doctor-result',
+          'PassingValidator',
+          label: captureAnyNamed('label'),
         )).captured,
         <dynamic>['installed', 'installed', 'installed'],
       );
@@ -243,25 +243,25 @@ void main() {
 
       expect(
         verify(mockUsage.sendEvent(
-          'doctorResult.PassingValidator',
-          captureAny,
-          label: anyNamed('label'),
+          'doctor-result',
+          'PassingValidator',
+          label: captureAnyNamed('label'),
         )).captured,
         <dynamic>['installed', 'installed'],
       );
       expect(
         verify(mockUsage.sendEvent(
-          'doctorResult.PartialValidatorWithHintsOnly',
-          captureAny,
-          label: anyNamed('label'),
+          'doctor-result',
+          'PartialValidatorWithHintsOnly',
+          label: captureAnyNamed('label'),
         )).captured,
         <dynamic>['partial'],
       );
       expect(
         verify(mockUsage.sendEvent(
-          'doctorResult.PartialValidatorWithErrors',
-          captureAny,
-          label: anyNamed('label'),
+          'doctor-result',
+          'PartialValidatorWithErrors',
+          label: captureAnyNamed('label'),
         )).captured,
         <dynamic>['partial'],
       );
@@ -275,41 +275,41 @@ void main() {
 
       expect(
         verify(mockUsage.sendEvent(
-          'doctorResult.PassingValidator',
-          captureAny,
-          label: anyNamed('label'),
+          'doctor-result',
+          'PassingValidator',
+          label: captureAnyNamed('label'),
         )).captured,
         <dynamic>['installed'],
       );
       expect(
         verify(mockUsage.sendEvent(
-          'doctorResult.MissingValidator',
-          captureAny,
-          label: anyNamed('label'),
+          'doctor-result',
+          'MissingValidator',
+          label: captureAnyNamed('label'),
         )).captured,
         <dynamic>['missing'],
       );
       expect(
         verify(mockUsage.sendEvent(
-          'doctorResult.NotAvailableValidator',
-          captureAny,
-          label: anyNamed('label'),
+          'doctor-result',
+          'NotAvailableValidator',
+          label: captureAnyNamed('label'),
         )).captured,
         <dynamic>['notAvailable'],
       );
       expect(
         verify(mockUsage.sendEvent(
-          'doctorResult.PartialValidatorWithHintsOnly',
-          captureAny,
-          label: anyNamed('label'),
+          'doctor-result',
+          'PartialValidatorWithHintsOnly',
+          label: captureAnyNamed('label'),
         )).captured,
         <dynamic>['partial'],
       );
       expect(
         verify(mockUsage.sendEvent(
-          'doctorResult.PartialValidatorWithErrors',
-          captureAny,
-          label: anyNamed('label'),
+          'doctor-result',
+          'PartialValidatorWithErrors',
+          label: captureAnyNamed('label'),
         )).captured,
         <dynamic>['partial'],
       );
@@ -323,17 +323,17 @@ void main() {
 
       expect(
         verify(mockUsage.sendEvent(
-          'doctorResult.PassingGroupedValidator',
-          captureAny,
-          label: anyNamed('label'),
+          'doctor-result',
+          'PassingGroupedValidator',
+          label: captureAnyNamed('label'),
         )).captured,
         <dynamic>['installed', 'installed', 'installed'],
       );
       expect(
         verify(mockUsage.sendEvent(
-          'doctorResult.MissingGroupedValidator',
-          captureAny,
-          label: anyNamed('label'),
+          'doctor-result',
+          'MissingGroupedValidator',
+          label: captureAnyNamed('label'),
         )).captured,
         <dynamic>['missing'],
       );

packages/flutter_tools/test/general.shard/analytics_test.dart

@@ -55,7 +55,7 @@ void main() {
 
       flutterUsage.enabled = true;
       await createProject(tempDir);
-      expect(count, flutterUsage.isFirstRun ? 0 : 3);
+      expect(count, flutterUsage.isFirstRun ? 0 : 4);
 
       count = 0;
       flutterUsage.enabled = false;

packages/flutter_tools/test/general.shard/commands/build_apk_test.dart

@@ -298,8 +298,9 @@ flutter:
           contains('To learn more, see: https://developer.android.com/studio/build/shrink-code'));
 
       verify(mockUsage.sendEvent(
-        'build-apk',
-        'r8-failure',
+        'build',
+        'apk',
+        label: 'r8-failure',
         parameters: anyNamed('parameters'),
       )).called(1);
     },

packages/flutter_tools/test/general.shard/commands/build_appbundle_test.dart

@@ -289,8 +289,9 @@ flutter:
           contains('To learn more, see: https://developer.android.com/studio/build/shrink-code'));
 
       verify(mockUsage.sendEvent(
-        'build-appbundle',
-        'r8-failure',
+        'build',
+        'appbundle',
+        label: 'r8-failure',
         parameters: anyNamed('parameters'),
       )).called(1);
     },

packages/flutter_tools/test/general.shard/dart/pub_get_test.dart

@@ -154,7 +154,7 @@ void main() {
   testUsingContext('analytics sent on success', () async {
     MockDirectory.findCache = true;
     await pubGet(context: PubContext.flutterTests, checkLastModified: false);
-    verify(flutterUsage.sendEvent('pub', 'flutter-tests', label: 'success')).called(1);
+    verify(flutterUsage.sendEvent('pub-result', 'flutter-tests', label: 'success')).called(1);
   }, overrides: <Type, Generator>{
     ProcessManager: () => MockProcessManager(0),
     FileSystem: () => MockFileSystem(),
@@ -173,7 +173,7 @@ void main() {
     } on ToolExit {
       // Ignore.
     }
-    verify(flutterUsage.sendEvent('pub', 'flutter-tests', label: 'failure')).called(1);
+    verify(flutterUsage.sendEvent('pub-result', 'flutter-tests', label: 'failure')).called(1);
   }, overrides: <Type, Generator>{
     ProcessManager: () => MockProcessManager(1),
     FileSystem: () => MockFileSystem(),
@@ -192,7 +192,7 @@ void main() {
     } on ToolExit {
       // Ignore.
     }
-    verify(flutterUsage.sendEvent('pub', 'flutter-tests', label: 'version-solving-failed')).called(1);
+    verify(flutterUsage.sendEvent('pub-result', 'flutter-tests', label: 'version-solving-failed')).called(1);
   }, overrides: <Type, Generator>{
     ProcessManager: () => MockProcessManager(
       1,

packages/flutter_tools/test/general.shard/ios/mac_test.dart

@@ -246,7 +246,9 @@ void main() {
       );
 
       await diagnoseXcodeBuildFailure(buildResult);
-      verify(mockUsage.sendEvent('build', 'xcode-bitcode-failure',
+      verify(mockUsage.sendEvent('build',
+        any,
+        label: 'xcode-bitcode-failure',
         parameters: <String, String>{
           cdKey(CustomDimensions.buildEventCommand): buildCommands.toString(),
           cdKey(CustomDimensions.buildEventSettings): buildSettings.toString(),

packages/flutter_tools/test/general.shard/runner/flutter_command_test.dart

@@ -77,8 +77,24 @@ void main() {
       );
       await flutterCommand.run();
 
-      verify(usage.sendCommand(captureAny, parameters: captureAnyNamed('parameters')));
-      verify(usage.sendEvent(captureAny, 'success', parameters: captureAnyNamed('parameters')));
+      verify(usage.sendCommand(
+        'dummy',
+        parameters: anyNamed('parameters'),
+      ));
+      verify(usage.sendEvent(
+        'tool-command-result',
+        'dummy',
+        label: 'success',
+        parameters: anyNamed('parameters'),
+      ));
+      expect(verify(usage.sendEvent(
+          'tool-command-max-rss',
+          'dummy',
+          label: 'success',
+          value: captureAnyNamed('value'),
+        )).captured[0],
+        10,
+      );
     });
 
     testUsingCommandContext('reports command that results in warning', () async {
@@ -92,8 +108,24 @@ void main() {
       );
       await flutterCommand.run();
 
-      verify(usage.sendCommand(captureAny, parameters: captureAnyNamed('parameters')));
-      verify(usage.sendEvent(captureAny, 'warning', parameters: captureAnyNamed('parameters')));
+      verify(usage.sendCommand(
+        'dummy',
+        parameters: anyNamed('parameters'),
+      ));
+      verify(usage.sendEvent(
+        'tool-command-result',
+        'dummy',
+        label: 'warning',
+        parameters: anyNamed('parameters'),
+      ));
+      expect(verify(usage.sendEvent(
+          'tool-command-max-rss',
+          'dummy',
+          label: 'warning',
+          value: captureAnyNamed('value'),
+        )).captured[0],
+        10,
+      );
     });
 
     testUsingCommandContext('reports command that results in failure', () async {
@@ -109,8 +141,24 @@ void main() {
       try {
         await flutterCommand.run();
       } on ToolExit {
-        verify(usage.sendCommand(captureAny, parameters: captureAnyNamed('parameters')));
-        verify(usage.sendEvent(captureAny, 'fail', parameters: captureAnyNamed('parameters')));
+        verify(usage.sendCommand(
+          'dummy',
+          parameters: anyNamed('parameters'),
+        ));
+        verify(usage.sendEvent(
+          'tool-command-result',
+          'dummy',
+          label: 'fail',
+          parameters: anyNamed('parameters'),
+        ));
+        expect(verify(usage.sendEvent(
+            'tool-command-max-rss',
+            'dummy',
+            label: 'fail',
+            value: captureAnyNamed('value'),
+          )).captured[0],
+          10,
+        );
       }
     });
 
@@ -129,8 +177,24 @@ void main() {
         await flutterCommand.run();
         fail('Mock should make this fail');
       } on ToolExit {
-        verify(usage.sendCommand(captureAny, parameters: captureAnyNamed('parameters')));
-        verify(usage.sendEvent(captureAny, 'fail', parameters: captureAnyNamed('parameters')));
+        verify(usage.sendCommand(
+          'dummy',
+          parameters: anyNamed('parameters'),
+        ));
+        verify(usage.sendEvent(
+          'tool-command-result',
+          'dummy',
+          label: 'fail',
+          parameters: anyNamed('parameters'),
+        ));
+        expect(verify(usage.sendEvent(
+            'tool-command-max-rss',
+            'dummy',
+            label: 'fail',
+            value: captureAnyNamed('value'),
+          )).captured[0],
+          10,
+        );
       }
     });
 
@@ -169,8 +233,24 @@ void main() {
         signalController.add(mockSignal);
         await completer.future;
 
-        verify(usage.sendCommand(any, parameters: anyNamed('parameters')));
-        verify(usage.sendEvent(any, 'killed', parameters: anyNamed('parameters')));
+        verify(usage.sendCommand(
+          'dummy',
+          parameters: anyNamed('parameters'),
+        ));
+        verify(usage.sendEvent(
+          'tool-command-result',
+          'dummy',
+          label: 'killed',
+          parameters: anyNamed('parameters'),
+        ));
+        expect(verify(usage.sendEvent(
+            'tool-command-max-rss',
+            'dummy',
+            label: 'killed',
+            value: captureAnyNamed('value'),
+          )).captured[0],
+          10,
+        );
       }, overrides: <Type, Generator>{
         ProcessInfo: () => mockProcessInfo,
         Signals: () => FakeSignals(
@@ -182,27 +262,6 @@ void main() {
       });
     });
 
-    testUsingCommandContext('reports maxRss', () async {
-      // Crash if called a third time which is unexpected.
-      mockTimes = <int>[1000, 2000];
-
-      final DummyFlutterCommand flutterCommand = DummyFlutterCommand(
-        commandFunction: () async {
-          return const FlutterCommandResult(ExitStatus.success);
-        }
-      );
-      await flutterCommand.run();
-
-      verify(usage.sendCommand(captureAny, parameters: captureAnyNamed('parameters')));
-      expect(verify(usage.sendEvent(
-          any,
-          'success',
-          parameters: captureAnyNamed('parameters'),
-        )).captured[0],
-        containsPair(cdKey(CustomDimensions.commandResultEventMaxRss),
-            mockProcessInfo.maxRss.toString()));
-    });
-
     testUsingCommandContext('report execution timing by default', () async {
       // Crash if called a third time which is unexpected.
       mockTimes = <int>[1000, 2000];

packages/flutter_tools/test/general.shard/runner/runner_test.dart

@@ -140,8 +140,15 @@ class CrashingUsage implements Usage {
     String category,
     String parameter, {
     String label,
+    int value,
     Map<String, String> parameters,
-  }) => _impl.sendEvent(category, parameter, label: label, parameters: parameters);
+  }) => _impl.sendEvent(
+    category,
+    parameter,
+    label: label,
+    value: value,
+    parameters: parameters,
+  );
 
   @override
   void sendTiming(

packages/flutter_tools/test/src/context.dart

@@ -303,7 +303,11 @@ class FakeUsage implements Usage {
   void sendCommand(String command, { Map<String, String> parameters }) { }
 
   @override
-  void sendEvent(String category, String parameter, { String label, Map<String, String> parameters }) { }
+  void sendEvent(String category, String parameter, {
+    String label,
+    int value,
+    Map<String, String> parameters,
+  }) { }
 
   @override
   void sendTiming(String category, String variableName, Duration duration, { String label }) { }

packages/flutter_tools/test/src/testbed.dart

@@ -162,7 +162,11 @@ class NoOpUsage implements Usage {
   void sendCommand(String command, {Map<String, String> parameters}) {}
 
   @override
-  void sendEvent(String category, String parameter, { String label, Map<String, String> parameters }) {}
+  void sendEvent(String category, String parameter, {
+    String label,
+    int value,
+    Map<String, String> parameters,
+  }) {}
 
   @override
   void sendException(dynamic exception) {}