Setting up package:unified_analytics within devtools (#7084)

* Edits to case statements for unified_analytics

* Update server_api.dart

* Pass the consent message from the server to app

* Hook function to confirm message has been shown

* Automatically onboard devtools if message shown

* Update pubspec.yaml

* Format fix

* `AnalyticsController. consentMessage` non-nullable

* Return null from `confirmConsentMessageShown`

* Swap for `apiAnalyticsConsentMessageShown`

* Fixing build time errors for non-nullable strings

* `get` --> `fetch` for methods getting consent msg

* Format fix

* Remove unused parameter

* Fix test

* Fix test to check that consent message is shown

* Update NEXT_RELEASE_NOTES.md

* Use hyperlink to link to the policy page

* Dart format fix

* Handle errors when parsing the consent message

* Use stubbed function to get fake message

* `confirmConsentMessageShown` -> `markConsentMessageAsShown`

* Fix typo

* Documentation added per code review

* Add analytics package to devtools_app

* Have `Analytics` instance created in dds

* Fix merge errors

* Fix nits from code review

* Use `LinkTextSpan` for url in consent message

* Fix test

* `devtools_tool fix-goldens --run-id=7890083211`

* Revert "`devtools_tool fix-goldens --run-id=7890083211`"

This reverts commit e77804a.

Author: eliasyishak

packages/devtools_app/benchmark/test_infra/automators/devtools_automator.dart

@@ -45,7 +45,11 @@ class DevToolsAutomater {
     Future<void>.delayed(safePumpDuration, automateDevToolsGestures);
     return DevToolsApp(
       defaultScreens(sampleData: sampleData),
-      AnalyticsController(enabled: false, firstRun: false),
+      AnalyticsController(
+        enabled: false,
+        firstRun: false,
+        consentMessage: 'fake message',
+      ),
     );
   }
 

packages/devtools_app/lib/src/shared/analytics/_analytics_controller_stub.dart

@@ -4,8 +4,13 @@
 
 import 'dart:async';
 
+import 'analytics.dart' as ga;
 import 'analytics_controller.dart';
 
-FutureOr<AnalyticsController> get devToolsAnalyticsController => _controller;
-AnalyticsController _controller =
-    AnalyticsController(enabled: false, firstRun: false);
+FutureOr<AnalyticsController> get devToolsAnalyticsController async {
+  return AnalyticsController(
+    enabled: false,
+    firstRun: false,
+    consentMessage: await ga.fetchAnalyticsConsentMessage(),
+  );
+}

packages/devtools_app/lib/src/shared/analytics/_analytics_controller_web.dart

@@ -33,6 +33,8 @@ Future<AnalyticsController> get devToolsAnalyticsController async {
         ga.initializeGA();
         ga.jsHookupListenerForGA();
       },
+      consentMessage: await ga.fetchAnalyticsConsentMessage(),
+      markConsentMessageAsShown: ga.markConsentMessageAsShown,
     ),
   );
   return _controllerCompleter!.future;

packages/devtools_app/lib/src/shared/analytics/_analytics_stub.dart

@@ -32,6 +32,11 @@ Future<void> enableAnalytics() async {}
 
 Future<void> disableAnalytics() async {}
 
+Future<String> fetchAnalyticsConsentMessage() async =>
+    'stubbed consent message';
+
+Future<void> markConsentMessageAsShown() async {}
+
 void screen(
   String screenName, [
   int value = 0,

packages/devtools_app/lib/src/shared/analytics/_analytics_web.dart

@@ -795,6 +795,19 @@ Future<bool> disableAnalytics() async {
   return await setAnalyticsEnabled(false);
 }
 
+/// Fetch the legal consent message for telemetry collection for
+/// package:unified_analyitcs from the server
+Future<String> fetchAnalyticsConsentMessage() async {
+  return await server.fetchAnalyticsConsentMessage();
+}
+
+/// Communicates with the server to confirm with package:unified_analyitcs
+/// that the consent message has successfully been shown and to allow events
+/// to be recorded if the user has decided to remain opted in.
+Future<void> markConsentMessageAsShown() async {
+  return await server.markConsentMessageAsShown();
+}
+
 /// Computes the DevTools application. Fills in the devtoolsPlatformType and
 /// devtoolsChrome.
 void computeDevToolsCustomGTagsData() {

packages/devtools_app/lib/src/shared/analytics/analytics_controller.dart

@@ -18,11 +18,15 @@ class AnalyticsController {
   AnalyticsController({
     required bool enabled,
     required bool firstRun,
+    required this.consentMessage,
     this.onEnableAnalytics,
     this.onDisableAnalytics,
     this.onSetupAnalytics,
+    AsyncAnalyticsCallback? markConsentMessageAsShown,
   })  : analyticsEnabled = ValueNotifier<bool>(enabled),
-        _shouldPrompt = ValueNotifier<bool>(firstRun && !enabled) {
+        _shouldPrompt =
+            ValueNotifier<bool>(firstRun && consentMessage.isNotEmpty),
+        _markConsentMessageAsShown = markConsentMessageAsShown {
     if (_shouldPrompt.value) {
       unawaited(toggleAnalyticsEnabled(true));
     }
@@ -43,8 +47,17 @@ class AnalyticsController {
 
   final AsyncAnalyticsCallback? onDisableAnalytics;
 
+  /// Method to call to confirm with package:unified_analytics the user has
+  /// seen the consent message.
+  final AsyncAnalyticsCallback? _markConsentMessageAsShown;
+  Future<void> markConsentMessageAsShown() async =>
+      await _markConsentMessageAsShown?.call();
+
   final VoidCallback? onSetupAnalytics;
 
+  /// Consent message for package:unified_analytics to be shown on first run.
+  final String consentMessage;
+
   Future<void> toggleAnalyticsEnabled(bool? enable) async {
     if (enable == true) {
       analyticsEnabled.value = true;

packages/devtools_app/lib/src/shared/analytics/prompt.dart

@@ -5,10 +5,9 @@
 import 'dart:async';
 
 import 'package:devtools_app_shared/ui.dart';
-import 'package:flutter/gestures.dart';
 import 'package:flutter/material.dart';
 
-import '../config_specific/launch_url/launch_url.dart';
+import '../common_widgets.dart';
 import '../utils.dart';
 import 'analytics_controller.dart';
 
@@ -35,9 +34,15 @@ class _AnalyticsPromptState extends State<AnalyticsPrompt>
   Widget build(BuildContext context) {
     final theme = Theme.of(context);
     final textTheme = theme.textTheme;
+
     return ValueListenableBuilder<bool>(
       valueListenable: controller.shouldPrompt,
       builder: (context, showPrompt, child) {
+        // Mark the consent message as shown for unified_analytics so that devtools
+        // can be onboarded into the config file
+        // ~/.dart-tool/dart-flutter-telemetry.config
+        if (showPrompt) unawaited(controller.markConsentMessageAsShown());
+
         return Column(
           crossAxisAlignment: CrossAxisAlignment.start,
           children: [
@@ -89,30 +94,42 @@ class _AnalyticsPromptState extends State<AnalyticsPrompt>
   }
 
   Widget _analyticsDescription(TextTheme textTheme) {
+    final consentMessageRegExpResults =
+        parseAnalyticsConsentMessage(controller.consentMessage);
+
+    // When failing to parse the consent message, fallback to
+    // displaying the consent message in its regular form
+    if (consentMessageRegExpResults == null) {
+      return RichText(
+        text: TextSpan(
+          children: [
+            TextSpan(
+              text: controller.consentMessage,
+              style: textTheme.titleMedium,
+            ),
+          ],
+        ),
+      );
+    }
+
     return RichText(
       text: TextSpan(
         children: [
           TextSpan(
-            text: 'DevTools reports feature usage statistics and basic '
-                'crash reports to Google in order to help Google improve '
-                'the tool over time. See Google\'s ',
+            text: consentMessageRegExpResults[0],
             style: textTheme.titleMedium,
           ),
-          TextSpan(
-            text: 'privacy policy',
+          LinkTextSpan(
+            link: Link(
+              display: consentMessageRegExpResults[1],
+              url: consentMessageRegExpResults[1],
+            ),
+            context: context,
             style:
                 textTheme.titleMedium?.copyWith(color: const Color(0xFF54C1EF)),
-            recognizer: TapGestureRecognizer()
-              ..onTap = () {
-                unawaited(
-                  launchUrl(
-                    'https://www.google.com/intl/en/policies/privacy',
-                  ),
-                );
-              },
           ),
           TextSpan(
-            text: '.',
+            text: consentMessageRegExpResults[2],
             style: textTheme.titleMedium,
           ),
         ],
@@ -146,3 +163,31 @@ class _AnalyticsPromptState extends State<AnalyticsPrompt>
     );
   }
 }
+
+/// This method helps to parse the consent message from
+/// `package:unified_analytics` so that the URL can be
+/// separated from the block of text so that we can have a
+/// hyperlink in the displayed consent message.
+List<String>? parseAnalyticsConsentMessage(String consentMessage) {
+  final results = <String>[];
+  final RegExp pattern =
+      RegExp(r'^([\S\s]*)(https?:\/\/[^\s]+)(\)\.)$', multiLine: true);
+
+  final matches = pattern.allMatches(consentMessage);
+  if (matches.isEmpty) {
+    return null;
+  }
+
+  matches.first.groups([1, 2, 3]).forEach((element) {
+    results.add(element!);
+  });
+
+  // There should be 3 groups returned if correctly parsed, one
+  // for most of the text, one for the URL, and one for what comes
+  // after the URL
+  if (results.length != 3) {
+    return null;
+  }
+
+  return results;
+}

packages/devtools_app/lib/src/shared/common_widgets.dart

@@ -1443,7 +1443,9 @@ class LinkIconLabel extends StatelessWidget {
 
   void _onLinkTap() {
     unawaited(launchUrl(link.url));
-    ga.select(link.gaScreenName, link.gaSelectedItemDescription);
+    if (link.gaScreenName != null && link.gaSelectedItemDescription != null) {
+      ga.select(link.gaScreenName!, link.gaSelectedItemDescription!);
+    }
   }
 }
 
@@ -1457,10 +1459,13 @@ class LinkTextSpan extends TextSpan {
           style: style ?? Theme.of(context).linkTextStyle,
           recognizer: TapGestureRecognizer()
             ..onTap = () async {
-              ga.select(
-                link.gaScreenName,
-                link.gaSelectedItemDescription,
-              );
+              if (link.gaScreenName != null &&
+                  link.gaSelectedItemDescription != null) {
+                ga.select(
+                  link.gaScreenName!,
+                  link.gaSelectedItemDescription!,
+                );
+              }
               await launchUrl(link.url);
             },
         );
@@ -1470,17 +1475,17 @@ class Link {
   const Link({
     required this.display,
     required this.url,
-    required this.gaScreenName,
-    required this.gaSelectedItemDescription,
+    this.gaScreenName,
+    this.gaSelectedItemDescription,
   });
 
   final String display;
 
   final String url;
 
-  final String gaScreenName;
+  final String? gaScreenName;
 
-  final String gaSelectedItemDescription;
+  final String? gaSelectedItemDescription;
 }
 
 class Legend extends StatelessWidget {

packages/devtools_app/lib/src/shared/server/_analytics_api.dart

@@ -56,6 +56,27 @@ Future<bool> setAnalyticsEnabled([bool value = true]) async {
   return false;
 }
 
+/// Fetch the consent message for package:unified_analytics.
+Future<String> fetchAnalyticsConsentMessage() async {
+  String? consentMessage = '';
+  if (isDevToolsServerAvailable) {
+    final resp = await request(apiGetConsentMessage);
+    if (resp?.statusOk ?? false) {
+      consentMessage = resp!.body;
+    }
+  }
+
+  return consentMessage;
+}
+
+/// Confirm with package:unified_analytics that the consent message
+/// has been shown to the user.
+Future<void> markConsentMessageAsShown() async {
+  if (isDevToolsServerAvailable) {
+    await request(apiMarkConsentMessageAsShown);
+  }
+}
+
 // TODO(terry): Move to an API scheme similar to the VM service extension where
 // '/api/devToolsEnabled' returns the value (identical VM service) and
 // '/api/devToolsEnabled?value=true' sets the value.

packages/devtools_app/pubspec.yaml

@@ -56,6 +56,7 @@ dependencies:
   stack_trace: ^1.10.0
   stream_channel: ^2.1.1
   string_scanner: ^1.1.0
+  unified_analytics: ^5.8.1
   url_launcher: ^6.1.0
   url_launcher_web: ^2.0.6
   vm_service: ^14.0.0