[cloud_firestore] Add FieldPath

packages/cloud_firestore/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.12.10
+
+* Added `FieldPath` class and `FieldPath.documentId` to refer to the document id in queries.
+
 ## 0.12.9+5
 
 * Fixes a crash on Android when running a transaction without an internet connection.

packages/cloud_firestore/example/android/gradle.properties

@@ -1 +1,2 @@
 org.gradle.jvmargs=-Xmx1536M
+android.enableR8=true

packages/cloud_firestore/example/test_driver/cloud_firestore.dart

@@ -294,5 +294,30 @@ void main() {
       await doc1.delete();
       await doc2.delete();
     });
+
+    test('FieldPath.documentId', () async {
+      // Populate the database with two test documents.
+      final CollectionReference messages = firestore.collection('messages');
+      final DocumentReference doc = messages.document();
+      // Use document ID as a unique identifier to ensure that we don't
+      // collide with other tests running against this database.
+      final String uniqueId = doc.documentID;
+      await doc.setData(<String, dynamic>{
+        'message': 'testing field path',
+        'created_at': FieldValue.serverTimestamp(),
+      });
+
+      final QuerySnapshot snapshot = await messages
+          .where(FieldPath.documentId, isEqualTo: uniqueId)
+          .getDocuments();
+
+      await doc.delete();
+
+      final List<DocumentSnapshot> results = snapshot.documents;
+      final DocumentSnapshot result = results[0];
+
+      expect(results.length, 1);
+      expect(result.data['message'], 'testing field path');
+    });
   });
 }

packages/cloud_firestore/lib/cloud_firestore.dart

@@ -22,6 +22,7 @@ part 'src/collection_reference.dart';
 part 'src/document_change.dart';
 part 'src/document_reference.dart';
 part 'src/document_snapshot.dart';
+part 'src/field_path.dart';
 part 'src/field_value.dart';
 part 'src/firestore.dart';
 part 'src/firestore_message_codec.dart';

packages/cloud_firestore/lib/src/field_path.dart

@@ -0,0 +1,11 @@
+// Copyright 2017, the Chromium project authors.  Please see the AUTHORS file
+// 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.
+
+part of cloud_firestore;
+
+/// A [FieldPath] refers to a field in a document.
+class FieldPath {
+  /// The path to the document id, which can be used in queries.
+  static String get documentId => '__name__';
+}

packages/cloud_firestore/pubspec.yaml

@@ -3,7 +3,7 @@ description: Flutter plugin for Cloud Firestore, a cloud-hosted, noSQL database
   live synchronization and offline support on Android and iOS.
 author: Flutter Team <flutter-dev@googlegroups.com>
 homepage: https://github.com/FirebaseExtended/flutterfire/tree/master/packages/cloud_firestore
-version: 0.12.9+5
+version: 0.12.10
 
 flutter:
   plugin:

packages/cloud_firestore/test/cloud_firestore_test.dart

@@ -968,6 +968,32 @@ void main() {
           ),
         );
       });
+
+      test('FieldPath', () async {
+        await collectionReference
+            .where(FieldPath.documentId, isEqualTo: 'bar')
+            .getDocuments();
+        expect(
+          log,
+          equals(<Matcher>[
+            isMethodCall(
+              'Query#getDocuments',
+              arguments: <String, dynamic>{
+                'app': app.name,
+                'path': 'foo',
+                'isCollectionGroup': false,
+                'parameters': <String, dynamic>{
+                  'where': <List<dynamic>>[
+                    <dynamic>['__name__', '==', 'bar'],
+                  ],
+                  'orderBy': <List<dynamic>>[],
+                },
+                'source': 'default',
+              },
+            ),
+          ]),
+        );
+      });
     });
 
     group('FirestoreMessageCodec', () {