Add admin API for fetching room reports #18253

turt2live · 2025-03-18T21:37:36Z

Very much a copy/paste of the event reporting API: https://element-hq.github.io/synapse/latest/admin_api/event_reports.html

Differences:

No sender or sender filtering - rooms don't have senders.
No get individual report detail API - there are other APIs for getting room details (which are the relevant parts of a report anyway).
No delete individual report API - just isn't needed at this stage. A future PR/contributor can add one.
No score - there isn't any.
No event_id - there isn't any.

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)

reivilibre · 2025-03-27T17:31:02Z

@turt2live the trial unit tests are failing FWIW

turt2live · 2025-03-27T19:32:29Z

I'm not seeing errors which look related to this PR. Is there somewhere else I should be looking?

anoadragon453

A few minor things, but on the whole looks good! Tests are failing due to this PR though, see below.

anoadragon453 · 2025-05-02T09:56:38Z

tests/rest/admin/test_room_reports.py

+        """Report a room"""
+        channel = self.make_request(
+            "POST",
+            "rooms/%s/report" % room_id,


Unit test failure logs can be seen here.

The shorthand form doesn't actually work here, as it prepends /_matrix/client/r0/:

synapse/tests/server.py

Lines 412 to 420 in 10812bc

# Decorate it to be the full path, if we're using shorthand

if (

shorthand

and not path.startswith(b"/_matrix")

and not path.startswith(b"/_synapse")

):

if path.startswith(b"/"):

path = path[1:]

path = b"/_matrix/client/r0/" + path

whereas /rooms/{roomId}/report only listens on v3:

synapse/synapse/rest/client/reporting.py

Lines 105 to 119 in 10812bc

class ReportRoomRestServlet(RestServlet):

"""This endpoint lets clients report a room for abuse.

Introduced by MSC4151: https://github.com/matrix-org/matrix-spec-proposals/pull/4151

"""

# Cast the Iterable to a list so that we can `append` below.

PATTERNS = list(

client_patterns(

"/rooms/(?P<room_id>[^/]*)/report$",

releases=("v3",),

unstable=False,

v1=False,

)

)

I'd recommend putting the full path to avoid the shorthand logic:

Suggested change

"rooms/%s/report" % room_id,

f"/_matrix/client/v3/rooms/{room_id}/report",

anoadragon453 · 2025-05-02T09:56:48Z

tests/rest/admin/test_room_reports.py

+        """Report a room, but omit reason"""
+        channel = self.make_request(
+            "POST",
+            "rooms/%s/report" % room_id,


Suggested change

"rooms/%s/report" % room_id,

f"/_matrix/client/v3/rooms/{room_id}/report",

anoadragon453 · 2025-05-02T09:58:39Z

docs/admin_api/room_reports.md

+```
+
+To paginate, check for `next_token` and if present, call the endpoint again with `from`
+set to the value of `next_token`. This will return a new page.


Suggested change

set to the value of `next_token`. This will return a new page.

set to the value of `next_token` and the same `limit`. This will return a new page.

anoadragon453 · 2025-05-02T09:58:49Z

docs/admin_api/room_reports.md

+If the endpoint does not return a `next_token` then there are no more reports to
+paginate through.
+
+**URL parameters:**


Suggested change

**URL parameters:**

**Query parameters:**

anoadragon453 · 2025-05-02T10:00:21Z

synapse/rest/admin/room_reports.py

+# Originally licensed under the Apache License, Version 2.0:
+# <http://www.apache.org/licenses/LICENSE-2.0>.
+#
+# [This file includes modifications made by New Vector Limited]
+#


As this is a new file, this section isn't needed.

Suggested change

# Originally licensed under the Apache License, Version 2.0:

# <http://www.apache.org/licenses/LICENSE-2.0>.

#

# [This file includes modifications made by New Vector Limited]

#

anoadragon453 · 2025-05-02T10:02:52Z

tests/rest/admin/test_room_reports.py

+            self.assertIn("user_id", c)
+            self.assertIn("canonical_alias", c)
+            self.assertIn("name", c)
+            self.assertIn("reason", c)


To make sure we don't accidentally introduce another field (since we're taking raw output from a database storage function:

Suggested change

self.assertIn("reason", c)

self.assertIn("reason", c)

self.assertEqual(len(c.keys()), 7)

anoadragon453 · 2025-05-02T10:05:19Z

tests/rest/admin/test_room_reports.py

+#
+# Originally licensed under the Apache License, Version 2.0:
+# <http://www.apache.org/licenses/LICENSE-2.0>.
+#
+# [This file includes modifications made by New Vector Limited]
+#


Suggested change

#

# Originally licensed under the Apache License, Version 2.0:

# <http://www.apache.org/licenses/LICENSE-2.0>.

#

# [This file includes modifications made by New Vector Limited]

#

Add admin API for fetching room reports

33e0abf

turt2live requested a review from a team as a code owner March 18, 2025 21:37

changelog

0f35e9a

github-actions bot deployed to PR Documentation Preview March 18, 2025 21:39 Active

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

Attempt to fix linting

97dc729

Empty commit to fix CI

c7e4846

github-actions bot deployed to PR Documentation Preview March 18, 2025 21:43 Active

Merge branch 'develop' into travis/adminapi-report-room

960bb62

github-actions bot deployed to PR Documentation Preview May 2, 2025 09:52 Active

anoadragon453 requested changes May 2, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add admin API for fetching room reports #18253

Add admin API for fetching room reports #18253

turt2live commented Mar 18, 2025 •

edited

Loading

reivilibre commented Mar 27, 2025

turt2live commented Mar 27, 2025

anoadragon453 left a comment

anoadragon453 May 2, 2025

anoadragon453 May 2, 2025

anoadragon453 May 2, 2025

anoadragon453 May 2, 2025

anoadragon453 May 2, 2025

anoadragon453 May 2, 2025

anoadragon453 May 2, 2025

	# Decorate it to be the full path, if we're using shorthand
	if (
	shorthand
	and not path.startswith(b"/_matrix")
	and not path.startswith(b"/_synapse")
	):
	if path.startswith(b"/"):
	path = path[1:]
	path = b"/_matrix/client/r0/" + path

	class ReportRoomRestServlet(RestServlet):
	"""This endpoint lets clients report a room for abuse.

	Introduced by MSC4151: https://github.com/matrix-org/matrix-spec-proposals/pull/4151
	"""

	# Cast the Iterable to a list so that we can `append` below.
	PATTERNS = list(
	client_patterns(
	"/rooms/(?P<room_id>[^/]*)/report$",
	releases=("v3",),
	unstable=False,
	v1=False,
	)
	)

	"rooms/%s/report" % room_id,
	f"/_matrix/client/v3/rooms/{room_id}/report",

	set to the value of `next_token`. This will return a new page.
	set to the value of `next_token` and the same `limit`. This will return a new page.

Add admin API for fetching room reports #18253

Are you sure you want to change the base?

Add admin API for fetching room reports #18253

Conversation

turt2live commented Mar 18, 2025 • edited Loading

Pull Request Checklist

reivilibre commented Mar 27, 2025

turt2live commented Mar 27, 2025

anoadragon453 left a comment

Choose a reason for hiding this comment

anoadragon453 May 2, 2025

Choose a reason for hiding this comment

anoadragon453 May 2, 2025

Choose a reason for hiding this comment

anoadragon453 May 2, 2025

Choose a reason for hiding this comment

anoadragon453 May 2, 2025

Choose a reason for hiding this comment

anoadragon453 May 2, 2025

Choose a reason for hiding this comment

anoadragon453 May 2, 2025

Choose a reason for hiding this comment

anoadragon453 May 2, 2025

Choose a reason for hiding this comment

turt2live commented Mar 18, 2025 •

edited

Loading