Add cancel_task API to the task scheduler by MatMaul · Pull Request #19310 · element-hq/synapse

MatMaul · 2025-12-16T16:00:01Z

This will be used in another PR to come that put in a background task the membership updates when changing the avatar or the display name.

Pull Request Checklist

Pull request is based on the develop branch
Pull request includes a changelog file.
Code style is correct (run the linters)

synapse/util/task_scheduler.py

anoadragon453

Looks good on the whole, just a few small things.

Useful addition, thank you!

synapse/replication/tcp/commands.py

synapse/replication/tcp/handler.py

synapse/util/task_scheduler.py

changelog.d/19310.misc

synapse/types/__init__.py

synapse/util/task_scheduler.py

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

anoadragon453

Just a couple small things left -- thanks for your patience!

synapse/util/task_scheduler.py

synapse/types/__init__.py

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

anoadragon453

Thanks for this!

I'm looking forward to seeing the ability to cancel tasks being added to sysadmin-facing interfaces.

synapse/rest/admin/scheduled_tasks.py

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

anoadragon453

Thanks @MatMaul!

This PR contains the following updates: | Package | Update | Change | |---|---|---| | [element-hq/synapse](https://github.com/element-hq/synapse) | minor | `1.145.0` → `1.146.0` | --- > ⚠️ **Warning** > > Some dependencies could not be looked up. Check the Dependency Dashboard for more information. --- ### Release Notes <details> <summary>element-hq/synapse (element-hq/synapse)</summary> ### [`v1.146.0`](https://github.com/element-hq/synapse/releases/tag/v1.146.0) [Compare Source](element-hq/synapse@v1.145.0...v1.146.0rc1) ### Synapse 1.146.0 (2026-01-27) No significant changes since 1.146.0rc1. #### Deprecations and Removals - [MSC2697](matrix-org/matrix-spec-proposals#2697) (Dehydrated devices) has been removed, as the MSC is closed. Developers should migrate to [MSC3814](matrix-org/matrix-spec-proposals#3814). ([#19346](element-hq/synapse#19346)) - Support for Ubuntu 25.04 (Plucky Puffin) has been dropped. Synapse no longer builds debian packages for Ubuntu 25.04. ### Synapse 1.146.0rc1 (2026-01-20) #### Features - Add a new config option [`enable_local_media_storage`](https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#enable_local_media_storage) which controls whether media is additionally stored locally when using configured `media_storage_providers`. Setting this to `false` allows off-site media storage without a local cache. Contributed by Patrice Brend'amour [@dr](https://github.com/dr).allgood. ([#19204](element-hq/synapse#19204)) - Stabilise support for [MSC4312](matrix-org/matrix-spec-proposals#4312 `m.oauth` User-Interactive Auth stage for resetting cross-signing identity with the OAuth 2.0 API. The old, unstable name (`org.matrix.cross_signing_reset`) is now deprecated and will be removed in a future release. ([#19273](element-hq/synapse#19273)) - Refactor Grafana dashboard to use `server_name` label (instead of `instance`). ([#19337](element-hq/synapse#19337)) #### Bugfixes - Fix joining a restricted v12 room locally when no local room creator is present but local users with sufficient power levels are. Contributed by [@nexy7574](https://github.com/nexy7574). ([#19321](element-hq/synapse#19321)) - Fixed parallel calls to `/_matrix/media/v1/create` being ratelimited for appservices even if `rate_limited: false` was set in the registration. Contributed by [@tulir](https://github.com/tulir) @ Beeper. ([#19335](element-hq/synapse#19335)) - Fix a bug introduced in 1.61.0 where a user's membership in a room was accidentally ignored when considering access to historical state events in rooms with the "shared" history visibility. Contributed by Lukas Tautz. ([#19353](element-hq/synapse#19353)) - [MSC4140](matrix-org/matrix-spec-proposals#4140): Store the JSON content of scheduled delayed events as text instead of a byte array. This fixes the inability to schedule a delayed event with non-ASCII characters in its content. ([#19360](element-hq/synapse#19360)) - Always rollback database transactions when retrying (avoid orphaned connections). ([#19372](element-hq/synapse#19372)) - Fix `InFlightGauge` typing to allow upgrading to `prometheus_client` 0.24. ([#19379](element-hq/synapse#19379)) #### Updates to the Docker image - Add [Prometheus HTTP service discovery](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#http_sd_config) endpoint for easy discovery of all workers when using the `docker/Dockerfile-workers` image (see the [*Metrics* section of our Docker testing docs](docker/README-testing.md#metrics)). ([#19336](element-hq/synapse#19336)) #### Improved Documentation - Remove docs on legacy metric names (no longer in the codebase since 2022-12-06). ([#19341](element-hq/synapse#19341)) - Clarify how the estimated value of room complexity is calculated internally. ([#19384](element-hq/synapse#19384)) #### Internal Changes - Add an internal `cancel_task` API to the task scheduler. ([#19310](element-hq/synapse#19310)) - Tweak docstrings and signatures of `auth_types_for_event` and `get_catchup_room_event_ids`. ([#19320](element-hq/synapse#19320)) - Replace usage of deprecated `assertEquals` with `assertEqual` in unit test code. ([#19345](element-hq/synapse#19345)) - Drop support for Ubuntu 25.04 'Plucky Puffin', add support for Ubuntu 25.10 'Questing Quokka'. ([#19348](element-hq/synapse#19348)) - Revert "Add an Admin API endpoint for listing quarantined media ([#19268](element-hq/synapse#19268))". ([#19351](element-hq/synapse#19351)) - Bump `mdbook` from 0.4.17 to 0.5.2 and remove our custom table-of-contents plugin in favour of the new default functionality. ([#19356](element-hq/synapse#19356)) - Replace deprecated usage of PyGitHub's `GitRelease.title` with `.name` in release script. ([#19358](element-hq/synapse#19358)) - Update the Element logo in Synapse's README to be an absolute URL, allowing it to render on other sites (such as PyPI). ([#19368](element-hq/synapse#19368)) - Apply minor tweaks to v1.145.0 changelog. ([#19376](element-hq/synapse#19376)) - Update Grafana dashboard syntax to use the latest from importing/exporting with Grafana 12.3.1. ([#19381](element-hq/synapse#19381)) - Warn about skipping reactor metrics when using unknown reactor type. ([#19383](element-hq/synapse#19383)) - Add support for reactor metrics with the `ProxiedReactor` used in worker Complement tests. ([#19385](element-hq/synapse#19385)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://gitea.alexlebens.dev/alexlebens/infrastructure/pulls/3533 Co-authored-by: Renovate Bot <renovate-bot@alexlebens.net> Co-committed-by: Renovate Bot <renovate-bot@alexlebens.net>

MatMaul force-pushed the add-cancel-task branch from 5764441 to 35a8c58 Compare December 16, 2025 16:16

MatMaul changed the title ~~Add cancel_task API to the task scheduler.~~ Add cancel_task API to the task scheduler Dec 16, 2025

MatMaul force-pushed the add-cancel-task branch 2 times, most recently from dd7ab8e to a3f995b Compare December 16, 2025 16:39

Add cancel_task API to the task scheduler

fa92257

MatMaul force-pushed the add-cancel-task branch from a3f995b to fa92257 Compare December 16, 2025 16:44

Improve tests

960fa62

MatMaul marked this pull request as ready for review December 17, 2025 10:51

MatMaul requested a review from a team as a code owner December 17, 2025 10:51

Remove global command queue since on_CANCEL_TASK can be async

0d32554

MatMaul commented Dec 19, 2025

View reviewed changes

synapse/util/task_scheduler.py Outdated Show resolved Hide resolved

Remove potential race

3b3d417

MatMaul force-pushed the add-cancel-task branch from 9199f0e to 3b3d417 Compare December 24, 2025 12:06

anoadragon453 requested changes Dec 29, 2025

View reviewed changes

MatMaul and others added 3 commits January 5, 2026 17:00

Apply suggestions from code review

50aa191

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

Address comments

58185fb

Rename parameter for coherency

0d4b8ed

MatMaul force-pushed the add-cancel-task branch from 53ee513 to 0d4b8ed Compare January 5, 2026 17:13

MatMaul added 2 commits January 5, 2026 18:18

Add logs

90327ee

Fix test

2166976

MatMaul requested a review from anoadragon453 January 5, 2026 17:59

anoadragon453 requested changes Jan 6, 2026

View reviewed changes

synapse/util/task_scheduler.py Outdated Show resolved Hide resolved

synapse/types/__init__.py Show resolved Hide resolved

MatMaul and others added 2 commits January 7, 2026 12:44

Update synapse/util/task_scheduler.py

22fadec

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

Add API compatibility

ee0501c

MatMaul requested a review from anoadragon453 January 7, 2026 12:18

anoadragon453 approved these changes Jan 7, 2026

View reviewed changes

synapse/rest/admin/scheduled_tasks.py Outdated Show resolved Hide resolved

Update synapse/rest/admin/scheduled_tasks.py

21828b8

Co-authored-by: Andrew Morgan <1342360+anoadragon453@users.noreply.github.com>

MatMaul requested a review from anoadragon453 January 7, 2026 19:26

anoadragon453 approved these changes Jan 8, 2026

View reviewed changes

anoadragon453 merged commit d372ab3 into element-hq:develop Jan 8, 2026
43 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add cancel_task API to the task scheduler#19310

Add cancel_task API to the task scheduler#19310
anoadragon453 merged 12 commits intoelement-hq:developfrom
tchapgouv:add-cancel-task

MatMaul commented Dec 16, 2025 •

edited

Loading

Uh oh!

Uh oh!

anoadragon453 left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

anoadragon453 left a comment

Uh oh!

Uh oh!

Uh oh!

anoadragon453 left a comment

Uh oh!

Uh oh!

anoadragon453 left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

MatMaul commented Dec 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Checklist

Uh oh!

Uh oh!

anoadragon453 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

anoadragon453 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

anoadragon453 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

anoadragon453 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

MatMaul commented Dec 16, 2025 •

edited

Loading