New event added for sending analytics within package on errors

pkgs/unified_analytics/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 5.8.2-wip
+
+- Added new event `Event.analyticsException` to track internal errors for this package
+- Redirecting the `Analytics.test` factory to return an instance of `FakeAnalytics`
+
 ## 5.8.1
 
 - Refactor logic for `okToSend` and `shouldShowMessage`

pkgs/unified_analytics/lib/src/analytics.dart

@@ -60,7 +60,7 @@ abstract class Analytics {
     final homeDirectory = getHomeDirectory(fs);
     if (homeDirectory == null ||
         !checkDirectoryForWritePermissions(homeDirectory)) {
-      return NoOpAnalytics();
+      return const NoOpAnalytics();
     }
 
     // Resolve the OS using dart:io
@@ -187,7 +187,7 @@ abstract class Analytics {
     int toolsMessageVersion = kToolsMessageVersion,
     String toolsMessage = kToolsMessage,
   }) =>
-      AnalyticsImpl(
+      FakeAnalytics(
         tool: tool,
         homeDirectory: homeDirectory,
         flutterChannel: flutterChannel,
@@ -203,7 +203,6 @@ abstract class Analytics {
               initializedSurveys: [],
             ),
         gaClient: gaClient ?? const FakeGAClient(),
-        enableAsserts: true,
         clientIde: clientIde,
         enabledFeatures: enabledFeatures,
       );
@@ -418,7 +417,11 @@ class AnalyticsImpl implements Analytics {
     // each event that is sent to Google Analytics -- it will be responsible
     // for getting the session id or rolling the session if the duration
     // exceeds [kSessionDurationMinutes]
-    _sessionHandler = Session(homeDirectory: homeDirectory, fs: fs);
+    _sessionHandler = Session(
+      homeDirectory: homeDirectory,
+      fs: fs,
+      analyticsInstance: this,
+    );
     userProperty = UserProperty(
       session: _sessionHandler,
       flutterChannel: flutterChannel,
@@ -436,7 +439,11 @@ class AnalyticsImpl implements Analytics {
     );
 
     // Initialize the log handler to persist events that are being sent
-    _logHandler = LogHandler(fs: fs, homeDirectory: homeDirectory);
+    _logHandler = LogHandler(
+      fs: fs,
+      homeDirectory: homeDirectory,
+      analyticsInstance: this,
+    );
   }
 
   @override
@@ -712,10 +719,12 @@ class FakeAnalytics extends AnalyticsImpl {
     super.flutterVersion,
     super.clientIde,
     super.enabledFeatures,
+    int? toolsMessageVersion,
+    GAClient? gaClient,
   }) : super(
-          gaClient: const FakeGAClient(),
+          gaClient: gaClient ?? const FakeGAClient(),
           enableAsserts: true,
-          toolsMessageVersion: kToolsMessageVersion,
+          toolsMessageVersion: toolsMessageVersion ?? kToolsMessageVersion,
         );
 
   @override
@@ -767,9 +776,7 @@ class NoOpAnalytics implements Analytics {
   final Map<String, Map<String, Object?>> userPropertyMap =
       const <String, Map<String, Object?>>{};
 
-  factory NoOpAnalytics() => const NoOpAnalytics._();
-
-  const NoOpAnalytics._();
+  const NoOpAnalytics();
 
   @override
   String get clientId => staticClientId;

pkgs/unified_analytics/lib/src/constants.dart

@@ -82,7 +82,7 @@ const int kLogFileLength = 2500;
 const String kLogFileName = 'dart-flutter-telemetry.log';
 
 /// The current version of the package, should be in line with pubspec version.
-const String kPackageVersion = '5.8.1';
+const String kPackageVersion = '5.8.2-wip';
 
 /// The minimum length for a session.
 const int kSessionDurationMinutes = 30;

pkgs/unified_analytics/lib/src/enums.dart

@@ -22,6 +22,10 @@ enum DashEvent {
     label: 'analytics_collection_enabled',
     description: 'The opt-in status for analytics collection',
   ),
+  analyticsException(
+    label: 'analytics_exception',
+    description: 'Errors that occur within the package for logging',
+  ),
   exception(
     label: 'exception',
     description: 'General errors to log',

pkgs/unified_analytics/lib/src/event.dart

@@ -19,6 +19,28 @@ final class Event {
       : eventName = DashEvent.analyticsCollectionEnabled,
         eventData = {'status': status};
 
+  /// Event that is emitted when an error occurs within
+  /// `package:unified_analytics`, tools that are using this package
+  /// should not use this event constructor. Instead they should use
+  /// the more generic [Event.exception] constructor.
+  ///
+  /// [workflow] - refers to what process caused the error, such as
+  ///   "LogHandler.logFileStats".
+  ///
+  /// [error] - the name of the error, such as "FormatException".
+  ///
+  /// [description] - the description of the error being caught.
+  Event.analyticsException({
+    required String workflow,
+    required String error,
+    String? description,
+  })  : eventName = DashEvent.analyticsException,
+        eventData = {
+          'workflow': workflow,
+          'error': error,
+          if (description != null) 'description': description,
+        };
+
   /// This is for various workflows within the flutter tool related
   /// to iOS and macOS workflows.
   ///

pkgs/unified_analytics/lib/src/log_handler.dart

@@ -8,6 +8,7 @@ import 'package:clock/clock.dart';
 import 'package:file/file.dart';
 import 'package:path/path.dart' as p;
 
+import '../unified_analytics.dart';
 import 'constants.dart';
 import 'initializer.dart';
 
@@ -81,22 +82,6 @@ class LogFileStats {
     required this.eventCount,
   });
 
-  @override
-  String toString() {
-    final encoder = const JsonEncoder.withIndent('  ');
-    return encoder.convert({
-      'startDateTime': startDateTime.toString(),
-      'minsFromStartDateTime': minsFromStartDateTime,
-      'endDateTime': endDateTime.toString(),
-      'minsFromEndDateTime': minsFromEndDateTime,
-      'sessionCount': sessionCount,
-      'recordCount': recordCount,
-      'eventCount': eventCount,
-      'toolCount': toolCount,
-      'flutterChannelCount': flutterChannelCount,
-    });
-  }
-
   /// Pass in a string label for one of the instance variables
   /// and return the integer value of that label.
   ///
@@ -149,6 +134,22 @@ class LogFileStats {
 
     return null;
   }
+
+  @override
+  String toString() {
+    final encoder = const JsonEncoder.withIndent('  ');
+    return encoder.convert({
+      'startDateTime': startDateTime.toString(),
+      'minsFromStartDateTime': minsFromStartDateTime,
+      'endDateTime': endDateTime.toString(),
+      'minsFromEndDateTime': minsFromEndDateTime,
+      'sessionCount': sessionCount,
+      'recordCount': recordCount,
+      'eventCount': eventCount,
+      'toolCount': toolCount,
+      'flutterChannelCount': flutterChannelCount,
+    });
+  }
 }
 
 /// This class is responsible for writing to a log
@@ -160,17 +161,23 @@ class LogHandler {
   final FileSystem fs;
   final Directory homeDirectory;
   final File logFile;
+  final Analytics _analyticsInstance;
+
+  /// Ensure we are only sending once per invocation for this class.
+  var _errorEventSent = false;
 
   /// A log handler constructor that will delegate saving
   /// logs and retrieving stats from the persisted log.
   LogHandler({
     required this.fs,
     required this.homeDirectory,
-  }) : logFile = fs.file(p.join(
+    required Analytics analyticsInstance,
+  })  : logFile = fs.file(p.join(
           homeDirectory.path,
           kDartToolDirectoryName,
           kLogFileName,
-        ));
+        )),
+        _analyticsInstance = analyticsInstance;
 
   /// Get stats from the persisted log file.
   ///
@@ -184,15 +191,27 @@ class LogHandler {
     final records = logFile
         .readAsLinesSync()
         .map((String e) {
-          // TODO: eliasyishak, once https://github.com/dart-lang/tools/issues/167
-          //  has landed ensure we are sending an event for each error
-          //  with helpful messages
           try {
             return LogItem.fromRecord(jsonDecode(e) as Map<String, Object?>);
-          } on FormatException {
+          } on FormatException catch (err) {
+            if (!_errorEventSent) {
+              _analyticsInstance.send(Event.analyticsException(
+                workflow: 'LogFileStats.logFileStats',
+                error: err.runtimeType.toString(),
+                description: 'message: ${err.message}\nsource: ${err.source}',
+              ));
+              _errorEventSent = true;
+            }
             return null;
             // ignore: avoid_catching_errors
-          } on TypeError {
+          } on TypeError catch (err) {
+            if (!_errorEventSent) {
+              _analyticsInstance.send(Event.analyticsException(
+                workflow: 'LogFileStats.logFileStats',
+                error: err.runtimeType.toString(),
+              ));
+              _errorEventSent = true;
+            }
             return null;
           }
         })

pkgs/unified_analytics/lib/src/session.dart

@@ -3,28 +3,35 @@
 // BSD-style license that can be found in the LICENSE file.
 
 import 'dart:convert';
-import 'dart:io';
 
 import 'package:clock/clock.dart';
 import 'package:file/file.dart';
 import 'package:path/path.dart' as p;
 
+import 'analytics.dart';
 import 'constants.dart';
+import 'event.dart';
 import 'initializer.dart';
 
 class Session {
   final Directory homeDirectory;
   final FileSystem fs;
   final File sessionFile;
+  final Analytics _analyticsInstance;
 
   late int _sessionId;
   late int _lastPing;
 
+  /// Ensure we are only sending once per invocation for this class.
+  var _errorEventSent = false;
+
   Session({
     required this.homeDirectory,
     required this.fs,
-  }) : sessionFile = fs.file(p.join(
-            homeDirectory.path, kDartToolDirectoryName, kSessionFileName)) {
+    required Analytics analyticsInstance,
+  })  : sessionFile = fs.file(p.join(
+            homeDirectory.path, kDartToolDirectoryName, kSessionFileName)),
+        _analyticsInstance = analyticsInstance {
     _refreshSessionData();
   }
 
@@ -87,13 +94,31 @@ class Session {
 
     try {
       parseContents();
-    } on FormatException {
+    } on FormatException catch (err) {
       Initializer.createSessionFile(sessionFile: sessionFile);
 
+      if (!_errorEventSent) {
+        _analyticsInstance.send(Event.analyticsException(
+          workflow: 'Session._refreshSessionData',
+          error: err.runtimeType.toString(),
+          description: 'message: ${err.message}\nsource: ${err.source}',
+        ));
+        _errorEventSent = true;
+      }
+
       parseContents();
-    } on PathNotFoundException {
+    } on FileSystemException catch (err) {
       Initializer.createSessionFile(sessionFile: sessionFile);
 
+      if (!_errorEventSent) {
+        _analyticsInstance.send(Event.analyticsException(
+          workflow: 'Session._refreshSessionData',
+          error: err.runtimeType.toString(),
+          description: err.osError?.toString(),
+        ));
+        _errorEventSent = true;
+      }
+
       parseContents();
     }
   }