1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
|
import asyncio
import random
from concurrent.futures import ThreadPoolExecutor
from contextlib import suppress
from typing import Any, Callable
from unittest import mock
import pytest
from aiohttp import WSMsgType
from aiohttp._websocket.reader import WebSocketDataQueue
from aiohttp.base_protocol import BaseProtocol
from aiohttp.compression_utils import ZLibBackend
from aiohttp.http import WebSocketReader, WebSocketWriter
@pytest.fixture
def protocol():
ret = mock.Mock()
ret._drain_helper = mock.AsyncMock()
return ret
@pytest.fixture
def transport():
ret = mock.Mock()
ret.is_closing.return_value = False
return ret
@pytest.fixture
async def writer(loop, protocol, transport):
return WebSocketWriter(protocol, transport, use_mask=False)
async def test_pong(writer: WebSocketWriter) -> None:
await writer.send_frame(b"", WSMsgType.PONG)
writer.transport.write.assert_called_with(b"\x8a\x00") # type: ignore[attr-defined]
async def test_ping(writer: WebSocketWriter) -> None:
await writer.send_frame(b"", WSMsgType.PING)
writer.transport.write.assert_called_with(b"\x89\x00") # type: ignore[attr-defined]
async def test_send_text(writer: WebSocketWriter) -> None:
await writer.send_frame(b"text", WSMsgType.TEXT)
writer.transport.write.assert_called_with(b"\x81\x04text") # type: ignore[attr-defined]
async def test_send_binary(writer: WebSocketWriter) -> None:
await writer.send_frame(b"binary", WSMsgType.BINARY)
writer.transport.write.assert_called_with(b"\x82\x06binary") # type: ignore[attr-defined]
async def test_send_binary_long(writer: WebSocketWriter) -> None:
await writer.send_frame(b"b" * 127, WSMsgType.BINARY)
assert writer.transport.write.call_args[0][0].startswith(b"\x82~\x00\x7fb") # type: ignore[attr-defined]
async def test_send_binary_very_long(writer: WebSocketWriter) -> None:
await writer.send_frame(b"b" * 65537, WSMsgType.BINARY)
assert (
writer.transport.write.call_args_list[0][0][0]
== b"\x82\x7f\x00\x00\x00\x00\x00\x01\x00\x01"
)
assert writer.transport.write.call_args_list[1][0][0] == b"b" * 65537
async def test_close(writer) -> None:
await writer.close(1001, "msg")
writer.transport.write.assert_called_with(b"\x88\x05\x03\xe9msg")
await writer.close(1001, b"msg")
writer.transport.write.assert_called_with(b"\x88\x05\x03\xe9msg")
# Test that Service Restart close code is also supported
await writer.close(1012, b"msg")
writer.transport.write.assert_called_with(b"\x88\x05\x03\xf4msg")
async def test_send_text_masked(protocol, transport) -> None:
writer = WebSocketWriter(
protocol, transport, use_mask=True, random=random.Random(123)
)
await writer.send_frame(b"text", WSMsgType.TEXT)
writer.transport.write.assert_called_with(b"\x81\x84\rg\xb3fy\x02\xcb\x12") # type: ignore[attr-defined]
@pytest.mark.usefixtures("parametrize_zlib_backend")
async def test_send_compress_text(protocol, transport) -> None:
compress_obj = ZLibBackend.compressobj(level=ZLibBackend.Z_BEST_SPEED, wbits=-15)
writer = WebSocketWriter(protocol, transport, compress=15)
msg = (
compress_obj.compress(b"text") + compress_obj.flush(ZLibBackend.Z_SYNC_FLUSH)
).removesuffix(b"\x00\x00\xff\xff")
await writer.send_frame(b"text", WSMsgType.TEXT)
writer.transport.write.assert_called_with( # type: ignore[attr-defined]
b"\xc1" + len(msg).to_bytes(1, "big") + msg
)
msg = (
compress_obj.compress(b"text") + compress_obj.flush(ZLibBackend.Z_SYNC_FLUSH)
).removesuffix(b"\x00\x00\xff\xff")
await writer.send_frame(b"text", WSMsgType.TEXT)
writer.transport.write.assert_called_with( # type: ignore[attr-defined]
b"\xc1" + len(msg).to_bytes(1, "big") + msg
)
@pytest.mark.usefixtures("parametrize_zlib_backend")
async def test_send_compress_text_notakeover(protocol, transport) -> None:
compress_obj = ZLibBackend.compressobj(level=ZLibBackend.Z_BEST_SPEED, wbits=-15)
writer = WebSocketWriter(protocol, transport, compress=15, notakeover=True)
msg = (
compress_obj.compress(b"text") + compress_obj.flush(ZLibBackend.Z_FULL_FLUSH)
).removesuffix(b"\x00\x00\xff\xff")
await writer.send_frame(b"text", WSMsgType.TEXT)
writer.transport.write.assert_called_with( # type: ignore[attr-defined]
b"\xc1" + len(msg).to_bytes(1, "big") + msg
)
await writer.send_frame(b"text", WSMsgType.TEXT)
writer.transport.write.assert_called_with( # type: ignore[attr-defined]
b"\xc1" + len(msg).to_bytes(1, "big") + msg
)
async def test_send_compress_text_per_message(protocol, transport) -> None:
writer = WebSocketWriter(protocol, transport)
await writer.send_frame(b"text", WSMsgType.TEXT, compress=15)
writer.transport.write.assert_called_with(b"\xc1\x06*I\xad(\x01\x00") # type: ignore[attr-defined]
await writer.send_frame(b"text", WSMsgType.TEXT)
writer.transport.write.assert_called_with(b"\x81\x04text") # type: ignore[attr-defined]
await writer.send_frame(b"text", WSMsgType.TEXT, compress=15)
writer.transport.write.assert_called_with(b"\xc1\x06*I\xad(\x01\x00") # type: ignore[attr-defined]
@pytest.mark.usefixtures("parametrize_zlib_backend")
async def test_send_compress_cancelled(
protocol: BaseProtocol,
transport: asyncio.Transport,
slow_executor: ThreadPoolExecutor,
monkeypatch: pytest.MonkeyPatch,
) -> None:
"""Test that cancelled compression doesn't corrupt subsequent sends.
Regression test for https://github.com/aio-libs/aiohttp/issues/11725
"""
monkeypatch.setattr("aiohttp._websocket.writer.WEBSOCKET_MAX_SYNC_CHUNK_SIZE", 1024)
writer = WebSocketWriter(protocol, transport, compress=15)
loop = asyncio.get_running_loop()
queue = WebSocketDataQueue(mock.Mock(_reading_paused=False), 2**16, loop=loop)
reader = WebSocketReader(queue, 50000)
# Replace executor with slow one to make race condition reproducible
writer._compressobj = writer._get_compressor(None)
writer._compressobj._executor = slow_executor
# Create large data that will trigger executor-based compression
large_data_1 = b"A" * 10000
large_data_2 = b"B" * 10000
# Start first send and cancel it during compression
async def send_and_cancel() -> None:
await writer.send_frame(large_data_1, WSMsgType.BINARY)
task = asyncio.create_task(send_and_cancel())
# Give it a moment to start compression
await asyncio.sleep(0.01)
task.cancel()
# Await task cancellation (expected and intentionally ignored)
with suppress(asyncio.CancelledError):
await task
# Send second message - this should NOT be corrupted
await writer.send_frame(large_data_2, WSMsgType.BINARY)
# Verify the second send produced correct data
last_call = writer.transport.write.call_args_list[-1] # type: ignore[attr-defined]
call_bytes = last_call[0][0]
result, _ = reader.feed_data(call_bytes)
assert result is False
msg = await queue.read()
assert msg.type is WSMsgType.BINARY
# The data should be all B's, not mixed with A's from the cancelled send
assert msg.data == large_data_2
@pytest.mark.usefixtures("parametrize_zlib_backend")
async def test_send_compress_multiple_cancelled(
protocol: BaseProtocol,
transport: asyncio.Transport,
slow_executor: ThreadPoolExecutor,
monkeypatch: pytest.MonkeyPatch,
) -> None:
"""Test that multiple compressed sends all complete despite cancellation.
Regression test for https://github.com/aio-libs/aiohttp/issues/11725
This verifies that once a send operation enters the shield, it completes
even if cancelled. With the lock inside the shield, all tasks that enter
the shield will complete their sends, even while waiting for the lock.
"""
monkeypatch.setattr("aiohttp._websocket.writer.WEBSOCKET_MAX_SYNC_CHUNK_SIZE", 1024)
writer = WebSocketWriter(protocol, transport, compress=15)
loop = asyncio.get_running_loop()
queue = WebSocketDataQueue(mock.Mock(_reading_paused=False), 2**16, loop=loop)
reader = WebSocketReader(queue, 50000)
# Replace executor with slow one
writer._compressobj = writer._get_compressor(None)
writer._compressobj._executor = slow_executor
# Create 5 large messages with different content
messages = [bytes([ord("A") + i]) * 10000 for i in range(5)]
# Start sending all 5 messages - they'll queue due to the lock
tasks = [
asyncio.create_task(writer.send_frame(msg, WSMsgType.BINARY))
for msg in messages
]
# Cancel all tasks during execution
# With lock inside shield, all tasks that enter the shield will complete
# even while waiting for the lock
await asyncio.sleep(0.1) # Let tasks enter the shield
for task in tasks:
task.cancel()
# Collect results
cancelled_count = 0
for task in tasks:
try:
await task
except asyncio.CancelledError:
cancelled_count += 1
# Wait for all background tasks to complete
# (they continue running even after cancellation due to shield)
await asyncio.gather(*writer._background_tasks, return_exceptions=True)
# All tasks that entered the shield should complete, even if cancelled
# With lock inside shield, all tasks enter shield immediately then wait for lock
sent_count = len(writer.transport.write.call_args_list) # type: ignore[attr-defined]
assert (
sent_count == 5
), "All 5 sends should complete due to shield protecting lock acquisition"
# Verify all sent messages are correct (no corruption)
for i in range(sent_count):
call = writer.transport.write.call_args_list[i] # type: ignore[attr-defined]
call_bytes = call[0][0]
result, _ = reader.feed_data(call_bytes)
assert result is False
msg = await queue.read()
assert msg.type is WSMsgType.BINARY
# Verify the data matches the expected message
expected_byte = bytes([ord("A") + i])
assert msg.data == expected_byte * 10000, f"Message {i} corrupted"
@pytest.mark.parametrize(
("max_sync_chunk_size", "payload_point_generator"),
(
(16, lambda count: count),
(4096, lambda count: count),
(32, lambda count: 64 + count if count % 2 else count),
),
)
@pytest.mark.usefixtures("parametrize_zlib_backend")
async def test_concurrent_messages(
protocol: Any,
transport: Any,
max_sync_chunk_size: int,
payload_point_generator: Callable[[int], int],
) -> None:
"""Ensure messages are compressed correctly when there are multiple concurrent writers.
This test generates is parametrized to
- Generate messages that are larger than patch
WEBSOCKET_MAX_SYNC_CHUNK_SIZE of 16
where compression will run in the executor
- Generate messages that are smaller than patch
WEBSOCKET_MAX_SYNC_CHUNK_SIZE of 4096
where compression will run in the event loop
- Interleave generated messages with a
WEBSOCKET_MAX_SYNC_CHUNK_SIZE of 32
where compression will run in the event loop
and in the executor
"""
with mock.patch(
"aiohttp._websocket.writer.WEBSOCKET_MAX_SYNC_CHUNK_SIZE", max_sync_chunk_size
):
writer = WebSocketWriter(protocol, transport, compress=15)
loop = asyncio.get_running_loop()
queue = WebSocketDataQueue(mock.Mock(_reading_paused=False), 2**16, loop=loop)
reader = WebSocketReader(queue, 50000)
writers = []
payloads = []
for count in range(1, 64 + 1):
point = payload_point_generator(count)
payload = bytes((point,)) * point
payloads.append(payload)
writers.append(writer.send_frame(payload, WSMsgType.BINARY))
await asyncio.gather(*writers)
for call in writer.transport.write.call_args_list:
call_bytes = call[0][0]
result, _ = reader.feed_data(call_bytes)
assert result is False
msg = await queue.read()
bytes_data: bytes = msg.data
first_char = bytes_data[0:1]
char_val = ord(first_char)
assert len(bytes_data) == char_val
# If we have a concurrency problem, the data
# tends to get mixed up between messages so
# we want to validate that all the bytes are
# the same value
assert bytes_data == bytes_data[0:1] * char_val
# Wait for any background tasks to complete
await asyncio.gather(*writer._background_tasks, return_exceptions=True)
|