Skip to content

Document that the new get single delayed event endpoint is workerisable - #20210

Merged
devonh merged 1 commit into
developfrom
bbz/delayed-events-worker-update
Sep 10, 2026
Merged

devonh merged 1 commit into
developfrom
bbz/delayed-events-worker-update

Conversation

@benbz

@benbz benbz commented Sep 10, 2026

Copy link
Copy Markdown
Member

Pull Request Checklist

Missed off of https://github.com/element-hq/synapse/pull/19926/changes IMO. My reading of https://github.com/element-hq/synapse/blob/v1.161.0rc1/synapse/rest/client/delayed_events.py is that the new endpoint (pattern r"/org\.matrix\.msc4140/delayed_events/(?P<delay_id>[^/]+)$" is workerisable) given how register_servlets flows. However given UpdateDelayedEventServlet covers the same pattern but for POST requests, this should go in the GET only part of the documentation.

  • 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)

@benbz
benbz requested a review from a team as a code owner September 10, 2026 11:40
@benbz
benbz requested review from devonh and removed request for a team September 10, 2026 11:40

@devonh devonh left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also see no reason why this endpoint cannot be workerisable.
The endpoint simply looks up a delayed event for a user directly from the DB. That functionality has no external dependency and should be a prime candidate for tossing on any worker.

@devonh
devonh merged commit f7cd91f into develop Sep 10, 2026
39 checks passed
@devonh
devonh deleted the bbz/delayed-events-worker-update branch September 10, 2026 16:25
@MadLittleMods MadLittleMods added A-Workers (includes replication) A-Docs labels Sep 23, 2026
reivilibre pushed a commit that referenced this pull request Sep 24, 2026
Previously, the worker endpoint pattern included only the multi-item
lookup and `/restart`. Adjust the pattern so that it includes the
per-`delay_id` lookup endpoint as well.

Also adjust the worker documentation to use this same endpoint pattern.

Follow-up of #20210
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-Delayed-Events MSC4140 A-Docs A-Workers (includes replication)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants