fix: limit data transferred as part of list_documents as we don't require field data (#280)

* fix: limit data transferred as part of list_documents as we don't require field data

Author: crwilcox

google/cloud/firestore_v1/base_collection.py

@@ -183,6 +183,10 @@ def _prep_list_documents(
             "collection_id": self.id,
             "page_size": page_size,
             "show_missing": True,
+            # list_documents returns an iterator of document references, which do not
+            # include any fields. To save on data transfer, we can set a field_path mask
+            # to include no fields
+            "mask": {"field_paths": None},
         }
         kwargs = _helpers.make_retry_timeout_kwargs(retry, timeout)
 

tests/unit/v1/test_async_collection.py

@@ -252,6 +252,7 @@ async def _next_page(self):
                 "collection_id": collection.id,
                 "page_size": page_size,
                 "show_missing": True,
+                "mask": {"field_paths": None},
             },
             metadata=client._rpc_metadata,
             **kwargs,

tests/unit/v1/test_collection.py

@@ -245,6 +245,7 @@ def _next_page(self):
                 "collection_id": collection.id,
                 "page_size": page_size,
                 "show_missing": True,
+                "mask": {"field_paths": None},
             },
             metadata=client._rpc_metadata,
             **kwargs,