Browse Source

Send the `m.room.create` stripped event with invites (support MSC1772). (#9966)

MSC1772 specifies the m.room.create event should be sent as part
of the invite_state. This was done optionally behind an experimental
flag, but is now done by default due to MSC1772 being approved.
tags/v1.34.0rc1
Patrick Cloke 3 years ago
committed by GitHub
parent
commit
28c6841102
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 34 additions and 5 deletions
  1. +29
    -0
      UPGRADE.rst
  2. +1
    -1
      changelog.d/9915.feature
  3. +1
    -0
      changelog.d/9966.feature
  4. +1
    -0
      docs/sample_config.yaml
  5. +2
    -4
      synapse/config/api.py

+ 29
- 0
UPGRADE.rst View File

@@ -85,6 +85,35 @@ for example:
wget https://packages.matrix.org/debian/pool/main/m/matrix-synapse-py3/matrix-synapse-py3_1.3.0+stretch1_amd64.deb
dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb

Upgrading to v1.34.0
====================

`room_invite_state_types` configuration setting
-----------------------------------------------

The ``room_invite_state_types`` configuration setting has been deprecated and
replaced with ``room_prejoin_state``. See the `sample configuration file <https://github.com/matrix-org/synapse/blob/v1.34.0/docs/sample_config.yaml#L1515>`_.

If you have set ``room_invite_state_types`` to the default value you should simply
remove it from your configuration file. The default value used to be:

.. code:: yaml

room_invite_state_types:
- "m.room.join_rules"
- "m.room.canonical_alias"
- "m.room.avatar"
- "m.room.encryption"
- "m.room.name"

If you have customised this value by adding addition state types, you should
remove ``room_invite_state_types`` and configure ``additional_event_types`` with
your customisations.

If you have customised this value by removing state types, you should rename
``room_invite_state_types`` to ``additional_event_types``, and set
``disable_default_event_types`` to ``true``.

Upgrading to v1.33.0
====================



+ 1
- 1
changelog.d/9915.feature View File

@@ -1 +1 @@
Support stable identifiers from [MSC1772](https://github.com/matrix-org/matrix-doc/pull/1772).
Support stable identifiers for [MSC1772](https://github.com/matrix-org/matrix-doc/pull/1772) Spaces. `m.space.child` events will now be taken into account when populating the experimental spaces summary response. Please see `UPGRADE.rst` if you have customised `room_invite_state_types` in your configuration.

+ 1
- 0
changelog.d/9966.feature View File

@@ -0,0 +1 @@
Support stable identifiers for [MSC1772](https://github.com/matrix-org/matrix-doc/pull/1772) Spaces. `m.space.child` events will now be taken into account when populating the experimental spaces summary response. Please see `UPGRADE.rst` if you have customised `room_invite_state_types` in your configuration.

+ 1
- 0
docs/sample_config.yaml View File

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


+ 2
- 4
synapse/config/api.py View File

@@ -88,10 +88,6 @@ class ApiConfig(Config):
if not room_prejoin_state_config.get("disable_default_event_types"):
yield from _DEFAULT_PREJOIN_STATE_TYPES

if self.spaces_enabled:
# MSC1772 suggests adding m.room.create to the prejoin state
yield EventTypes.Create

yield from room_prejoin_state_config.get("additional_event_types", [])


@@ -109,6 +105,8 @@ _DEFAULT_PREJOIN_STATE_TYPES = [
EventTypes.RoomAvatar,
EventTypes.RoomEncryption,
EventTypes.Name,
# Per MSC1772.
EventTypes.Create,
]




Loading…
Cancel
Save