🎨 ♻️ Improves task cancellation with new cancel_and_wait utility
#7956
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
pcrespov
changed the title
cancel_and_wait tool
pcrespov
changed the title
cancel_and_wait toolcancel_and_wait utility
pcrespov
requested review from
GitHK,
giancarloromeo,
matusdrobuliak66 and
sanderegg
as code owners
Member
Author
|
@mergify queue |
Contributor
🟠 Waiting for conditions to match
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
Introduces a new cancel_and_wait utility to standardize asyncio task cancellation across services and replaces ad-hoc cancel/await logic. Also adds unit tests for the new utility.
- Added
cancel_and_waitimplementation incommon_library.async_tools - Updated multiple cleanup functions in payment and garbage-collector modules to use
cancel_and_wait - Added tests for
cancel_and_waitintest_async_tools.py
Reviewed Changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| services/web/server/src/simcore_service_webserver/payments/_tasks.py | Replaced manual cancel/await with cancel_and_wait |
| services/web/server/src/simcore_service_webserver/garbage_collector/_tasks_users.py | Ditto for user GC task |
| services/web/server/src/simcore_service_webserver/garbage_collector/_tasks_trash.py | Ditto for trash GC task |
| services/web/server/src/simcore_service_webserver/garbage_collector/_tasks_core.py | Ditto for core GC background task |
| services/web/server/src/simcore_service_webserver/garbage_collector/_tasks_api_keys.py | Ditto for API-key GC task |
| packages/common-library/src/common_library/async_tools.py | New cancel_and_wait function added |
| packages/common-library/tests/test_async_tools.py | Tests for cancel_and_wait added |
Comments suppressed due to low confidence (1)
packages/common-library/tests/test_async_tools.py:6
- The tests reference
asyncio(e.g.,asyncio.sleep,asyncio.create_task) but don't import it. Addimport asyncioat the top of the file.
from common_library.async_tools import cancel_and_wait, make_async, maybe_await
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #7956 +/- ##
==========================================
- Coverage 87.83% 87.62% -0.21%
==========================================
Files 1849 1451 -398
Lines 71343 59996 -11347
Branches 1250 705 -545
==========================================
- Hits 62663 52572 -10091
+ Misses 8318 7189 -1129
+ Partials 362 235 -127
Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
sanderegg
requested changes
Jun 23, 2025
Member
sanderegg
left a comment
sanderegg
left a comment
There was a problem hiding this comment.
Please replace the other one called cancel_wait_task thanks!
pcrespov
changed the title
cancel_and_wait utilitycancel_and_wait utility
pcrespov
changed the title
cancel_and_wait utilitycancel_and_wait utility
giancarloromeo
approved these changes
Jun 24, 2025
pcrespov
force-pushed
the
mai/sonarcloud-task-cancellation
branch
2 times, most recently
from
70c353e to
d502eaa
Compare
matusdrobuliak66
approved these changes
Jun 24, 2025
pcrespov
force-pushed
the
mai/sonarcloud-task-cancellation
branch
from
cfe5917 to
cc1ffe1
Compare
… garbage collector tasks
pcrespov
force-pushed
the
mai/sonarcloud-task-cancellation
branch
from
7400200 to
b715ab0
Compare
Member
Author
|
@mergify queue |
Contributor
🟠 Waiting for conditions to match
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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?
This pull request introduces a new utility function,
cancel_and_wait, to simplify and standardize the cancellation and cleanup of asyncio tasks. It also updates existing code to use this function in various services and adds corresponding unit tests to ensure its correctness._cleanup_ctx_funin multiple service files to usecancel_and_waitfor task cancellation to solvesonarcloudwarnings:services/web/server/src/simcore_service_webserver/garbage_collector/_tasks_api_keys.pyservices/web/server/src/simcore_service_webserver/garbage_collector/_tasks_core.pyservices/web/server/src/simcore_service_webserver/garbage_collector/_tasks_trash.pyservices/web/server/src/simcore_service_webserver/garbage_collector/_tasks_users.pyservices/web/server/src/simcore_service_webserver/payments/_tasks.pyservicelib.cancel_wait_taskRelated issue/s
How to test
Dev-ops
NOne