-
Notifications
You must be signed in to change notification settings - Fork 1.1k
PYTHON-4745 - Test behavior of async task cancellation #2136
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
Merged
Merged
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
2601054
PYTHON-4745 - Document and Test Behavior when User Cancels Async Oper…
NoahStapp e27062c
WIP
NoahStapp 91eb68f
WIP
NoahStapp fd18b7a
Verify that connections, transactions, and cursors are terminated whe…
NoahStapp 4906897
Test change_stream cancellation
NoahStapp 09b545d
Fix platform requirements
NoahStapp cbc1160
More require updates
NoahStapp fcaf8f9
Add comments to catching BaseException, speed up tests
NoahStapp 4fd6b13
Performance improvements
NoahStapp File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,136 @@ | ||
# Copyright 2025-present MongoDB, Inc. | ||
# | ||
# Licensed under the Apache License, Version 2.0 (the "License"); | ||
# you may not use this file except in compliance with the License. | ||
# You may obtain a copy of the License at | ||
# | ||
# http://www.apache.org/licenses/LICENSE-2.0 | ||
# | ||
# Unless required by applicable law or agreed to in writing, software | ||
# distributed under the License is distributed on an "AS IS" BASIS, | ||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
# See the License for the specific language governing permissions and | ||
# limitations under the License. | ||
|
||
"""Test that async cancellation performed by users clean up resources correctly.""" | ||
from __future__ import annotations | ||
|
||
import asyncio | ||
import sys | ||
from test.utils import async_get_pool, delay, one | ||
|
||
sys.path[0:0] = [""] | ||
|
||
from test.asynchronous import AsyncIntegrationTest, async_client_context, connected | ||
|
||
|
||
class TestAsyncCancellation(AsyncIntegrationTest): | ||
async def test_async_cancellation_closes_connection(self): | ||
client = await self.async_rs_or_single_client(maxPoolSize=1) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think all of these tests can reuse the global test client instead of creating new ones. |
||
pool = await async_get_pool(client) | ||
await connected(client) | ||
conn = one(pool.conns) | ||
await client.db.test.insert_one({"x": 1}) | ||
self.addAsyncCleanup(client.db.test.drop) | ||
|
||
async def task(): | ||
await client.db.test.find_one({"$where": delay(0.2)}) | ||
|
||
task = asyncio.create_task(task()) | ||
|
||
await asyncio.sleep(0.1) | ||
|
||
task.cancel() | ||
with self.assertRaises(asyncio.CancelledError): | ||
await task | ||
|
||
self.assertTrue(conn.closed) | ||
|
||
@async_client_context.require_transactions | ||
async def test_async_cancellation_aborts_transaction(self): | ||
client = await self.async_rs_or_single_client() | ||
await connected(client) | ||
await client.db.test.insert_one({"x": 1}) | ||
self.addAsyncCleanup(client.db.test.drop) | ||
|
||
session = client.start_session() | ||
|
||
async def callback(session): | ||
await client.db.test.find_one({"$where": delay(0.2)}, session=session) | ||
|
||
async def task(): | ||
await session.with_transaction(callback) | ||
|
||
task = asyncio.create_task(task()) | ||
|
||
await asyncio.sleep(0.1) | ||
|
||
task.cancel() | ||
with self.assertRaises(asyncio.CancelledError): | ||
await task | ||
|
||
self.assertFalse(session.in_transaction) | ||
|
||
@async_client_context.require_failCommand_blockConnection | ||
async def test_async_cancellation_closes_cursor(self): | ||
client = await self.async_rs_or_single_client() | ||
await connected(client) | ||
for _ in range(2): | ||
await client.db.test.insert_one({"x": 1}) | ||
self.addAsyncCleanup(client.db.test.drop) | ||
|
||
cursor = client.db.test.find({}, batch_size=1) | ||
await cursor.next() | ||
|
||
# Make sure getMore commands block | ||
fail_command = { | ||
"configureFailPoint": "failCommand", | ||
"mode": "alwaysOn", | ||
"data": {"failCommands": ["getMore"], "blockConnection": True, "blockTimeMS": 200}, | ||
} | ||
|
||
async def task(): | ||
async with self.fail_point(fail_command): | ||
await cursor.next() | ||
|
||
task = asyncio.create_task(task()) | ||
|
||
await asyncio.sleep(0.1) | ||
|
||
task.cancel() | ||
with self.assertRaises(asyncio.CancelledError): | ||
await task | ||
|
||
self.assertTrue(cursor._killed) | ||
|
||
@async_client_context.require_change_streams | ||
@async_client_context.require_failCommand_blockConnection | ||
async def test_async_cancellation_closes_change_stream(self): | ||
client = await self.async_rs_or_single_client() | ||
await connected(client) | ||
self.addAsyncCleanup(client.db.test.drop) | ||
|
||
change_stream = await client.db.test.watch(batch_size=2) | ||
|
||
# Make sure getMore commands block | ||
fail_command = { | ||
"configureFailPoint": "failCommand", | ||
"mode": "alwaysOn", | ||
"data": {"failCommands": ["getMore"], "blockConnection": True, "blockTimeMS": 200}, | ||
} | ||
|
||
async def task(): | ||
async with self.fail_point(fail_command): | ||
for _ in range(2): | ||
await client.db.test.insert_one({"x": 1}) | ||
await change_stream.next() | ||
|
||
task = asyncio.create_task(task()) | ||
|
||
await asyncio.sleep(0.1) | ||
|
||
task.cancel() | ||
with self.assertRaises(asyncio.CancelledError): | ||
await task | ||
|
||
self.assertTrue(change_stream._closed) |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Everywhere we catch BaseException, can you add a one line comment to explain it's intentional? Something like: