Include the topic event in the prejoin state, per MSC3173. (#11666)

Invites and knocks will now include the topic in the stripped state
send to clients before joining the room.

changelog.d/11666.feature

@@ -0,0 +1 @@
+Include the room topic in the stripped state included with invites and knocking.

docs/sample_config.yaml

@@ -1488,6 +1488,7 @@ room_prejoin_state:
    # - m.room.encryption
    # - m.room.name
    # - m.room.create
+   # - m.room.topic
    #
    # Uncomment the following to disable these defaults (so that only the event
    # types listed in 'additional_event_types' are shared). Defaults to 'false'.

synapse/config/api.py

@@ -107,6 +107,8 @@ def _get_prejoin_state_types(self, config: JsonDict) -> Iterable[str]:
     EventTypes.Name,
     # Per MSC1772.
     EventTypes.Create,
+    # Per MSC3173.
+    EventTypes.Topic,
 ]
 
 

tests/federation/transport/test_knocking.py

@@ -108,6 +108,15 @@ def send_example_state_events_to_room(
                         "state_key": "",
                     },
                 ),
+                (
+                    EventTypes.Topic,
+                    {
+                        "content": {
+                            "topic": "A really cool room",
+                        },
+                        "state_key": "",
+                    },
+                ),
             ]
         )