element-hq / element-hq/synapse

Allow spam checkers to override the error message

Open
#16,259 0 comments 0 reactions 0 assignees View on GitHub
A-Moderation O-Uncommon S-Minor T-Enhancement
Dominant language
Python
Stars
4.6k
Forks
600
Avg merge
5d 22h
Merged PRs (30d)
51

Description

This issue has been migrated from [#16259](https://github.com/matrix-org/synapse/issues/16259).

---

**Description:**

For instance in [user_may_join_room](https://matrix-org.github.io/synapse/latest/modules/spam_checker_callbacks.html#user_may_join_room)

![image](https://github.com/matrix-org/synapse/assets/24363938/327db977-b9b4-498d-9759-b6878a8d9782)

It is currently possible to override the status code / error code but not the error message. It would be useful for plugin devs to specify to users trying to join a room why they were denied for the room and what they can do in order to be granted access.

Clients like Element can then then display that error message.

Contributor guide

Open the contributing guide

Research direction

Start with the user_may_join_room spam-checker callback documentation linked in the issue, then trace how its status and error code reach the client. Done means spam-checker plugins can provide a user-facing denial message that clients such as Element can display, with the callback behavior and compatibility covered.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.