Add a new Event for analytics for new analyzer plugins (#2286)

Author: srawlins

pkgs/unified_analytics/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 8.0.12
+- Added `Event.plugins` to track new analyzer plugins
+
 ## 8.0.11
 - Added `DashEvent.ideEvent` to track IDE reported events.
 

pkgs/unified_analytics/lib/src/constants.dart

@@ -87,7 +87,7 @@ const int kMaxLogFileSize = 25 * (1 << 20);
 const String kLogFileName = 'dart-flutter-telemetry.log';
 
 /// The current version of the package, should be in line with pubspec version.
-const String kPackageVersion = '8.0.11';
+const String kPackageVersion = '8.0.12';
 
 /// The minimum length for a session.
 const int kSessionDurationMinutes = 30;

pkgs/unified_analytics/lib/src/enums.dart

@@ -170,11 +170,17 @@ enum DashEvent {
   ),
   pluginRequest(
     label: 'plugin_request',
-    description: 'Request responses from plugins',
+    description:
+        'Analyzer plugin performance information regarding server requests',
+  ),
+  plugins(
+    label: 'plugins',
+    description: 'Information about how often _new_ analyzer plugins were used',
   ),
   pluginUse(
     label: 'plugin_use',
-    description: 'Information about how often a plugin was used',
+    description:
+        'Information about how often a _legacy_ analyzer plugin was used',
   ),
   serverSession(
     label: 'server_session',

pkgs/unified_analytics/lib/src/event.dart

@@ -866,16 +866,16 @@ final class Event {
           },
         );
 
-  /// Event that is emitted periodically to report the performance of plugins
-  /// when handling requests.
+  /// Event that is emitted periodically to report the performance of analyzer
+  /// plugins when handling requests.
   ///
-  /// [duration] - json encoded percentile values indicating how long it took
+  /// [duration] - JSON-encoded percentile values indicating how long it took
   ///     from the time the request was sent to the plugin until the response
   ///     was processed by the server.
   ///
   /// [method] - the name of the request sent to the plugin.
   ///
-  /// [pluginId] - the id of the plugin whose performance is being reported.
+  /// [pluginId] - the ID of the plugin whose performance is being reported.
   Event.pluginRequest({
     required String duration,
     required String method,
@@ -889,16 +889,45 @@ final class Event {
           },
         );
 
+  /// Event that is emitted periodically to report information about how _new_
+  /// analyzer plugins are used.
+  ///
+  /// - [count] - the number of new plugins that were configured.
+  /// - [lintRuleCounts] - JSON-encoded percentile values indicating the number
+  ///   of enabled lint rules for each plugin.
+  /// - [warningRuleCounts] - JSON-encoded percentile values indicating the
+  ///   number of enabled warning rules for each plugin.
+  /// - [fixCounts] - JSON-encoded percentile values indicating the number of
+  ///   fixes provided by each plugin.
+  /// - [assistCounts] - JSON-encoded percentile values indicating the number of
+  ///   assists provided by each plugin.
+  Event.plugins({
+    required int count,
+    required String lintRuleCounts,
+    required String warningRuleCounts,
+    required String fixCounts,
+    required String assistCounts,
+  }) : this._(
+          eventName: DashEvent.plugins,
+          eventData: {
+            'count': count,
+            'lintRuleCounts': lintRuleCounts,
+            'warningRuleCounts': warningRuleCounts,
+            'fixCounts': fixCounts,
+            'assistCounts': assistCounts,
+          },
+        );
+
   /// Event that is emitted periodically to report the frequency with which a
-  /// given plugin has been used.
+  /// given _legacy_ analyzer plugin has been used.
   ///
   /// [count] - the number of times plugins usage was changed, which will always
   ///     be at least one.
   ///
-  /// [enabled] - json encoded percentile values indicating the number of
-  ///     contexts for which the plugin was enabled.
+  /// [enabled] - JSON-encoded percentile values indicating the number of
+  ///     analysis contexts for which the plugin was enabled.
   ///
-  /// [pluginId] - the id of the plugin associated with the data.
+  /// [pluginId] - the ID of the plugin associated with the data.
   Event.pluginUse({
     required int count,
     required String enabled,

pkgs/unified_analytics/pubspec.yaml

@@ -5,7 +5,7 @@ description: >-
 # LINT.IfChange
 # When updating this, keep the version consistent with the changelog and the
 # value in lib/src/constants.dart.
-version: 8.0.11
+version: 8.0.12
 # LINT.ThenChange(lib/src/constants.dart)
 repository: https://github.com/dart-lang/tools/tree/main/pkgs/unified_analytics
 issue_tracker: https://github.com/dart-lang/tools/issues?q=is%3Aissue+is%3Aopen+label%3Apackage%3Aunified_analytics

pkgs/unified_analytics/test/event_test.dart

@@ -270,6 +270,28 @@ void main() {
     expect(constructedEvent.eventData.length, 3);
   });
 
+  test('Event.plugins constructed', () {
+    Event generateEvent() => Event.plugins(
+          count: 5,
+          lintRuleCounts: 'lintRuleCounts',
+          warningRuleCounts: 'warningRuleCounts',
+          fixCounts: 'fixCounts',
+          assistCounts: 'assistCounts',
+        );
+
+    final constructedEvent = generateEvent();
+
+    expect(generateEvent, returnsNormally);
+    expect(constructedEvent.eventName, DashEvent.plugins);
+    expect(constructedEvent.eventData['count'], 5);
+    expect(constructedEvent.eventData['lintRuleCounts'], 'lintRuleCounts');
+    expect(
+        constructedEvent.eventData['warningRuleCounts'], 'warningRuleCounts');
+    expect(constructedEvent.eventData['fixCounts'], 'fixCounts');
+    expect(constructedEvent.eventData['assistCounts'], 'assistCounts');
+    expect(constructedEvent.eventData, hasLength(5));
+  });
+
   test('Event.pluginUse constructed', () {
     Event generateEvent() => Event.pluginUse(
           count: 5,
@@ -804,7 +826,7 @@ void main() {
 
     // Change this integer below if your PR either adds or removes
     // an Event constructor
-    final eventsAccountedForInTests = 32;
+    final eventsAccountedForInTests = 33;
     expect(eventsAccountedForInTests, constructorCount,
         reason: 'If you added or removed an event constructor, '
             'ensure you have updated '