♻️Maintenance: improve cancellation error handling #8367
Merged
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR improves cancellation error handling in the asyncio codebase by replacing manual task cancellation patterns with the centralized cancel_wait_task utility function. The changes follow best practices for asyncio.CancelledError handling to ensure proper cancellation propagation.
- Replaces manual task cancellation with
cancel_wait_taskutility function - Improves CancelledError handling to properly propagate cancellations when the owner function is being cancelled
- Updates redis-commander image and fixes a typo
Reviewed Changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| services/web/server/tests/unit/with_dbs/docker-compose-devel.yml | Updates redis-commander image and adds user configuration |
| services/docker-compose-ops.yml | Updates redis-commander image and adds user configuration |
| services/director-v2/src/simcore_service_director_v2/modules/dynamic_sidecar/scheduler/_core/_scheduler.py | Replaces manual task cancellation with cancel_wait_task utility |
| services/director-v2/src/simcore_service_director_v2/modules/dynamic_sidecar/scheduler/_core/_observer.py | Removes unnecessary CancelledError catch-and-reraise pattern |
| services/catalog/src/simcore_service_catalog/core/background_tasks.py | Removes noqa comment from CancelledError handling |
| packages/service-library/tests/redis/test_decorators.py | Fixes typo in comment |
| packages/service-library/src/servicelib/utils.py | Removes ellipsis from function overloads and noqa comment |
| packages/service-library/src/servicelib/redis/_utils.py | Improves type annotations with ParamSpec and TypeVar |
| packages/service-library/src/servicelib/redis/_decorators.py | Replaces manual task cancellation with cancel_wait_task utility |
| packages/service-library/src/servicelib/long_running_tasks/task.py | Adds proper cancellation propagation check |
| packages/service-library/src/servicelib/fastapi/requests_decorators.py | Replaces manual task cancellation with cancel_wait_task utility |
| packages/service-library/src/servicelib/deferred_tasks/_worker_tracker.py | Adds proper cancellation propagation check |
| packages/service-library/src/servicelib/async_utils.py | Replaces manual task cancellation with cancel_wait_task utility |
| packages/common-library/src/common_library/async_tools.py | Improves cancel_wait_task implementation with better error handling |
| .github/instructions/python.instructions.md | Restructures instructions file and adds testing guidelines |
| .github/instructions/node.instructions.md | Creates new Node.js specific instructions file |
| .github/instructions/general.md.instructions.md | Creates general instructions with typo in filename |
| .github/instructions/general.instructions.md | Creates general instructions file |
Codecov Report❌ Patch coverage is Additional details and impacted files@@ Coverage Diff @@
## master #8367 +/- ##
==========================================
- Coverage 87.88% 87.86% -0.02%
==========================================
Files 1945 1945
Lines 75620 75626 +6
Branches 1316 1321 +5
==========================================
- Hits 66458 66451 -7
- Misses 8765 8777 +12
- Partials 397 398 +1
Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
🧪 CI InsightsHere's what we observed from your CI run for c091814. ❌ Job Failures
✅ Passed Jobs With Interesting Signals
|
sanderegg
force-pushed
the
maintenance/improve-cancellation-error-handling
branch
from
88e3c72 to
110c727
Compare
sanderegg
requested review from
GitHK,
giancarloromeo,
matusdrobuliak66 and
pcrespov
as code owners
giancarloromeo
approved these changes
Sep 15, 2025
pcrespov
approved these changes
Sep 15, 2025
packages/service-library/src/servicelib/deferred_tasks/_worker_tracker.py
Show resolved
Hide resolved
...ctor-v2/src/simcore_service_director_v2/modules/dynamic_sidecar/scheduler/_core/_observer.py
Show resolved
Hide resolved
|
sanderegg
deleted the
maintenance/improve-cancellation-error-handling
branch
This was referenced Sep 18, 2025
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
What do these changes do?
asyncio.CancelledErrorThis should never be consumed anywhere without good reasons --> Always re-raise as any coroutine may be cancelledRelated issue/s
How to test
Dev-ops