fix: allow logEvent to accept items inside parameters

firebase · Sep 29, 2024 · 9332cf4 · 9332cf4
1 parent 15ab6ab
commit 9332cf4
Show file tree

Hide file tree

Showing 2 changed files with 104 additions and 7 deletions.
diff --git a/packages/firebase_analytics/firebase_analytics/lib/src/firebase_analytics.dart b/packages/firebase_analytics/firebase_analytics/lib/src/firebase_analytics.dart
@@ -104,7 +104,10 @@ class FirebaseAnalytics extends FirebasePluginPlatform {
   }) async {
     _logEventNameValidation(name);
 
-    _assertParameterTypesAreCorrect(parameters);
+    _assertParameterTypesAreCorrect(
+      parameters,
+      allowItems: true,
+    );
 
     await _delegate.logEvent(
       name: name,
@@ -1385,14 +1388,37 @@ List<Map<String, dynamic>>? _marshalItems(List<AnalyticsEventItem>? items) {
 }
 
 void _assertParameterTypesAreCorrect(
-  Map<String, Object>? parameters,
-) =>
-    parameters?.forEach((key, value) {
+  Map<String, Object>? parameters, {
+  bool allowItems = false,
+}) {
+  if (parameters == null) {
+    return;
+  }
+
+  for (final MapEntry(:key, :value) in parameters.entries) {
+    if (allowItems && key == _ITEMS) {
+      assert(value is List, "$_ITEMS must be a 'List'");
+
+      if (value is List) {
+        for (final item in value) {
+          assert(
+            item is Map<String, Object>,
+            "item in $_ITEMS must be a 'Map<String, Object>'",
+          );
+
+          if (item is Map<String, Object>) {
+            _assertParameterTypesAreCorrect(item);
+          }
+        }
+      }
+    } else {
       assert(
         value is String || value is num,
         "'string' OR 'number' must be set as the value of the parameter: $key. $value found instead",
       );
-    });
+    }
+  }
+}
 
 void _assertItemsParameterTypesAreCorrect(List<AnalyticsEventItem>? items) =>
     items?.forEach((item) {

diff --git a/packages/firebase_analytics/firebase_analytics/test/firebase_analytics_test.dart b/packages/firebase_analytics/firebase_analytics/test/firebase_analytics_test.dart
@@ -136,10 +136,74 @@ void main() {
         expect(analytics!.logEvent(name: 'firebase_foo'), throwsArgumentError);
       });
 
+      test('reject events with wrong param value', () async {
+        expect(
+          () => analytics!.logEvent(
+            name: 'test_event',
+            parameters: {
+              'a': true,
+            },
+          ),
+          throwsAssertionError,
+        );
+      });
+
+      test('reject events with wrong param items', () async {
+        expect(
+          () => analytics!.logEvent(
+            name: 'test_event',
+            parameters: {
+              'items': true,
+            },
+          ),
+          throwsAssertionError,
+        );
+      });
+
+      test('reject events with wrong param items values', () async {
+        expect(
+          () => analytics!.logEvent(
+            name: 'test_event',
+            parameters: {
+              'items': [
+                {
+                  'a': 123,
+                },
+                true,
+              ],
+            },
+          ),
+          throwsAssertionError,
+        );
+      });
+
+      test('reject events with wrong param items items', () async {
+        expect(
+          () => analytics!.logEvent(
+            name: 'test_event',
+            parameters: {
+              'items': [
+                {
+                  'items': [],
+                },
+              ],
+            },
+          ),
+          throwsAssertionError,
+        );
+      });
+
       test('custom event with correct parameters', () async {
         await analytics!.logEvent(
           name: 'test-event',
-          parameters: {'a': 'b'},
+          parameters: {
+            'a': 'b',
+            'items': [
+              {
+                'c': 'd',
+              },
+            ],
+          },
         );
         expect(
           methodCallLog,
@@ -148,7 +212,14 @@ void main() {
               'Analytics#logEvent',
               arguments: {
                 'eventName': 'test-event',
-                'parameters': {'a': 'b'},
+                'parameters': {
+                  'a': 'b',
+                  'items': [
+                    {
+                      'c': 'd',
+                    },
+                  ],
+                },
               },
             ),
           ],