🦺 prevent Utils.encode from calling toString on complex types

techouse · Apr 5, 2024 · e2bdcf5 · e2bdcf5
1 parent 5d2a214
commit e2bdcf5
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 19 deletions.
diff --git a/lib/src/utils.dart b/lib/src/utils.dart
@@ -225,6 +225,16 @@ final class Utils {
     Encoding charset = utf8,
     Format? format = Format.rfc3986,
   }) {
+    // these can not be encoded
+    if (value is Iterable ||
+        value is Map ||
+        value is Symbol ||
+        value is Record ||
+        value is Future ||
+        value is Undefined) {
+      return '';
+    }
+
     final String? str = value is ByteBuffer
         ? charset.decode(value.asUint8List())
         : value?.toString();

diff --git a/test/unit/utils_test.dart b/test/unit/utils_test.dart
@@ -27,28 +27,25 @@ void main() {
       );
       expect(DummyEnum.lorem, isA<Enum>());
       expect(Utils.encode(DummyEnum.lorem), equals('lorem'));
+
+      // does not encode
+      // Iterable
+      expect(Utils.encode([1, 2]), equals(''));
+      // Map
+      expect(Utils.encode({'a': 'b'}), equals(''));
+      // Symbol
+      expect(Utils.encode(#a), equals(''));
+      // Record
+      expect(Utils.encode(('a', 'b')), equals(''));
+      // Future
       expect(
-        Utils.encode({
-          'foo': 'bar',
-          'baz': [
-            {'a': 'b'},
-            {'c': DummyEnum.dolor},
-          ],
-        }),
-        equals(
-          '%7Bfoo%3A%20bar%2C%20baz%3A%20%5B%7Ba%3A%20b%7D%2C%20%7Bc%3A%20dolor%7D%5D%7D',
-        ),
+        Utils.encode(Future.value('b')),
+        equals(''),
       );
+      // Undefined
       expect(
-        Utils.encode({
-          'filters': {
-            'name': 'foo',
-            'example': DummyEnum.lorem,
-          }
-        }),
-        equals(
-          '%7Bfilters%3A%20%7Bname%3A%20foo%2C%20example%3A%20lorem%7D%7D',
-        ),
+        Utils.encode(const Undefined()),
+        equals(''),
       );
     });