RDBC-1023: add session.advanced.what_changed_for(entity) and get_tracked_entities()

C# Advanced.WhatChangedFor(entity) returns DocumentsChanges[] for a single entity. Python had no equivalent. Added _what_changed_for() to InMemoryDocumentSessionOperations and exposed it via Advanced.what_changed_for().

Matches C# behaviour: returns [DocumentDeleted] immediately when the entity has been deleted in the same session, before running the JSON diff.

C# Advanced.GetTrackedEntities() returns a dict of all entities currently tracked by the session (stored and deleted). Added _get_tracked_entities() to InMemoryDocumentSessionOperations and exposed it via Advanced.get_tracked_entities(). Each entry maps document ID to a dict with keys: id, entity, is_deleted. Matches C# behaviour: entries deleted by string ID (present in _known_missing_ids but absent from _deleted_entities) appear with is_deleted=True.

Regression tests: test_session_advanced_api.py verifies that what_changed_for() returns per-entity changes and correctly reports DocumentDeleted when the entity is deleted before the call; get_tracked_entities() includes newly stored entities with is_deleted=False and entries deleted by string id with is_deleted=True.

Author: redknightlois

ravendb/documents/session/document_info.py

@@ -44,4 +44,5 @@ def get_new_document_info(cls, document: Dict) -> DocumentInfo:
         if not change_vector or not isinstance(change_vector, str):
             raise ValueError(f"Document {key} must have a Change Vector")
 
+        # Shallow-copy metadata so mutations on this DocumentInfo don't alias the original document dict
         return cls(key=key, document=document, metadata=dict(metadata), entity=None, change_vector=change_vector)

ravendb/documents/session/document_session.py

@@ -803,6 +803,12 @@ def graph_query(self, object_type: type, query: str):  # -> GraphDocumentQuery:
         def what_changed(self) -> Dict[str, List[DocumentsChanges]]:
             return self._session._what_changed()
 
+        def what_changed_for(self, entity: object) -> List[DocumentsChanges]:
+            return self._session._what_changed_for(entity)
+
+        def get_tracked_entities(self) -> Dict[str, dict]:
+            return self._session._get_tracked_entities()
+
         def exists(self, key: str) -> bool:
             if key is None:
                 raise ValueError("Key cannot be None")

ravendb/documents/session/document_session_operations/in_memory_document_session_operations.py

@@ -1183,6 +1183,51 @@ def _what_changed(self) -> Dict[str, List[DocumentsChanges]]:
 
         return changes
 
+    def _what_changed_for(self, entity: object) -> List[DocumentsChanges]:
+        if (doc_info := self._documents_by_entity.get(entity)) is None:
+            return []
+        if entity in self._deleted_entities:
+            return [
+                DocumentsChanges(
+                    field_old_value="",
+                    field_new_value="",
+                    change=DocumentsChanges.ChangeType.DOCUMENT_DELETED,
+                )
+            ]
+        _update_metadata_modifications(doc_info.metadata_instance, doc_info.metadata)
+        new_obj = self.entity_to_json.convert_entity_to_json(entity, doc_info)
+        changes: Dict[str, List[DocumentsChanges]] = {}
+        if not self._entity_changed(new_obj, doc_info, changes):
+            return []
+        return [
+            DocumentsChanges(
+                field_old_value=d["old_value"],
+                field_new_value=d["new_value"],
+                change=d["change"],
+                field_name=d["field_name"],
+                field_path=d["field_path"],
+            )
+            for d in changes.get(doc_info.key, [])
+        ]
+
+    def _get_tracked_entities(self) -> Dict[str, dict]:
+        result = {}
+        for entity_result in self._documents_by_entity:
+            doc_info = entity_result.value
+            result[doc_info.key] = {
+                "id": doc_info.key,
+                "entity": entity_result.key,
+                "is_deleted": self.is_deleted(doc_info.key),
+            }
+        for key in self._known_missing_ids:
+            if key not in result:
+                result[key] = {
+                    "id": key,
+                    "entity": None,
+                    "is_deleted": True,
+                }
+        return result
+
     def __get_all_entities_changes(self, changes: Dict[str, List[DocumentsChanges]]) -> None:
         for key, value in self._documents_by_id.items():
             _update_metadata_modifications(value.metadata_instance, value.metadata)

ravendb/json/json_operation.py

@@ -193,7 +193,10 @@ def compare_json_array(field_path: str, key: str, old_collection, new_collection
                             DocumentsChanges.ChangeType.ARRAY_VALUE_CHANGED,
                         )
             elif isinstance(new_collection_item, (int, float, bool, str)):
-                if type(old_collection_item) != type(new_collection_item) or old_collection_item != new_collection_item:
+                if (
+                    type(old_collection_item) is not type(new_collection_item)
+                    or old_collection_item != new_collection_item
+                ):
                     if changes is not None:
                         JsonOperation.new_change(
                             JsonOperation.add_index_field_path(field_path, position),

ravendb/tests/session_tests/test_change_tracking_metadata.py

@@ -18,7 +18,7 @@ class TestRavenDBWhatChangedIdempotent(TestBase):
     def setUp(self):
         super().setUp()
 
-    def test_what_changed_is_idempotent_with_no_modifications(self):
+    def test_what_changed_should_be_idempotent_operation(self):
         """
         After saving a document and loading it without any modification,
         calling what_changed() twice must return the same (empty) result.
@@ -43,7 +43,7 @@ def test_what_changed_is_idempotent_with_no_modifications(self):
                 ),
             )
 
-    def test_what_changed_is_idempotent_with_field_change(self):
+    def test_what_changed_should_be_idempotent_operation_with_changes(self):
         """
         After modifying a field, calling what_changed() twice must return the
         same result both times.

ravendb/tests/session_tests/test_change_tracking_type_coercion.py

@@ -17,7 +17,7 @@ class TestRavenDBWhatChangedTypeCoercion(TestBase):
     def setUp(self):
         super().setUp()
 
-    def test_int_to_string_array_change_is_detected(self):
+    def test_ravendb_8169(self):
         """
         Changing array elements from int to string (same digit representation)
         must produce ARRAY_VALUE_CHANGED entries — one per changed element.
@@ -52,7 +52,7 @@ def test_int_to_string_array_change_is_detected(self):
             ),
         )
 
-    def test_int_to_string_change_is_detected_and_persisted(self):
+    def test_ravendb_8169_persisted(self):
         """
         After changing array elements from int to string, save_changes() persists
         the new string values to the server.