Add DashEvent for toggling telemetry collection + send event whenever toggled (#23)

* Added new event + modified setTelemetry to send toggle status to GA

* setTelemetry saves the event + tests added

Author: eliasyishak

pkgs/unified_analytics/lib/src/analytics.dart

@@ -130,6 +130,9 @@ abstract class Analytics {
 
   /// Pass a boolean to either enable or disable telemetry and make
   /// the necessary changes in the persisted configuration file
+  ///
+  /// Setting the telemetry status will also send an event to GA
+  /// indicating the latest status of the telemetry from [reportingBool]
   Future<void> setTelemetry(bool reportingBool);
 }
 
@@ -260,8 +263,26 @@ class AnalyticsImpl implements Analytics {
   }
 
   @override
-  Future<void> setTelemetry(bool reportingBool) =>
-      _configHandler.setTelemetry(reportingBool);
+  Future<void> setTelemetry(bool reportingBool) {
+    _configHandler.setTelemetry(reportingBool);
+
+    // Construct the body of the request to signal
+    // telemetry status toggling
+    //
+    // We use don't use the sendEvent method because it may
+    // be blocked by the [telemetryEnabled] getter
+    final Map<String, Object?> body = generateRequestBody(
+      clientId: _clientId,
+      eventName: DashEvent.analyticsCollectionEnabled,
+      eventData: {'status': reportingBool},
+      userProperty: userProperty,
+    );
+
+    _logHandler.save(data: body);
+
+    // Pass to the google analytics client to send
+    return _gaClient.sendData(body);
+  }
 }
 
 /// This class extends [AnalyticsImpl] and subs out any methods that

pkgs/unified_analytics/lib/src/enums.dart

@@ -7,6 +7,14 @@
 /// The [label] for each enum value is what will be logged, the [description]
 /// is here for documentation purposes
 enum DashEvent {
+  // Events that can be sent by all tools; these
+  // events should not be tool specific; toolOwner
+  // not necessary for these events
+  analyticsCollectionEnabled(
+    label: 'analytics_collection_enabled',
+    description: 'The opt-in status for analytics collection',
+  ),
+
   // Events for flutter_tools
   hotReloadTime(
     label: 'hot_reload_time',
@@ -49,11 +57,11 @@ enum DashEvent {
 
   final String label;
   final String description;
-  final DashTool toolOwner;
+  final DashTool? toolOwner;
   const DashEvent({
     required this.label,
     required this.description,
-    required this.toolOwner,
+    this.toolOwner,
   });
 }
 

pkgs/unified_analytics/test/unified_analytics_test.dart

@@ -142,16 +142,38 @@ void main() {
     expect(analytics.telemetryEnabled, true,
         reason: 'Telemetry should be enabled by default '
             'when initialized for the first time');
-
     // Use the API to disable analytics
+    expect(logFile.readAsLinesSync().length, 0);
     await analytics.setTelemetry(false);
     expect(analytics.telemetryEnabled, false,
         reason: 'Analytics telemetry should be disabled');
+    expect(logFile.readAsLinesSync().length, 1,
+        reason: 'One event should have been logged for disabling analytics');
+
+    // Extract the last log item to check for the keys
+    Map<String, Object?> lastLogItem =
+        jsonDecode(logFile.readAsLinesSync().last);
+    expect((lastLogItem['events'] as List).last['name'],
+        'analytics_collection_enabled',
+        reason: 'Check on event name');
+    expect((lastLogItem['events'] as List).last['params']['status'], false,
+        reason: 'Status should be false');
 
     // Toggle it back to being enabled
     await analytics.setTelemetry(true);
     expect(analytics.telemetryEnabled, true,
         reason: 'Analytics telemetry should be enabled');
+    expect(logFile.readAsLinesSync().length, 2,
+        reason: 'Second event should have been logged toggling '
+            'analytics back on');
+
+    // Extract the last log item to check for the keys
+    lastLogItem = jsonDecode(logFile.readAsLinesSync().last);
+    expect((lastLogItem['events'] as List).last['name'],
+        'analytics_collection_enabled',
+        reason: 'Check on event name');
+    expect((lastLogItem['events'] as List).last['params']['status'], true,
+        reason: 'Status should be false');
   });
 
   test(