Skip to content

Python 3.8+ handle cancellation during HELLO #801

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
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion neo4j/_async/io/_bolt.py
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,11 @@ def time_remaining():
await connection.hello()
finally:
connection.socket.set_deadline(None)
except Exception as e:
except (
Exception,
# Python 3.8+: CancelledError is a subclass of BaseException
asyncio.CancelledError,
) as e:
log.debug("[#%04X] C: <OPEN FAILED> %r", connection.local_port, e)
connection.kill()
raise
Expand Down
6 changes: 5 additions & 1 deletion neo4j/_sync/io/_bolt.py
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,11 @@ def time_remaining():
connection.hello()
finally:
connection.socket.set_deadline(None)
except Exception as e:
except (
Exception,
# Python 3.8+: CancelledError is a subclass of BaseException
asyncio.CancelledError,
) as e:
log.debug("[#%04X] C: <OPEN FAILED> %r", connection.local_port, e)
connection.kill()
raise
Expand Down
29 changes: 29 additions & 0 deletions tests/unit/async_/io/test_class_bolt.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,14 @@
# limitations under the License.


import asyncio

import pytest

from neo4j._async.io import AsyncBolt
from neo4j._async_compat.network import AsyncBoltSocket

from ...._async_compat import AsyncTestDecorators


# python -m pytest tests/unit/io/test_class_bolt.py -s -v
Expand Down Expand Up @@ -74,3 +79,27 @@ def test_magic_preamble():
preamble = 0x6060B017
preamble_bytes = preamble.to_bytes(4, byteorder="big")
assert AsyncBolt.MAGIC_PREAMBLE == preamble_bytes


@AsyncTestDecorators.mark_async_only_test
async def test_cancel_hello_in_open(mocker):
address = ("localhost", 7687)
socket_mock = mocker.AsyncMock(spec=AsyncBoltSocket)

socket_cls_mock = mocker.patch("neo4j._async.io._bolt.AsyncBoltSocket",
autospec=True)
socket_cls_mock.connect.return_value = (
socket_mock, (5, 0), None, None
)
socket_mock.getpeername.return_value = address
bolt_cls_mock = mocker.patch("neo4j._async.io._bolt5.AsyncBolt5x0",
autospec=True)
bolt_mock = bolt_cls_mock.return_value
bolt_mock.socket = socket_mock
bolt_mock.hello.side_effect = asyncio.CancelledError()
bolt_mock.local_port = 1234

with pytest.raises(asyncio.CancelledError):
await AsyncBolt.open(address)

bolt_mock.kill.assert_called_once_with()
29 changes: 29 additions & 0 deletions tests/unit/sync/io/test_class_bolt.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,15 @@
# limitations under the License.


import asyncio

import pytest

from neo4j._async_compat.network import BoltSocket
from neo4j._sync.io import Bolt

from ...._async_compat import TestDecorators


# python -m pytest tests/unit/io/test_class_bolt.py -s -v

Expand Down Expand Up @@ -74,3 +79,27 @@ def test_magic_preamble():
preamble = 0x6060B017
preamble_bytes = preamble.to_bytes(4, byteorder="big")
assert Bolt.MAGIC_PREAMBLE == preamble_bytes


@TestDecorators.mark_async_only_test
def test_cancel_hello_in_open(mocker):
address = ("localhost", 7687)
socket_mock = mocker.Mock(spec=BoltSocket)

socket_cls_mock = mocker.patch("neo4j._sync.io._bolt.BoltSocket",
autospec=True)
socket_cls_mock.connect.return_value = (
socket_mock, (5, 0), None, None
)
socket_mock.getpeername.return_value = address
bolt_cls_mock = mocker.patch("neo4j._sync.io._bolt5.Bolt5x0",
autospec=True)
bolt_mock = bolt_cls_mock.return_value
bolt_mock.socket = socket_mock
bolt_mock.hello.side_effect = asyncio.CancelledError()
bolt_mock.local_port = 1234

with pytest.raises(asyncio.CancelledError):
Bolt.open(address)

bolt_mock.kill.assert_called_once_with()