feat: Add namedQueryWithConverterGet (#9715)

firebase · Oct 13, 2022 · 6d025fd · 6d025fd
1 parent 75cd372
commit 6d025fd
Show file tree

Hide file tree

Showing 2 changed files with 68 additions and 0 deletions.
diff --git a/packages/cloud_firestore/cloud_firestore/example/test_driver/load_bundle_e2e.dart b/packages/cloud_firestore/cloud_firestore/example/test_driver/load_bundle_e2e.dart
@@ -161,5 +161,61 @@ void runLoadBundleTests() {
         );
       });
     });
+
+    group('FirebaeFirestore.namedQueryWithConverterGet()', () {
+      test('namedQueryWithConverterGet() successful', () async {
+        const int number = 4;
+        Uint8List buffer = await loadBundleSetup(number);
+        LoadBundleTask task = firestore.loadBundle(buffer);
+
+        // ensure the bundle has been completely cached
+        await task.stream.last;
+
+        // namedQuery 'named-bundle-test' which returns a QuerySnaphot of the same 3 documents
+        // with 'number' property
+        QuerySnapshot<ConverterPlaceholder> snapshot =
+            await firestore.namedQueryWithConverterGet<ConverterPlaceholder>(
+          'named-bundle-test-$number',
+          options: const GetOptions(source: Source.cache),
+          fromFirestore: ConverterPlaceholder.new,
+          toFirestore: (value, options) => value.toFirestore(),
+        );
+
+        expect(
+          snapshot.docs.map((document) => document['number']),
+          everyElement(anyOf(1, 2, 3)),
+        );
+      });
+
+      test('namedQueryWithConverterGet() error', () async {
+        Uint8List buffer = await loadBundleSetup(4);
+        LoadBundleTask task = firestore.loadBundle(buffer);
+
+        // ensure the bundle has been completely cached
+        await task.stream.last;
+
+        await expectLater(
+          firestore.namedQueryWithConverterGet<ConverterPlaceholder>(
+            'wrong-name',
+            options: const GetOptions(source: Source.cache),
+            fromFirestore: ConverterPlaceholder.new,
+            toFirestore: (value, options) => value.toFirestore(),
+          ),
+          throwsA(
+            isA<FirebaseException>()
+                .having((e) => e.code, 'code', 'non-existent-named-query'),
+          ),
+        );
+      });
+    });
   });
 }
+
+class ConverterPlaceholder {
+  ConverterPlaceholder(this.firestore, this.getOptions);
+
+  final DocumentSnapshot<Map<String, Object?>> firestore;
+  final SnapshotOptions? getOptions;
+
+  Map<String, Object?> toFirestore() => firestore.data()!;
+}
diff --git a/packages/cloud_firestore/cloud_firestore/lib/src/firestore.dart b/packages/cloud_firestore/cloud_firestore/lib/src/firestore.dart
@@ -136,6 +136,18 @@ class FirebaseFirestore extends FirebasePluginPlatform {
     }
   }
 
+  /// Performs a [namedQueryGet] and decode the result using [Query.withConverter].
+  Future<QuerySnapshot<T>> namedQueryWithConverterGet<T>(
+    String name, {
+    GetOptions options = const GetOptions(),
+    required FromFirestore<T> fromFirestore,
+    required ToFirestore<T> toFirestore,
+  }) async {
+    final snapshot = await namedQueryGet(name, options: options);
+
+    return _WithConverterQuerySnapshot<T>(snapshot, fromFirestore, toFirestore);
+  }
+
   /// Reads a [QuerySnapshot] if a namedQuery has been retrieved and passed as a [Buffer] to [loadBundle()]. To read from cache, pass [GetOptions.source] value as [Source.cache].
   /// To read from the Firestore backend, use [GetOptions.source] as [Source.server].
   Future<QuerySnapshot<Map<String, dynamic>>> namedQueryGet(