BUG32778827: Raise an error if the _id is different when replacing a document

If a document provided for replacement, using the Collection.replace_one()
or Collection.add_or_replace_one() methods, contains an "_id" different
from the original document, the new "_id" is ignored.

This patch fixes this error by raising an error if the "_id" in the
document provided for replacement is different from the original.

Tests were added for regression.

Author: nmariz

CHANGES.txt

@@ -14,6 +14,7 @@ v8.0.26
 - WL#14542: Deprecate TLS 1.0 and 1.1
 - WL#14440: Support for authentication_kerberos_client authentication plugin
 - WL#14237: Support query attributes
+- BUG#32778827: Raise an error if the _id is different when replacing a document
 - BUG#32623479: The X DevAPI returns str for binary types values
 
 v8.0.25

lib/mysqlx/crud.py

@@ -551,6 +551,11 @@ def replace_one(self, doc_id, doc):
             doc_id (str): Document ID
             doc (:class:`mysqlx.DbDoc` or `dict`): New Document
         """
+        if "_id" in doc and doc["_id"] != doc_id:
+            raise ProgrammingError(
+                "Replacement document has an _id that is different than the "
+                "matched document"
+            )
         return self.modify("_id = :id").set("$", doc) \
                    .bind("id", doc_id).execute()
 
@@ -562,6 +567,11 @@ def add_or_replace_one(self, doc_id, doc):
             doc_id (str): Document ID
             doc (:class:`mysqlx.DbDoc` or dict): New Document
         """
+        if "_id" in doc and doc["_id"] != doc_id:
+            raise ProgrammingError(
+                "Replacement document has an _id that is different than the "
+                "matched document"
+            )
         if not isinstance(doc, DbDoc):
             doc = DbDoc(doc)
         return self.add(doc.copy(doc_id)).upsert(True).execute()

lib/mysqlx/dbdoc.py

@@ -1,4 +1,4 @@
-# Copyright (c) 2016, 2019, Oracle and/or its affiliates. All rights reserved.
+# Copyright (c) 2016, 2021, Oracle and/or its affiliates. All rights reserved.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0, as
@@ -74,6 +74,9 @@ def __setitem__(self, index, value):
     def __getitem__(self, index):
         return self.__dict__[index]
 
+    def __contains__(self, item):
+        return item in self.__dict__
+
     def copy(self, doc_id=None):
         """Returns a new copy of a :class:`mysqlx.DbDoc` object containing the
         `doc_id` provided. If `doc_id` is not provided, it will be removed from

tests/test_mysqlx_crud.py

@@ -1840,6 +1840,17 @@ def test_replace_one(self):
         result = collection.find("age = 21").execute().fetch_one()
         self.assertEqual("George", result["name"])
 
+        doc = {"_id": "5", "name": "Fred", "age": 21}
+        self.assertRaises(
+            mysqlx.ProgrammingError,
+            collection.replace_one, "1", doc
+        )
+        doc = mysqlx.DbDoc({"_id": "5", "name": "Fred", "age": 21})
+        self.assertRaises(
+            mysqlx.ProgrammingError,
+            collection.replace_one, "1", doc
+        )
+
         self.schema.drop_collection(collection_name)
 
     @unittest.skipIf(tests.MYSQL_VERSION < (8, 0, 2), "Upsert not supported")
@@ -1863,12 +1874,23 @@ def test_add_or_replace_one(self):
 
         result = collection.find("_id = 'new_id'").execute().fetch_all()
         self.assertEqual(0, len(result))
-        upsert = {"_id": "11", 'name': 'Melissandre', "age": 99999}
+        upsert = {'name': 'Melissandre', "age": 99999}
         collection.add_or_replace_one("new_id", upsert)
         result = collection.find("age = 99999").execute().fetch_one()
         self.assertEqual("Melissandre", result["name"])
         self.assertEqual("new_id", result["_id"])
 
+        doc = {"_id": "5", "name": "Fred", "age": 21}
+        self.assertRaises(
+            mysqlx.ProgrammingError,
+            collection.add_or_replace_one, "1", doc
+        )
+        doc = mysqlx.DbDoc({"_id": "5", "name": "Fred", "age": 21})
+        self.assertRaises(
+            mysqlx.ProgrammingError,
+            collection.add_or_replace_one, "1", doc
+        )
+
         self.schema.drop_collection(collection_name)
 
     def test_get_one(self):