Construct the EventContext in the state handler rather than constructing one and then immediately calling state_handler.annotate_context_with_state

3 files changed, 34 insertions, 36 deletions

diff --git a/tests/handlers/test_federation.py b/tests/handlers/test_federation.py
index ed351367cc..ed21defd13 100644
--- a/tests/handlers/test_federation.py
+++ b/tests/handlers/test_federation.py
@@ -34,7 +34,7 @@ class FederationTestCase(unittest.TestCase):
         self.mock_config.signing_key = [MockKey()]
 
         self.state_handler = NonCallableMock(spec_set=[
-            "annotate_context_with_state",
+            "compute_event_context",
         ])
 
         self.auth = NonCallableMock(spec_set=[
@@ -91,11 +91,12 @@ class FederationTestCase(unittest.TestCase):
         self.datastore.get_room.return_value = defer.succeed(True)
         self.auth.check_host_in_room.return_value = defer.succeed(True)
 
-        def annotate(ev, context, old_state=None):
+        def annotate(ev, old_state=None):
+            context = Mock()
             context.current_state = {}
             context.auth_events = {}
-            return defer.succeed(False)
-        self.state_handler.annotate_context_with_state.side_effect = annotate
+            return defer.succeed(context)
+        self.state_handler.compute_event_context.side_effect = annotate
 
         yield self.handlers.federation_handler.on_receive_pdu(
             "fo", pdu, False
@@ -109,15 +110,12 @@ class FederationTestCase(unittest.TestCase):
             context=ANY,
         )
 
-        self.state_handler.annotate_context_with_state.assert_called_once_with(
-            ANY,
-            ANY,
-            old_state=None,
+        self.state_handler.compute_event_context.assert_called_once_with(
+            ANY, old_state=None,
         )
 
         self.auth.check.assert_called_once_with(ANY, auth_events={})
 
         self.notifier.on_new_room_event.assert_called_once_with(
-            ANY,
-            extra_users=[]
+            ANY, extra_users=[]
         )
diff --git a/tests/handlers/test_room.py b/tests/handlers/test_room.py
index 83493cae20..0cb8aa4fbc 100644
--- a/tests/handlers/test_room.py
+++ b/tests/handlers/test_room.py
@@ -60,7 +60,7 @@ class RoomMemberHandlerTestCase(unittest.TestCase):
                 "check_host_in_room",
             ]),
             state_handler=NonCallableMock(spec_set=[
-                "annotate_context_with_state",
+                "compute_event_context",
                 "get_current_state",
             ]),
             config=self.mock_config,
@@ -110,7 +110,8 @@ class RoomMemberHandlerTestCase(unittest.TestCase):
             defer.succeed([])
         )
 
-        def annotate(_, ctx):
+        def annotate(_):
+            ctx = Mock()
             ctx.current_state = {
                 (EventTypes.Member, "@alice:green"): self._create_member(
                     user_id="@alice:green",
@@ -121,10 +122,11 @@ class RoomMemberHandlerTestCase(unittest.TestCase):
                     room_id=room_id,
                 ),
             }
+            ctx.prev_state_events = []
 
-            return defer.succeed(True)
+            return defer.succeed(ctx)
 
-        self.state_handler.annotate_context_with_state.side_effect = annotate
+        self.state_handler.compute_event_context.side_effect = annotate
 
         def add_auth(_, ctx):
             ctx.auth_events = ctx.current_state[
@@ -146,8 +148,8 @@ class RoomMemberHandlerTestCase(unittest.TestCase):
 
         yield room_handler.change_membership(event, context)
 
-        self.state_handler.annotate_context_with_state.assert_called_once_with(
-            builder, context
+        self.state_handler.compute_event_context.assert_called_once_with(
+            builder
         )
 
         self.auth.add_auth_events.assert_called_once_with(
@@ -189,7 +191,8 @@ class RoomMemberHandlerTestCase(unittest.TestCase):
             defer.succeed([])
         )
 
-        def annotate(_, ctx):
+        def annotate(_):
+            ctx = Mock()
             ctx.current_state = {
                 (EventTypes.Member, "@bob:red"): self._create_member(
                     user_id="@bob:red",
@@ -197,10 +200,11 @@ class RoomMemberHandlerTestCase(unittest.TestCase):
                     membership=Membership.INVITE
                 ),
             }
+            ctx.prev_state_events = []
 
-            return defer.succeed(True)
+            return defer.succeed(ctx)
 
-        self.state_handler.annotate_context_with_state.side_effect = annotate
+        self.state_handler.compute_event_context.side_effect = annotate
 
         def add_auth(_, ctx):
             ctx.auth_events = ctx.current_state[
@@ -262,7 +266,8 @@ class RoomMemberHandlerTestCase(unittest.TestCase):
             defer.succeed([])
         )
 
-        def annotate(_, ctx):
+        def annotate(_):
+            ctx = Mock()
             ctx.current_state = {
                 (EventTypes.Member, "@bob:red"): self._create_member(
                     user_id="@bob:red",
@@ -270,10 +275,11 @@ class RoomMemberHandlerTestCase(unittest.TestCase):
                     membership=Membership.JOIN
                 ),
             }
+            ctx.prev_state_events = []
 
-            return defer.succeed(True)
+            return defer.succeed(ctx)
 
-        self.state_handler.annotate_context_with_state.side_effect = annotate
+        self.state_handler.compute_event_context.side_effect = annotate
 
         def add_auth(_, ctx):
             ctx.auth_events = ctx.current_state[
diff --git a/tests/test_state.py b/tests/test_state.py
index 197e35f140..98ad9e54cd 100644
--- a/tests/test_state.py
+++ b/tests/test_state.py
@@ -38,7 +38,6 @@ class StateTestCase(unittest.TestCase):
     @defer.inlineCallbacks
     def test_annotate_with_old_message(self):
         event = self.create_event(type="test_message", name="event")
-        context = Mock()
 
         old_state = [
             self.create_event(type="test1", state_key="1"),
@@ -46,8 +45,8 @@ class StateTestCase(unittest.TestCase):
             self.create_event(type="test2", state_key=""),
         ]
 
-        yield self.state.annotate_context_with_state(
-            event, context, old_state=old_state
+        context = yield self.state.compute_event_context(
+            event, old_state=old_state
         )
 
         for k, v in context.current_state.items():
@@ -64,7 +63,6 @@ class StateTestCase(unittest.TestCase):
     @defer.inlineCallbacks
     def test_annotate_with_old_state(self):
         event = self.create_event(type="state", state_key="", name="event")
-        context = Mock()
 
         old_state = [
             self.create_event(type="test1", state_key="1"),
@@ -72,8 +70,8 @@ class StateTestCase(unittest.TestCase):
             self.create_event(type="test2", state_key=""),
         ]
 
-        yield self.state.annotate_context_with_state(
-            event, context, old_state=old_state
+        context = yield self.state.compute_event_context(
+            event, old_state=old_state
         )
 
         for k, v in context.current_state.items():
@@ -92,7 +90,6 @@ class StateTestCase(unittest.TestCase):
     def test_trivial_annotate_message(self):
         event = self.create_event(type="test_message", name="event")
         event.prev_events = []
-        context = Mock()
 
         old_state = [
             self.create_event(type="test1", state_key="1"),
@@ -106,7 +103,7 @@ class StateTestCase(unittest.TestCase):
             group_name: old_state,
         }
 
-        yield self.state.annotate_context_with_state(event, context)
+        context = yield self.state.compute_event_context(event)
 
         for k, v in context.current_state.items():
             type, state_key = k
@@ -124,7 +121,6 @@ class StateTestCase(unittest.TestCase):
     def test_trivial_annotate_state(self):
         event = self.create_event(type="state", state_key="", name="event")
         event.prev_events = []
-        context = Mock()
 
         old_state = [
             self.create_event(type="test1", state_key="1"),
@@ -138,7 +134,7 @@ class StateTestCase(unittest.TestCase):
             group_name: old_state,
         }
 
-        yield self.state.annotate_context_with_state(event, context)
+        context = yield self.state.compute_event_context(event)
 
         for k, v in context.current_state.items():
             type, state_key = k
@@ -156,7 +152,6 @@ class StateTestCase(unittest.TestCase):
     def test_resolve_message_conflict(self):
         event = self.create_event(type="test_message", name="event")
         event.prev_events = []
-        context = Mock()
 
         old_state_1 = [
             self.create_event(type="test1", state_key="1"),
@@ -178,7 +173,7 @@ class StateTestCase(unittest.TestCase):
             group_name_2: old_state_2,
         }
 
-        yield self.state.annotate_context_with_state(event, context)
+        context = yield self.state.compute_event_context(event)
 
         self.assertEqual(len(context.current_state), 5)
 
@@ -188,7 +183,6 @@ class StateTestCase(unittest.TestCase):
     def test_resolve_state_conflict(self):
         event = self.create_event(type="test4", state_key="", name="event")
         event.prev_events = []
-        context = Mock()
 
         old_state_1 = [
             self.create_event(type="test1", state_key="1"),
@@ -210,7 +204,7 @@ class StateTestCase(unittest.TestCase):
             group_name_2: old_state_2,
         }
 
-        yield self.state.annotate_context_with_state(event, context)
+        context = yield self.state.compute_event_context(event)
 
         self.assertEqual(len(context.current_state), 5)