RDBC-839 Test for custom find identity property

Author: poissoncorp

ravendb/documents/conventions.py

@@ -68,7 +68,7 @@ def __init__(self):
 
         # Utilities
         self.document_id_generator: Optional[Callable[[str, object], str]] = None
-        self._get_identity_property_name: Callable[[Type[Any]], str] = lambda type_: "Id"
+        self._find_identity_property_name: Callable[[Type[Any]], str] = lambda type_: "Id"
         self._id_property_name_cache: Dict[Type, str] = {}
         self._find_python_class: Optional[Callable[[str, Dict], str]] = None
         self._find_collection_name: Callable[[Type], str] = self.default_get_collection_name
@@ -225,6 +225,14 @@ def disable_atomic_document_writes_in_cluster_wide_transaction(self, value: bool
         self._assert_not_frozen()
         self._disable_atomic_document_writes_in_cluster_wide_transaction = value
 
+    @property
+    def find_identity_property_name(self) -> Callable[[Type[Any]], str]:
+        return self._find_identity_property_name
+
+    @find_identity_property_name.setter
+    def find_identity_property_name(self, find_identity_property_name_function: Callable[[Type[Any]], str]):
+        self._find_identity_property_name = find_identity_property_name_function
+
     @staticmethod
     def json_default(o):
         if o is None:
@@ -376,7 +384,7 @@ def clone(self) -> DocumentConventions:
         cloned._save_enums_as_integers = self._save_enums_as_integers
         cloned.identity_parts_separator = self.identity_parts_separator
         cloned.disable_topology_updates = self.disable_topology_updates
-        cloned._get_identity_property_name = self._get_identity_property_name
+        cloned._find_identity_property_name = self._find_identity_property_name
 
         cloned.document_id_generator = self.document_id_generator
 
@@ -397,7 +405,7 @@ def get_identity_property_name(self, object_type: Type[Any]) -> Optional[str]:
         if object_type in self._id_property_name_cache:
             return self._id_property_name_cache[object_type]
 
-        id_property_name = self._get_identity_property_name(object_type)
+        id_property_name = self.find_identity_property_name(object_type)
 
         # Cache the result
         self._id_property_name_cache[object_type] = id_property_name

ravendb/tests/session_tests/test_conventions.py

@@ -0,0 +1,40 @@
+from typing import Type, Any
+
+from ravendb import DocumentStore
+from ravendb.infrastructure.orders import Company
+from ravendb.tests.test_base import TestBase
+
+
+class TestConventions(TestBase):
+    def setUp(self):
+        super().setUp()
+
+    def test_custom_find_identity_property_name(self):
+        store = DocumentStore(self.store.urls, self.store.database)
+
+        class MyUniqueCompany(Company):
+            def __init__(self, name: str = None, Id: str = None):
+                super().__init__(Id=Id, name=name)
+                self.special_identity_field: str = "MySpecialCompanies/unique"
+
+        def _find_identity_property_name(object_type: Type[Any]) -> str:
+            if object_type is MyUniqueCompany:
+                return "special_identity_field"
+            return "Id"
+
+        store.conventions.find_identity_property_name = _find_identity_property_name
+        store.initialize()
+
+        with store.open_session() as session:
+            session.store(MyUniqueCompany(name="Borpa Corp", Id="PerfectlyRelevantDocumentId/1"))
+            session.store(Company(name="Poissoncorp", Id="companies/1"))
+            session.save_changes()
+
+        with store.open_session() as session:
+            non_existing_company = session.load("PerfectlyRelevantDocumentId/1", MyUniqueCompany)
+            custom_id_field_company = session.load("MySpecialCompanies/unique", MyUniqueCompany)
+            regular_company = session.load("companies/1", Company)
+
+            self.assertIsNone(non_existing_company)
+            self.assertEqual("Borpa Corp", custom_id_field_company.name)
+            self.assertEqual("Poissoncorp", regular_company.name)