Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 91f8de7

Browse files
Clarify the workers that the ThirdPartyRules' on_new_event callback will run on (#15071)
1 parent 647ff3e commit 91f8de7

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

changelog.d/15071.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Clarify which worker processes the ThirdPartyRules' [`on_new_event`](https://matrix-org.github.io/synapse/v1.78/modules/third_party_rules_callbacks.html#on_new_event) module API callback runs on.

docs/modules/third_party_rules_callbacks.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,9 @@ Note that this callback is called when the event has already been processed and
146146
into the room, which means this callback cannot be used to deny persisting the event. To
147147
deny an incoming event, see [`check_event_for_spam`](spam_checker_callbacks.md#check_event_for_spam) instead.
148148

149+
For any given event, this callback will be called on every worker process, even if that worker will not end up
150+
acting on that event. This callback will not be called for events that are marked as rejected.
151+
149152
If multiple modules implement this callback, Synapse runs them all in order.
150153

151154
### `check_can_shutdown_room`

0 commit comments

Comments
 (0)