Skip to content
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

Define delayed event ratelimit category #18019

Open
wants to merge 17 commits into
base: develop
Choose a base branch
from

Conversation

AndrewFerr
Copy link
Member

@AndrewFerr AndrewFerr commented Dec 9, 2024

Apply ratelimiting on delayed event management separately from messages.

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)

Apply ratelimiting on delayed event management separately from messages.
@AndrewFerr AndrewFerr requested a review from a team as a code owner December 9, 2024 20:18
@github-actions github-actions bot deployed to PR Documentation Preview December 9, 2024 20:19 Active
Copy link
Member

@hughns hughns left a comment

Choose a reason for hiding this comment

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

Please see question inline about the default value.

docs/usage/configuration/config_documentation.md Outdated Show resolved Hide resolved
docs/usage/configuration/config_documentation.md Outdated Show resolved Hide resolved
synapse/handlers/delayed_events.py Outdated Show resolved Hide resolved
synapse/config/ratelimiting.py Outdated Show resolved Hide resolved
tests/rest/client/test_delayed_events.py Outdated Show resolved Hide resolved
@fkwp
Copy link

fkwp commented Feb 6, 2025

@AndrewFerr what is the current status on this topic?

@AndrewFerr
Copy link
Member Author

@AndrewFerr what is the current status on this topic?

I still need to address the review comments, but once that's done, this should be good to go (barring further review). It should also be usable for testing/development until then.

Since this ratelimit targets the simpler management commands of cancel/restart/get, it's less complicated than the ratelimits we want for delayed messages themselves, which does require more thought.

@github-actions github-actions bot deployed to PR Documentation Preview February 7, 2025 21:25 Active
Copy link
Member

@anoadragon453 anoadragon453 left a comment

Choose a reason for hiding this comment

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

This LGTM!

Complement test failures are a flake. Note that TestDelayedEvents/delayed_state_events_are_kept_on_server_restart has been flakey for a while; could you please fix that in another PR @AndrewFerr :)

demo/start.sh Outdated Show resolved Hide resolved
synapse/handlers/delayed_events.py Outdated Show resolved Hide resolved
@anoadragon453 anoadragon453 enabled auto-merge (squash) February 10, 2025 07:00
@github-actions github-actions bot deployed to PR Documentation Preview February 10, 2025 07:00 Active
This rate limit is for the _management_ of delayed events, not the
sending of the events themselves (which will be managed by a different
ratelimit setting to be added later).
auto-merge was automatically disabled February 10, 2025 13:35

Head branch was pushed to by a user without write access

@github-actions github-actions bot deployed to PR Documentation Preview February 10, 2025 13:36 Active
AndrewFerr added a commit to AndrewFerr/sytest that referenced this pull request Feb 10, 2025
@github-actions github-actions bot deployed to PR Documentation Preview February 14, 2025 19:44 Active
@github-actions github-actions bot requested a deployment to PR Documentation Preview February 18, 2025 13:43 In progress
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants