Reinstate removed EventBase methods

changelog.d/19712.misc

@@ -0,0 +1 @@
+Small simplifications to the events class.

synapse/events/__init__.py

@@ -34,6 +34,7 @@
 )
 
 import attr
+from typing_extensions import deprecated
 from unpaddedbase64 import encode_base64
 
 from synapse.api.constants import (
@@ -219,6 +220,9 @@ def __init__(
     state_key: DictProperty[str] = DictProperty("state_key")
     type: DictProperty[str] = DictProperty("type")
 
+    # This is a deprecated property, use `sender` instead. Only used by modules.
+    user_id: DictProperty[str] = DictProperty("sender")
+
     @property
     def event_id(self) -> str:
         raise NotImplementedError()
@@ -360,6 +364,11 @@ def __repr__(self) -> str:
             ">"
         )
 
+    # Using `__getitem__` is deprecated. Only used by modules.
+    @deprecated("Use attribute access instead")
+    def __getitem__(self, field: str) -> Any | None:
+        return self._dict[field]
+
 
 class FrozenEvent(EventBase):
     format_version = EventFormatVersions.ROOM_V1_V2  # All events of this type are V1

tests/module_api/test_api.py

@@ -828,6 +828,24 @@ async def _on_logged_out_mock(
         # Ensure the pushers were deleted after the callback.
         self.assertEqual(len(self.hs.get_pusherpool().pushers[user_id].values()), 0)
 
+    def test_event_deprecated_methods(self) -> None:
+        """Test that deprecated methods on events are still functional."""
+        user_id = self.register_user("user", "password")
+        tok = self.login("user", "password")
+
+        room_id = self.helper.create_room_as(tok=tok)
+
+        state = self.get_success(
+            self.hs.get_storage_controllers().state.get_current_state(room_id)
+        )
+        create_event = state[(EventTypes.Create, "")]
+
+        # `.user_id` is a deprecated alias for `.sender`.
+        self.assertEqual(create_event.user_id, user_id)
+
+        # The event supports looking up keys via `__getitem__` although deprecated
+        self.assertEqual(create_event["room_id"], room_id)
+
 
 class ModuleApiWorkerTestCase(BaseModuleApiTestCase, BaseMultiWorkerStreamTestCase):
     """For testing ModuleApi functionality in a multi-worker setup"""