Add report user API from MSC4260 #18120

turt2live · 2025-01-30T23:06:02Z

matrix-org/matrix-spec-proposals#4260

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)

turt2live · 2025-01-31T20:46:35Z

test failures appear unrelated

sandhose

Overall looks good

synapse/storage/schema/main/delta/88/07_add_user_reports.sql

synapse/rest/client/reporting.py

anoadragon453

Some further notes and ideas below.

synapse/rest/client/reporting.py

synapse/storage/databases/main/room.py

tests/rest/client/test_reporting.py

synapse/rest/client/reporting.py

Co-authored-by: Andrew Morgan <[email protected]>

sandhose

Very non-blocking concerns, happy to merge as-is, just let me know

synapse/handlers/reports.py

synapse/storage/schema/main/delta/91/02_add_user_reports.sql

anoadragon453

Seems we probably should have defined a way to delete these reports during the MSC process... Do we have a plan to clear reports out once they're handled?

Otherwise the below is the only blocking comment.

docs/usage/configuration/config_documentation.md

turt2live · 2025-06-19T17:21:40Z

Seems we probably should have defined a way to delete these reports during the MSC process... Do we have a plan to clear reports out once they're handled?

Like any other report: no. Implementations are left to their own decisions in this regard.

We'll add applicable admin APIs later - I'd like to avoid overloading this PR.

anoadragon453 · 2025-06-19T17:26:55Z

Seems we probably should have defined a way to delete these reports during the MSC process... Do we have a plan to clear reports out once they're handled?

Like any other report: no. Implementations are left to their own decisions in this regard.

We'll add applicable admin APIs later - I'd like to avoid overloading this PR.

Sorry, I wasn't suggesting adding any more APIs to this PR. I was more wondering if there were plans to create tooling to remove reports. It sounds like there are, but from a different angle that the C-S API.

Happy to discuss that more in a separate issue/MSC.

turt2live · 2025-06-19T17:28:12Z

honestly, the hope is to bypass the Synapse database entirely one day, but that's very long term thoughts. In the meantime, we'll slowly add admin APIs as we (T&S) need them, if others don't contribute them.

anoadragon453

This LGTM. Thanks for working on this and other T&S features ❤️

anoadragon453 · 2025-06-20T12:01:01Z

synapse/handlers/reports.py

+        if not self._hs.is_mine_id(target_user_id):
+            return  # hide that they're not ours/that we can't do anything about them


Non-blocking, but would it not be useful for the reporter to get an error here telling them that the homeserver operator likely don't do much about remote users? And tell them to contact the remote homeserver's operator instead?

Possibly/probably, though IIRC this is in the MSC.

One day we do also hope to support federated reports.

@kfiven

Builds on NetBSD 10 amd64, and builds/tests-ok on NetBSD 9 amd64 using dependencies from 2025Q2. NB: A security update to synapse is scheduled for July 22. Consult https://matrix.org/blog/2025/07/security-predisclosure/ for further details. Those running synapse in production may wish to update to 1.134.0 to reduce the magnitude of change when updating to the July 22 version (although that will be a big update regardless). Note that the usual pkgsrc pre-commit test is upgrading from the current pkgsrc version and briefly checking operation. Therefore, not upgrading has a theoretical risk of encountering a 1.127.1 to 1.135.0 update bug when 1.127.1 to 134.0 and 1.134.0 to 1.135.0 are ok. # Synapse 1.134.0 (2025-07-15) - Support for [MSC4235](matrix-org/matrix-spec-proposals#4235): `via` query param for hierarchy endpoint. Contributed by Krishan (@kfiven). ([\#18070](element-hq/synapse#18070)) - Add `forget_forced_upon_leave` capability as per [MSC4267](matrix-org/matrix-spec-proposals#4267). ([\#18196](element-hq/synapse#18196)) - Add `federated_user_may_invite` spam checker callback which receives the entire invite event. Contributed by @tulir @ Beeper. ([\#18241](element-hq/synapse#18241)) # Synapse 1.133.0 (2025-07-01) - Add support for the [MSC4260 user report API](matrix-org/matrix-spec-proposals#4260). ([\#18120](element-hq/synapse#18120)) # Synapse 1.132.0 (2025-06-17) - Add support for [MSC4155](matrix-org/matrix-spec-proposals#4155) Invite Filtering. ([\#18288](element-hq/synapse#18288)) - Add experimental `user_may_send_state_event` module API callback. ([\#18455](element-hq/synapse#18455)) - Add experimental `get_media_config_for_user` and `is_user_allowed_to_upload_media_of_size` module API callbacks that allow overriding of media repository maximum upload size. ([\#18457](element-hq/synapse#18457)) - Add experimental `get_ratelimit_override_for_user` module API callback that allows overriding of per-user ratelimits. ([\#18458](element-hq/synapse#18458)) - Pass `room_config` argument to `user_may_create_room` spam checker module callback. ([\#18486](element-hq/synapse#18486)) - Support configuration of default and extra user types. ([\#18456](element-hq/synapse#18456)) - Successful requests to `/_matrix/app/v1/ping` will now force Synapse to reattempt delivering transactions to appservices. ([\#18521](element-hq/synapse#18521)) - Support the import of the `RatelimitOverride` type from `synapse.module_api` in modules and rename `messages_per_second` to `per_second`. ([\#18513](element-hq/synapse#18513)) # Synapse 1.131.0 (2025-06-03) - Add `msc4263_limit_key_queries_to_users_who_share_rooms` config option as per [MSC4263](matrix-org/matrix-spec-proposals#4263). ([\#18180](element-hq/synapse#18180)) - Add option to allow registrations that begin with `_`. Contributed by `_` (@hex5f). ([\#18262](element-hq/synapse#18262)) - Include room ID in response to the [Room Deletion Status Admin API](https://element-hq.github.io/synapse/latest/admin_api/rooms.html#status-of-deleting-rooms). ([\#18318](element-hq/synapse#18318)) - Add support for calling Policy Servers ([MSC4284](matrix-org/matrix-spec-proposals#4284)) to mark events as spam. ([\#18387](element-hq/synapse#18387)) # Synapse 1.130.0 (2025-05-20) - Add an Admin API endpoint `GET /_synapse/admin/v1/scheduled_tasks` to fetch scheduled tasks. ([\#18214](element-hq/synapse#18214)) - Add config option `user_directory.exclude_remote_users` which, when enabled, excludes remote users from user directory search results. ([\#18300](element-hq/synapse#18300)) - Add support for handling `GET /devices/` on workers. ([\#18355](element-hq/synapse#18355)) # Synapse 1.129.0 (2025-05-06) - Add `passthrough_authorization_parameters` in OIDC configuration to allow passing parameters to the authorization grant URL. ([\#18232](element-hq/synapse#18232)) - Add `total_event_count`, `total_message_count`, and `total_e2ee_event_count` fields to the homeserver usage statistics. ([\#18260](element-hq/synapse#18260)) # Synapse 1.128.0 (2025-04-08) - Add an access token introspection cache to make Matrix Authentication Service integration ([MSC3861](matrix-org/matrix-spec-proposals#3861)) more efficient. ([\#18231](element-hq/synapse#18231)) - Add background job to clear unreferenced state groups. ([\#18254](element-hq/synapse#18254)) - Hashes of media files are now tracked by Synapse. Media quarantines will now apply to all files with the same hash. ([\#18277](element-hq/synapse#18277), [\#18302](element-hq/synapse#18302), [\#18296](element-hq/synapse#18296))

@kfiven

chat/matrix-synapse: Update package in anticipation of security fix Revisions pulled up: - chat/matrix-synapse/Makefile 1.112 - chat/matrix-synapse/PLIST 1.59 - chat/matrix-synapse/cargo-depends.mk 1.27 - chat/matrix-synapse/distinfo 1.80 --- Module Name: pkgsrc Committed By: gdt Date: Thu Jul 17 11:24:44 UTC 2025 Modified Files: pkgsrc/chat/matrix-synapse: Makefile PLIST cargo-depends.mk distinfo Log Message: chat/matrix-synapse: Update to 1.134.0 Builds on NetBSD 10 amd64, and builds/tests-ok on NetBSD 9 amd64 using dependencies from 2025Q2. NB: A security update to synapse is scheduled for July 22. Consult https://matrix.org/blog/2025/07/security-predisclosure/ for further details. Those running synapse in production may wish to update to 1.134.0 to reduce the magnitude of change when updating to the July 22 version (although that will be a big update regardless). Note that the usual pkgsrc pre-commit test is upgrading from the current pkgsrc version and briefly checking operation. Therefore, not upgrading has a theoretical risk of encountering a 1.127.1 to 1.135.0 update bug when 1.127.1 to 134.0 and 1.134.0 to 1.135.0 are ok. # Synapse 1.134.0 (2025-07-15) - Support for [MSC4235](matrix-org/matrix-spec-proposals#4235): `via` query param for hierarchy endpoint. Contributed by Krishan (@kfiven). ([\#18070](element-hq/synapse#18070)) - Add `forget_forced_upon_leave` capability as per [MSC4267](matrix-org/matrix-spec-proposals#4267). ([\#18196](element-hq/synapse#18196)) - Add `federated_user_may_invite` spam checker callback which receives the entire invite event. Contributed by @tulir @ Beeper. ([\#18241](element-hq/synapse#18241)) # Synapse 1.133.0 (2025-07-01) - Add support for the [MSC4260 user report API](matrix-org/matrix-spec-proposals#4260). ([\#18120](element-hq/synapse#18120)) # Synapse 1.132.0 (2025-06-17) - Add support for [MSC4155](matrix-org/matrix-spec-proposals#4155) Invite Filtering. ([\#18288](element-hq/synapse#18288)) - Add experimental `user_may_send_state_event` module API callback. ([\#18455](element-hq/synapse#18455)) - Add experimental `get_media_config_for_user` and `is_user_allowed_to_upload_media_of_size` module API callbacks that allow overriding of media repository maximum upload size. ([\#18457](element-hq/synapse#18457)) - Add experimental `get_ratelimit_override_for_user` module API callback that allows overriding of per-user ratelimits. ([\#18458](element-hq/synapse#18458)) - Pass `room_config` argument to `user_may_create_room` spam checker module callback. ([\#18486](element-hq/synapse#18486)) - Support configuration of default and extra user types. ([\#18456](element-hq/synapse#18456)) - Successful requests to `/_matrix/app/v1/ping` will now force Synapse to reattempt delivering transactions to appservices. ([\#18521](element-hq/synapse#18521)) - Support the import of the `RatelimitOverride` type from `synapse.module_api` in modules and rename `messages_per_second` to `per_second`. ([\#18513](element-hq/synapse#18513)) # Synapse 1.131.0 (2025-06-03) - Add `msc4263_limit_key_queries_to_users_who_share_rooms` config option as per [MSC4263](matrix-org/matrix-spec-proposals#4263). ([\#18180](element-hq/synapse#18180)) - Add option to allow registrations that begin with `_`. Contributed by `_` (@hex5f). ([\#18262](element-hq/synapse#18262)) - Include room ID in response to the [Room Deletion Status Admin API](https://element-hq.github.io/synapse/latest/admin_api/rooms.html#status-of-deleting-rooms). ([\#18318](element-hq/synapse#18318)) - Add support for calling Policy Servers ([MSC4284](matrix-org/matrix-spec-proposals#4284)) to mark events as spam. ([\#18387](element-hq/synapse#18387)) # Synapse 1.130.0 (2025-05-20) - Add an Admin API endpoint `GET /_synapse/admin/v1/scheduled_tasks` to fetch scheduled tasks. ([\#18214](element-hq/synapse#18214)) - Add config option `user_directory.exclude_remote_users` which, when enabled, excludes remote users from user directory search results. ([\#18300](element-hq/synapse#18300)) - Add support for handling `GET /devices/` on workers. ([\#18355](element-hq/synapse#18355)) # Synapse 1.129.0 (2025-05-06) - Add `passthrough_authorization_parameters` in OIDC configuration to allow passing parameters to the authorization grant URL. ([\#18232](element-hq/synapse#18232)) - Add `total_event_count`, `total_message_count`, and `total_e2ee_event_count` fields to the homeserver usage statistics. ([\#18260](element-hq/synapse#18260)) # Synapse 1.128.0 (2025-04-08) - Add an access token introspection cache to make Matrix Authentication Service integration ([MSC3861](matrix-org/matrix-spec-proposals#3861)) more efficient. ([\#18231](element-hq/synapse#18231)) - Add background job to clear unreferenced state groups. ([\#18254](element-hq/synapse#18254)) - Hashes of media files are now tracked by Synapse. Media quarantines will now apply to all files with the same hash. ([\#18277](element-hq/synapse#18277), [\#18302](element-hq/synapse#18302), [\#18296](element-hq/synapse#18296))

turt2live added 2 commits January 30, 2025 16:05

Add report user API from MSC4260

f347547

changelog

b5f359a

turt2live mentioned this pull request Jan 30, 2025

MSC4260: Reporting users (Client-Server API) matrix-org/matrix-spec-proposals#4260

Merged

turt2live and others added 2 commits January 30, 2025 23:13

Attempt to fix linting

f0dcc7a

kick ci

61f2750

turt2live marked this pull request as ready for review January 30, 2025 23:19

turt2live requested a review from a team as a code owner January 30, 2025 23:19

turt2live and others added 8 commits January 30, 2025 17:13

Include in /versions

facf07a

Annotate the tests instead

85747b7

await

e8d102d

Attempt to fix linting

a842c66

kick ci

44dbcab

Adjust testing

41d185c

Attempt to fix linting

133380f

kick ci

6ef7a87

Merge branch 'develop' into travis/report-user

dbe43a1

sandhose requested changes Feb 19, 2025

View reviewed changes

synapse/storage/schema/main/delta/88/07_add_user_reports.sql Outdated Show resolved Hide resolved

synapse/rest/client/reporting.py Outdated Show resolved Hide resolved

turt2live added 3 commits March 18, 2025 15:06

Merge branch 'develop' into travis/report-user

8b84c23

Move delta

79c2a0a

Unstable -> Stable

1029a79

turt2live requested a review from sandhose March 18, 2025 21:10

turt2live and others added 2 commits March 18, 2025 21:12

Attempt to fix linting

6ce8cc0

Empty commit to fix CI

42b4207

Johennes mentioned this pull request Mar 24, 2025

MSC4277: Harmonizing the reporting endpoints matrix-org/matrix-spec-proposals#4277

Open

anoadragon453 requested changes May 2, 2025

View reviewed changes

turt2live and others added 4 commits May 2, 2025 11:13

Apply suggestions from code review

386a9e6

Co-authored-by: Andrew Morgan <[email protected]>

Merge branch 'develop' into travis/report-user

2058b2b

Fix local user check

c394ad1

Limit length of reason; add rate limit; move to handler

2f8958c

github-actions bot deployed to PR Documentation Preview May 2, 2025 17:48 Active

turt2live added 2 commits May 2, 2025 11:49

move delta again

51aceab

I guess imports are important

ba32d12

github-actions bot deployed to PR Documentation Preview May 2, 2025 17:50 Active

Add types

223df14

github-actions bot deployed to PR Documentation Preview May 2, 2025 17:55 Active

turt2live requested a review from anoadragon453 May 2, 2025 17:56

sandhose reviewed May 5, 2025

View reviewed changes

synapse/handlers/reports.py Show resolved Hide resolved

synapse/storage/schema/main/delta/91/02_add_user_reports.sql Outdated Show resolved Hide resolved

anoadragon453 removed their request for review May 29, 2025 11:56

turt2live added 3 commits June 19, 2025 10:27

Merge branch 'develop' into travis/report-user

592a32d

add docs

cf03535

Add second index; move to new delta

746c506

turt2live requested review from anoadragon453, sandhose and a team June 19, 2025 16:34

github-actions bot deployed to PR Documentation Preview June 19, 2025 16:35 Active

anoadragon453 requested changes Jun 19, 2025

View reviewed changes

docs/usage/configuration/config_documentation.md Outdated Show resolved Hide resolved

move config

7d46b07

Use generated config

c4cdded

github-actions bot deployed to PR Documentation Preview June 19, 2025 17:55 Active

turt2live requested a review from anoadragon453 June 19, 2025 17:59

anoadragon453 approved these changes Jun 20, 2025

View reviewed changes

anoadragon453 merged commit 74ca7ae into develop Jun 20, 2025
47 checks passed

anoadragon453 deleted the travis/report-user branch June 20, 2025 12:02

anoadragon453 removed the request for review from sandhose June 20, 2025 12:02

		if not self._hs.is_mine_id(target_user_id):
		return # hide that they're not ours/that we can't do anything about them

Add report user API from MSC4260 #18120

Add report user API from MSC4260 #18120

Uh oh!

Conversation

turt2live commented Jan 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Checklist

Uh oh!

turt2live commented Jan 31, 2025

Uh oh!

sandhose left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

anoadragon453 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sandhose left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

anoadragon453 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

turt2live commented Jun 19, 2025

Uh oh!

anoadragon453 commented Jun 19, 2025

Uh oh!

turt2live commented Jun 19, 2025

Uh oh!

anoadragon453 left a comment

Choose a reason for hiding this comment

Uh oh!

anoadragon453 Jun 20, 2025

Choose a reason for hiding this comment

Uh oh!

turt2live Jun 20, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

turt2live commented Jan 30, 2025 •

edited

Loading