-
Notifications
You must be signed in to change notification settings - Fork 255
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add 'on_user_search' callback to third_party_rules callback #18156
Open
awesome-michael
wants to merge
6
commits into
element-hq:develop
Choose a base branch
from
Awesome-Technologies:module_api
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Add 'on_user_search' callback to third_party_rules callback #18156
awesome-michael
wants to merge
6
commits into
element-hq:develop
from
Awesome-Technologies:module_api
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Change-Id: Ieeb68956a043048c496f17ba56b75b8b068d5389 Signed-off-by: Michael Albert <[email protected]>
Change-Id: Ifaea3c0d303710c17b94ca074aa3f3ffd8b2b17f
Change-Id: Ib19a0e297d3f2150a864655610ce3956ad6b8815
clokep
reviewed
Feb 27, 2025
Comment on lines
+89
to
+91
# Let the third party rules modify the result list if needed, or abort | ||
# the search entirely with an exception. | ||
await self._third_party_event_rules.on_user_search(requester, results) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would probably make more sense to do this at the handler level (
synapse/synapse/handlers/user_directory.py
Lines 143 to 175 in c360da0
async def search_users( | |
self, user_id: str, search_term: str, limit: int | |
) -> SearchResult: | |
"""Searches for users in directory | |
Returns: | |
dict of the form:: | |
{ | |
"limited": <bool>, # whether there were more results or not | |
"results": [ # Ordered by best match first | |
{ | |
"user_id": <user_id>, | |
"display_name": <display_name>, | |
"avatar_url": <avatar_url> | |
} | |
] | |
} | |
""" | |
results = await self.store.search_user_dir( | |
user_id, search_term, limit, self.show_locked_users | |
) | |
# Remove any spammy users from the results. | |
non_spammy_users = [] | |
for user in results["results"]: | |
if not await self._spam_checker_module_callbacks.check_username_for_spam( | |
user, user_id | |
): | |
non_spammy_users.append(user) | |
results["results"] = non_spammy_users | |
return results |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add 'on_user_search' callback to the third_party_rules section of the module API.
This allows to write modules that can trigger on search requests on the user directory and alter the results.
Possible use cases:
Pull Request Checklist
EventStore
toEventWorkerStore
.".code blocks
.(run the linters)