Add plain-text handling for rich-text topics as per MSC3765 #18195

Johennes · 2025-02-28T09:40:35Z

This implements matrix-org/matrix-spec-proposals#3765 which is already merged and, therefore, can use stable identifiers.

For /publicRooms and /hierarchy, the topic is read from the eponymous field of the current_state_events table. Rather than introduce further columns in this table, I changed the insertion / update logic to write the plain-text topic from the rich topic into the existing field. This will not take effect for existing rooms unless their topic is changed. However, existing rooms shouldn't have rich topics to begin with.

Similarly, for server-side search, I changed the insertion logic of the event_search table to prefer the value from the rich topic. Again, existing events shouldn't have rich topics and, therefore, don't need to be migrated in the table.

Spec doc: https://spec.matrix.org/v1.15/client-server-api/#mroomtopic

Part of supporting Matrix v1.15: https://spec.matrix.org/v1.15/client-server-api/#mroomtopic

Pull Request Checklist

Pull request is based on the develop branch
Pull request includes a changelog file. The entry should:
- Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
- Use markdown where necessary, mostly for code blocks.
- End with either a period (.) or an exclamation mark (!).
- Start with a capital letter.
- Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
Code style is correct
(run the linters)

Signed-off-by: Johannes Marbach <[email protected]>

CLAassistant · 2025-03-23T05:09:52Z

All committers have signed the CLA.

synapse/util/events.py

MadLittleMods · 2025-06-26T23:21:48Z

tests/rest/client/test_rooms.py

@@ -757,6 +757,59 @@ def test_post_room_initial_state(self) -> None:
        assert channel.resource_usage is not None
        self.assertEqual(37, channel.resource_usage.db_txn_count)

+    def test_post_room_topic(self) -> None:


We would benefit more if we converted this to a set of Complement tests that any homeserver implementation could test against.

Good call. I've opened matrix-org/complement#788 for this. Do you want me to remove the tests here in this PR?

I think we can leave them here ⏩

synapse/util/events.py

synapse/storage/databases/main/events.py

synapse/handlers/room.py

synapse/util/events.py

Co-authored-by: Eric Eastwood <[email protected]>

Johennes · 2025-07-08T13:33:25Z

All comments except for the Complement tests addressed.

I haven't used pydantic before so this part is most probably utter crap. 🙈

Pydantic v2 has an OnErrorOmit which would simplify a few things but if I'm reading things correctly, we don't use v2 consistently.

MadLittleMods

I think this is good to go. Just want to have you look at my changes before shipping to ensure I'm not overlooking something.

synapse/util/events.py

synapse/util/pydantic_models.py

Johennes · 2025-07-09T09:23:50Z

I think this is good to go. Just want to have you look at my changes before shipping to ensure I'm not overlooking something.

Thanks and sorry you had to patch my mess up yourself.

MadLittleMods · 2025-07-09T18:47:57Z

tests/rest/client/test_rooms.py

@@ -757,6 +757,59 @@ def test_post_room_initial_state(self) -> None:
        assert channel.resource_usage is not None
        self.assertEqual(37, channel.resource_usage.db_txn_count)

+    def test_post_room_topic(self) -> None:


I think we can leave them here ⏩

MadLittleMods · 2025-07-09T19:15:18Z

Thanks for the contribution and being willing to jump to robust Pydantic parsing @Johennes 🐏

@clokep

Tested on NetBSD 9 amd64 (federation, multiple clients) # Synapse 1.135.0 (2025-08-01) ## Features - Add `recaptcha_private_key_path` and `recaptcha_public_key_path` config option. ([\#17984](element-hq/synapse#17984), [\#18684](element-hq/synapse#18684)) - Add plain-text handling for rich-text topics as per [MSC3765](matrix-org/matrix-spec-proposals#3765). ([\#18195](element-hq/synapse#18195)) - If enabled by the user, server admins will see [soft failed](https://spec.matrix.org/v1.13/server-server-api/#soft-failure) events over the Client-Server API. ([\#18238](element-hq/synapse#18238)) - Add experimental support for [MSC4277: Harmonizing the reporting endpoints](matrix-org/matrix-spec-proposals#4277). ([\#18263](element-hq/synapse#18263)) - Add ability to limit amount of media uploaded by a user in a given time period. ([\#18527](element-hq/synapse#18527)) - Enable workers to write directly to the device lists stream and handle device list updates, reducing load on the main process. ([\#18581](element-hq/synapse#18581)) - Support arbitrary profile fields. Contributed by @clokep. ([\#18635](element-hq/synapse#18635)) - Advertise support for Matrix v1.12. ([\#18647](element-hq/synapse#18647)) - Add an option to issue redactions as an admin user via the [admin redaction endpoint](https://element-hq.github.io/synapse/latest/admin_api/user_admin_api.html#redact-all-the-events-of-a-user). ([\#18671](element-hq/synapse#18671)) - Add experimental and incomplete support for [MSC4306: Thread Subscriptions](https://github.com/matrix-org/matrix-spec-proposals/blob/rei/msc_thread_subscriptions/proposals/4306-thread-subscriptions.md). ([\#18674](element-hq/synapse#18674)) - Include `event_id` when getting state with `?format=event`. Contributed by @tulir @ Beeper. ([\#18675](element-hq/synapse#18675))

Johennes added 2 commits February 28, 2025 10:39

Add plain-text handling for rich-text topics as per MSC3765

c323dc1

Signed-off-by: Johannes Marbach <[email protected]>

Add changelog

42c5182

Johennes mentioned this pull request Feb 28, 2025

MSC3765: Rich text in room topics matrix-org/matrix-spec-proposals#3765

Merged

Johennes marked this pull request as ready for review February 28, 2025 10:01

Johennes requested a review from a team as a code owner February 28, 2025 10:01

Appease the linter

4dbca25

Johennes force-pushed the johannes/msc3765 branch from 4bdb12d to 4dbca25 Compare February 28, 2025 10:51

MadLittleMods requested changes Jun 26, 2025

View reviewed changes

MadLittleMods added the A-Spec-Compliance label Jun 26, 2025

Johennes added 5 commits June 27, 2025 10:10

Add comment to explain default mimetype

64012ba

Extract constants for accessing m.room.topic fields

00d0607

Explain that we prefer m.topic over topic when extracting the plain text

759f4fe

Skip invalid plain text representations and scrutinise body

efd05b7

Read plain text representation if available when reindexing search

174bc8f

MadLittleMods reviewed Jun 27, 2025

View reviewed changes

synapse/util/events.py Outdated Show resolved Hide resolved

synapse/util/events.py Outdated Show resolved Hide resolved

synapse/util/events.py Show resolved Hide resolved

synapse/util/events.py Outdated Show resolved Hide resolved

Johennes and others added 6 commits July 8, 2025 13:40

Wrap comment

1ca087f

Improve comment

5471c32

Add doc string for args

ea45ecd

Co-authored-by: Eric Eastwood <[email protected]>

Switch to use pydantic models for parsing topic event contents

2059b64

Fix type annotations

00d88c1

Fix type annotations _again_

39dfb69

Johennes mentioned this pull request Jul 8, 2025

MSC4155: Invite filtering matrix-org/matrix-spec-proposals#4155

Open

MadLittleMods added 5 commits July 8, 2025 12:56

Merge branch 'develop' into johannes/msc3765

eb0a3d2

Add doc comments

3146ec1

Use ParseModel in other spots

b081611

Update comment with text/plain marked as value

2296cea

Simpler pattern to pick first text/plain representation

94296f9

MadLittleMods approved these changes Jul 8, 2025

View reviewed changes

synapse/util/events.py Show resolved Hide resolved

synapse/util/pydantic_models.py Show resolved Hide resolved

Merge branch 'develop' into johannes/msc3765

8c6d776

MadLittleMods approved these changes Jul 9, 2025

View reviewed changes

MadLittleMods merged commit b9b8775 into element-hq:develop Jul 9, 2025
39 checks passed

Add plain-text handling for rich-text topics as per MSC3765 #18195

Add plain-text handling for rich-text topics as per MSC3765 #18195

Uh oh!

Conversation

Johennes commented Feb 28, 2025 • edited by MadLittleMods Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Checklist

Uh oh!

CLAassistant commented Mar 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

MadLittleMods Jun 26, 2025

Choose a reason for hiding this comment

Uh oh!

Johennes Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

MadLittleMods Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Johennes commented Jul 8, 2025

Uh oh!

MadLittleMods left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Johennes commented Jul 9, 2025

Uh oh!

MadLittleMods Jul 9, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

MadLittleMods commented Jul 9, 2025

Uh oh!

Uh oh!

Johennes commented Feb 28, 2025 •

edited by MadLittleMods

Loading

CLAassistant commented Mar 23, 2025 •

edited

Loading