feat(firestore): adds OR filter query (GoogleCloudPlatform#9769)

* feat(firestore): adds OR filter query

* feat(firestore): more test

* lint

* fix

* lint

* update

* fixed tests

* region tag mismatch fix

* lint

* switched bulkwriter to transaction

* moar test fix

* test fix

* test fix

* test fix

* chore: refactor test fixture logic to explicitly use all fixtures, and add retry fixture components with backoff (GoogleCloudPlatform#9812)

* chore: update for linting

---------

Co-authored-by: nicain <[email protected]>

Author: telpirion

firestore/cloud-client/query_filter_or.py

@@ -0,0 +1,37 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# [START firestore_query_filter_or]
+from google.cloud import firestore
+from google.cloud.firestore_v1.base_query import FieldFilter, Or
+
+
+def query_or_composite_filter(project_id: str) -> None:
+    # Instantiate the Firestore client
+    client = firestore.Client(project=project_id)
+    col_ref = client.collection("users")
+
+    filter_1 = FieldFilter(u"birthYear", u"==", 1906)
+    filter_2 = FieldFilter(u"birthYear", u"==", 1912)
+
+    # Create the union filter of the two filters (queries)
+    or_filter = Or(filters=[filter_1, filter_2])
+
+    # Execute the query
+    docs = col_ref.where(filter=or_filter).stream()
+
+    print("Documents found:")
+    for doc in docs:
+        print(f"ID: {doc.id}")
+# [END firestore_query_filter_or]

firestore/cloud-client/query_filter_or_test.py

@@ -0,0 +1,69 @@
+# Copyright 2023 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the 'License');
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an 'AS IS' BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+
+import backoff
+from google.cloud import firestore
+import pytest
+
+from query_filter_or import query_or_composite_filter
+
+os.environ['GOOGLE_CLOUD_PROJECT'] = os.environ['FIRESTORE_PROJECT']
+PROJECT_ID = os.environ['FIRESTORE_PROJECT']
+
+
+@pytest.fixture(scope="module")
+def data():
+    return {
+            u'aturing': {u'birthYear': 1912},
+            u'cbabbage': {u'birthYear': 1791},
+            u'ghopper': {u'birthYear': 1906},
+            u'alovelace': {u'birthYear': 1815},
+    }
+
+
+@backoff.on_exception(backoff.expo, Exception, max_tries=3)
+def create_document(key, val, collection):
+    collection.document(key).set(val)
+
+
+def create_document_collection(data, collection):
+    for key, val in data.items():
+        create_document(key, val, collection)
+
+
+@backoff.on_exception(backoff.expo, Exception, max_tries=3)
+def delete_document(key, collection):
+    collection.document(key).delete()
+
+
+def delete_document_collection(data, collection):
+    for key in data:
+        delete_document(key, collection)
+
+
+@backoff.on_exception(backoff.expo, Exception, max_tries=3)
+def test_query_or_composite_filter(capsys, data):
+    client = firestore.Client(project=PROJECT_ID)
+    collection = client.collection('users')
+
+    try:
+        create_document_collection(data, collection)
+        query_or_composite_filter(PROJECT_ID)
+    finally:
+        delete_document_collection(data, collection)
+
+    out, _ = capsys.readouterr()
+    assert 'aturing' in out

firestore/cloud-client/requirements-test.txt

@@ -1,2 +1,3 @@
+backoff==2.2.1
 pytest==7.0.1
 flaky==3.7.0