add optional data to exception

dart-lang · Sep 9, 2024 · d033b83 · d033b83
1 parent fc52bcd
commit d033b83
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 6 deletions.
diff --git a/pkgs/unified_analytics/CHANGELOG.md b/pkgs/unified_analytics/CHANGELOG.md
@@ -1,7 +1,8 @@
 ## 6.1.3
 
 - Require Dart 3.4.
-- Added `isWasm` parameter to `Event.devtoolsEvent` constructor.
+- Added `isWasm` parameter to the `Event.devtoolsEvent` constructor.
+- Added an optional parameter `data` to the `Event.exception` constructor.
 
 ## 6.1.2
 

diff --git a/pkgs/unified_analytics/lib/src/event.dart b/pkgs/unified_analytics/lib/src/event.dart
@@ -482,9 +482,15 @@ final class Event {
   /// exception that we want to log.
   ///
   /// [exception] - string representation of the exception that occured.
-  Event.exception({required String exception})
-      : eventName = DashEvent.exception,
-        eventData = {'exception': exception};
+  /// [data] - optional structured data to include with the exception event.
+  Event.exception({
+    required String exception,
+    Map<String, Object?> data = const <String, Object?>{},
+  })  : eventName = DashEvent.exception,
+        eventData = {
+          'exception': exception,
+          ...data,
+        };
 
   /// Event that is emitted from the flutter tool when a build invocation
   /// has been run by the user.

diff --git a/pkgs/unified_analytics/test/event_test.dart b/pkgs/unified_analytics/test/event_test.dart
@@ -429,14 +429,19 @@ void main() {
   });
 
   test('Event.exception constructed', () {
-    Event generateEvent() => Event.exception(exception: 'exception');
+    Event generateEvent() => Event.exception(
+          exception: 'exception',
+          data: {'foo': 'bar', 'baz': 1},
+        );
 
     final constructedEvent = generateEvent();
 
     expect(generateEvent, returnsNormally);
     expect(constructedEvent.eventName, DashEvent.exception);
     expect(constructedEvent.eventData['exception'], 'exception');
-    expect(constructedEvent.eventData.length, 1);
+    expect(constructedEvent.eventData['foo'], 'bar');
+    expect(constructedEvent.eventData['baz'], 1);
+    expect(constructedEvent.eventData.length, 3);
   });
 
   test('Event.timing constructed', () {