Implement `MergeOption` as an option #4851

chemelnucfin · 2018-02-07T21:18:24Z

Should close #4111
The first and second commits is #4654.

firestore/google/cloud/firestore_v1beta1/_helpers.py

@@ -768,6 +763,22 @@ def get_doc_id(document_pb, expected_prefix):
    return document_id


+def get_field_paths(update_data):


firestore/google/cloud/firestore_v1beta1/_helpers.py

@@ -880,15 +891,16 @@ def pbs_for_set(document_path, document_data, option):
        or two ``Write`` protobuf instances for ``set()``.
    """
    transform_paths, actual_data = remove_server_timestamp(document_data)
-
    update_pb = write_pb2.Write(
        update=document_pb2.Document(
            name=document_path,
            fields=encode_dict(actual_data),
        ),
    )
    if option is not None:


firestore/google/cloud/firestore_v1beta1/client.py



 DEFAULT_DATABASE = '(default)'
 """str: The default database used in a :class:`~.firestore.client.Client`."""
 _BAD_OPTION_ERR = (
-    'Exactly one of ``create_if_missing``, ``last_update_time`` '
-    'and ``exists`` must be provided.')
+    'Exactly one of ``last_update_time`` or ``exists`` must be provided.')


firestore/google/cloud/firestore_v1beta1/client.py

-        elif not self._create_if_missing:
-            current_doc = types.Precondition(exists=True)
-            write_pb.current_document.CopyFrom(current_doc)
+        mask = common_pb2.DocumentMask(field_paths=sorted(field_paths))


schmidt-sebastian

This looks pretty close from a functional perspective. Some comments (mostly small nits) remaining.

Can you send this over to someone that understands Python after you resolved these last comments? Thanks!

firestore/google/cloud/firestore_v1beta1/_helpers.py

+            for sub_path in sub_transform_paths:
+                field_path = FieldPath.from_string(field_name)
+                field_path.parts = field_path.parts + sub_path.parts
+                transform_paths.extend([field_path])


firestore/google/cloud/firestore_v1beta1/_helpers.py

+            if split_on_dots:
+                transform_paths.append(FieldPath(*field_name.split(".")))
+            else:
+                transform_paths.append(FieldPath.from_string(field_name))


firestore/google/cloud/firestore_v1beta1/_helpers.py

-    else:
-        return field_paths, document_data
+            field_paths.append(FieldPath(field_name))
+    if not transform_paths:


firestore/google/cloud/firestore_v1beta1/client.py

@@ -39,8 +39,8 @@
 DEFAULT_DATABASE = '(default)'
 """str: The default database used in a :class:`~.firestore.client.Client`."""
 _BAD_OPTION_ERR = (
-    'Exactly one of ``create_if_missing``, ``last_update_time`` '
-    'and ``exists`` must be provided.')
+    'Exactly one of ``last_update_time``, ``exists`` '


firestore/tests/system.py


-    # 1. Use ``set()`` to create the document (using an option).
+    # 1. Use ``create()`` to create the document (using an option).


firestore/tests/system.py


    data2 = {'1a.ab': '4d', '6f.7g': '9h'}
-    option2 = client.write_option(create_if_missing=True)
+    option2 = client.write_option(exists=True)


firestore/tests/system.py

+    snapshot = document.get()
+    assert not snapshot.exists
+
+    # 1. Use ``set()`` to create the document (using an option).


firestore/tests/unit/test_cross_language.py

                self.run_write_test(test_proto, desc)
+            except (AssertionError, Exception) as error:
+                count += 1


firestore/tests/unit/test_cross_language.py

        elif kind == "set":
            tp = test_proto.set
            client, doc = self.setup(firestore_api, tp)
            data = convert_data(json.loads(tp.json_data))
-            # TODO: call doc.set.
+            if tp.HasField("option"):
+                option = True


mikedh · 2018-10-16T02:59:39Z

Hey, this finally made it to Pypi in a release, and unfortunately broke some things for me. This PR removes firestore.CreateIfMissingOption, which is still recommended in the Firebase docs. The docs:

If the document does not exist, it will be created. If the document does exist, its contents will be overwritten with the newly provided data, unless you specify that the data should be merged into the existing document, as follows:

# The option to merge data is not yet available for Python. Instead, call the
# update method and pass the option to create the document if it's missing.

city_ref = db.collection(u'cities').document(u'BJ')

city_ref.update({
    u'capital': True
}, firestore.CreateIfMissingOption(True))

It looks like the migration here is (?):

city_ref.update({
    u'capital': True}, merge=True)

Given the arg ordering, an ugly backwards compatibility patch could be:

CreateIfMissingOption = lambda x : bool(x)

tseaver · 2018-10-16T14:45:58Z

@mikedh The Firestore API team explicitly asked us to remove CreateIfMissingOption from the API surface of google-cloud-firestore.

@schmidt-sebastian Can you comment here?

samtstern · 2018-10-16T14:50:56Z

That's the correct API change, just looks like it took a bit longer for it to land in Python than the other SDKs and we didn't time the doc updates with the release. I'll get the docs updated.

samtstern · 2018-10-16T15:03:58Z

Fixing here:
GoogleCloudPlatform/python-docs-samples#1767

mikedh · 2018-10-16T19:44:59Z

Thanks! The API change seems like an improvement.

chemelnucfin requested a review from lukesneeringer as a code owner February 7, 2018 21:18

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Feb 7, 2018

chemelnucfin added type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. api: firestore Issues related to the Firestore API. labels Feb 7, 2018

chemelnucfin force-pushed the firestore_merge_option branch from 77795e1 to 2efc83f Compare February 7, 2018 22:35

chemelnucfin closed this Feb 7, 2018

chemelnucfin reopened this Feb 8, 2018

chemelnucfin force-pushed the firestore_merge_option branch from 2efc83f to 16c9588 Compare February 8, 2018 00:20

chemelnucfin removed the type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. label Feb 8, 2018

chemelnucfin force-pushed the firestore_merge_option branch from 16c9588 to c5e2ed4 Compare February 8, 2018 04:33

chemelnucfin requested a review from tseaver as a code owner February 8, 2018 04:33

googlebot added cla: no This human has *not* signed the Contributor License Agreement. and removed cla: yes This human has signed the Contributor License Agreement. labels Feb 8, 2018

chemelnucfin force-pushed the firestore_merge_option branch from c5e2ed4 to 03dc67f Compare February 8, 2018 04:35

chemelnucfin added cla: yes This human has signed the Contributor License Agreement. and removed cla: no This human has *not* signed the Contributor License Agreement. labels Feb 8, 2018

googleapis deleted a comment from googlebot Feb 8, 2018

chemelnucfin mentioned this pull request Feb 8, 2018

Firestore integer simple fields #4858

Closed

chemelnucfin changed the title ~~Firestore merge option~~ Implement MergeOption as an option Feb 20, 2018

chemelnucfin self-assigned this Feb 20, 2018

This was referenced Feb 22, 2018

Remove CreateIfMissing option #4654

Closed

firestore.CreateIfMissingOption should be replaced #4111

Closed

chemelnucfin force-pushed the firestore_merge_option branch 2 times, most recently from 08f0ee5 to e0d9b28 Compare March 25, 2018 16:52

schmidt-sebastian suggested changes Mar 28, 2018

View reviewed changes

chemelnucfin force-pushed the firestore_merge_option branch 4 times, most recently from 7eec589 to 1af5b12 Compare March 28, 2018 18:57

chemelnucfin force-pushed the firestore_merge_option branch 3 times, most recently from fa1e5d0 to 53159e9 Compare April 6, 2018 14:51

chemelnucfin added 9 commits April 6, 2018 11:56

Firestore: Remove CreateIfMissing option

b8b7f97

Review Changes

e44f7b6

MergeOption

45e23d6

Review Changes

1341080

Merge Option True

6e1c926

Pass conformance tests

f37fac5

Review Changes

cf2149e

Firestore: split on dots

56071b6

Firestore: Implement firestore merge as a boolean

421efcd

chemelnucfin force-pushed the firestore_merge_option branch from 2ea0832 to 93f0441 Compare April 6, 2018 18:57

Remove extract_field_paths

138111b

chemelnucfin force-pushed the firestore_merge_option branch from 93f0441 to 138111b Compare April 6, 2018 19:00

schmidt-sebastian suggested changes Apr 6, 2018

View reviewed changes

Review Changes

b166f06

chemelnucfin force-pushed the firestore_merge_option branch from 10d612b to b166f06 Compare April 6, 2018 20:39

schmidt-sebastian approved these changes Apr 6, 2018

View reviewed changes

tseaver merged commit dd4b646 into googleapis:master Apr 10, 2018

chemelnucfin deleted the firestore_merge_option branch April 10, 2018 19:18

tseaver mentioned this pull request Apr 10, 2018

Add 'FieldPath.__repr__' #5112

Closed

samtstern mentioned this pull request Oct 16, 2018

Cloud Firestore remove CreateIfMissingOption GoogleCloudPlatform/python-docs-samples#1766

Closed

tseaver mentioned this pull request Oct 23, 2018

Firestore: conformance tests hiding failures #6290

Closed

yoskmr mentioned this pull request May 20, 2020

Fixed merge option joewalk102/firebase-orm#1

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement `MergeOption` as an option #4851

Implement `MergeOption` as an option #4851

chemelnucfin commented Feb 7, 2018 •

edited

Loading

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

schmidt-sebastian left a comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

mikedh commented Oct 16, 2018

tseaver commented Oct 16, 2018

samtstern commented Oct 16, 2018

samtstern commented Oct 16, 2018

mikedh commented Oct 16, 2018

		@@ -768,6 +763,22 @@ def get_doc_id(document_pb, expected_prefix):
		return document_id


		def get_field_paths(update_data):


		# 1. Use ``set()`` to create the document (using an option).
		# 1. Use ``create()`` to create the document (using an option).

Implement MergeOption as an option #4851

Implement MergeOption as an option #4851

Conversation

chemelnucfin commented Feb 7, 2018 • edited Loading

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

schmidt-sebastian left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

mikedh commented Oct 16, 2018

tseaver commented Oct 16, 2018

samtstern commented Oct 16, 2018

samtstern commented Oct 16, 2018

mikedh commented Oct 16, 2018

Implement `MergeOption` as an option #4851

Implement `MergeOption` as an option #4851

chemelnucfin commented Feb 7, 2018 •

edited

Loading