Serializing/deserializing methods for Event instances

pkgs/unified_analytics/lib/src/enums.dart

@@ -2,8 +2,6 @@
 // for details. All rights reserved. Use of this source code is governed by a
 // BSD-style license that can be found in the LICENSE file.
 
-import 'package:collection/collection.dart';
-
 /// The valid dash tool labels stored in the [DashTool] enum.
 List<String> get validDashTools =>
     DashTool.values.map((e) => e.label).toList()..sort();
@@ -159,7 +157,7 @@ enum DashEvent {
   /// This takes in the string label for a given [DashEvent] and returns the
   /// enum for that string label.
   static DashEvent? fromLabel(String label) =>
-      DashEvent.values.firstWhereOrNull((e) => e.label == label);
+      DashEvent.values.where((e) => e.label == label).firstOrNull;
 }
 
 /// Officially-supported clients of this package as logical
@@ -206,7 +204,7 @@ enum DashTool {
 
   /// This takes in the string label for a given [DashTool] and returns the
   /// enum for that string label.
-  static DashTool? fromLabel(String label) {
+  static DashTool fromLabel(String label) {
     for (final tool in DashTool.values) {
       if (tool.label == label) return tool;
     }

pkgs/unified_analytics/lib/src/event.dart

@@ -4,13 +4,8 @@
 
 import 'dart:convert';
 
-import 'package:collection/collection.dart';
-
 import 'enums.dart';
 
-final DeepCollectionEquality _deepCollectionEquality =
-    const DeepCollectionEquality();
-
 final class Event {
   final DashEvent eventName;
   final Map<String, Object?> eventData;
@@ -459,7 +454,6 @@ final class Event {
       : eventName = DashEvent.hotReloadTime,
         eventData = {'timeMs': timeMs};
 
-  // TODO: eliasyishak, add better dartdocs to explain each param
   /// Events to be sent for the Flutter Hot Runner.
   Event.hotRunnerInfo({
     required String label,
@@ -511,6 +505,7 @@ final class Event {
           if (reloadVMTimeInMs != null) 'reloadVMTimeInMs': reloadVMTimeInMs,
         };
 
+  // TODO: eliasyishak, add better dartdocs to explain each param
   /// Event that is emitted periodically to report the number of times each lint
   /// has been enabled.
   ///
@@ -724,22 +719,9 @@ final class Event {
       other is Event &&
       other.runtimeType == runtimeType &&
       other.eventName == eventName &&
-      _deepCollectionEquality.equals(other.eventData, eventData);
+      _compareEventData(other.eventData, eventData);
 
   /// Converts an instance of [Event] to JSON.
-  ///
-  /// Example for [Event.timing] converted to JSON below.
-  /// ```json
-  /// {
-  ///   "eventName": "timing",
-  ///   "eventData": {
-  ///     "workflow": "my-work-flow",
-  ///     "variableName": "my-variable",
-  ///     "elapsedMilliseconds": 123,
-  ///     "label": "my-label"
-  ///   }
-  /// }
-  /// ```
   String toJson() => jsonEncode({
         'eventName': eventName.label,
         'eventData': eventData,
@@ -748,20 +730,32 @@ final class Event {
   @override
   String toString() => toJson();
 
+  /// Utility function to take in two maps [a] and [b] and compares them
+  /// to ensure that they have the same keys and values
+  bool _compareEventData(Map<String, Object?> a, Map<String, Object?> b) {
+    final keySetA = a.keys.toSet();
+    final keySetB = b.keys.toSet();
+    final intersection = keySetA.intersection(keySetB);
+
+    // Ensure that the keys are the same for each object
+    if (intersection.length != keySetA.length ||
+        intersection.length != keySetB.length) {
+      return false;
+    }
+
+    // Ensure that each of the key's values are the same
+    for (final key in a.keys) {
+      if (a[key] != b[key]) return false;
+    }
+
+    return true;
+  }
+
   /// Returns a valid instance of [Event] if [json] follows the correct schema.
   ///
-  /// Schema is below with the following notes:
-  /// - The `eventName` key must have a string value that exists in [DashEvent].
-  /// - The `eventData` key must have a nested object as its value.
-  /// ```json
-  /// {
-  ///   "eventName": "string-label",
-  ///   "eventData": {
-  ///     "myVar1": "value1",
-  ///     "myVar2": 123
-  ///   }
-  /// }
-  /// ```
+  /// Common use case for this static method involves clients of this package
+  /// that have a client-server setup where the server sends events that the
+  /// client creates.
   static Event? fromJson(String json) {
     try {
       final jsonMap = jsonDecode(json) as Map<String, Object?>;

pkgs/unified_analytics/lib/src/survey_handler.dart

@@ -136,7 +136,6 @@ class Survey {
             : json['samplingRate'] as double,
         excludeDashToolList = (json['excludeDashTools'] as List<dynamic>)
             .map((e) => DashTool.fromLabel(e as String))
-            .whereType<DashTool>()
             .toList(),
         conditionList = (json['conditions'] as List<dynamic>).map((e) {
           return Condition.fromJson(e as Map<String, dynamic>);

pkgs/unified_analytics/pubspec.yaml

@@ -12,7 +12,6 @@ environment:
 
 dependencies:
   clock: ^1.1.1
-  collection: '>=1.18.0 <2.0.0'
   file: '>=6.1.4 <8.0.0'
   http: '>=0.13.5 <2.0.0'
   intl: '>=0.18.0 <0.20.0'