Add transaction to event slots

python/pycrdt/_array.py

@@ -387,7 +387,7 @@ class ArrayEvent(BaseEvent):
         path (list[int | str]): A list with the indices pointing to the array that was changed.
     """
 
-    __slots__ = "target", "delta", "path"
+    __slots__ = "target", "delta", "path", "transaction"
 
 
 class ArrayIterator:

python/pycrdt/_base.py

@@ -2,6 +2,7 @@
 
 import threading
 from abc import ABC, abstractmethod
+from collections import Counter
 from functools import lru_cache, partial
 from inspect import signature
 from typing import TYPE_CHECKING, Any, Callable, Type, cast, get_type_hints
@@ -11,7 +12,7 @@
 from ._pycrdt import Doc as _Doc
 from ._pycrdt import Subscription
 from ._pycrdt import Transaction as _Transaction
-from ._transaction import ReadTransaction, Transaction
+from ._transaction import BaseTransaction, ReadTransaction, Transaction
 
 if TYPE_CHECKING:
     from ._doc import Doc
@@ -26,6 +27,55 @@ def forbid_read_transaction(txn: Transaction):
         raise RuntimeError("Read-only transaction cannot be used to modify document structure")
 
 
+def hash_origin(origin: Any) -> int:
+    try:
+        return hash(origin)
+    except Exception:
+        raise TypeError("Origin must be hashable")
+
+
+class Origins:
+    """Mapping of origins to their ID."""
+
+    def __init__(self) -> None:
+        self._map: dict[int, Any] = {}
+        self._counter = Counter[int]()
+
+    def __len__(self) -> int:
+        """Return the number of origins."""
+        return len(self._map)
+
+    def add(self, value: Any) -> int:
+        """Add a new origin.
+
+        Args:
+            value: Origin
+        Returns:
+            The origin ID.
+        """
+        key = hash_origin(value)
+        if key not in self._map:
+            self._map[key] = value
+        self._counter.update([key])
+
+        return key
+
+    def get(self, key: int) -> Any | None:
+        """Get the origin by its ID.
+
+        Returns:
+            The origin or None if not found.
+        """
+        return self._map.get(key)
+
+    def remove(self, key: int) -> None:
+        """Remove the origin by its ID."""
+        if key in self._map:
+            self._counter.subtract([key])
+            if self._counter[key] == 0:
+                del self._map[key]
+
+
 class BaseDoc:
     _doc: _Doc
     _twin_doc: BaseDoc | None
@@ -35,7 +85,7 @@ class BaseDoc:
     _allow_multithreading: bool
     _Model: Any
     _subscriptions: list[Subscription]
-    _origins: dict[int, Any]
+    _origins: Origins
 
     def __init__(
         self,
@@ -55,7 +105,7 @@ def __init__(
         self._txn_async_lock = anyio.Lock()
         self._Model = Model
         self._subscriptions = []
-        self._origins = {}
+        self._origins = Origins()
         self._allow_multithreading = allow_multithreading
 
 
@@ -237,6 +287,8 @@ def process_event(value: Any, doc: Doc) -> Any:
     elif isinstance(value, dict):
         for key, val in value.items():
             value[key] = process_event(val, doc)
+    elif isinstance(value, _Transaction):
+        value = BaseTransaction(doc, doc._origins.get(value.origin()))
     else:
         val_type = type(value)
         if val_type in base_types:

python/pycrdt/_map.py

@@ -363,7 +363,7 @@ class MapEvent(BaseEvent):
         path (list[int | str]): A list with the indices pointing to the map that was changed.
     """
 
-    __slots__ = "target", "keys", "path"
+    __slots__ = "target", "keys", "path", "transaction"
 
 
 base_types[_Map] = Map

python/pycrdt/_text.py

@@ -315,7 +315,7 @@ class TextEvent(BaseEvent):
         path (list[int | str]): A list with the indices pointing to the text that was changed.
     """
 
-    __slots__ = "target", "delta", "path"
+    __slots__ = "target", "delta", "path", "transaction"
 
 
 base_types[_Text] = Text

python/pycrdt/_transaction.py

@@ -2,7 +2,7 @@
 
 from functools import partial
 from types import TracebackType
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, cast
 
 from anyio import to_thread
 
@@ -12,7 +12,38 @@
     from ._doc import Doc
 
 
-class Transaction:
+class BaseTransaction:
+    """
+    Base class for read-write and read-only transactions.
+
+    It allows to persist the origin of the transaction outside of its context.
+    """
+
+    _doc: Doc
+    _origin_hash: int | None
+
+    def __init__(
+        self,
+        doc: Doc,
+        origin: Any = None,
+    ) -> None:
+        self._doc = doc
+        if origin is None:
+            self._origin_hash = None
+        else:
+            self._origin_hash = doc._origins.add(origin)
+
+    def __del__(self) -> None:
+        if getattr(self, "_origin_hash", None) is not None:
+            self._doc._origins.remove(cast(int, self._origin_hash))
+
+    @property
+    def origin(self) -> Any:
+        """The origin of the transaction."""
+        return None if self._origin_hash is None else self._doc._origins.get(self._origin_hash)
+
+
+class Transaction(BaseTransaction):
     """
     A read-write transaction that can be used to mutate a document.
     It must be used with a context manager (see [Doc.transaction()][pycrdt.Doc.transaction]):
@@ -22,10 +53,8 @@ class Transaction:
     ```
     """
 
-    _doc: Doc
     _txn: _Transaction | None
     _leases: int
-    _origin_hash: int | None
     _timeout: float
 
     def __init__(
@@ -36,14 +65,9 @@ def __init__(
         origin: Any = None,
         timeout: float | None = None,
     ) -> None:
-        self._doc = doc
+        super().__init__(doc, origin)
         self._txn = _txn
         self._leases = 0
-        if origin is None:
-            self._origin_hash = None
-        else:
-            self._origin_hash = hash_origin(origin)
-            doc._origins[self._origin_hash] = origin
         self._timeout = -1 if timeout is None else timeout
 
     def __enter__(self, _acquire_transaction: bool = True) -> Transaction:
@@ -75,9 +99,6 @@ def __exit__(
             assert self._txn is not None
             if not isinstance(self, ReadTransaction):
                 self._txn.commit()
-                origin_hash = self._txn.origin()
-                if origin_hash is not None:
-                    del self._doc._origins[origin_hash]
                 if self._doc._allow_multithreading:
                     self._doc._txn_lock.release()
             self._txn.drop()
@@ -99,7 +120,7 @@ def origin(self) -> Any:
         if origin_hash is None:
             return None
 
-        return self._doc._origins[origin_hash]
+        return self._doc._origins.get(origin_hash)
 
 
 class NewTransaction(Transaction):
@@ -141,10 +162,3 @@ class ReadTransaction(Transaction):
     """
     A read-only transaction that cannot be used to mutate a document.
     """
-
-
-def hash_origin(origin: Any) -> int:
-    try:
-        return hash(origin)
-    except Exception:
-        raise TypeError("Origin must be hashable")

python/pycrdt/_undo.py

@@ -3,14 +3,13 @@
 from time import time_ns
 from typing import TYPE_CHECKING, Any, Callable
 
-from ._base import BaseType
+from ._base import BaseType, hash_origin
 from ._pycrdt import (
     StackItem,
 )
 from ._pycrdt import (
     UndoManager as _UndoManager,
 )
-from ._transaction import hash_origin
 
 if TYPE_CHECKING:
     from ._doc import Doc

python/pycrdt/_xml.py

@@ -310,7 +310,7 @@ def clear(self) -> None:
 
 
 class XmlEvent(BaseEvent):
-    __slots__ = ["children_changed", "target", "path", "delta", "keys"]
+    __slots__ = ["children_changed", "target", "path", "delta", "keys", "transaction"]
 
 
 class XmlAttributesView:

tests/test_array.py

@@ -126,8 +126,15 @@ def cb(events):
         deep_events.append(events)
 
     sid4 = array.observe_deep(cb)
-    array.append("bar")
-    assert str(deep_events[0][0]) == """{target: ["bar"], delta: [{'insert': ['bar']}], path: []}"""
+    origin = "test"
+    with doc.transaction(origin=origin):
+        array.append("bar")
+    assert deep_events[0]
+    event = deep_events[0][0]
+    assert str(event.target) == '["bar"]'
+    assert str(event.delta) == "[{'insert': ['bar']}]"
+    assert str(event.path) == "[]"
+    assert event.transaction.origin == origin
     deep_events.clear()
     array.unobserve(sid4)
     array.append("baz")

tests/test_map.py

@@ -142,11 +142,14 @@ def test_observe():
     events = []
 
     sub = map0.observe(partial(callback, events))
-    map0["0"] = 0
-    assert (
-        str(events[0])
-        == """{target: {"0":0}, keys: {'0': {'action': 'add', 'newValue': 0.0}}, path: []}"""
-    )
+    origin = "test-map"
+    with doc.transaction(origin=origin):
+        map0["0"] = 0
+    event = events[0]
+    assert str(event.target) == '{"0":0}'
+    assert str(event.keys) == "{'0': {'action': 'add', 'newValue': 0.0}}"
+    assert event.path == []
+    assert event.transaction.origin == origin
     events.clear()
     map0.unobserve(sub)
     map0["1"] = 1
@@ -155,10 +158,11 @@ def test_observe():
     deep_events = []
     sub = map1.observe_deep(partial(callback_deep, deep_events))
     map1["1"] = 1
-    assert (
-        str(deep_events[0][0])
-        == """{target: {"1":1}, keys: {'1': {'action': 'add', 'newValue': 1.0}}, path: []}"""
-    )
+    event = deep_events[0][0]
+    assert str(event.target) == '{"1":1}'
+    assert str(event.keys) == "{'1': {'action': 'add', 'newValue': 1.0}}"
+    assert event.path == []
+    assert event.transaction.origin is None
     deep_events.clear()
     map1.unobserve(sub)
     map1["0"] = 0

tests/test_text.py

@@ -1,3 +1,5 @@
+import re
+
 import pytest
 from pycrdt import Array, Doc, Map, Text
 
@@ -161,5 +163,18 @@ def callback(event):
         events.append(event)
 
     sub = text.observe(callback)  # noqa: F841
-    text += hello
-    assert str(events[0]) == """{target: Hello, delta: [{'insert': 'Hello'}], path: []}"""
+    origin = "test-text"
+    with doc.transaction(origin=origin):
+        text += hello
+    event = events[0]
+    assert str(event.target) == hello
+    assert str(event.delta) == f"[{{'insert': '{hello}'}}]"
+    assert event.path == []
+    assert event.transaction.origin == origin
+    assert (
+        re.match(
+            r"{target: Hello, delta: \[{'insert': 'Hello'}\], path: \[\], transaction: <[\w\.]+ object at 0x[a-fA-F\d]+>}",  # noqa E501
+            str(event),
+        )
+        is not None
+    ), "Event string representation"

tests/test_transaction.py

@@ -1,17 +1,22 @@
+import platform
 import sys
 import time
 from functools import partial
 
 import pytest
 from anyio import create_task_group, fail_after, sleep, to_thread
 from pycrdt import Array, Doc, Map, Text
+from pycrdt._base import hash_origin
 
 if sys.version_info < (3, 11):
     from exceptiongroup import ExceptionGroup  # pragma: no cover
 
 pytestmark = pytest.mark.anyio
 
 
+IS_CPYTHON = platform.python_implementation() == "CPython"
+
+
 def test_callback_transaction():
     text = Text()
     array = Array()
@@ -91,13 +96,15 @@ def callback(event, txn):
             assert txn0.origin == origin0
             assert txn1.origin == origin0
             assert len(doc0._origins) == 1
-            assert list(doc0._origins.values())[0] == origin0
-            assert doc0._origins == doc1._origins
+            hashed_origin = hash_origin(origin0)
+            assert doc0._origins.get(hashed_origin) == origin0
+            assert doc1._origins.get(hashed_origin) == origin0
         assert len(doc0._origins) == 1
-        assert list(doc0._origins.values())[0] == origin0
-        assert len(doc1._origins) == 0
-    assert len(doc0._origins) == 0
-    assert len(doc1._origins) == 0
+        assert doc0._origins.get(hash_origin(origin0)) == origin0
+        del txn1
+        assert (doc1._origins.get(hashed_origin) is None) is (True if IS_CPYTHON else False)
+    del txn0
+    assert (doc1._origins.get(hashed_origin) is None) is (True if IS_CPYTHON else False)
 
     with doc0.transaction(origin=123):
         with doc0.transaction(origin=123):